peddler 5.4.0 → 5.5.0

data/lib/peddler/apis/replenishment_2022_11_07/list_offer_metrics_request_filters.rb

@@ -8,8 +8,8 @@ require "time"
 module Peddler
   module APIs
     class Replenishment20221107
-      # Use these parameters to filter results. Any result must match all provided parameters. For any parameter that is
-      # an array, the result must match at least one element in the provided array.
+      # Use these parameters to filter results. Any result must match all provided parameters. For parameters that
+      # accept multiple values (arrays), the API returns results that match at least one value in the array.
       ListOfferMetricsRequestFilters = Structure.new do
         # @return [String] The marketplace identifier. The supported marketplaces for both sellers and vendors are US,
         #   CA, ES, UK, FR, IT, IN, DE, and JP. The supported marketplaces for vendors only are BR, AU, MX, AE, and NL.
@@ -29,8 +29,21 @@ module Peddler
         # @return [String]
         attribute?(:aggregation_frequency, String, from: "aggregationFrequency")
 
-        # @return [Array<String>] A list of Amazon Standard Identification Numbers (ASINs).
+        # @return [Array<String>] A list of Amazon Standard Identification Numbers (ASINs) to filter by.
         attribute?(:asins, [String])
+
+        # @return [Array<String>] [Applicable only for US marketplace] A list of brand names to filter by.
+        attribute?(:brand_names, [String], from: "brandNames")
+
+        # @return [Array<FulfillmentChannelType>] [Applicable only for Sellers] The fulfillment channel types to filter
+        #   by.
+        attribute?(:fulfillment_channel_types, Array, from: "fulfillmentChannelTypes")
+
+        # @return [Array<String>] [Applicable only for Vendors] A list of product group names to filter by.
+        attribute?(:product_groups, [String], from: "productGroups")
+
+        # @return [Array<String>] [Applicable only for Sellers] A list of SKUs to filter by.
+        attribute?(:skus, [String])
       end
     end
   end

data/lib/peddler/apis/replenishment_2022_11_07/list_offer_metrics_response_offer.rb

@@ -17,6 +17,9 @@ module Peddler
         # @return [String] The Amazon Standard Identification Number (ASIN).
         attribute?(:asin, String)
 
+        # @return [String] The brand name associated with the offer.
+        attribute?(:brand_name, String, from: "brandName")
+
         # @return [Float] The percentage of revenue from ASINs with coupons out of total revenue from all ASINs.
         #   Applicable to `PERFORMANCE` `timePeriodType`.
         attribute?(:coupons_revenue_penetration, Float, from: "couponsRevenuePenetration")
@@ -60,11 +63,15 @@ module Peddler
         #   time due to being out of stock. Applicable to `PERFORMANCE` `timePeriodType`.
         attribute?(:not_delivered_due_to_oos, Float, from: "notDeliveredDueToOOS")
 
+        # @return [String] The product group associated with the offer. This property is only supported for vendors and
+        #   not for sellers.
+        attribute?(:product_group, String, from: "productGroup")
+
         # @return [Float] The percentage of total program revenue out of total product revenue. Applicable to
         #   `PERFORMANCE` `timePeriodType`.
         attribute?(:revenue_penetration, Float, from: "revenuePenetration")
 
-        # @return [Float] The percentage of new subscriptions acquired through coupons. Applicable to `PERFORMANCE`
+        # @return [Float] The percentage of new subscriptions from coupons. Applicable to `PERFORMANCE`
         #   `timePeriodType`.
         attribute?(:share_of_coupon_subscriptions, Float, from: "shareOfCouponSubscriptions")
 

data/lib/peddler/apis/replenishment_2022_11_07/list_offers_request.rb

@@ -10,8 +10,8 @@ module Peddler
       # The request body for the `listOffers` operation.
       ListOffersRequest = Structure.new do
         # @return [ListOffersRequestFilters] Use these parameters to filter results. Any result must match all provided
-        #   parameters. For any parameter that is an array, the result must match at least one element in the provided
-        #   array.
+        #   parameters. For parameters that accept multiple values (arrays), the API returns results that match at least
+        #   one value in the array.
         attribute(:filters, ListOffersRequestFilters, null: false)
 
         # @return [ListOffersRequestPagination] Use these parameters to paginate through the response.

data/lib/peddler/apis/replenishment_2022_11_07/list_offers_request_filters.rb

@@ -7,8 +7,8 @@ require "structure"
 module Peddler
   module APIs
     class Replenishment20221107
-      # Use these parameters to filter results. Any result must match all provided parameters. For any parameter that is
-      # an array, the result must match at least one element in the provided array.
+      # Use these parameters to filter results. Any result must match all provided parameters. For parameters that
+      # accept multiple values (arrays), the API returns results that match at least one value in the array.
       ListOffersRequestFilters = Structure.new do
         # @return [String] The marketplace identifier. The supported marketplaces for both sellers and vendors are US,
         #   CA, ES, UK, FR, IT, IN, DE, and JP. The supported marketplaces for vendors only are BR, AU, MX, AE, and NL.

data/lib/peddler/apis/replenishment_2022_11_07/time_interval.rb

@@ -8,20 +8,23 @@ require "time"
 module Peddler
   module APIs
     class Replenishment20221107
-      # A date-time interval in ISO 8601 format which is used to compute metrics. Only the date is required, but you
-      # must pass the complete date and time value. For example, November 11, 2022 should be passed as
-      # "2022-11-11T00:00:00Z". Note that only data for the trailing 2 years is supported.
+      # A date-time interval in ISO 8601 format used to compute metrics. Only the date is required, but you must pass
+      # the complete date and time value. For example, November 11, 2022 should be passed as "2022-11-11T00:00:00Z".
+      # Note that only data for the trailing 2 years is supported.
       #
-      # **Note**: The `listOfferMetrics` operation only supports a time interval which covers a single unit of the
+      # **Note**: * The `listOfferMetrics` operation only supports a time interval which covers a single unit of the
       # aggregation frequency. For example, for a MONTH aggregation frequency, the duration of the interval between the
       # startDate and endDate can not be more than 1 month.
+      # * For the `getSellingPartnerMetrics` operation with DAY aggregation frequency, the time interval cannot exceed
+      # 31 days.
       TimeInterval = Structure.new do
         # @return [Time] When this object is used as a request parameter, the specified `endDate` is adjusted based on
         #   the aggregation frequency.
         #
+        # * For `DAY` the metric is computed up to the specific day indicated by the `endDate`.
         # * For `WEEK` the metric is computed up to the last day of the week (Sunday, based on ISO 8601) that contains
         #   the `endDate`.
-        # * For `MONTH`, the metric is computed up to the last day that contains the `endDate`.
+        # * For `MONTH`, the metric is computed up to the last day of the month that contains the `endDate`.
         # * For `QUARTER` the metric is computed up to the last day of the quarter that contains the `endDate`.
         # * For `YEAR` the metric is computed up to the last day of the year that contains the `endDate`.
         # Note: The end date may be adjusted to a lower value based on the data available in our system.
@@ -30,7 +33,8 @@ module Peddler
         # @return [Time] When this object is used as a request parameter, the specified `startDate` is adjusted based on
         #   the aggregation frequency.
         #
-        # * For `WEEK` the metric is computed from the first day of the week (Sunday, based on ISO 8601) that contains
+        # * For `DAY` the metric is computed from the specific day indicated by the `startDate`.
+        # * For `WEEK` the metric is computed from the first day of the week (Monday, based on ISO 8601) that contains
         #   the `startDate`.
         # * For `MONTH` the metric is computed from the first day of the month that contains the `startDate`.
         # * For `QUARTER` the metric is computed from the first day of the quarter that contains the `startDate`.

data/lib/peddler/apis/services_v1/associated_item.rb

@@ -21,6 +21,9 @@ module Peddler
         # @return [String] The status of the item.
         attribute?(:item_status, String, from: "itemStatus")
 
+        # @return [Array<LinkedAsset>] A list of customer-owned assets on which the service must be performed.
+        attribute?(:linked_assets, [LinkedAsset], from: "linkedAssets")
+
         # @return [String] The Amazon-defined identifier for an order placed by the buyer in 3-7-7 format.
         attribute?(:order_id, String, from: "orderId")
 

data/lib/peddler/apis/services_v1/linked_asset.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class ServicesV1
+      # Information about an asset linked to an associated item, such as vehicle information for Ship-to-Store orders.
+      LinkedAsset = Structure.new do
+        # @return [Hash] Additional attributes of the linked asset, such as vehicle make, model, year, and engine
+        #   details.
+        attribute?(:additional_attributes, Hash, from: "additionalAttributes")
+
+        # @return [String] The name of the linked asset. For example: `2024 Polaris Slingshot SLR AutoDrive`.
+        attribute?(:asset_name, String, from: "assetName")
+
+        # @return [String] The type of the linked asset. For example: `VEHICLE`.
+        attribute?(:asset_type, String, from: "assetType")
+      end
+    end
+  end
+end

data/lib/peddler/apis/services_v1/service_job.rb

@@ -32,6 +32,9 @@ module Peddler
         #   buyer selected appointment windows when creating the order.
         attribute?(:preferred_appointment_times, [AppointmentTime], from: "preferredAppointmentTimes")
 
+        # @return [Array<String>] A list of associated product order IDs for the service job.
+        attribute?(:product_order_ids, [String], from: "productOrderIds")
+
         # @return [ScopeOfWork] The scope of work for the order.
         attribute?(:scope_of_work, ScopeOfWork, from: "scopeOfWork")
 
@@ -55,6 +58,9 @@ module Peddler
 
         # @return [String] The Amazon-defined identifier for the region scope.
         attribute?(:store_id, String, from: "storeId")
+
+        # @return [Array<String>] A list of associated product tracking IDs for the service job.
+        attribute?(:tracking_ids, [String], from: "trackingIds")
       end
     end
   end

data/lib/peddler/apis/services_v1.rb

@@ -57,6 +57,10 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param service_order_ids [Array<String>] List of service order ids for the query you want to perform.Max values
       #   supported 20.
+      # @param product_order_ids [Array<String>] A list of up to 20 associated product order IDs. You can use these IDs
+      #   to query service jobs.
+      # @param tracking_ids [Array<String>] A list of up to 20 associated product tracking IDs. You can use these IDs to
+      #   query service jobs.
       # @param service_job_status [Array<String>] A list of one or more job status by which to filter the list of jobs.
       # @param page_token [String] String returned in the response of your previous request.
       # @param page_size [Integer] A non-negative integer that indicates the maximum number of jobs to return in the
@@ -87,13 +91,15 @@ module Peddler
       #   is 50.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def get_service_jobs(marketplace_ids, service_order_ids: nil, service_job_status: nil, page_token: nil,
-        page_size: 20, sort_field: nil, sort_order: nil, created_after: nil, created_before: nil,
-        last_updated_after: nil, last_updated_before: nil, schedule_start_date: nil, schedule_end_date: nil, asins: nil,
-        required_skills: nil, store_ids: nil, rate_limit: 10.0)
+      def get_service_jobs(marketplace_ids, service_order_ids: nil, product_order_ids: nil, tracking_ids: nil,
+        service_job_status: nil, page_token: nil, page_size: 20, sort_field: nil, sort_order: nil, created_after: nil,
+        created_before: nil, last_updated_after: nil, last_updated_before: nil, schedule_start_date: nil,
+        schedule_end_date: nil, asins: nil, required_skills: nil, store_ids: nil, rate_limit: 10.0)
         path = "/service/v1/serviceJobs"
         params = {
           "serviceOrderIds" => stringify_array(service_order_ids),
+          "productOrderIds" => stringify_array(product_order_ids),
+          "trackingIds" => stringify_array(tracking_ids),
           "serviceJobStatus" => stringify_array(service_job_status),
           "pageToken" => page_token,
           "pageSize" => page_size,

data/lib/peddler/apis/uploads_2020_11_01.rb

@@ -26,7 +26,7 @@ module Peddler
       #   create an upload destination for an Aplus content document, the `{resource}` would be
       #   `aplus/2020-11-01/contentDocuments` and the path would be
       #   `/uploads/2020-11-01/uploadDestinations/aplus/2020-11-01/contentDocuments`.
-      # @param content_type [String] The content type of the file you upload.
+      # @param content_type [String] The content type of the file you upload. This parameter is required for A+ content.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def create_upload_destination_for_resource(marketplace_ids, content_md5, resource, content_type: nil,

data/lib/peddler/notifications/order_change/notification.rb

@@ -9,20 +9,21 @@ module Peddler
     module OrderChange
       # The notification response schema that comprises the entire JSON document for ORDER_CHANGE notification.
       Notification = Structure.new do
-        # @return [String] The time when this notification was published, in ISO-8601 date/time format.
+        # @return [String] The time when this notification was published, presented in ISO-8601 date/time format.
         attribute(:event_time, String, null: false, from: "EventTime")
 
         # @return [Hash] The notification metadata.
         attribute(:notification_metadata, Hash, null: false, from: "NotificationMetadata")
 
         # @return [String] The type of this notification, used to differentiate different notifications. Combined with
-        #   payload version, this controls the structure of the payload object.
+        #   payload version controls the structure of payload object.
         attribute(:notification_type, String, null: false, from: "NotificationType")
 
         # @return [String] The notification version.
         attribute(:notification_version, String, null: false, from: "NotificationVersion")
 
-        # @return [Payload] The payload for the ORDER_CHANGE notification.
+        # @return [Payload] The payload for this ORDER_CHANGE notification. It's unique for different event type and
+        #   will provide more in-depth information about this notification.
         attribute(:payload, Payload, null: false, from: "Payload")
 
         # @return [String] The payload version of the notification.

data/lib/peddler/notifications/order_change/order_change_notification.rb

@@ -18,8 +18,8 @@ module Peddler
         # @return [OrderChangeTrigger]
         attribute(:order_change_trigger, OrderChangeTrigger, null: false, from: "OrderChangeTrigger")
 
-        # @return [String] The type of order change that caused the notification to be sent. Possible values are
-        #   BuyerRequestedChange and OrderStatusChange.
+        # @return [String] Change type of this notification. The possible values include BuyerRequestedChange,
+        #   DeliveryTipChange, OrderStatusChange.
         attribute(:order_change_type, String, null: false, from: "OrderChangeType")
 
         # @return [String] The selling partner identifier.

data/lib/peddler/notifications/order_change/order_change_trigger.rb

@@ -7,13 +7,13 @@ require "structure"
 module Peddler
   module Notifications
     module OrderChange
-      # Details about what caused this ORDER_CHANGE notification to be sent.
+      # Details about what triggered this ORDER_CHANGE notification.
       OrderChangeTrigger = Structure.new do
-        # @return [String] The reason this ORDER_CHANGE notification was sent.
+        # @return [String] The reason for this ORDER_CHANGE notification.
         attribute(:change_reason, String, null: false, from: "ChangeReason")
 
-        # @return [String] The time of the change that caused this notification, in ISO-8601 date/time format. Will be
-        #   null when there is no related timestamp.
+        # @return [String] The timestamp for the change that caused this notification, presented in ISO-8601 date/time
+        #   format. It will be null when there is no related timestamp.
         attribute(:time_of_order_change, String, from: "TimeOfOrderChange")
       end
     end

data/lib/peddler/notifications/order_change/order_item.rb

@@ -15,24 +15,24 @@ module Peddler
         # @return [Integer] The number of items in the order.
         attribute(:quantity, Integer, null: false, from: "Quantity")
 
-        # @return [String] The seller-specific SKU for an item.
+        # @return [String] The seller-specific SKU identifier for an item.
         attribute(:seller_sku, String, null: false, from: "SellerSKU")
 
-        # @return [String] The unique identifier of the supply source. Will be null when there is no related
+        # @return [String] The unique identifier of the supply source. It will be null when there is no related
         #   information.
         attribute(:supply_source_id, String, from: "SupplySourceId")
 
-        # @return [:boolean] True when the buyer has requested cancelation.
+        # @return [:boolean] Information about whether or not a buyer requested cancellation. When true, the buyer has
+        #   requested cancellation.
         attribute?(:buyer_requested_cancel, :boolean, from: "IsBuyerRequestedCancel")
 
-        # @return [String] The start of the time period during which you have committed to fulfill the order.
+        # @return [String] The start of the time period within which you have committed to fulfill the order item.
         attribute?(:item_earliest_delivery_date, String, from: "ItemEarliestDeliveryDate")
 
-        # @return [String] The end of the time period during which you have committed to fulfill the order.
+        # @return [String] The end of the time period within which you have committed to fulfill the order item.
         attribute?(:item_latest_delivery_date, String, from: "ItemLatestDeliveryDate")
 
-        # @return [String] The current status of the order item. This field Will have a non-null value when items'
-        #   statuses are different.
+        # @return [String] The current status of the order item. Will display it when items' status are different.
         attribute?(:order_item_status, String, from: "OrderItemStatus")
 
         # @return [Integer] The number of items shipped.

data/lib/peddler/notifications/order_change/summary.rb

@@ -7,7 +7,7 @@ require "structure"
 module Peddler
   module Notifications
     module OrderChange
-      # Information about the order and order items that had the change.
+      # Information about order and order items that had the change.
       Summary = Structure.new do
         # @return [String] The destination postal code. It will be null when there is no related information.
         attribute(:destination_postal_code, String, from: "DestinationPostalCode")
@@ -19,7 +19,7 @@ module Peddler
         attribute(:marketplace_id, String, null: false, from: "MarketplaceId")
 
         # @return [Array<OrderItem>] Information about order items included in this order. For OrderItemLevel
-        #   notifications, one payload includes one item, while for OrderLevel notifications, one payload includes all
+        #   notification, one payload include one item, while for OrderLevel notification, one payload include all
         #   items.
         attribute(:order_items, [OrderItem], null: false, from: "OrderItems")
 
@@ -29,20 +29,20 @@ module Peddler
         # @return [String] The type of the order.
         attribute(:order_type, String, null: false, from: "OrderType")
 
-        # @return [String] The purchase date of the order, in ISO-8601 date/time format. It will be null when there is
-        #   no related information.
+        # @return [String] The purchase date of the order, presented in ISO-8601 date/time format. It will be null when
+        #   there is no related information.
         attribute(:purchase_date, String, from: "PurchaseDate")
 
-        # @return [String] The end of the time period during which you must notify the seller of possible cancellation,
-        #   in ISO-8601 date/time format.
+        # @return [String] The end of the time period which you cancel notify for the order, presented in ISO-8601
+        #   date/time format.
         attribute?(:cancel_notify_date, String, from: "CancelNotifyDate")
 
-        # @return [String] The start of the time period during which you committed to fulfill the order, in ISO-8601
-        #   date/time format. Returned only for seller-fulfilled orders.
+        # @return [String] The start of the time period within which you have committed to fulfill the order, presented
+        #   in ISO-8601 date/time format. Returned only for seller-fulfilled orders.
         attribute?(:earliest_delivery_date, String, from: "EarliestDeliveryDate")
 
-        # @return [String] The start of the time period during which you committed to ship the order, in ISO-8601
-        #   date/time format.
+        # @return [String] The start of the time period within which you have committed to ship the order, presented in
+        #   ISO-8601 date/time format.
         attribute?(:earliest_ship_date, String, from: "EarliestShipDate")
 
         # @return [String] The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship
@@ -52,13 +52,13 @@ module Peddler
         # @return [String] The status of the electronic invoice.
         attribute?(:electronic_invoice_status, String, from: "ElectronicInvoiceStatus")
 
-        # @return [String] The end of the time period during which you committed to fulfill the order, in ISO-8601
-        #   date/time format. Returned only for seller-fulfilled orders that do not have a PendingAvailability, Pending,
-        #   or Canceled status.
+        # @return [String] The end of the time period within which you have committed to fulfill the order, presented in
+        #   ISO-8601 date/time format. Returned only for seller-fulfilled orders that do not have a PendingAvailability,
+        #   Pending, or Canceled status.
         attribute?(:latest_delivery_date, String, from: "LatestDeliveryDate")
 
-        # @return [String] The end of the time period during which you committed to ship the order, in ISO-8601
-        #   date/time format.
+        # @return [String] The end of the time period within which you have committed to ship the order, presented in
+        #   ISO-8601 date/time format.
         attribute?(:latest_ship_date, String, from: "LatestShipDate")
 
         # @return [Integer] The number of items shipped.
@@ -67,10 +67,10 @@ module Peddler
         # @return [Integer] The number of items unshipped.
         attribute?(:number_of_items_unshipped, Integer, from: "NumberOfItemsUnshipped")
 
-        # @return [Array<String>] The order programs in which this order participates.
+        # @return [Array<String>] The order programs, if any, in which this order participates.
         attribute?(:order_programs, [String], from: "OrderPrograms")
 
-        # @return [Array<String>] The shipping programs in which this order participates.
+        # @return [Array<String>] The shipping programs, if any, in which this order participates.
         attribute?(:shipping_programs, [String], from: "ShippingPrograms")
       end
     end

data/lib/peddler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Peddler
-  VERSION = "5.4.0"
+  VERSION = "5.5.0"
 end

data/sig/peddler/api.rbs

@@ -6,6 +6,8 @@ module Peddler
     class MustSandbox < StandardError
     end
 
+    TRANSIENT_STATUSES: Array[Integer]
+
     @access_token: String
     @endpoint: Endpoint
     @http: HTTP::Client