peddler 5.3.1 → 5.5.0

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class ServicesV1
+      # Payment information for the service job.
+      Payment = Structure.new do
+        # @return [MoneyAmount] The payment amount.
+        attribute?(:amount, MoneyAmount)
+
+        # @return [String] The payment instrument used for the transaction.
+        attribute?(:instrument, String)
+      end
+    end
+  end
+end

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

@@ -25,10 +25,16 @@ module Peddler
         # @return [String] The marketplace identifier.
         attribute?(:marketplace_id, String, from: "marketplaceId")
 
+        # @return [Array<Payment>] A list that contains payment information for the service job.
+        attribute?(:payments, [Payment])
+
         # @return [Array<AppointmentTime>] A list of appointment windows preferred by the buyer. Included only if the
         #   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")
 
@@ -52,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,
@@ -148,7 +154,7 @@ module Peddler
       # @param service_job_id [String] An Amazon-defined service job identifier. Get this value by calling the
       #   `getServiceJobs` operation of the Services API.
       # @param appointment_id [String] An Amazon-defined identifier of active service job appointment.
-      # @param body [Hash]
+      # @param body [Hash] Input containing the resource details to be assigned to the appointment.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def assign_appointment_resources(service_job_id, appointment_id, body, rate_limit: 1.0)

data/lib/peddler/apis/shipment_invoicing_v0/payment_information.rb

@@ -7,21 +7,21 @@ require "structure"
 module Peddler
   module APIs
     class ShipmentInvoicingV0
-      # Payment transaction information
+      # Information about a payment transaction.
       PaymentInformation = Structure.new do
-        # @return [String] Government ID of acquirer
+        # @return [String] The government ID of the acquirer.
         attribute?(:acquirer_id, String, from: "AcquirerId")
 
-        # @return [String] Authorization code for this payment
+        # @return [String] The authorization code of this payment.
         attribute?(:authorization_code, String, from: "AuthorizationCode")
 
-        # @return [String] Credit card brand (if payment method is CreditCard)
+        # @return [String] The credit card brand if the payment method is `CreditCard`.
         attribute?(:card_brand, String, from: "CardBrand")
 
-        # @return [String] Payment method name
+        # @return [String] The name of the payment method.
         attribute?(:payment_method, String, from: "PaymentMethod")
 
-        # @return [Money] Amount paid in this payment
+        # @return [Money] The amount paid in this payment.
         attribute?(:payment_value, Money, from: "PaymentValue")
       end
     end

data/lib/peddler/apis/shipment_invoicing_v0/payment_information_list.rb

@@ -5,7 +5,7 @@
 module Peddler
   module APIs
     class ShipmentInvoicingV0
-      # List of payment transactions
+      # A list of payment transactions.
       class PaymentInformationList < Array
         class << self
           def parse(array)

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/data_kiosk/economics20240315.json

@@ -2035,6 +2035,12 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "VARIABLE_DEFINITION",
+              "description": "Location adjacent to a variable definition.",
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "SCHEMA",
               "description": "Location adjacent to a schema definition.",
@@ -2100,12 +2106,6 @@
               "description": "Location adjacent to an input object field definition.",
               "isDeprecated": false,
               "deprecationReason": null
-            },
-            {
-              "name": "VARIABLE_DEFINITION",
-              "description": "Location adjacent to a variable definition.",
-              "isDeprecated": false,
-              "deprecationReason": null
             }
           ],
           "possibleTypes": null

data/lib/peddler/data_kiosk/sales_and_traffic20231115.json

@@ -1900,6 +1900,12 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "VARIABLE_DEFINITION",
+              "description": "Location adjacent to a variable definition.",
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "SCHEMA",
               "description": "Location adjacent to a schema definition.",
@@ -1965,12 +1971,6 @@
               "description": "Location adjacent to an input object field definition.",
               "isDeprecated": false,
               "deprecationReason": null
-            },
-            {
-              "name": "VARIABLE_DEFINITION",
-              "description": "Location adjacent to a variable definition.",
-              "isDeprecated": false,
-              "deprecationReason": null
             }
           ],
           "possibleTypes": null

data/lib/peddler/data_kiosk/sales_and_traffic20240424.json

@@ -2465,6 +2465,12 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "VARIABLE_DEFINITION",
+              "description": "Location adjacent to a variable definition.",
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "SCHEMA",
               "description": "Location adjacent to a schema definition.",
@@ -2530,12 +2536,6 @@
               "description": "Location adjacent to an input object field definition.",
               "isDeprecated": false,
               "deprecationReason": null
-            },
-            {
-              "name": "VARIABLE_DEFINITION",
-              "description": "Location adjacent to a variable definition.",
-              "isDeprecated": false,
-              "deprecationReason": null
             }
           ],
           "possibleTypes": null

data/lib/peddler/data_kiosk/vendor_analytics20240930.json

@@ -2067,6 +2067,12 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "VARIABLE_DEFINITION",
+              "description": "Location adjacent to a variable definition.",
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "SCHEMA",
               "description": "Location adjacent to a schema definition.",
@@ -2132,12 +2138,6 @@
               "description": "Location adjacent to an input object field definition.",
               "isDeprecated": false,
               "deprecationReason": null
-            },
-            {
-              "name": "VARIABLE_DEFINITION",
-              "description": "Location adjacent to a variable definition.",
-              "isDeprecated": false,
-              "deprecationReason": null
             }
           ],
           "possibleTypes": null

data/lib/peddler/errors.rb

@@ -4,6 +4,7 @@ module Peddler
   # Container module for dynamically generated error classes
   module Errors
     class AccessDenied < Error; end
+    class InternalFailure < Error; end
     class InvalidGrant < Error; end
     class InvalidInput < Error; end
     class InvalidRequest < Error; end

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.3.1"
+  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
@@ -21,7 +23,7 @@ module Peddler
     def endpoint_uri: () -> URI::HTTPS
     def sandbox: () -> self
     def sandbox?: () -> bool
-    def http: (?rate_limit: Float?) -> HTTP::Client
+    def http: (?rate_limit: Float?) -> HTTP::Session
 
     private