Class: OrderCloud::MessageSendersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/order_cloud/api/message_senders_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MessageSendersApi

Returns a new instance of MessageSendersApi.



30
31
32
 
# File 'lib/order_cloud/api/message_senders_api.rb', line 30

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/order_cloud/api/message_senders_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#delete_assignment(message_sender_id, opts = {}) ⇒ nil

Parameters:

  • message_sender_id —

    ID of the message sender.

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

    the optional parameters

Options Hash (opts):

  • :buyer_id (String) —

    ID of the buyer.

  • :user_id (String) —

    ID of the user.

  • :user_group_id (String) —

    ID of the user group.

Returns:

  • (nil) 


42
43
44
45
 
# File 'lib/order_cloud/api/message_senders_api.rb', line 42

def delete_assignment(message_sender_id, opts = {})
  delete_assignment_with_http_info(message_sender_id, opts)
  return nil
end

#delete_assignment_with_http_info(message_sender_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • message_sender_id —

    ID of the message sender.

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

    the optional parameters

Options Hash (opts):

  • :buyer_id (String) —

    ID of the buyer.

  • :user_id (String) —

    ID of the user.

  • :user_group_id (String) —

    ID of the user group.

Returns:

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

    nil, response status code and response headers



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
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/order_cloud/api/message_senders_api.rb', line 55

def delete_assignment_with_http_info(message_sender_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessageSendersApi.delete_assignment ..."
  end
  # verify the required parameter 'message_sender_id' is set
  fail ArgumentError, "Missing the required parameter 'message_sender_id' when calling MessageSendersApi.delete_assignment" if message_sender_id.nil?
  # resource path
  local_var_path = "/messagesenders/{messageSenderID}/assignments".sub('{format}','json').sub('{' + 'messageSenderID' + '}', message_sender_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'buyerID'] = opts[:'buyer_id'] if !opts[:'buyer_id'].nil?
  query_params[:'userID'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'userGroupID'] = opts[:'user_group_id'] if !opts[:'user_group_id'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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', 'text/plain; 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 = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessageSendersApi#delete_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(message_sender_id, opts = {}) ⇒ MessageSender

Parameters:

  • message_sender_id —

    ID of the message sender.

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

    the optional parameters

Returns:



104
105
106
107
 
# File 'lib/order_cloud/api/message_senders_api.rb', line 104

def get(message_sender_id, opts = {})
  data, _status_code, _headers = get_with_http_info(message_sender_id, opts)
  return data
end

#get_with_http_info(message_sender_id, opts = {}) ⇒ Array<(MessageSender, Fixnum, Hash)>

Returns MessageSender data, response status code and response headers.

Parameters:

  • message_sender_id —

    ID of the message sender.

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

    the optional parameters

Returns:

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

    MessageSender data, response status code and response headers



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
149
150
151
152
153
154
 
# File 'lib/order_cloud/api/message_senders_api.rb', line 114

def get_with_http_info(message_sender_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessageSendersApi.get ..."
  end
  # verify the required parameter 'message_sender_id' is set
  fail ArgumentError, "Missing the required parameter 'message_sender_id' when calling MessageSendersApi.get" if message_sender_id.nil?
  # resource path
  local_var_path = "/messagesenders/{messageSenderID}".sub('{format}','json').sub('{' + 'messageSenderID' + '}', message_sender_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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', 'text/plain; 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 = nil
  auth_names = ['oauth2']
  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 => 'MessageSender')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessageSendersApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ ListMessageSender

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the message sender.

  • :search_on (Array<String>) —

    Search on of the message sender.

  • :sort_by (Array<String>) —

    Sort by of the message sender.

  • :page (Integer) —

    Page of the message sender.

  • :page_size (Integer) —

    Page size of the message sender.

  • :filters (Hash<String, String>) —

    Filters of the message sender.

Returns:



166
167
168
169
 
# File 'lib/order_cloud/api/message_senders_api.rb', line 166

def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  return data
end

#list_assignments(opts = {}) ⇒ ListMessageSenderAssignment

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :buyer_id (String) —

    ID of the buyer.

  • :message_sender_id (String) —

    ID of the message sender.

  • :user_id (String) —

    ID of the user.

  • :user_group_id (String) —

    ID of the user group.

  • :level (String) —

    Level of the message sender.

  • :page (Integer) —

    Page of the message sender.

  • :page_size (Integer) —

    Page size of the message sender.

Returns:



238
239
240
241
 
# File 'lib/order_cloud/api/message_senders_api.rb', line 238

def list_assignments(opts = {})
  data, _status_code, _headers = list_assignments_with_http_info(opts)
  return data
end

#list_assignments_with_http_info(opts = {}) ⇒ Array<(ListMessageSenderAssignment, Fixnum, Hash)>

Returns ListMessageSenderAssignment data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :buyer_id (String) —

    ID of the buyer.

  • :message_sender_id (String) —

    ID of the message sender.

  • :user_id (String) —

    ID of the user.

  • :user_group_id (String) —

    ID of the user group.

  • :level (String) —

    Level of the message sender.

  • :page (Integer) —

    Page of the message sender.

  • :page_size (Integer) —

    Page size of the message sender.

Returns:



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/order_cloud/api/message_senders_api.rb', line 254

def list_assignments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessageSendersApi.list_assignments ..."
  end
  # resource path
  local_var_path = "/messagesenders/assignments".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'buyerID'] = opts[:'buyer_id'] if !opts[:'buyer_id'].nil?
  query_params[:'messageSenderID'] = opts[:'message_sender_id'] if !opts[:'message_sender_id'].nil?
  query_params[:'userID'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'userGroupID'] = opts[:'user_group_id'] if !opts[:'user_group_id'].nil?
  query_params[:'level'] = opts[:'level'] if !opts[:'level'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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', 'text/plain; 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 = nil
  auth_names = ['oauth2']
  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 => 'ListMessageSenderAssignment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessageSendersApi#list_assignments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cc_listener_assignments(opts = {}) ⇒ ListMessageCCListenerAssignment

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the message sender.

  • :search_on (Array<String>) —

    Search on of the message sender.

  • :sort_by (Array<String>) —

    Sort by of the message sender.

  • :page (Integer) —

    Page of the message sender.

  • :page_size (Integer) —

    Page size of the message sender.

  • :filters (Hash<String, String>) —

    Filters of the message sender.

Returns:



311
312
313
314
 
# File 'lib/order_cloud/api/message_senders_api.rb', line 311

def list_cc_listener_assignments(opts = {})
  data, _status_code, _headers = list_cc_listener_assignments_with_http_info(opts)
  return data
end

#list_cc_listener_assignments_with_http_info(opts = {}) ⇒ Array<(ListMessageCCListenerAssignment, Fixnum, Hash)>

Returns ListMessageCCListenerAssignment data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the message sender.

  • :search_on (Array<String>) —

    Search on of the message sender.

  • :sort_by (Array<String>) —

    Sort by of the message sender.

  • :page (Integer) —

    Page of the message sender.

  • :page_size (Integer) —

    Page size of the message sender.

  • :filters (Hash<String, String>) —

    Filters of the message sender.

Returns:



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/order_cloud/api/message_senders_api.rb', line 326

def list_cc_listener_assignments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessageSendersApi.list_cc_listener_assignments ..."
  end
  # resource path
  local_var_path = "/messagesenders/CCListenerAssignments".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'searchOn'] = @api_client.build_collection_param(opts[:'search_on'], :csv) if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = @api_client.build_collection_param(opts[:'sort_by'], :csv) if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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', 'text/plain; 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 = nil
  auth_names = ['oauth2']
  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 => 'ListMessageCCListenerAssignment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessageSendersApi#list_cc_listener_assignments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_with_http_info(opts = {}) ⇒ Array<(ListMessageSender, Fixnum, Hash)>

Returns ListMessageSender data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the message sender.

  • :search_on (Array<String>) —

    Search on of the message sender.

  • :sort_by (Array<String>) —

    Sort by of the message sender.

  • :page (Integer) —

    Page of the message sender.

  • :page_size (Integer) —

    Page size of the message sender.

  • :filters (Hash<String, String>) —

    Filters of the message sender.

Returns:

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

    ListMessageSender data, response status code and response headers



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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/order_cloud/api/message_senders_api.rb', line 181

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessageSendersApi.list ..."
  end
  # resource path
  local_var_path = "/messagesenders".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'searchOn'] = @api_client.build_collection_param(opts[:'search_on'], :csv) if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = @api_client.build_collection_param(opts[:'sort_by'], :csv) if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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', 'text/plain; 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 = nil
  auth_names = ['oauth2']
  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 => 'ListMessageSender')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessageSendersApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#save_assignment(assignment, opts = {}) ⇒ nil

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


377
378
379
380
 
# File 'lib/order_cloud/api/message_senders_api.rb', line 377

def save_assignment(assignment, opts = {})
  save_assignment_with_http_info(assignment, opts)
  return nil
end

#save_assignment_with_http_info(assignment, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/order_cloud/api/message_senders_api.rb', line 387

def save_assignment_with_http_info(assignment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessageSendersApi.save_assignment ..."
  end
  # verify the required parameter 'assignment' is set
  fail ArgumentError, "Missing the required parameter 'assignment' when calling MessageSendersApi.save_assignment" if assignment.nil?
  # resource path
  local_var_path = "/messagesenders/assignments".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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', 'text/plain; 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(assignment)
  auth_names = ['oauth2']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessageSendersApi#save_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#save_cc_listener_assignment(assignment, opts = {}) ⇒ nil

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


433
434
435
436
 
# File 'lib/order_cloud/api/message_senders_api.rb', line 433

def save_cc_listener_assignment(assignment, opts = {})
  save_cc_listener_assignment_with_http_info(assignment, opts)
  return nil
end

#save_cc_listener_assignment_with_http_info(assignment, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/order_cloud/api/message_senders_api.rb', line 443

def save_cc_listener_assignment_with_http_info(assignment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessageSendersApi.save_cc_listener_assignment ..."
  end
  # verify the required parameter 'assignment' is set
  fail ArgumentError, "Missing the required parameter 'assignment' when calling MessageSendersApi.save_cc_listener_assignment" if assignment.nil?
  # resource path
  local_var_path = "/messagesenders/CCListenerAssignments".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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', 'text/plain; 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(assignment)
  auth_names = ['oauth2']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessageSendersApi#save_cc_listener_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end