Module: Peddler::Types::MessagingV1

Defined in:: lib/peddler/types/messaging_v1/error.rb,
lib/peddler/types/messaging_v1/attachment.rb,
lib/peddler/types/messaging_v1/error_list.rb,
lib/peddler/types/messaging_v1/link_object.rb,
lib/peddler/types/messaging_v1/invoice_request.rb,
lib/peddler/types/messaging_v1/invoice_response.rb,
lib/peddler/types/messaging_v1/messaging_action.rb,
lib/peddler/types/messaging_v1/get_schema_response.rb,
lib/peddler/types/messaging_v1/create_warranty_request.rb,
lib/peddler/types/messaging_v1/get_attributes_response.rb,
lib/peddler/types/messaging_v1/create_warranty_response.rb,
lib/peddler/types/messaging_v1/create_amazon_motors_request.rb,
lib/peddler/types/messaging_v1/create_amazon_motors_response.rb,
lib/peddler/types/messaging_v1/get_messaging_action_response.rb,
lib/peddler/types/messaging_v1/create_legal_disclosure_request.rb,
lib/peddler/types/messaging_v1/create_legal_disclosure_response.rb,
lib/peddler/types/messaging_v1/create_digital_access_key_request.rb,
lib/peddler/types/messaging_v1/create_unexpected_problem_request.rb,
lib/peddler/types/messaging_v1/create_digital_access_key_response.rb,
lib/peddler/types/messaging_v1/create_unexpected_problem_response.rb,
lib/peddler/types/messaging_v1/create_confirm_order_details_request.rb,
lib/peddler/types/messaging_v1/create_confirm_order_details_response.rb,
lib/peddler/types/messaging_v1/create_confirm_service_details_request.rb,
lib/peddler/types/messaging_v1/create_confirm_delivery_details_request.rb,
lib/peddler/types/messaging_v1/create_confirm_service_details_response.rb,
lib/peddler/types/messaging_v1/create_confirm_delivery_details_response.rb,
lib/peddler/types/messaging_v1/get_messaging_actions_for_order_response.rb,
lib/peddler/types/messaging_v1/create_confirm_customization_details_request.rb,
lib/peddler/types/messaging_v1/create_confirm_customization_details_response.rb

Defined Under Namespace

Constant Summary collapse

Error = Error response returned when the request is unsuccessful.

Structure.new do
  # @return [String] An error code that identifies the type of error that occurred.
  attribute(:code, String)

  # @return [String] A message that describes the error condition.
  attribute(:message, String)

  # @return [String] Additional details that can help the caller understand or fix the issue.
  attribute?(:details, String)
end

Attachment = Represents a file that was uploaded to a destination that was created by the Uploads API [‘createUploadDestinationForResource`](developer-docs.amazon.com/sp-api/reference/createuploaddestinationforresource) operation.

Structure.new do
  # @return [String] The name of the file, including the extension. This is the file name that will appear in the
  # message. This does not need to match the file name of the file that you uploaded.
  attribute(:file_name, String, from: "fileName")

  # @return [String] The identifier for the upload destination. To retrieve this value, call the Uploads API
  # [`createUploadDestinationForResource`](https://developer-docs.amazon.com/sp-api/reference/createuploaddestinationforresource)
  # operation.
  attribute(:upload_destination_id, String, from: "uploadDestinationId")
end

LinkObject = A Link object.

Structure.new do
  # @return [String] A URI for this object.
  attribute(:href, String)

  # @return [String] An identifier for this object.
  attribute?(:name, String)
end

InvoiceRequest = The request schema for the ‘sendInvoice` operation.

Structure.new do
  # @return [Array<Attachment>] Attachments to include in the message to the buyer.
  attribute?(:attachments, [Attachment])
end

InvoiceResponse = The response schema for the sendInvoice operation.

Structure.new do
  # @return [Array<Error>]
  attribute?(:errors, [Error])
end

MessagingAction = A simple object containing the name of the template.

Structure.new do
  # @return [String] The name of the template.
  attribute(:name, String)
end

GetSchemaResponse = The ‘GET` request schema response.

Structure.new do
  # @return [Hash] The links response that is associated with the object.
  attribute?(:_links, Hash)

  # @return [Array<Error>]
  attribute?(:errors, [Error])

  # @return [Hash]
  attribute?(:payload, Hash)
end

CreateWarrantyRequest = The request schema for the createWarranty operation.

Structure.new do
  # @return [Array<Attachment>] Attachments to include in the message to the buyer. If any text is included in the
  # attachment, the text must be written in the buyer's language of preference, which can be retrieved from the
  # GetAttributes operation.
  attribute?(:attachments, [Attachment])

  # @return [String] The end date of the warranty coverage to include in the message to the buyer.
  attribute?(:coverage_end_date, String, from: "coverageEndDate")

  # @return [String] The start date of the warranty coverage to include in the message to the buyer.
  attribute?(:coverage_start_date, String, from: "coverageStartDate")
end

GetAttributesResponse = The response schema for the GetAttributes operation.

Structure.new do
  # @return [Hash] The list of attributes related to the buyer.
  attribute?(:buyer, Hash)

  # @return [Array<Error>]
  attribute?(:errors, [Error])
end

CreateWarrantyResponse = The response schema for the createWarranty operation.

Structure.new do
  # @return [Array<Error>]
  attribute?(:errors, [Error])
end

CreateAmazonMotorsRequest = The request schema for the createAmazonMotors operation.

Structure.new do
  # @return [Array<Attachment>] Attachments to include in the message to the buyer. If any text is included in the
  # attachment, the text must be written in the buyer's language of preference, which can be retrieved from the
  # GetAttributes operation.
  attribute?(:attachments, [Attachment])
end

CreateAmazonMotorsResponse = The response schema for the createAmazonMotors operation.

Structure.new do
  # @return [Array<Error>]
  attribute?(:errors, [Error])
end

GetMessagingActionResponse = Describes a messaging action that can be taken for an order. Provides a JSON Hypertext Application Language (HAL) link to the JSON schema document that describes the expected input.

Structure.new do
  # @return [Hash] The embedded response associated with the messaging action.
  attribute?(:_embedded, Hash)

  # @return [Hash] The links response that is associated with the messaging action.
  attribute?(:_links, Hash)

  # @return [Array<Error>]
  attribute?(:errors, [Error])

  # @return [MessagingAction]
  attribute?(:payload, MessagingAction)
end

CreateLegalDisclosureRequest = The request schema for the createLegalDisclosure operation.

Structure.new do
  # @return [Array<Attachment>] Attachments to include in the message to the buyer. If any text is included in the
  # attachment, the text must be written in the buyer's language of preference, which can be retrieved from the
  # GetAttributes operation.
  attribute?(:attachments, [Attachment])
end

CreateLegalDisclosureResponse = The response schema for the createLegalDisclosure operation.

Structure.new do
  # @return [Array<Error>]
  attribute?(:errors, [Error])
end

CreateDigitalAccessKeyRequest = The request schema for the ‘createDigitalAccessKey` operation.

Structure.new do
  # @return [Array<Attachment>] Attachments that you want to include in the message to the buyer.
  attribute?(:attachments, [Attachment])

  # @return [String] The text that is sent to the buyer. Only links that are related to the digital access key are
  # allowed. Do not include HTML or email addresses. The text must be written in the buyer's preferred language,
  # which you can retrieve from the `GetAttributes` operation.
  attribute?(:text, String)
end

CreateUnexpectedProblemRequest = The request schema for the createUnexpectedProblem operation.

Structure.new do
  # @return [String] The text to be sent to the buyer. Only links related to unexpected problem calls are allowed.
  # Do not include HTML or email addresses. The text must be written in the buyer's language of preference, which
  # can be retrieved from the GetAttributes operation.
  attribute?(:text, String)
end

CreateDigitalAccessKeyResponse = The response schema for the ‘createDigitalAccessKey` operation.

Structure.new do
  # @return [Array<Error>]
  attribute?(:errors, [Error])
end

CreateUnexpectedProblemResponse = The response schema for the createUnexpectedProblem operation.

Structure.new do
  # @return [Array<Error>]
  attribute?(:errors, [Error])
end

CreateConfirmOrderDetailsRequest = The request schema for the createConfirmOrderDetails operation.

Structure.new do
  # @return [String] The text to be sent to the buyer. Only links related to order completion are allowed. Do not
  # include HTML or email addresses. The text must be written in the buyer's language of preference, which can be
  # retrieved from the GetAttributes operation.
  attribute?(:text, String)
end

CreateConfirmOrderDetailsResponse = The response schema for the createConfirmOrderDetails operation.

Structure.new do
  # @return [Array<Error>]
  attribute?(:errors, [Error])
end

CreateConfirmServiceDetailsRequest = The request schema for the createConfirmServiceDetails operation.

Structure.new do
  # @return [String] The text to be sent to the buyer. Only links related to Home Service calls are allowed. Do
  # not include HTML or email addresses. The text must be written in the buyer's language of preference, which can
  # be retrieved from the GetAttributes operation.
  attribute?(:text, String)
end

CreateConfirmDeliveryDetailsRequest = The request schema for the createConfirmDeliveryDetails operation.

Structure.new do
  # @return [String] The text to be sent to the buyer. Only links related to order delivery are allowed. Do not
  # include HTML or email addresses. The text must be written in the buyer's language of preference, which can be
  # retrieved from the GetAttributes operation.
  attribute?(:text, String)
end

CreateConfirmServiceDetailsResponse = The response schema for the createConfirmServiceDetails operation.

Structure.new do
  # @return [Array<Error>]
  attribute?(:errors, [Error])
end

CreateConfirmDeliveryDetailsResponse = The response schema for the createConfirmDeliveryDetails operation.

Structure.new do
  # @return [Array<Error>]
  attribute?(:errors, [Error])
end

GetMessagingActionsForOrderResponse = The response schema for the ‘getMessagingActionsForOrder` operation.

Structure.new do
  # @return [Hash] The messaging actions response that is associated with the specified `amazonOrderId`.
  attribute?(:_embedded, Hash)

  # @return [Hash] The links response that is associated with the specified `amazonOrderId`.
  attribute?(:_links, Hash)

  # @return [Array<Error>]
  attribute?(:errors, [Error])
end

CreateConfirmCustomizationDetailsRequest = The request schema for the confirmCustomizationDetails operation.

Structure.new do
  # @return [Array<Attachment>] Attachments to include in the message to the buyer.
  attribute?(:attachments, [Attachment])

  # @return [String] The text to be sent to the buyer. Only links related to customization details are allowed. Do
  # not include HTML or email addresses. The text must be written in the buyer's language of preference, which can
  # be retrieved from the GetAttributes operation.
  attribute?(:text, String)
end

CreateConfirmCustomizationDetailsResponse = The response schema for the confirmCustomizationDetails operation.

Structure.new do
  # @return [Array<Error>]
  attribute?(:errors, [Error])
end