peddler 5.1.0 → 5.2.0

data/lib/peddler/apis/orders_2026_01_01/buyer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Information about the customer who purchased the order.
+      Buyer = Structure.new do
+        # @return [String] The name of the company or organization for a business order.
+        attribute?(:buyer_company_name, String, from: "buyerCompanyName")
+
+        # @return [String] The anonymized email address of the buyer. **Note:** Only available for merchant-fulfilled
+        #   (FBM) orders.
+        attribute?(:buyer_email, String, from: "buyerEmail")
+
+        # @return [String] The full name of the customer who placed the order.
+        attribute?(:buyer_name, String, from: "buyerName")
+
+        # @return [String] The purchase order (PO) number entered by the buyer at checkout. Only returned for orders
+        #   where the buyer entered a PO number at checkout.
+        attribute?(:buyer_purchase_order_number, String, from: "buyerPurchaseOrderNumber")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/customer_address.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # The physical address of the customer.
+      CustomerAddress = Structure.new do
+        # @return [String] The primary street address.
+        attribute?(:address_line1, String, from: "addressLine1")
+
+        # @return [String] Additional address information.
+        attribute?(:address_line2, String, from: "addressLine2")
+
+        # @return [String] Additional address information.
+        attribute?(:address_line3, String, from: "addressLine3")
+
+        # @return [String] The type of location.
+        #
+        # **Possible values**: `RESIDENTIAL`, `COMMERCIAL`, `PICKUP_POINT`
+        attribute?(:address_type, String, from: "addressType")
+
+        # @return [String] The city of the address.
+        attribute?(:city, String)
+
+        # @return [String] The name of the business or organization at this address.
+        attribute?(:company_name, String, from: "companyName")
+
+        # @return [String] The two-letter country code identifying the country of the address, in ISO 3166-1 format.
+        attribute?(:country_code, String, from: "countryCode")
+
+        # @return [String] The district or county of the address.
+        attribute?(:district_or_county, String, from: "districtOrCounty")
+
+        # @return [AddressExtendedFields] Additional address components specific to certain countries that provide more
+        #   detailed location information.
+        #
+        # **Note**: Only available with Brazil shipping addresses.
+        attribute?(:extended_fields, AddressExtendedFields, from: "extendedFields")
+
+        # @return [String] The municipality of the address.
+        attribute?(:municipality, String)
+
+        # @return [String] The full name of the person who will receive the delivery at this address.
+        attribute?(:name, String)
+
+        # @return [String] The contact phone number for delivery coordination and customer communication.
+        #
+        # **Note**: The buyer phone number will be suppressed in some cases, including but not limited to:
+        #
+        # - All FBA (Fulfillment by Amazon) orders.
+        # - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date.
+        attribute?(:phone, String)
+
+        # @return [String] The postal code, ZIP code, or equivalent mailing code of the address.
+        attribute?(:postal_code, String, from: "postalCode")
+
+        # @return [String] The state, province, or region of the address.
+        attribute?(:state_or_region, String, from: "stateOrRegion")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/date_time_range.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+require "time"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # A time period with start and end boundaries.
+      DateTimeRange = Structure.new do
+        # @return [Time] The beginning of the time period, in [ISO
+        #   8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+        attribute?(:earliest_date_time, Time, from: "earliestDateTime")
+
+        # @return [Time] The end of the time period, in [ISO
+        #   8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+        attribute?(:latest_date_time, Time, from: "latestDateTime")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/delivery_preference.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+require "time"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Contains all delivery instructions that the customer provides for the shipping address.
+      DeliveryPreference = Structure.new do
+        # @return [String] Building instructions, nearby landmark, or navigation instructions.
+        attribute?(:address_instruction, String, from: "addressInstruction")
+
+        # @return [Array<PreferredDeliveryCapability>] A list of miscellaneous delivery capabilities associated with the
+        #   shipping address.
+        attribute?(:delivery_capabilities, Array, from: "deliveryCapabilities")
+
+        # @return [PreferredDeliveryTime] Business hours and days when the delivery is preferred.
+        attribute?(:delivery_time, PreferredDeliveryTime, from: "deliveryTime")
+
+        # @return [String] The drop-off location selected by the customer.
+        attribute?(:drop_off_location, String, from: "dropOffLocation")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/error.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Error response returned when the request is unsuccessful.
+      Error = 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
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/error_list.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # A list of error responses returned when a request is unsuccessful.
+      ErrorList = Structure.new do
+        # @return [Array<Error>] A list of errors.
+        attribute(:errors, [Error])
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/exception_date.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+require "time"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Special dates when normal business hours are modified or suspended, requiring different delivery scheduling.
+      ExceptionDate = Structure.new do
+        # @return [Date] Specific calendar date when normal operating hours do not apply. In [ISO
+        #   8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format at day granularity.
+        attribute?(:exception_date, Date, from: "exceptionDate")
+
+        # @return [String] Operational status of the business on the specified exception date.
+        attribute?(:exception_date_type, String, from: "exceptionDateType")
+
+        # @return [Array<TimeWindow>] Alternative operating hours that apply specifically to this exception date.
+        attribute?(:time_windows, [TimeWindow], from: "timeWindows")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/get_order_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Order details.
+      GetOrderResponse = Structure.new do
+        # @return [Order] All available information about the requested order.
+        attribute(:order, Order)
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/gift_option.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Gift wrapping and personalization options selected by the customer for an order item.
+      GiftOption = Structure.new do
+        # @return [String] Personal message from the buyer to be included with the gift-wrapped item.
+        attribute?(:gift_message, String, from: "giftMessage")
+
+        # @return [String] Type or quality level of gift wrapping service selected by the customer.
+        attribute?(:gift_wrap_level, String, from: "giftWrapLevel")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/hour_minute.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # The time when the business opens or closes.
+      HourMinute = Structure.new do
+        # @return [Integer] The hour when the business opens or closes, in 24-hour format (0-23).
+        attribute?(:hour, Integer)
+
+        # @return [Integer] The minute when the business opens or closes.
+        attribute?(:minute, Integer)
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_cancellation.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # The cancellation information of the order item.
+      ItemCancellation = Structure.new do
+        # @return [ItemCancellationRequest] Details of the cancellation request submitted for this order item.
+        attribute?(:cancellation_request, ItemCancellationRequest, from: "cancellationRequest")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_cancellation_request.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Detailed information about a cancellation request submitted for a specific order item.
+      ItemCancellationRequest = Structure.new do
+        # @return [String] Explanation provided for why the cancellation was requested.
+        attribute?(:cancel_reason, String, from: "cancelReason")
+
+        # @return [String] Entity that initiated the cancellation request for this item.
+        #
+        # **Possible values**: `BUYER`
+        attribute?(:requester, String)
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_condition.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Detailed information about the physical condition and quality state of the item being sold.
+      ItemCondition = Structure.new do
+        # @return [String] Additional details provided by the seller to describe the specific condition of this
+        #   particular item.
+        attribute?(:condition_note, String, from: "conditionNote")
+
+        # @return [String] A more specific condition classification that provides additional detail about the item's
+        #   quality within the main condition type.
+        #
+        # **Possible values**: `NEW`, `MINT`, `VERY_GOOD`, `GOOD`, `ACCEPTABLE`, `POOR`, `CLUB`, `OEM`, `WARRANTY`,
+        #   `REFURBISHED_WARRANTY`, `REFURBISHED`, `OPEN_BOX`, `ANY`, `OTHER`.
+        attribute?(:condition_subtype, String, from: "conditionSubtype")
+
+        # @return [String] The primary condition category that broadly describes the item's state.
+        #
+        # **Possible values**: `NEW`, `USED`, `COLLECTIBLE`, `REFURBISHED`, `PREORDER`, `CLUB`.
+        attribute?(:condition_type, String, from: "conditionType")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_customization.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Information about any personalization, customization, or special modifications applied to this order item.
+      ItemCustomization = Structure.new do
+        # @return [String] The URL of the customized data for custom orders from the Amazon Custom program.
+        attribute?(:customized_url, String, from: "customizedUrl")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_expense.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # The expense information related to this specific item.
+      ItemExpense = Structure.new do
+        # @return [ItemPointsCost] The cost of points.
+        attribute?(:points_cost, ItemPointsCost, from: "pointsCost")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_fulfillment.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Information about how the order item should be processed, packed, and shipped to the customer.
+      ItemFulfillment = Structure.new do
+        # @return [ItemPacking] Information related to the packaging process for this item.
+        attribute?(:packing, ItemPacking)
+
+        # @return [ItemPicking] Information related to the warehouse picking process for this item.
+        attribute?(:picking, ItemPicking)
+
+        # @return [Integer] The number of units of this item that have been successfully processed and shipped.
+        attribute?(:quantity_fulfilled, Integer, from: "quantityFulfilled")
+
+        # @return [Integer] The number of units of this item that remain to be processed and shipped.
+        attribute?(:quantity_unfulfilled, Integer, from: "quantityUnfulfilled")
+
+        # @return [ItemShipping] Information related to the shipping and delivery process for this item.
+        attribute?(:shipping, ItemShipping)
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_international_shipping.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Additional requirements needed for cross-border shipping of an order item.
+      ItemInternationalShipping = Structure.new do
+        # @return [String] Import One-Stop Shop registration number required for EU VAT compliance when shipping from
+        #   outside the European Union. Sellers shipping to the EU from outside the EU must provide this IOSS number to
+        #   their carrier when Amazon has collected the VAT on the sale.
+        attribute?(:ioss_number, String, from: "iossNumber")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_packing.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Information related to the packaging process for an order item.
+      ItemPacking = Structure.new do
+        # @return [GiftOption] Gift wrapping and messaging specified for this item.
+        attribute?(:gift_option, GiftOption, from: "giftOption")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_picking.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Information related to the warehouse picking process for an order item.
+      ItemPicking = Structure.new do
+        # @return [ItemSubstitutionPreference] Substitution preference for an order item when it becomes unavailable
+        #   during fulfillment
+        attribute?(:substitution_preference, ItemSubstitutionPreference, from: "substitutionPreference")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_points_cost.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Information about Amazon Points granted with the purchase of an item, including both quantity and monetary
+      # equivalent value.
+      ItemPointsCost = Structure.new do
+        # @return [PointsGranted] Details of the Amazon Points granted, including count and monetary value.
+        attribute?(:points_granted, PointsGranted, from: "pointsGranted")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_price.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Pricing information for the order item.
+      ItemPrice = Structure.new do
+        # @return [String] Indicates that the selling price is a special price that is only available for Amazon
+        #   Business orders. For more information about the Amazon Business Seller Program, refer to the [Amazon
+        #   Business website](https://www.amazon.com/b2b/info/amazon-business).
+        #
+        # **Possible value**: `BUSINESS_PRICE`
+        attribute?(:price_designation, String, from: "priceDesignation")
+
+        # @return [Money] The price charged for a single unit of this product, before any quantity-based calculations.
+        attribute?(:unit_price, Money, from: "unitPrice")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_proceeds.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # The money that the seller receives from the sale of this specific item.
+      ItemProceeds = Structure.new do
+        # @return [Array<ItemProceedsBreakdown>] The breakdown of proceeds.
+        attribute?(:breakdowns, [ItemProceedsBreakdown])
+
+        # @return [Money] The total monetary amount for this order item.
+        attribute?(:proceeds_total, Money, from: "proceedsTotal")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_proceeds_breakdown.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Detailed proceeds breakdown for a specific order item.
+      ItemProceedsBreakdown = Structure.new do
+        # @return [Array<ItemProceedsDetailedBreakdown>] Further granular breakdown of the subtotal.
+        attribute?(:detailed_breakdowns, [ItemProceedsDetailedBreakdown], from: "detailedBreakdowns")
+
+        # @return [Money] Monetary amount for the proceeds breakdown.
+        attribute?(:subtotal, Money)
+
+        # @return [String] Category classification of the proceeds breakdown.
+        #
+        # **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`
+        attribute?(:type, String)
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_proceeds_detailed_breakdown.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Further granular breakdown of the subtotal of the proceeds breakdown, only available for TAX and DISCOUNT
+      # proceeds type.
+      ItemProceedsDetailedBreakdown = Structure.new do
+        # @return [String] Specific classification of the further granular breakdown.
+        #
+        # **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`
+        attribute?(:subtype, String)
+
+        # @return [Money] Monetary amount for the further granular breakdown.
+        attribute?(:value, Money)
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_product.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Product information for an order item.
+      ItemProduct = Structure.new do
+        # @return [String] The Amazon Standard Identification Number (ASIN) of the item.
+        attribute?(:asin, String)
+
+        # @return [ItemCondition] Information about the physical condition and quality of the item being sold.
+        attribute?(:condition, ItemCondition)
+
+        # @return [ItemCustomization] Information about any personalization or customization applied to this product.
+        attribute?(:customization, ItemCustomization)
+
+        # @return [ItemPrice] Pricing information for this product.
+        attribute?(:price, ItemPrice)
+
+        # @return [String] The item's seller stock keeping unit (SKU).
+        attribute?(:seller_sku, String, from: "sellerSku")
+
+        # @return [Array<String>] Unique serial numbers for products that require individual tracking, typically
+        #   provided for FBA orders.
+        attribute?(:serial_numbers, [String], from: "serialNumbers")
+
+        # @return [String] The product name or title as displayed to customers in the marketplace.
+        attribute?(:title, String)
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_promotion.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Details about any discounts, coupons, or promotional offers applied to this item.
+      ItemPromotion = Structure.new do
+        # @return [Array<ItemPromotionBreakdown>] A list of promotions applied to the order item.
+        attribute?(:breakdowns, [ItemPromotionBreakdown])
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_promotion_breakdown.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Detailed information about a specific promotional offer applied to an order item.
+      ItemPromotionBreakdown = Structure.new do
+        # @return [String] Unique identifier for the promotion applied to this item.
+        attribute?(:promotion_id, String, from: "promotionId")
+      end
+    end
+  end
+end