peddler 5.4.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea43bac8eb39d36256c21f7fa3f2b1db30878a89d1e9d3545dcd637ec420c503
-  data.tar.gz: 4fc3347ad7d0ce503f9551f781285ec8ad0558a27e17f0cfdf6bf69e63f0642a
+  metadata.gz: dfaa728f0b1fe2e6c63402f3bc188b58f9b6d2d35177666a48f2dcf36420e353
+  data.tar.gz: 80d2163af9c60fdd65feaa9d4b9d24d3c5e4babc4d6386228ed03f8ac9851bcf
 SHA512:
-  metadata.gz: 86af994dfeaf305576af803e1e885cdc3f8e39b7ed70734e80aa89a4fcae5c63c351299bdd25af6096383d17263b54dcc40d90cfea3e8a625e6eb002ccd51c16
-  data.tar.gz: 8c977d54bba2653f97f7508bbfa397a1c2f8dbe2be8d0d4d371163e9b17d1b73e1d040b75d652271631f56fa20f4ed775e68ad8b4120fa30a2047d70a0f142d6
+  metadata.gz: 73ecd6efcc89cf60e4565e5d13e39c96240a8bf1e2a08e7f88eeb1ed5f72f65ed63c18a7d2f300727c09adb430a05cea4b110b22ad0e98fd73c20cb4404d4a9e
+  data.tar.gz: d1c8d6b7d388b26110edc1326fa1907e7ad696d79d8f9a7acfea37d7df739fbc6ddd6908933496e7734dded1725553fcc417be22491ed8bace4b887463169567

data/README.md

@@ -14,7 +14,7 @@ Add to your Gemfile.
 
 ### Agent skill
 
-If you use a coding agent, install the peddler skill for SP-API spec research and Ruby usage help:
+If you use an agent, install the SP-API skill:
 
 ```shell
 npx skills add lineofflight/peddler
@@ -197,6 +197,21 @@ rescue Peddler::Error => e
 end
 ```
 
+#### Rescuing Specific Errors
+
+Peddler raises specific pre-defined subclasses for common Amazon error codes (e.g., `Peddler::Errors::QuotaExceeded`, `Peddler::Errors::NotFound`, `Peddler::Errors::InvalidInput`).
+
+If Amazon returns an undocumented or newly introduced error code, Peddler dynamically instantiates a matching subclass under the `Peddler::Errors` namespace at runtime. To rescue a new specific subclass without causing a boot-time `NameError` in your application, define the class beforehand in an initializer:
+
+```ruby
+# config/initializers/peddler_errors.rb
+module Peddler
+  module Errors
+    class NewAmazonErrorCode < Error; end
+  end
+end
+```
+
 ### Available APIs
 
 Peddler provides Ruby interfaces to all Amazon SP-API endpoints. Each API is available in its respective version. Access APIs by calling methods on the Peddler module:
@@ -334,6 +349,10 @@ For complete method signatures, see [sig/peddler/apis/](sig/peddler/apis/)
 
 For a complete list of available APIs and their detailed documentation, refer to the [API models repository][openapi-models].
 
+## Best practices
+
+Writing efficient SP-API code? See the [best-practices checklist](skills/sp-api-ruby/best-practices.md) bundled with the agent skill: cutting call volume, batching, caching, API versions, reports, and per-API quirks.
+
 ## Development
 
 ```bash

data/lib/peddler/api.rb

@@ -9,6 +9,8 @@ module Peddler
     class CannotSandbox < StandardError; end
     class MustSandbox < StandardError; end
 
+    TRANSIENT_STATUSES = [429, 500, 502, 503, 504].freeze
+
     # @return [Peddler::Endpoint]
     attr_reader :endpoint
 
@@ -62,10 +64,32 @@ module Peddler
         "X-Amz-Date" => timestamp,
       )
 
-      return client if retries.zero? || rate_limit.nil?
-
-      delay = sandbox? ? 0.2 : 1.0 / rate_limit
-      client.retriable(delay:, tries: retries + 1, retry_statuses: [429])
+      return client if retries.zero?
+
+      on_retry = ->(_req, _err, res) {
+        Thread.current[:peddler_last_retry_status] = res&.status
+      }
+
+      delay = ->(iteration) {
+        last_status = Thread.current[:peddler_last_retry_status]
+
+        if last_status == 429 && rate_limit
+          # Rate-limit-aware exponential backoff with jitter if throttled
+          # @see https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
+          initial_delay = sandbox? ? 0.2 : 1.0 / rate_limit
+          (initial_delay * (2.0**(iteration - 1))) + (rand * 0.1)
+        else
+          # Standard backoff for network errors and 5xx
+          (2.0**(iteration - 1)) - 1 + rand
+        end
+      }
+
+      client.retriable(
+        tries: retries + 1,
+        delay: delay,
+        on_retry: on_retry,
+        retry_statuses: TRANSIENT_STATUSES,
+      )
     end
 
     private

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/order_attribute.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class AmazonWarehousingAndDistribution20240509
+      # Consists of the order preference and corresponding preference value.
+      OrderAttribute = Structure.new do
+        # @return [String] Preference for the distribution order.
+        attribute(:order_preference, String, null: false, from: "orderPreference")
+
+        # @return [String] Value for the order preference.
+        attribute(:order_preference_value, String, null: false, from: "orderPreferenceValue")
+      end
+    end
+  end
+end

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_execution_error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class AmazonWarehousingAndDistribution20240509
+      # Execution errors associated with the outbound order. This field will be populated if the order failed
+      # validation.
+      OutboundExecutionError = Structure.new do
+        # @return [String] Failure code details for the error.
+        attribute(:failure_code, String, null: false, from: "failureCode")
+
+        # @return [Array<String>] Failure reasons for the error.
+        attribute(:failure_reasons, [String], null: false, from: "failureReasons")
+
+        # @return [String] MSKU associated with the error.
+        attribute?(:sku, String)
+      end
+    end
+  end
+end

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_listing.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class AmazonWarehousingAndDistribution20240509
+      # A list of paginated outbound orders filtered by the attributes passed in the request.
+      OutboundListing = Structure.new do
+        # @return [String] TA token that is used to retrieve the next page of results. The response includes `nextToken`
+        #   when the number of results exceeds the specified `maxResults` value. To get the next page of results, call
+        #   the operation with this token and include the same arguments as the call that produced the token. To get a
+        #   complete list, call this operation until `nextToken` is null. Note that this operation can return empty
+        #   pages.
+        attribute?(:next_token, String, from: "nextToken")
+
+        # @return [Array<OutboundOrder>] List of outbound orders.
+        attribute?(:outbound_orders, [OutboundOrder], from: "outboundOrders")
+      end
+    end
+  end
+end

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_order.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+require "time"
+
+module Peddler
+  module APIs
+    class AmazonWarehousingAndDistribution20240509
+      # Represents an AWD outbound order.
+      OutboundOrder = Structure.new do
+        # @return [String] Order ID for the outbound order.
+        attribute(:order_id, String, null: false, from: "orderId")
+
+        # @return [String] Status for the outbound order.
+        attribute(:order_status, String, null: false, from: "orderStatus")
+
+        # @return [Array<OutboundShipment>] List of outbound shipments that are part of this order.
+        attribute(:outbound_shipments, [OutboundShipment], null: false, from: "outboundShipments")
+
+        # @return [Time] Date on which this outbound order was confirmed.
+        attribute?(:confirmed_on, Time, from: "confirmedOn")
+
+        # @return [Time] Date on which this outbound order was created.
+        attribute?(:created_at, Time, from: "createdAt")
+
+        # @return [Array<DistributionPackageQuantity>] List of packages that are eligible for outbound.
+        attribute?(:eligible_packages_to_outbound, [DistributionPackageQuantity], from: "eligiblePackagesToOutbound")
+
+        # @return [Array<ProductQuantity>] List of product units that are eligible for outbound.
+        attribute?(:eligible_products_to_outbound, [ProductQuantity], from: "eligibleProductsToOutbound")
+
+        # @return [Array<OutboundExecutionError>] Execution errors associated with the outbound order. This field will
+        #   be populated if the order failed validation.
+        attribute?(:execution_errors, [OutboundExecutionError], from: "executionErrors")
+
+        # @return [Array<OrderAttribute>] Order preferences for this outbound order.
+        attribute?(:order_preferences, [OrderAttribute], from: "orderPreferences")
+
+        # @return [Array<DistributionPackageQuantity>] List of packages to be outbound.
+        attribute?(:packages_to_outbound, [DistributionPackageQuantity], from: "packagesToOutbound")
+
+        # @return [Array<ProductQuantity>] List of product units to be outbound.
+        attribute?(:products_to_outbound, [ProductQuantity], from: "productsToOutbound")
+
+        # @return [Array<DistributionPackageQuantity>] Outbound packages that are shipped after the execution has
+        #   completed post confirmation.
+        attribute?(:shipped_outbound_packages, [DistributionPackageQuantity], from: "shippedOutboundPackages")
+
+        # @return [Array<ProductQuantity>] Outbound product units that are shipped after the execution has completed
+        #   post confirmation.
+        attribute?(:shipped_outbound_products, [ProductQuantity], from: "shippedOutboundProducts")
+
+        # @return [Time] Date on which this outbound order was last updated.
+        attribute?(:updated_at, Time, from: "updatedAt")
+      end
+    end
+  end
+end

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_order_creation_data.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class AmazonWarehousingAndDistribution20240509
+      # Payload for creating an outbound order.
+      OutboundOrderCreationData = Structure.new do
+        # @return [Array<OrderAttribute>] Order preferences for the outbound order.
+        attribute?(:order_preferences, [OrderAttribute], from: "orderPreferences")
+
+        # @return [Array<DistributionPackageQuantity>] List of packages to be outbound.
+        attribute?(:packages_to_outbound, [DistributionPackageQuantity], from: "packagesToOutbound")
+
+        # @return [Array<ProductQuantity>] List of product units to be outbound.
+        attribute?(:products_to_outbound, [ProductQuantity], from: "productsToOutbound")
+      end
+    end
+  end
+end

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_order_reference.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class AmazonWarehousingAndDistribution20240509
+      # A response that contains the reference identifier for the newly created or updated outbound order. This includes
+      # an order ID.
+      OutboundOrderReference = Structure.new do
+        # @return [String] outbound order ID.
+        attribute(:order_id, String, null: false, from: "orderId")
+      end
+    end
+  end
+end

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_shipment.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+require "time"
+
+module Peddler
+  module APIs
+    class AmazonWarehousingAndDistribution20240509
+      # Represents an AWD outbound shipment.
+      OutboundShipment = Structure.new do
+        # @return [Address] Destination address for this shipment.
+        attribute(:destination_address, Address, null: false, from: "destinationAddress")
+
+        # @return [String] Outbound order ID this outbound shipment belongs to.
+        attribute(:order_id, String, null: false, from: "orderId")
+
+        # @return [Address] Origin address for this shipment.
+        attribute(:origin_address, Address, null: false, from: "originAddress")
+
+        # @return [String] Unique shipment ID.
+        attribute(:shipment_id, String, null: false, from: "shipmentId")
+
+        # @return [String] Current status of this shipment.
+        attribute(:shipment_status, String, null: false, from: "shipmentStatus")
+
+        # @return [Time] Timestamp when the shipment was created.
+        attribute?(:created_at, Time, from: "createdAt")
+
+        # @return [Array<DistributionPackageQuantity>] Specific distribution packages that are included in the context
+        #   of this shipment.
+        attribute?(:shipment_package_quantities, [DistributionPackageQuantity], from: "shipmentPackageQuantities")
+
+        # @return [Array<ProductQuantity>] Specific product units that are included in the context of this shipment.
+        attribute?(:shipment_product_quantities, [ProductQuantity], from: "shipmentProductQuantities")
+
+        # @return [Time] Timestamp when the shipment was updated.
+        attribute?(:updated_at, Time, from: "updatedAt")
+      end
+    end
+  end
+end

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/shipment_label_page_types.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class AmazonWarehousingAndDistribution20240509
+      # Shipment label page types.
+      ShipmentLabelPageTypes = Structure.new do
+        # @return [String] Status of label page types.
+        attribute(:label_status, String, null: false, from: "labelStatus")
+
+        # @return [Array<PageType>] List of available page types.
+        attribute?(:page_types, Array, from: "pageTypes")
+      end
+    end
+  end
+end

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09.rb

@@ -108,6 +108,19 @@ module Peddler
         get(path, params:, rate_limit:, parser:)
       end
 
+      # Retrieves the available label page types for a shipment ID that you specify. This is an asynchronous operation.
+      # If the label status is `GENERATED`, then the pageTypes are available.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param shipment_id [String] ID for the shipment.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_label_page_types(shipment_id, rate_limit: 1.0)
+        path = "/awd/2024-05-09/inboundShipments/#{percent_encode(shipment_id)}/labelPageTypes"
+        parser = -> { ShipmentLabelPageTypes }
+        get(path, rate_limit:, parser:)
+      end
+
       # Updates transport details for an AWD shipment.
       #
       # @note This operation can make a static sandbox call.
@@ -197,6 +210,93 @@ module Peddler
         get(path, params:, rate_limit:, parser:)
       end
 
+      # Retrieves all outbound AWD orders (with optional filters) that pertain to a merchant. By default, orders are
+      # sorted by the `updatedAt` attribute in descending order.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param updated_after [String] Get the outbound orders updated after a certain time (inclusive). The date must be
+      #   in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param updated_before [String] Get the outbound orders updated before a certain time (inclusive). The date must
+      #   be in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param sort_order [String] Sort the response in `ASCENDING` or `DESCENDING` order.
+      # @param max_results [Integer] Maximum number of results to return.
+      # @param next_token [String] A token that is used to retrieve the next page of results. The response includes
+      #   `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of
+      #   results, call the operation with this token and include the same arguments as the call that produced the
+      #   token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can
+      #   return empty pages.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def list_outbounds(updated_after: nil, updated_before: nil, sort_order: nil, max_results: 25, next_token: nil,
+        rate_limit: 1.0)
+        path = "/awd/2024-05-09/outboundOrders"
+        params = {
+          "updatedAfter" => updated_after,
+          "updatedBefore" => updated_before,
+          "sortOrder" => sort_order,
+          "maxResults" => max_results,
+          "nextToken" => next_token,
+        }.compact
+        parser = -> { OutboundListing }
+        get(path, params:, rate_limit:, parser:)
+      end
+
+      # Creates a draft AWD outbound order with the specified products. The API returns the order ID for the newly
+      # created order and starts an async validation check on the outbound products. After the validation check, the
+      # order status transitions from `VALIDATING` to `ELIGIBLE/INELIGIBLE`.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] Payload for creating an outbound order.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def create_outbound(body, rate_limit: 1.0)
+        path = "/awd/2024-05-09/outboundOrders"
+        parser = -> { OutboundOrderReference }
+        post(path, body:, rate_limit:, parser:)
+      end
+
+      # Retrieves an AWD outbound order with a set of shipments that contain items that are outbound into a destination
+      # channel. If the order is not eligible, the validation errors field is included in the order response. The API
+      # returns the order ID for the newly created order and starts an async validation check on the outbound products.
+      # After the validation check, the order status transitions from `VALIDATING` to `ELIGIBLE/INELIGIBLE`.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param order_id [String] ID for the outbound order to be retrieved.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_outbound(order_id, rate_limit: 1.0)
+        path = "/awd/2024-05-09/outboundOrders/#{percent_encode(order_id)}"
+        parser = -> { OutboundOrder }
+        get(path, rate_limit:, parser:)
+      end
+
+      # Updates an AWD outbound order that is in `DRAFT`, `ELIGIBLE`, or `INELIGIBLE` status. This API allows updates on
+      # `productsToOutbound` and `orderPreferences` attributes only. Any updates will restart the outbound order
+      # validation.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param order_id [String] ID for the outbound order to be updated.
+      # @param body [Hash] Represents an AWD outbound order.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def update_outbound(order_id, body, rate_limit: 1.0)
+        path = "/awd/2024-05-09/outboundOrders/#{percent_encode(order_id)}"
+        parser = -> { OutboundOrderReference }
+        put(path, body:, rate_limit:, parser:)
+      end
+
+      # Confirms an AWD outbound order for a set of shipments that contain items that must be outbound to a destination
+      # node. You can confirm the order only if it's in an`ELIGIBLE` state.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param order_id [String] ID for the outbound order you want to confirm.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def confirm_outbound(order_id, rate_limit: 1.0)
+        path = "/awd/2024-05-09/outboundOrders/#{percent_encode(order_id)}/confirmation"
+        post(path, rate_limit:)
+      end
+
       # Retrieves all the AWD replenishment orders pertaining to a merchant with optional filters.
       # API by default will sort orders by updatedAt attribute in descending order.
       #

data/lib/peddler/apis/listings_restrictions_2021_08_01/restriction_list.rb

@@ -9,7 +9,7 @@ module Peddler
     class ListingsRestrictions20210801
       # A list of restrictions for the specified Amazon catalog item.
       RestrictionList = Structure.new do
-        # @return [Array<Restriction>]
+        # @return [Array<Restriction>] A list of restrictions.
         attribute(:restrictions, [Restriction], null: false)
       end
     end

data/lib/peddler/apis/listings_restrictions_2021_08_01.rb

@@ -25,10 +25,12 @@ module Peddler
       # @param reason_locale [String] A locale for reason text localization. When not provided, the default language
       #   code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to
       #   "en_US" when a localization is not available in the specified locale.
+      # @param product_type [String] The product type of the item. When provided with the brand name, the API evaluates
+      #   GTIN exemption restrictions in addition to brand restrictions for the specified product type.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def get_listings_restrictions(asin, seller_id, marketplace_ids, condition_type: nil, reason_locale: nil,
-        rate_limit: 5.0)
+        product_type: nil, rate_limit: 5.0)
         path = "/listings/2021-08-01/restrictions"
         params = {
           "asin" => asin,
@@ -36,6 +38,7 @@ module Peddler
           "sellerId" => seller_id,
           "marketplaceIds" => stringify_array(marketplace_ids),
           "reasonLocale" => reason_locale,
+          "productType" => product_type,
         }.compact
         parser = -> { RestrictionList }
         get(path, params:, rate_limit:, parser:)

data/lib/peddler/apis/notifications_v1/aggregation_filter.rb

@@ -7,8 +7,8 @@ require "structure"
 module Peddler
   module APIs
     class NotificationsV1
-      # A filter used to select the aggregation time period at which to send notifications (for example: limit to one
-      # notification every five minutes for high frequency notifications).
+      # A filter you can use to select the aggregation time period at which to send notifications (for example, limit to
+      # one notification every five minutes for high frequency notifications).
       AggregationFilter = Structure.new do
         # @return [AggregationSettings]
         attribute?(:aggregation_settings, AggregationSettings, from: "aggregationSettings")

data/lib/peddler/apis/notifications_v1/destination.rb

@@ -7,7 +7,7 @@ require "structure"
 module Peddler
   module APIs
     class NotificationsV1
-      # Information about the destination created when you call the `createDestination` operation.
+      # Information about the destination you create when you call the `createDestination` operation.
       Destination = Structure.new do
         # @return [String] The destination identifier generated when you created the destination.
         attribute(:destination_id, String, null: false, from: "destinationId")

data/lib/peddler/apis/notifications_v1/event_bridge_resource.rb

@@ -16,8 +16,8 @@ module Peddler
         # @return [String] The name of the partner event source associated with the destination.
         attribute(:name, String, null: false)
 
-        # @return [String] The AWS region in which you receive the notifications. For AWS regions that are supported in
-        #   Amazon EventBridge, refer to [Amazon EventBridge endpoints and
+        # @return [String] The AWS region in which you receive the notifications. For AWS regions that Amazon
+        #   EventBridge supports, refer to [Amazon EventBridge endpoints and
         #   quotas](https://docs.aws.amazon.com/general/latest/gr/ev.html).
         attribute(:region, String, null: false)
       end

data/lib/peddler/apis/notifications_v1/event_filter.rb

@@ -7,13 +7,13 @@ require "structure"
 module Peddler
   module APIs
     class NotificationsV1
-      # A `notificationType` specific filter. This object contains all of the currently available filters and properties
-      # that you can use to define a `notificationType` specific filter.
+      # A `notificationType` filter. This object contains all of the available filters and properties that you can use
+      # to define a `notificationType` specific filter.
       EventFilter = Structure.new do
-        # @return [String] An `eventFilterType` value that is supported by the specific `notificationType`. This is used
-        #   by the subscription service to determine the type of event filter. Refer to [Notification Type
-        #   Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values) to determine if an
-        #   `eventFilterType` is supported.
+        # @return [String] An `eventFilterType` value that the `notificationType` supports. The subscription service
+        #   uses the `eventFilterType` to determine the type of event filter. To determine if a specific
+        #   `notificationType` supports an `eventFilterType`, refer to [Notification Type Values](
+        #   https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
         attribute(:event_filter_type, String, null: false, from: "eventFilterType")
 
         # @return [AggregationSettings]

data/lib/peddler/apis/notifications_v1/marketplace_filter.rb

@@ -7,7 +7,7 @@ require "structure"
 module Peddler
   module APIs
     class NotificationsV1
-      # An event filter to customize your subscription to send notifications for only the specified `marketplaceId`s.
+      # An event filter you can use to customize your subscription to send notifications for specific `marketplaceId`s.
       MarketplaceFilter = Structure.new do
         # @return [Array<String>]
         attribute?(:marketplace_ids, [String], from: "marketplaceIds")

data/lib/peddler/apis/notifications_v1/marketplace_ids.rb

@@ -5,8 +5,8 @@
 module Peddler
   module APIs
     class NotificationsV1
-      # A list of marketplace identifiers to subscribe to (for example: ATVPDKIKX0DER). To receive notifications in
-      # every marketplace, do not provide this list.
+      # A list of marketplace identifiers you can subscribe to (for example, `ATVPDKIKX0DER`). To receive notifications
+      # in every marketplace, do not provide this list.
       class MarketplaceIds < Array
         class << self
           def parse(array)

data/lib/peddler/apis/notifications_v1/order_change_type_filter.rb

@@ -7,7 +7,8 @@ require "structure"
 module Peddler
   module APIs
     class NotificationsV1
-      # An event filter to customize your subscription to send notifications for only the specified `orderChangeType`.
+      # An event filter you can use to customize your subscription to send notifications for a specific
+      # `orderChangeType`.
       OrderChangeTypeFilter = Structure.new do
         # @return [Array<OrderChangeTypeEnum>]
         attribute?(:order_change_types, Array, from: "orderChangeTypes")

data/lib/peddler/apis/notifications_v1/order_change_types.rb

@@ -5,8 +5,8 @@
 module Peddler
   module APIs
     class NotificationsV1
-      # A list of order change types to subscribe to (for example: `BuyerRequestedChange`). To receive notifications of
-      # all change types, do not provide this list.
+      # A list of order change types you can subscribe to (for example, `BuyerRequestedChange`). To receive
+      # notifications of all change types, do not provide this list.
       class OrderChangeTypes < Array
         class << self
           def parse(array)

data/lib/peddler/apis/notifications_v1/processing_directive.rb

@@ -8,15 +8,26 @@ module Peddler
   module APIs
     class NotificationsV1
       # Additional information passed to the subscription to control the processing of notifications. For example, you
-      # can use an `eventFilter` to customize your subscription to send notifications for only the specified
-      # `marketplaceId`s, or select the aggregation time period at which to send notifications (for example: limit to
-      # one notification every five minutes for high frequency notifications). The specific features available vary
-      # depending on the `notificationType`.
-      #
-      # This feature is currently only supported by the `ANY_OFFER_CHANGED` and `ORDER_CHANGE` `notificationType`s.
+      # can use an `eventFilter` to customize your subscription to send notifications for only the `marketplaceId`s that
+      # you specify, or select the aggregation time period at which to send notifications (for example, you can set a
+      # limit of one notification every five minutes for high frequency notifications). You can also use
+      # `filterExpression` to filter events based on notification payload. The specific features available can vary by
+      # the `notificationType`.
       ProcessingDirective = Structure.new do
-        # @return [EventFilter] A `notificationType` specific filter.
+        # @return [EventFilter] A `notificationType` filter. Note: eventFilter and filterExpression are mutually
+        #   exclusive, meaning if eventFilter is provided, filterExpression field cannot be used.
         attribute?(:event_filter, EventFilter, from: "eventFilter")
+
+        # @return [String] An expression for filtering events before delivery to destination based on the notification
+        #   payload (example: FulfillmentOrderStatusNotification.FulfillmentOrderStatus == `SHIPPED` ). The
+        #   `filterExpression` is a string that follows the CEL expression syntax (https://github.com/google/cel-spec)
+        #   excluding arithmetic operators (+, -, *, /, %) and list/map indexing ([]). Refer to Notification Type Values
+        #   to determine if filter Expression is supported for a Notification Type. Refer to CEL Operators
+        #   (https://developer-docs.amazon.com/sp-api/docs/filter-notification-subscriptions) to see if a CEL operator
+        #   is supported.
+        # Note: eventFilter and filterExpression are mutually exclusive. You can use filterExpression to replace
+        #   existing eventFilter configurations.
+        attribute?(:filter_expression, String, from: "filterExpression")
       end
     end
   end

data/lib/peddler/apis/notifications_v1/send_test_notification_request.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class NotificationsV1
+      # The request schema for the `sendTestNotification` operation.
+      SendTestNotificationRequest = Structure.new do
+        # @return [String] The identifier for the destination where notifications will be delivered.
+        attribute?(:destination_id, String, from: "destinationId")
+
+        # @return [TestNotification]
+        attribute?(:test_notification, TestNotification, from: "testNotification")
+      end
+    end
+  end
+end