Class: AmzSpApi::MessagingApiModel::MessagingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/messaging-api-model/api/messaging_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MessagingApi

Returns a new instance of MessagingApi.



16
17
18
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#confirm_customization_details(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ CreateConfirmCustomizationDetailsResponse

Sends a message asking a buyer to provide or verify customization details such as name spelling, images, initials, etc. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 25

def confirm_customization_details(body, marketplace_ids, amazon_order_id, opts = {})
  data, _status_code, _headers = confirm_customization_details_with_http_info(body, marketplace_ids, amazon_order_id, opts)
  data
end

#confirm_customization_details_with_http_info(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ Array<(CreateConfirmCustomizationDetailsResponse, Integer, Hash)>

Sends a message asking a buyer to provide or verify customization details such as name spelling, images, initials, etc. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:



36
37
38
39
40
41
42
43
44
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
87
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 36

def confirm_customization_details_with_http_info(body, marketplace_ids, amazon_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagingApi.confirm_customization_details ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MessagingApi.confirm_customization_details"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling MessagingApi.confirm_customization_details"
  end
  # verify the required parameter 'amazon_order_id' is set
  if @api_client.config.client_side_validation && amazon_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'amazon_order_id' when calling MessagingApi.confirm_customization_details"
  end
  # resource path
  local_var_path = '/messaging/v1/orders/{amazonOrderId}/messages/confirmCustomizationDetails'.sub('{' + 'amazonOrderId' + '}', amazon_order_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'CreateConfirmCustomizationDetailsResponse' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#confirm_customization_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_amazon_motors(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ CreateAmazonMotorsResponse

Sends a message to a buyer to provide details about an Amazon Motors order. This message can only be sent by Amazon Motors sellers. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 94

def create_amazon_motors(body, marketplace_ids, amazon_order_id, opts = {})
  data, _status_code, _headers = create_amazon_motors_with_http_info(body, marketplace_ids, amazon_order_id, opts)
  data
end

#create_amazon_motors_with_http_info(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ Array<(CreateAmazonMotorsResponse, Integer, Hash)>

Sends a message to a buyer to provide details about an Amazon Motors order. This message can only be sent by Amazon Motors sellers. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:

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

    CreateAmazonMotorsResponse 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
149
150
151
152
153
154
155
156
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 105

def create_amazon_motors_with_http_info(body, marketplace_ids, amazon_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagingApi.create_amazon_motors ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MessagingApi.create_amazon_motors"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling MessagingApi.create_amazon_motors"
  end
  # verify the required parameter 'amazon_order_id' is set
  if @api_client.config.client_side_validation && amazon_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'amazon_order_id' when calling MessagingApi.create_amazon_motors"
  end
  # resource path
  local_var_path = '/messaging/v1/orders/{amazonOrderId}/messages/amazonMotors'.sub('{' + 'amazonOrderId' + '}', amazon_order_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'CreateAmazonMotorsResponse' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#create_amazon_motors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_confirm_delivery_details(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ CreateConfirmDeliveryDetailsResponse

Sends a message to a buyer to arrange a delivery or to confirm contact information for making a delivery. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:



163
164
165
166
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 163

def create_confirm_delivery_details(body, marketplace_ids, amazon_order_id, opts = {})
  data, _status_code, _headers = create_confirm_delivery_details_with_http_info(body, marketplace_ids, amazon_order_id, opts)
  data
end

#create_confirm_delivery_details_with_http_info(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ Array<(CreateConfirmDeliveryDetailsResponse, Integer, Hash)>

Sends a message to a buyer to arrange a delivery or to confirm contact information for making a delivery. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:



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

def create_confirm_delivery_details_with_http_info(body, marketplace_ids, amazon_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagingApi.create_confirm_delivery_details ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MessagingApi.create_confirm_delivery_details"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling MessagingApi.create_confirm_delivery_details"
  end
  # verify the required parameter 'amazon_order_id' is set
  if @api_client.config.client_side_validation && amazon_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'amazon_order_id' when calling MessagingApi.create_confirm_delivery_details"
  end
  # resource path
  local_var_path = '/messaging/v1/orders/{amazonOrderId}/messages/confirmDeliveryDetails'.sub('{' + 'amazonOrderId' + '}', amazon_order_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'CreateConfirmDeliveryDetailsResponse' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#create_confirm_delivery_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_confirm_order_details(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ CreateConfirmOrderDetailsResponse

Sends a message to ask a buyer an order-related question prior to shipping their order. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:



232
233
234
235
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 232

def create_confirm_order_details(body, marketplace_ids, amazon_order_id, opts = {})
  data, _status_code, _headers = create_confirm_order_details_with_http_info(body, marketplace_ids, amazon_order_id, opts)
  data
end

#create_confirm_order_details_with_http_info(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ Array<(CreateConfirmOrderDetailsResponse, Integer, Hash)>

Sends a message to ask a buyer an order-related question prior to shipping their order. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:



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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 243

def create_confirm_order_details_with_http_info(body, marketplace_ids, amazon_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagingApi.create_confirm_order_details ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MessagingApi.create_confirm_order_details"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling MessagingApi.create_confirm_order_details"
  end
  # verify the required parameter 'amazon_order_id' is set
  if @api_client.config.client_side_validation && amazon_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'amazon_order_id' when calling MessagingApi.create_confirm_order_details"
  end
  # resource path
  local_var_path = '/messaging/v1/orders/{amazonOrderId}/messages/confirmOrderDetails'.sub('{' + 'amazonOrderId' + '}', amazon_order_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'CreateConfirmOrderDetailsResponse' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#create_confirm_order_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_confirm_service_details(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ CreateConfirmServiceDetailsResponse

Sends a message to contact a Home Service customer to arrange a service call or to gather information prior to a service call. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:



301
302
303
304
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 301

def create_confirm_service_details(body, marketplace_ids, amazon_order_id, opts = {})
  data, _status_code, _headers = create_confirm_service_details_with_http_info(body, marketplace_ids, amazon_order_id, opts)
  data
end

#create_confirm_service_details_with_http_info(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ Array<(CreateConfirmServiceDetailsResponse, Integer, Hash)>

Sends a message to contact a Home Service customer to arrange a service call or to gather information prior to a service call. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:



312
313
314
315
316
317
318
319
320
321
322
323
324
325
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
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 312

def create_confirm_service_details_with_http_info(body, marketplace_ids, amazon_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagingApi.create_confirm_service_details ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MessagingApi.create_confirm_service_details"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling MessagingApi.create_confirm_service_details"
  end
  # verify the required parameter 'amazon_order_id' is set
  if @api_client.config.client_side_validation && amazon_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'amazon_order_id' when calling MessagingApi.create_confirm_service_details"
  end
  # resource path
  local_var_path = '/messaging/v1/orders/{amazonOrderId}/messages/confirmServiceDetails'.sub('{' + 'amazonOrderId' + '}', amazon_order_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'CreateConfirmServiceDetailsResponse' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#create_confirm_service_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_digital_access_key(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ CreateDigitalAccessKeyResponse

Sends a message to a buyer to share a digital access key needed to utilize digital content in their order. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:



370
371
372
373
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 370

def create_digital_access_key(body, marketplace_ids, amazon_order_id, opts = {})
  data, _status_code, _headers = create_digital_access_key_with_http_info(body, marketplace_ids, amazon_order_id, opts)
  data
end

#create_digital_access_key_with_http_info(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ Array<(CreateDigitalAccessKeyResponse, Integer, Hash)>

Sends a message to a buyer to share a digital access key needed to utilize digital content in their order. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:



381
382
383
384
385
386
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
427
428
429
430
431
432
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 381

def create_digital_access_key_with_http_info(body, marketplace_ids, amazon_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagingApi.create_digital_access_key ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MessagingApi.create_digital_access_key"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling MessagingApi.create_digital_access_key"
  end
  # verify the required parameter 'amazon_order_id' is set
  if @api_client.config.client_side_validation && amazon_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'amazon_order_id' when calling MessagingApi.create_digital_access_key"
  end
  # resource path
  local_var_path = '/messaging/v1/orders/{amazonOrderId}/messages/digitalAccessKey'.sub('{' + 'amazonOrderId' + '}', amazon_order_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'CreateDigitalAccessKeyResponse' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#create_digital_access_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_legal_disclosure(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ CreateLegalDisclosureResponse

Sends a critical message that contains documents that a seller is legally obligated to provide to the buyer. This message should only be used to deliver documents that are required by law. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:



439
440
441
442
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 439

def create_legal_disclosure(body, marketplace_ids, amazon_order_id, opts = {})
  data, _status_code, _headers = create_legal_disclosure_with_http_info(body, marketplace_ids, amazon_order_id, opts)
  data
end

#create_legal_disclosure_with_http_info(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ Array<(CreateLegalDisclosureResponse, Integer, Hash)>

Sends a critical message that contains documents that a seller is legally obligated to provide to the buyer. This message should only be used to deliver documents that are required by law. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:



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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 450

def create_legal_disclosure_with_http_info(body, marketplace_ids, amazon_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagingApi.create_legal_disclosure ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MessagingApi.create_legal_disclosure"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling MessagingApi.create_legal_disclosure"
  end
  # verify the required parameter 'amazon_order_id' is set
  if @api_client.config.client_side_validation && amazon_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'amazon_order_id' when calling MessagingApi.create_legal_disclosure"
  end
  # resource path
  local_var_path = '/messaging/v1/orders/{amazonOrderId}/messages/legalDisclosure'.sub('{' + 'amazonOrderId' + '}', amazon_order_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'CreateLegalDisclosureResponse' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#create_legal_disclosure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_negative_feedback_removal(amazon_order_id, marketplace_ids, opts = {}) ⇒ CreateNegativeFeedbackRemovalResponse

Sends a non-critical message that asks a buyer to remove their negative feedback. This message should only be sent after the seller has resolved the buyer’s problem. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

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

    the optional parameters

Returns:



507
508
509
510
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 507

def create_negative_feedback_removal(amazon_order_id, marketplace_ids, opts = {})
  data, _status_code, _headers = create_negative_feedback_removal_with_http_info(amazon_order_id, marketplace_ids, opts)
  data
end

#create_negative_feedback_removal_with_http_info(amazon_order_id, marketplace_ids, opts = {}) ⇒ Array<(CreateNegativeFeedbackRemovalResponse, Integer, Hash)>

Sends a non-critical message that asks a buyer to remove their negative feedback. This message should only be sent after the seller has resolved the buyer&#x27;s problem. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

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

    the optional parameters

Returns:



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 517

def create_negative_feedback_removal_with_http_info(amazon_order_id, marketplace_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagingApi.create_negative_feedback_removal ...'
  end
  # verify the required parameter 'amazon_order_id' is set
  if @api_client.config.client_side_validation && amazon_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'amazon_order_id' when calling MessagingApi.create_negative_feedback_removal"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling MessagingApi.create_negative_feedback_removal"
  end
  # resource path
  local_var_path = '/messaging/v1/orders/{amazonOrderId}/messages/negativeFeedbackRemoval'.sub('{' + 'amazonOrderId' + '}', amazon_order_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'CreateNegativeFeedbackRemovalResponse' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#create_negative_feedback_removal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_unexpected_problem(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ CreateUnexpectedProblemResponse

Sends a critical message to a buyer that an unexpected problem was encountered affecting the completion of the order. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:



569
570
571
572
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 569

def create_unexpected_problem(body, marketplace_ids, amazon_order_id, opts = {})
  data, _status_code, _headers = create_unexpected_problem_with_http_info(body, marketplace_ids, amazon_order_id, opts)
  data
end

#create_unexpected_problem_with_http_info(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ Array<(CreateUnexpectedProblemResponse, Integer, Hash)>

Sends a critical message to a buyer that an unexpected problem was encountered affecting the completion of the order. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:



580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 580

def create_unexpected_problem_with_http_info(body, marketplace_ids, amazon_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagingApi.create_unexpected_problem ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MessagingApi.create_unexpected_problem"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling MessagingApi.create_unexpected_problem"
  end
  # verify the required parameter 'amazon_order_id' is set
  if @api_client.config.client_side_validation && amazon_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'amazon_order_id' when calling MessagingApi.create_unexpected_problem"
  end
  # resource path
  local_var_path = '/messaging/v1/orders/{amazonOrderId}/messages/unexpectedProblem'.sub('{' + 'amazonOrderId' + '}', amazon_order_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'CreateUnexpectedProblemResponse' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#create_unexpected_problem\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_warranty(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ CreateWarrantyResponse

Sends a message to a buyer to provide details about warranty information on a purchase in their order. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:



638
639
640
641
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 638

def create_warranty(body, marketplace_ids, amazon_order_id, opts = {})
  data, _status_code, _headers = create_warranty_with_http_info(body, marketplace_ids, amazon_order_id, opts)
  data
end

#create_warranty_with_http_info(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ Array<(CreateWarrantyResponse, Integer, Hash)>

Sends a message to a buyer to provide details about warranty information on a purchase in their order. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:

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

    CreateWarrantyResponse data, response status code and response headers



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 649

def create_warranty_with_http_info(body, marketplace_ids, amazon_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagingApi.create_warranty ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MessagingApi.create_warranty"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling MessagingApi.create_warranty"
  end
  # verify the required parameter 'amazon_order_id' is set
  if @api_client.config.client_side_validation && amazon_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'amazon_order_id' when calling MessagingApi.create_warranty"
  end
  # resource path
  local_var_path = '/messaging/v1/orders/{amazonOrderId}/messages/warranty'.sub('{' + 'amazonOrderId' + '}', amazon_order_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'CreateWarrantyResponse' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#create_warranty\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_attributes(amazon_order_id, marketplace_ids, opts = {}) ⇒ GetAttributesResponse

Returns a response containing attributes related to an order. This includes buyer preferences. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 |

Parameters:

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

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

    the optional parameters

Returns:



706
707
708
709
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 706

def get_attributes(amazon_order_id, marketplace_ids, opts = {})
  data, _status_code, _headers = get_attributes_with_http_info(amazon_order_id, marketplace_ids, opts)
  data
end

#get_attributes_with_http_info(amazon_order_id, marketplace_ids, opts = {}) ⇒ Array<(GetAttributesResponse, Integer, Hash)>

Returns a response containing attributes related to an order. This includes buyer preferences. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 |

Parameters:

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

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

    the optional parameters

Returns:

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

    GetAttributesResponse data, response status code and response headers



716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 716

def get_attributes_with_http_info(amazon_order_id, marketplace_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagingApi.get_attributes ...'
  end
  # verify the required parameter 'amazon_order_id' is set
  if @api_client.config.client_side_validation && amazon_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'amazon_order_id' when calling MessagingApi.get_attributes"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling MessagingApi.get_attributes"
  end
  # resource path
  local_var_path = '/messaging/v1/orders/{amazonOrderId}/attributes'.sub('{' + 'amazonOrderId' + '}', amazon_order_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'GetAttributesResponse' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#get_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_messaging_actions_for_order(amazon_order_id, marketplace_ids, opts = {}) ⇒ GetMessagingActionsForOrderResponse

Returns a list of message types that are available for an order that you specify. A message type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a message. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which you want a list of available message types.

  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

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

    the optional parameters

Returns:



767
768
769
770
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 767

def get_messaging_actions_for_order(amazon_order_id, marketplace_ids, opts = {})
  data, _status_code, _headers = get_messaging_actions_for_order_with_http_info(amazon_order_id, marketplace_ids, opts)
  data
end

#get_messaging_actions_for_order_with_http_info(amazon_order_id, marketplace_ids, opts = {}) ⇒ Array<(GetMessagingActionsForOrderResponse, Integer, Hash)>

Returns a list of message types that are available for an order that you specify. A message type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a message. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which you want a list of available message types.

  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

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

    the optional parameters

Returns:



777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 777

def get_messaging_actions_for_order_with_http_info(amazon_order_id, marketplace_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagingApi.get_messaging_actions_for_order ...'
  end
  # verify the required parameter 'amazon_order_id' is set
  if @api_client.config.client_side_validation && amazon_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'amazon_order_id' when calling MessagingApi.get_messaging_actions_for_order"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling MessagingApi.get_messaging_actions_for_order"
  end
  # resource path
  local_var_path = '/messaging/v1/orders/{amazonOrderId}'.sub('{' + 'amazonOrderId' + '}', amazon_order_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'GetMessagingActionsForOrderResponse' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#get_messaging_actions_for_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_invoice(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ InvoiceResponse

Sends a message providing the buyer an invoice

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:



829
830
831
832
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 829

def send_invoice(body, marketplace_ids, amazon_order_id, opts = {})
  data, _status_code, _headers = send_invoice_with_http_info(body, marketplace_ids, amazon_order_id, opts)
  data
end

#send_invoice_with_http_info(body, marketplace_ids, amazon_order_id, opts = {}) ⇒ Array<(InvoiceResponse, Integer, Hash)>

Sends a message providing the buyer an invoice

Parameters:

  • body
  • marketplace_ids —

    A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

  • amazon_order_id —

    An Amazon order identifier. This specifies the order for which a message is sent.

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

    the optional parameters

Returns:

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

    InvoiceResponse data, response status code and response headers



840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/messaging-api-model/api/messaging_api.rb', line 840

def send_invoice_with_http_info(body, marketplace_ids, amazon_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagingApi.send_invoice ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MessagingApi.send_invoice"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling MessagingApi.send_invoice"
  end
  # verify the required parameter 'amazon_order_id' is set
  if @api_client.config.client_side_validation && amazon_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'amazon_order_id' when calling MessagingApi.send_invoice"
  end
  # resource path
  local_var_path = '/messaging/v1/orders/{amazonOrderId}/messages/invoice'.sub('{' + 'amazonOrderId' + '}', amazon_order_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'InvoiceResponse' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#send_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end