Class: WhiteLabelMachineName::DeliveryIndicationService

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/api/delivery_indication_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DeliveryIndicationService

Returns a new instance of DeliveryIndicationService.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/delivery_indication_service_api.rb', line 24

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



22
23
24
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/delivery_indication_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#count(space_id, opts = {}) ⇒ Integer

Count Counts the number of items in the database as restricted by the given filter.

Parameters:

  • space_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (EntityQueryFilter) —

    The filter which restricts the entities which are used to calculate the count.

Returns:

  • (Integer) 


34
35
36
37
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/delivery_indication_service_api.rb', line 34

def count(space_id, opts = {})
  data, _status_code, _headers = count_with_http_info(space_id, opts)
  return data
end

#count_with_http_info(space_id, opts = {}) ⇒ Array<(Integer, Fixnum, Hash)>

Count Counts the number of items in the database as restricted by the given filter.

Parameters:

  • space_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (EntityQueryFilter) —

    The filter which restricts the entities which are used to calculate the count.

Returns:

  • (Array<(Integer, Fixnum, Hash)>) —

    Integer data, response status code and response headers



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/delivery_indication_service_api.rb', line 45

def count_with_http_info(space_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DeliveryIndicationService.count ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling DeliveryIndicationService.count" if space_id.nil?
  # resource path
  local_var_path = "/delivery-indication/count".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'filter'])
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Integer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DeliveryIndicationService#count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mark_as_not_suitable(space_id, delivery_indication_id, opts = {}) ⇒ DeliveryIndication

markAsNotSuitable This operation marks the delivery indication as not suitable.

Parameters:

  • space_id
  • delivery_indication_id —

    The delivery indication id which should be marked as not suitable.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/delivery_indication_service_api.rb', line 94

def mark_as_not_suitable(space_id, delivery_indication_id, opts = {})
  data, _status_code, _headers = mark_as_not_suitable_with_http_info(space_id, delivery_indication_id, opts)
  return data
end

#mark_as_not_suitable_with_http_info(space_id, delivery_indication_id, opts = {}) ⇒ Array<(DeliveryIndication, Fixnum, Hash)>

markAsNotSuitable This operation marks the delivery indication as not suitable.

Parameters:

  • space_id
  • delivery_indication_id —

    The delivery indication id which should be marked as not suitable.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DeliveryIndication, Fixnum, Hash)>) —

    DeliveryIndication data, response status code and response headers



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/delivery_indication_service_api.rb', line 105

def mark_as_not_suitable_with_http_info(space_id, delivery_indication_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DeliveryIndicationService.mark_as_not_suitable ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling DeliveryIndicationService.mark_as_not_suitable" if space_id.nil?
  # verify the required parameter 'delivery_indication_id' is set
  fail ArgumentError, "Missing the required parameter 'delivery_indication_id' when calling DeliveryIndicationService.mark_as_not_suitable" if delivery_indication_id.nil?
  # resource path
  local_var_path = "/delivery-indication/markAsNotSuitable".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(delivery_indication_id)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DeliveryIndication')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DeliveryIndicationService#mark_as_not_suitable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mark_as_suitable(space_id, delivery_indication_id, opts = {}) ⇒ DeliveryIndication

markAsSuitable This operation marks the delivery indication as suitable.

Parameters:

  • space_id
  • delivery_indication_id —

    The delivery indication id which should be marked as suitable.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



156
157
158
159
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/delivery_indication_service_api.rb', line 156

def mark_as_suitable(space_id, delivery_indication_id, opts = {})
  data, _status_code, _headers = mark_as_suitable_with_http_info(space_id, delivery_indication_id, opts)
  return data
end

#mark_as_suitable_with_http_info(space_id, delivery_indication_id, opts = {}) ⇒ Array<(DeliveryIndication, Fixnum, Hash)>

markAsSuitable This operation marks the delivery indication as suitable.

Parameters:

  • space_id
  • delivery_indication_id —

    The delivery indication id which should be marked as suitable.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DeliveryIndication, Fixnum, Hash)>) —

    DeliveryIndication data, response status code and response headers



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/delivery_indication_service_api.rb', line 167

def mark_as_suitable_with_http_info(space_id, delivery_indication_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DeliveryIndicationService.mark_as_suitable ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling DeliveryIndicationService.mark_as_suitable" if space_id.nil?
  # verify the required parameter 'delivery_indication_id' is set
  fail ArgumentError, "Missing the required parameter 'delivery_indication_id' when calling DeliveryIndicationService.mark_as_suitable" if delivery_indication_id.nil?
  # resource path
  local_var_path = "/delivery-indication/markAsSuitable".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(delivery_indication_id)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DeliveryIndication')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DeliveryIndicationService#mark_as_suitable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read(space_id, id, opts = {}) ⇒ DeliveryIndication

Read Reads the entity with the given ‘id’ and returns it.

Parameters:

  • space_id
  • id —

    The id of the delivery indication which should be returned.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



218
219
220
221
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/delivery_indication_service_api.rb', line 218

def read(space_id, id, opts = {})
  data, _status_code, _headers = read_with_http_info(space_id, id, opts)
  return data
end

#read_with_http_info(space_id, id, opts = {}) ⇒ Array<(DeliveryIndication, Fixnum, Hash)>

Read Reads the entity with the given &#39;id&#39; and returns it.

Parameters:

  • space_id
  • id —

    The id of the delivery indication which should be returned.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DeliveryIndication, Fixnum, Hash)>) —

    DeliveryIndication data, response status code and response headers



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/delivery_indication_service_api.rb', line 229

def read_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DeliveryIndicationService.read ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling DeliveryIndicationService.read" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling DeliveryIndicationService.read" if id.nil?
  # resource path
  local_var_path = "/delivery-indication/read".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DeliveryIndication')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DeliveryIndicationService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(space_id, query, opts = {}) ⇒ Array<DeliveryIndication>

Search Searches for the entities as specified by the given query.

Parameters:

  • space_id
  • query —

    The query restricts the delivery indications which are returned by the search.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



281
282
283
284
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/delivery_indication_service_api.rb', line 281

def search(space_id, query, opts = {})
  data, _status_code, _headers = search_with_http_info(space_id, query, opts)
  return data
end

#search_with_http_info(space_id, query, opts = {}) ⇒ Array<(Array<DeliveryIndication>, Fixnum, Hash)>

Search Searches for the entities as specified by the given query.

Parameters:

  • space_id
  • query —

    The query restricts the delivery indications which are returned by the search.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<DeliveryIndication>, Fixnum, Hash)>) —

    Array<DeliveryIndication> data, response status code and response headers



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/delivery_indication_service_api.rb', line 292

def search_with_http_info(space_id, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DeliveryIndicationService.search ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling DeliveryIndicationService.search" if space_id.nil?
  # verify the required parameter 'query' is set
  fail ArgumentError, "Missing the required parameter 'query' when calling DeliveryIndicationService.search" if query.nil?
  # resource path
  local_var_path = "/delivery-indication/search".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(query)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<DeliveryIndication>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DeliveryIndicationService#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end