peddler 4.5.0 → 4.6.1

data/lib/peddler/types/orders_v0/order_item_buyer_info.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "peddler/money"
+require "peddler/types/orders_v0/buyer_customized_info_detail"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # A single order item's buyer information.
+      OrderItemBuyerInfo = Structure.new do
+        # @return [String] An Amazon-defined order item identifier.
+        attribute(:order_item_id, String, from: "OrderItemId")
+
+        # @return [BuyerCustomizedInfoDetail] Buyer information for custom orders from the Amazon Custom program.
+        #
+        # **Note**: This attribute is only available for MFN (fulfilled by seller) orders.
+        attribute(:buyer_customized_info, BuyerCustomizedInfoDetail, from: "BuyerCustomizedInfo")
+
+        # @return [Money] The gift wrap price of the item.
+        attribute(:gift_wrap_price, Money, from: "GiftWrapPrice")
+
+        # @return [Money] The tax on the gift wrap price.
+        attribute(:gift_wrap_tax, Money, from: "GiftWrapTax")
+
+        # @return [String] A gift message provided by the buyer.
+        #
+        # **Note**: This attribute is only available for MFN (fulfilled by seller) orders.
+        attribute(:gift_message_text, String, from: "GiftMessageText")
+
+        # @return [String] The gift wrap level specified by the buyer.
+        attribute(:gift_wrap_level, String, from: "GiftWrapLevel")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/order_items_buyer_info_list.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "peddler/types/orders_v0/order_item_buyer_info"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # A single order item's buyer information list with the order ID.
+      OrderItemsBuyerInfoList = Structure.new do
+        # @return [Array<OrderItemBuyerInfo>]
+        attribute(:order_items, [OrderItemBuyerInfo], from: "OrderItems")
+
+        # @return [String] When present and not empty, pass this string token in the next request to return the next
+        # response page.
+        attribute(:next_token, String, from: "NextToken")
+
+        # @return [String] An Amazon-defined order identifier, in 3-7-7 format.
+        attribute(:amazon_order_id, String, from: "AmazonOrderId")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/order_items_list.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "peddler/types/orders_v0/order_item"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # The order items list along with the order ID.
+      OrderItemsList = Structure.new do
+        # @return [Array<OrderItem>]
+        attribute(:order_items, [OrderItem], from: "OrderItems")
+
+        # @return [String] When present and not empty, pass this string token in the next request to return the next
+        # response page.
+        attribute(:next_token, String, from: "NextToken")
+
+        # @return [String] An Amazon-defined order identifier, in 3-7-7 format.
+        attribute(:amazon_order_id, String, from: "AmazonOrderId")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/order_regulated_info.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "peddler/types/orders_v0/regulated_information"
+require "peddler/types/orders_v0/regulated_order_verification_status"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # The order's regulated information along with its verification status.
+      OrderRegulatedInfo = Structure.new do
+        # @return [String] An Amazon-defined order identifier, in 3-7-7 format.
+        attribute(:amazon_order_id, String, from: "AmazonOrderId")
+
+        # @return [RegulatedInformation] The regulated information collected during purchase and used to verify the
+        # order.
+        attribute(:regulated_information, RegulatedInformation, from: "RegulatedInformation")
+
+        # @return [:boolean] When true, the order requires attaching a dosage information label when shipped.
+        attribute(:requires_dosage_label, :boolean, from: "RequiresDosageLabel")
+
+        # @return [RegulatedOrderVerificationStatus] The order's verification status.
+        attribute(:regulated_order_verification_status, RegulatedOrderVerificationStatus, from: "RegulatedOrderVerificationStatus")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/orders_list.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "peddler/types/orders_v0/order"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # A list of orders along with additional information to make subsequent API calls.
+      OrdersList = Structure.new do
+        # @return [Array<Order>]
+        attribute(:orders, [Order], from: "Orders")
+
+        # @return [String] When present and not empty, pass this string token in the next request to return the next
+        # response page.
+        attribute(:next_token, String, from: "NextToken")
+
+        # @return [String] Use this date to select orders that were last updated before (or at) a specified time. An
+        # update is defined as any change in order status, including the creation of a new order. Includes updates made
+        # by Amazon and by the seller. Use [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format for
+        # all dates.
+        attribute(:last_updated_before, String, from: "LastUpdatedBefore")
+
+        # @return [String] Use this date to select orders created before (or at) a specified time. Only orders placed
+        # before the specified time are returned. The date must be in [ISO
+        # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+        attribute(:created_before, String, from: "CreatedBefore")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/package_detail.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "peddler/types/orders_v0/confirm_shipment_order_item"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # Properties of packages
+      PackageDetail = Structure.new do
+        # @return [String]
+        attribute(:package_reference_id, String, from: "packageReferenceId")
+
+        # @return [String] Identifies the carrier that will deliver the package. This field is required for all
+        # marketplaces. For more information, refer to the [`CarrierCode`
+        # announcement](https://developer-docs.amazon.com/sp-api/changelog/carriercode-value-required-in-shipment-confirmations-for-br-mx-ca-sg-au-in-jp-marketplaces).
+        attribute(:carrier_code, String, from: "carrierCode")
+
+        # @return [String] Carrier name that will deliver the package. Required when `carrierCode` is "Other"
+        attribute(:carrier_name, String, from: "carrierName")
+
+        # @return [String] Ship method to be used for shipping the order.
+        attribute(:shipping_method, String, from: "shippingMethod")
+
+        # @return [String] The tracking number used to obtain tracking and delivery information.
+        attribute(:tracking_number, String, from: "trackingNumber")
+
+        # @return [String] The shipping date for the package. Must be in <a
+        # href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.
+        attribute(:ship_date, String, from: "shipDate")
+
+        # @return [String] The unique identifier for the supply source.
+        attribute(:ship_from_supply_source_id, String, from: "shipFromSupplySourceId")
+
+        # @return [Array<ConfirmShipmentOrderItem>] The list of order items and quantities to be updated.
+        attribute(:order_items, [ConfirmShipmentOrderItem], from: "orderItems")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/payment_execution_detail_item.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "peddler/money"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # Information about a sub-payment method used to pay for a COD order.
+      PaymentExecutionDetailItem = Structure.new do
+        # @return [Money]
+        attribute(:payment, Money, from: "Payment")
+
+        # @return [String] The sub-payment method for an order.
+        #
+        # **Possible values**:
+        # * `COD`: Cash on delivery
+        # * `GC`: Gift card
+        # * `PointsAccount`: Amazon Points
+        # * `Invoice`: Invoice
+        # * `CreditCard`: Credit card
+        # * `Pix`: Pix
+        # * `Other`: Other.
+        attribute(:payment_method, String, from: "PaymentMethod")
+
+        # @return [String] The Brazilian Taxpayer Identifier (CNPJ) of the payment processor or acquiring bank that
+        # authorizes the payment.
+        #
+        # **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `PaymentMethod`
+        # is `CreditCard` or `Pix`.
+        attribute(:acquirer_id, String, from: "AcquirerId")
+
+        # @return [String] The card network or brand used in the payment transaction (for example, Visa or Mastercard).
+        #
+        # **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `PaymentMethod`
+        # is `CreditCard`.
+        attribute(:card_brand, String, from: "CardBrand")
+
+        # @return [String] The unique code that confirms the payment authorization.
+        #
+        # **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `PaymentMethod`
+        # is `CreditCard` or `Pix`.
+        attribute(:authorization_code, String, from: "AuthorizationCode")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/points_granted_detail.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "peddler/money"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # The number of Amazon Points offered with the purchase of an item, and their monetary value.
+      PointsGrantedDetail = Structure.new do
+        # @return [Integer] The number of Amazon Points granted with the purchase of an item.
+        attribute(:points_number, Integer, from: "PointsNumber")
+
+        # @return [Money] The monetary value of the Amazon Points granted.
+        attribute(:points_monetary_value, Money, from: "PointsMonetaryValue")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/preferred_delivery_time.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "peddler/types/orders_v0/business_hours"
+require "peddler/types/orders_v0/exception_dates"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # The time window when the delivery is preferred.
+      PreferredDeliveryTime = Structure.new do
+        # @return [Array<BusinessHours>] Business hours when the business is open for deliveries.
+        attribute(:business_hours, [BusinessHours], from: "BusinessHours")
+
+        # @return [Array<ExceptionDates>] Dates when the business is closed during the next 30 days.
+        attribute(:exception_dates, [ExceptionDates], from: "ExceptionDates")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/prescription_detail.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # Information about the prescription that is used to verify a regulated product. This must be provided once per
+      # order and reflect the seller’s own records. Only approved orders can have prescriptions.
+      PrescriptionDetail = Structure.new do
+        # @return [String] The identifier for the prescription used to verify the regulated product.
+        attribute(:prescription_id, String, from: "prescriptionId")
+
+        # @return [String] The expiration date of the prescription used to verify the regulated product, in [ISO
+        # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
+        attribute(:expiration_date, String, from: "expirationDate")
+
+        # @return [Integer] The number of units in each fill as provided in the prescription.
+        attribute(:written_quantity, Integer, from: "writtenQuantity")
+
+        # @return [Integer] The total number of refills written in the original prescription used to verify the
+        # regulated product. If a prescription originally had no refills, this value must be 0.
+        attribute(:total_refills_authorized, Integer, from: "totalRefillsAuthorized")
+
+        # @return [Integer] The number of refills remaining for the prescription used to verify the regulated product.
+        # If a prescription originally had 10 total refills, this value must be `10` for the first order, `9` for the
+        # second order, and `0` for the eleventh order. If a prescription originally had no refills, this value must be
+        # 0.
+        attribute(:refills_remaining, Integer, from: "refillsRemaining")
+
+        # @return [String] The identifier for the clinic which provided the prescription used to verify the regulated
+        # product.
+        attribute(:clinic_id, String, from: "clinicId")
+
+        # @return [String] The instructions for the prescription as provided by the approver of the regulated product.
+        attribute(:usage_instructions, String, from: "usageInstructions")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/product_info_detail.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # Product information on the number of items.
+      ProductInfoDetail = Structure.new do
+        # @return [String] The total number of items that are included in the ASIN.
+        attribute(:number_of_items, String, from: "NumberOfItems")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/regulated_information.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "peddler/types/orders_v0/regulated_information_field"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # The regulated information collected during purchase and used to verify the order.
+      RegulatedInformation = Structure.new do
+        # @return [Array<RegulatedInformationField>] A list of regulated information fields as collected from the
+        # regulatory form.
+        attribute(:fields, [RegulatedInformationField], from: "Fields")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/regulated_information_field.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # A field collected from the regulatory form.
+      RegulatedInformationField = Structure.new do
+        # @return [String] The unique identifier of the field.
+        attribute(:field_id, String, from: "FieldId")
+
+        # @return [String] The name of the field.
+        attribute(:field_label, String, from: "FieldLabel")
+
+        # @return [String] The type of field.
+        attribute(:field_type, String, from: "FieldType")
+
+        # @return [String] The content of the field as collected in regulatory form. Note that `FileAttachment` type
+        # fields contain a URL where you can download the attachment.
+        attribute(:field_value, String, from: "FieldValue")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/regulated_order_verification_status.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "peddler/types/orders_v0/rejection_reason"
+require "peddler/types/orders_v0/valid_verification_detail"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # The verification status of the order, along with associated approval or rejection metadata.
+      RegulatedOrderVerificationStatus = Structure.new do
+        # @return [String] The verification status of the order.
+        attribute(:status, String, from: "Status")
+
+        # @return [:boolean] When true, the regulated information provided in the order requires a review by the
+        # merchant.
+        attribute(:requires_merchant_action, :boolean, from: "RequiresMerchantAction")
+
+        # @return [Array<RejectionReason>] A list of valid rejection reasons that may be used to reject the order's
+        # regulated information.
+        attribute(:valid_rejection_reasons, [RejectionReason], from: "ValidRejectionReasons")
+
+        # @return [RejectionReason] The reason for rejecting the order's regulated information. Not present if the order
+        # isn't rejected.
+        attribute(:rejection_reason, RejectionReason, from: "RejectionReason")
+
+        # @return [String] The date the order was reviewed. In [ISO
+        # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
+        attribute(:review_date, String, from: "ReviewDate")
+
+        # @return [String] The identifier for the order's regulated information reviewer.
+        attribute(:external_reviewer_id, String, from: "ExternalReviewerId")
+
+        # @return [Array<ValidVerificationDetail>] A list of valid verification details that may be provided and the
+        # criteria required for when the verification detail can be provided.
+        attribute(:valid_verification_details, [ValidVerificationDetail], from: "ValidVerificationDetails")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/rejection_reason.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # The reason for rejecting the order's regulated information. This is only present if the order is rejected.
+      RejectionReason = Structure.new do
+        # @return [String] The unique identifier for the rejection reason.
+        attribute(:rejection_reason_id, String, from: "RejectionReasonId")
+
+        # @return [String] The description of this rejection reason.
+        attribute(:rejection_reason_description, String, from: "RejectionReasonDescription")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/shipping_constraints.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # Delivery constraints applicable to this order.
+      ShippingConstraints = Structure.new do
+        # @return [String] Indicates if the line item needs to be delivered by pallet.
+        attribute(:pallet_delivery, String, from: "PalletDelivery")
+
+        # @return [String] Indicates that the recipient of the line item must sign to confirm its delivery.
+        attribute(:signature_confirmation, String, from: "SignatureConfirmation")
+
+        # @return [String] Indicates that the person receiving the line item must be the same as the intended recipient
+        # of the order.
+        attribute(:recipient_identity_verification, String, from: "RecipientIdentityVerification")
+
+        # @return [String] Indicates that the carrier must confirm the recipient is of the legal age to receive the line
+        # item upon delivery.
+        attribute(:recipient_age_verification, String, from: "RecipientAgeVerification")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/substitution_option.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "peddler/types/orders_v0/measurement"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # Substitution options for an order item.
+      SubstitutionOption = Structure.new do
+        # @return [String] The item's Amazon Standard Identification Number (ASIN).
+        attribute(:asin, String, from: "ASIN")
+
+        # @return [Integer] The number of items to be picked for this substitution option.
+        attribute(:quantity_ordered, Integer, from: "QuantityOrdered")
+
+        # @return [String] The item's seller stock keeping unit (SKU).
+        attribute(:seller_sku, String, from: "SellerSKU")
+
+        # @return [String] The item's title.
+        attribute(:title, String, from: "Title")
+
+        # @return [Measurement] Measurement information for the substitution option.
+        attribute(:measurement, Measurement, from: "Measurement")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/substitution_preferences.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "peddler/types/orders_v0/substitution_option"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # Substitution preferences for an order item.
+      SubstitutionPreferences = Structure.new do
+        # @return [String] The type of substitution that these preferences represent.
+        attribute(:substitution_type, String, from: "SubstitutionType")
+
+        # @return [Array<SubstitutionOption>] Substitution options for the order item.
+        attribute(:substitution_options, [SubstitutionOption], from: "SubstitutionOptions")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/tax_classification.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # The tax classification of the order.
+      TaxClassification = Structure.new do
+        # @return [String] The type of tax.
+        attribute(:name, String, from: "Name")
+
+        # @return [String] The buyer's tax identifier.
+        attribute(:value, String, from: "Value")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/tax_collection.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # Information about withheld taxes.
+      TaxCollection = Structure.new do
+        # @return [String] The tax collection model applied to the item.
+        attribute(:model, String, from: "Model")
+
+        # @return [String] The party responsible for withholding the taxes and remitting them to the taxing authority.
+        attribute(:responsible_party, String, from: "ResponsibleParty")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/update_shipment_status_error_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "peddler/types/orders_v0/error"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # The error response schema for the `UpdateShipmentStatus` operation.
+      UpdateShipmentStatusErrorResponse = Structure.new do
+        # @return [Array<Error>] One or more unexpected errors occurred during the `UpdateShipmentStatus` operation.
+        attribute(:errors, [Error])
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/update_shipment_status_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # The request body for the `updateShipmentStatus` operation.
+      UpdateShipmentStatusRequest = Structure.new do
+        # @return [String]
+        attribute(:marketplace_id, String, from: "marketplaceId")
+
+        # @return [String]
+        attribute(:shipment_status, String, from: "shipmentStatus")
+
+        # @return [Array]
+        attribute(:order_items, Array, from: "orderItems")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/update_verification_status_error_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "peddler/types/orders_v0/error"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # The error response schema for the `UpdateVerificationStatus` operation.
+      UpdateVerificationStatusErrorResponse = Structure.new do
+        # @return [Array<Error>] One or more unexpected errors occurred during the `UpdateVerificationStatus` operation.
+        attribute(:errors, [Error])
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/update_verification_status_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "peddler/types/orders_v0/update_verification_status_request_body"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # The request body for the `updateVerificationStatus` operation.
+      UpdateVerificationStatusRequest = Structure.new do
+        # @return [UpdateVerificationStatusRequestBody] The updated values of the `VerificationStatus` field.
+        attribute(:regulated_order_verification_status, UpdateVerificationStatusRequestBody, from: "regulatedOrderVerificationStatus")
+      end
+    end
+  end
+end

data/lib/peddler/types/orders_v0/update_verification_status_request_body.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "peddler/types/orders_v0/verification_details"
+
+module Peddler
+  module Types
+    module OrdersV0
+      # The updated values of the `VerificationStatus` field.
+      UpdateVerificationStatusRequestBody = Structure.new do
+        # @return [String] The new verification status of the order.
+        attribute(:status, String)
+
+        # @return [String] The identifier of the order's regulated information reviewer.
+        attribute(:external_reviewer_id, String, from: "externalReviewerId")
+
+        # @return [String] The unique identifier of the rejection reason used for rejecting the order's regulated
+        # information. Only required if the new status is rejected.
+        attribute(:rejection_reason_id, String, from: "rejectionReasonId")
+
+        # @return [VerificationDetails] Additional information regarding the verification of the order.
+        attribute(:verification_details, VerificationDetails, from: "verificationDetails")
+      end
+    end
+  end
+end