class AmzSpApi::MessagingApiModel::MessagingApi
Attributes
Public Class Methods
# File lib/messaging-api-model/api/messaging_api.rb, line 16 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
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. @param body @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param [Hash] opts the optional parameters @return [CreateConfirmCustomizationDetailsResponse]
# 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
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. @param body @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param [Hash] opts the optional parameters @return [Array<(CreateConfirmCustomizationDetailsResponse
, Integer, Hash)>] CreateConfirmCustomizationDetailsResponse
data, response status code and response headers
# 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
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. @param body @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param [Hash] opts the optional parameters @return [CreateAmazonMotorsResponse]
# 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
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. @param body @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param [Hash] opts the optional parameters @return [Array<(CreateAmazonMotorsResponse
, Integer, Hash)>] CreateAmazonMotorsResponse
data, response status code and response headers
# 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
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. @param body @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param [Hash] opts the optional parameters @return [CreateConfirmDeliveryDetailsResponse]
# 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
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. @param body @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param [Hash] opts the optional parameters @return [Array<(CreateConfirmDeliveryDetailsResponse
, Integer, Hash)>] CreateConfirmDeliveryDetailsResponse
data, response status code and response headers
# 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
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. @param body @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param [Hash] opts the optional parameters @return [CreateConfirmOrderDetailsResponse]
# 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
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. @param body @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param [Hash] opts the optional parameters @return [Array<(CreateConfirmOrderDetailsResponse
, Integer, Hash)>] CreateConfirmOrderDetailsResponse
data, response status code and response headers
# 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
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. @param body @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param [Hash] opts the optional parameters @return [CreateConfirmServiceDetailsResponse]
# 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
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. @param body @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param [Hash] opts the optional parameters @return [Array<(CreateConfirmServiceDetailsResponse
, Integer, Hash)>] CreateConfirmServiceDetailsResponse
data, response status code and response headers
# 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
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. @param body @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param [Hash] opts the optional parameters @return [CreateDigitalAccessKeyResponse]
# 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
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. @param body @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param [Hash] opts the optional parameters @return [Array<(CreateDigitalAccessKeyResponse
, Integer, Hash)>] CreateDigitalAccessKeyResponse
data, response status code and response headers
# 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
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. @param body @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param [Hash] opts the optional parameters @return [CreateLegalDisclosureResponse]
# 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
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. @param body @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param [Hash] opts the optional parameters @return [Array<(CreateLegalDisclosureResponse
, Integer, Hash)>] CreateLegalDisclosureResponse
data, response status code and response headers
# 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
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. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param [Hash] opts the optional parameters @return [CreateNegativeFeedbackRemovalResponse]
# 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
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. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param [Hash] opts the optional parameters @return [Array<(CreateNegativeFeedbackRemovalResponse
, Integer, Hash)>] CreateNegativeFeedbackRemovalResponse
data, response status code and response headers
# 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
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. @param body @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param [Hash] opts the optional parameters @return [CreateUnexpectedProblemResponse]
# 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
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. @param body @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param [Hash] opts the optional parameters @return [Array<(CreateUnexpectedProblemResponse
, Integer, Hash)>] CreateUnexpectedProblemResponse
data, response status code and response headers
# 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
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. @param body @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param [Hash] opts the optional parameters @return [CreateWarrantyResponse]
# 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
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. @param body @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param [Hash] opts the optional parameters @return [Array<(CreateWarrantyResponse
, Integer, Hash)>] CreateWarrantyResponse
data, response status code and response headers
# 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
Returns a response containing attributes related to an order. This includes buyer preferences. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param [Hash] opts the optional parameters @return [GetAttributesResponse]
# 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
Returns a response containing attributes related to an order. This includes buyer preferences. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 | @param amazon_order_id An Amazon order identifier. This specifies the order for which a message is sent. @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param [Hash] opts the optional parameters @return [Array<(GetAttributesResponse
, Integer, Hash)>] GetAttributesResponse
data, response status code and response headers
# 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
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. @param amazon_order_id An Amazon order identifier. This specifies the order for which you want a list of available message types. @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param [Hash] opts the optional parameters @return [GetMessagingActionsForOrderResponse]
# 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
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. @param amazon_order_id An Amazon order identifier. This specifies the order for which you want a list of available message types. @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @param [Hash] opts the optional parameters @return [Array<(GetMessagingActionsForOrderResponse
, Integer, Hash)>] GetMessagingActionsForOrderResponse
data, response status code and response headers
# 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