peddler 4.0.1 → 4.2.0

data/lib/peddler/apis/vendor_direct_fulfillment_sandbox_test_data_2021_10_28.rb

@@ -19,9 +19,8 @@ module Peddler
       #
       # @note This operation can make a dynamic sandbox call.
       # @param body [Hash] The request payload containing parameters for generating test order data scenarios.
-      # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def generate_order_scenarios(body, rate_limit: nil)
+      def generate_order_scenarios(body)
         path = "/vendor/directFulfillment/sandbox/2021-10-28/orders"
 
         post(path, body:)
@@ -33,9 +32,8 @@ module Peddler
       # @note This operation can make a dynamic sandbox call.
       # @param transaction_id [String] The transaction identifier returned in the response to the generateOrderScenarios
       #   operation.
-      # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def get_order_scenarios(transaction_id, rate_limit: nil)
+      def get_order_scenarios(transaction_id)
         path = "/vendor/directFulfillment/sandbox/2021-10-28/transactions/#{transaction_id}"
 
         get(path)

data/lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28.rb

@@ -12,22 +12,23 @@ module Peddler
   module APIs
     # Selling Partner API for Direct Fulfillment Shipping
     #
-    # The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment
-    # vendor's shipping data.
+    # Use the Selling Partner API for Direct Fulfillment Shipping to access a direct fulfillment vendor's shipping data.
     class VendorDirectFulfillmentShipping20211228 < API
-      # Returns a list of shipping labels created during the time frame that you specify. You define that time frame
-      # using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to
-      # search must not be more than 7 days.
+      # Returns a list of shipping labels created during the time frame that you specify. Use the `createdAfter` and
+      # `createdBefore` parameters to define the time frame. You must use both of these parameters. The date range to
+      # search must not be more than seven days.
       #
       # @note This operation can make a dynamic sandbox call.
-      # @param ship_from_party_id [String] The vendor warehouseId for order fulfillment. If not specified, the result
-      #   will contain orders for all warehouses.
+      # @param ship_from_party_id [String] The vendor `warehouseId` for order fulfillment. If not specified, the result
+      #   contains orders for all warehouses.
       # @param limit [Integer] The limit to the number of records returned.
       # @param created_after [String] Shipping labels that became available after this date and time will be included in
-      #   the result. Must be in ISO-8601 date/time format.
+      #   the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
       # @param created_before [String] Shipping labels that became available before this date and time will be included
-      #   in the result. Must be in ISO-8601 date/time format.
-      # @param sort_order [String] Sort ASC or DESC by order creation date.
+      #   in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time
+      #   format.
+      # @param sort_order [String] The sort order creation date. You can choose between ascending (`ASC`) or descending
+      #   (`DESC`) sort order.
       # @param next_token [String] Used for pagination when there are more ship labels than the specified result size
       #   limit. The token value is returned in the previous API call.
       # @param rate_limit [Float] Requests per second
@@ -47,10 +48,10 @@ module Peddler
         meter(rate_limit).get(path, params:)
       end
 
-      # Creates a shipping label for a purchase order and returns a transactionId for reference.
+      # Creates a shipping label for a purchase order and returns a `transactionId` for reference.
       #
       # @note This operation can make a dynamic sandbox call.
-      # @param body [Hash] Request body containing the shipping labels data.
+      # @param body [Hash] The request body that contains the shipping labels data.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def submit_shipping_label_request(body, rate_limit: 10.0)
@@ -59,11 +60,11 @@ module Peddler
         meter(rate_limit).post(path, body:)
       end
 
-      # Returns a shipping label for the purchaseOrderNumber that you specify.
+      # Returns a shipping label for the `purchaseOrderNumber` that you specify.
       #
       # @note This operation can make a dynamic sandbox call.
-      # @param purchase_order_number [String] The purchase order number for which you want to return the shipping label
-      #   and should be the same purchaseOrderNumber as received in the order.
+      # @param purchase_order_number [String] The purchase order number for which you want to return the shipping label.
+      #   It should be the same `purchaseOrderNumber` that you received in the order.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def get_shipping_label(purchase_order_number, rate_limit: 10.0)
@@ -76,8 +77,8 @@ module Peddler
       #
       # @note This operation can make a dynamic sandbox call.
       # @param purchase_order_number [String] The purchase order number for which you want to return the shipping
-      #   labels. It should be the same purchaseOrderNumber as received in the order.
-      # @param body [Hash] The request payload containing parameters for creating shipping labels.
+      #   labels. It should be the same number as the `purchaseOrderNumber` in the order.
+      # @param body [Hash] The request payload that contains the parameters for creating shipping labels.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def create_shipping_labels(purchase_order_number, body, rate_limit: 10.0)
@@ -121,9 +122,9 @@ module Peddler
       #   will contain orders for all warehouses.
       # @param limit [Integer] The limit to the number of records returned
       # @param created_after [String] Orders that became available after this date and time will be included in the
-      #   result. Must be in ISO-8601 date/time format.
+      #   result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
       # @param created_before [String] Orders that became available before this date and time will be included in the
-      #   result. Must be in ISO-8601 date/time format.
+      #   result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
       # @param sort_order [String] Sort ASC or DESC by order creation date.
       # @param next_token [String] Used for pagination when there are more orders than the specified result size limit.
       #   The token value is returned in the previous API call.
@@ -160,14 +161,14 @@ module Peddler
       # must not be more than 7 days.
       #
       # @note This operation can make a dynamic sandbox call.
-      # @param ship_from_party_id [String] The vendor warehouseId for order fulfillment. If not specified the result
-      #   will contain orders for all warehouses.
-      # @param limit [Integer] The limit to the number of records returned
-      # @param created_after [String] Packing slips that became available after this date and time will be included in
-      #   the result. Must be in ISO-8601 date/time format.
+      # @param ship_from_party_id [String] The vendor `warehouseId` for order fulfillment. If not specified, the result
+      #   contains orders for all warehouses.
+      # @param limit [Integer] The maximum number of records to return.
+      # @param created_after [String] Packing slips that become available after this date and time will be included in
+      #   the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
       # @param created_before [String] Packing slips that became available before this date and time will be included in
-      #   the result. Must be in ISO-8601 date/time format.
-      # @param sort_order [String] Sort ASC or DESC by packing slip creation date.
+      #   the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+      # @param sort_order [String] The packing slip creation dates, which are sorted by ascending or descending order.
       # @param next_token [String] Used for pagination when there are more packing slips than the specified result size
       #   limit. The token value is returned in the previous API call.
       # @param rate_limit [Float] Requests per second
@@ -190,7 +191,7 @@ module Peddler
       # Returns a packing slip based on the purchaseOrderNumber that you specify.
       #
       # @note This operation can make a dynamic sandbox call.
-      # @param purchase_order_number [String] The purchaseOrderNumber for the packing slip you want.
+      # @param purchase_order_number [String] The `purchaseOrderNumber` for the packing slip that you want.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def get_packing_slip(purchase_order_number, rate_limit: 10.0)
@@ -198,6 +199,18 @@ module Peddler
 
         meter(rate_limit).get(path)
       end
+
+      # Creates a container (pallet) label for the associated shipment package.
+      #
+      # @note This operation can make a dynamic sandbox call.
+      # @param body [Hash] Request body containing the container label data.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def create_container_label(body, rate_limit: 10.0)
+        path = "/vendor/directFulfillment/shipping/2021-12-28/containerLabel"
+
+        meter(rate_limit).post(path, body:)
+      end
     end
   end
 end

data/lib/peddler/apis/vendor_invoices_v1.rb

@@ -10,7 +10,7 @@ module Peddler
   end
 
   module APIs
-    # Vendor Invoices v1
+    # Selling Partner API for Retail Procurement Payments
     #
     # The Selling Partner API for Retail Procurement Payments provides programmatic access to vendors payments data.
     class VendorInvoicesV1 < API

data/lib/peddler/apis/vendor_shipments_v1.rb

@@ -10,7 +10,7 @@ module Peddler
   end
 
   module APIs
-    # Vendor Shipments v1
+    # Selling Partner API for Retail Procurement Shipments
     #
     # The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for
     # vendors.
@@ -127,6 +127,45 @@ module Peddler
 
         meter(rate_limit).get(path, params:)
       end
+
+      # Returns small parcel shipment labels based on the filters that you specify.
+      #
+      # @param limit [Integer] The limit to the number of records returned. Default value is 50 records.
+      # @param sort_order [String] Sort the list by shipment label creation date in ascending or descending order.
+      # @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 `pageSize` 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 label_created_after [String] Shipment labels created after this time will be included in the result. This
+      #   field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format.
+      # @param label_created_before [String] Shipment labels created before this time will be included in the result.
+      #   This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format.
+      # @param buyer_reference_number [String] Get Shipment labels by passing buyer reference number.
+      # @param vendor_shipment_identifier [String] Get Shipment labels by passing vendor shipment identifier.
+      # @param seller_warehouse_code [String] Get Shipping labels based on vendor warehouse code. This value must be
+      #   same as the `sellingParty.partyId` in the shipment.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_shipment_labels(limit: nil, sort_order: nil, next_token: nil, label_created_after: nil,
+        label_created_before: nil, buyer_reference_number: nil, vendor_shipment_identifier: nil,
+        seller_warehouse_code: nil, rate_limit: 10.0)
+        cannot_sandbox!
+
+        path = "/vendor/shipping/v1/transportLabels"
+        params = {
+          "limit" => limit,
+          "sortOrder" => sort_order,
+          "nextToken" => next_token,
+          "labelCreatedAfter" => label_created_after,
+          "labelCreatedBefore" => label_created_before,
+          "buyerReferenceNumber" => buyer_reference_number,
+          "vendorShipmentIdentifier" => vendor_shipment_identifier,
+          "sellerWarehouseCode" => seller_warehouse_code,
+        }.compact
+
+        meter(rate_limit).get(path, params:)
+      end
     end
   end
 end

data/lib/peddler/error.rb

@@ -8,7 +8,7 @@ module Peddler
     class << self
       def build(response)
         error = JSON.parse(response).dig("errors").first
-        class_name = error.dig("code")
+        class_name = normalize_class_name(error.dig("code"))
         message = error.dig("message")
         klass = if Errors.const_defined?(class_name)
           Errors.const_get(class_name)
@@ -23,6 +23,16 @@ module Peddler
       rescue NameError
         # Do nothing if code cannot be converted to a class name
       end
+
+      private
+
+      def normalize_class_name(code)
+        if code.match?(/\A[A-Z_]+\z/)
+          code.split("_").map(&:capitalize).join
+        else
+          code
+        end
+      end
     end
 
     def initialize(msg = nil, response = nil)

data/lib/peddler/token.rb

@@ -45,6 +45,18 @@ module Peddler
       response
     end
 
+    def grant_type
+      if options.key?(:grant_type)
+        options[:grant_type]
+      elsif options.key?(:refresh_token)
+        "refresh_token"
+      elsif options.key?(:scope)
+        "client_credentials"
+      elsif options.key?(:code)
+        "authorization_code"
+      end
+    end
+
     private
 
     def params
@@ -54,17 +66,5 @@ module Peddler
         client_secret: client_secret,
       }.compact.merge(options)
     end
-
-    def grant_type
-      return if options.key?(:grant_type)
-
-      if options.key?(:refresh_token)
-        "refresh_token"
-      elsif options.key?(:scope)
-        "client_credentials"
-      elsif options.key?(:code)
-        "authorization_code"
-      end
-    end
   end
 end

data/lib/peddler/version.rb

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

data/lib/peddler.rb

@@ -12,6 +12,7 @@ require "peddler/apis/easy_ship_2022_03_23"
 require "peddler/apis/fba_inbound_eligibility_v1"
 require "peddler/apis/fba_inventory_v1"
 require "peddler/apis/feeds_2021_06_30"
+require "peddler/apis/finances_2024_06_01"
 require "peddler/apis/finances_2024_06_19"
 require "peddler/apis/finances_v0"
 require "peddler/apis/fulfillment_inbound_2024_03_20"
@@ -41,6 +42,7 @@ require "peddler/apis/solicitations_v1"
 require "peddler/apis/supply_sources_2020_07_01"
 require "peddler/apis/tokens_2021_03_01"
 require "peddler/apis/uploads_2020_11_01"
+require "peddler/apis/vehicles_2024_11_01"
 require "peddler/apis/vendor_direct_fulfillment_inventory_v1"
 require "peddler/apis/vendor_direct_fulfillment_orders_2021_12_28"
 require "peddler/apis/vendor_direct_fulfillment_orders_v1"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: peddler
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.2.0
 platform: ruby
 authors:
 - Hakan Ensari
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-13 00:00:00.000000000 Z
+date: 2025-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -30,7 +29,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.0'
-description:
 email:
 - hakanensari@gmail.com
 executables: []
@@ -53,6 +51,7 @@ files:
 - lib/peddler/apis/fba_inbound_eligibility_v1.rb
 - lib/peddler/apis/fba_inventory_v1.rb
 - lib/peddler/apis/feeds_2021_06_30.rb
+- lib/peddler/apis/finances_2024_06_01.rb
 - lib/peddler/apis/finances_2024_06_19.rb
 - lib/peddler/apis/finances_v0.rb
 - lib/peddler/apis/fulfillment_inbound_2024_03_20.rb
@@ -82,6 +81,7 @@ files:
 - lib/peddler/apis/supply_sources_2020_07_01.rb
 - lib/peddler/apis/tokens_2021_03_01.rb
 - lib/peddler/apis/uploads_2020_11_01.rb
+- lib/peddler/apis/vehicles_2024_11_01.rb
 - lib/peddler/apis/vendor_direct_fulfillment_inventory_v1.rb
 - lib/peddler/apis/vendor_direct_fulfillment_orders_2021_12_28.rb
 - lib/peddler/apis/vendor_direct_fulfillment_orders_v1.rb
@@ -98,7 +98,6 @@ files:
 - lib/peddler/endpoint.rb
 - lib/peddler/error.rb
 - lib/peddler/helpers/feeds_2021_06_30.rb
-- lib/peddler/json_feed_document.rb
 - lib/peddler/marketplace.rb
 - lib/peddler/response.rb
 - lib/peddler/token.rb
@@ -108,7 +107,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -123,8 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Amazon Selling Partner API (SP-API) in Ruby
 test_files: []

data/lib/peddler/json_feed_document.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Peddler
-  class JSONFeedDocument
-    CONTENT_TYPE = "application/json; charset=UTF-8"
-
-    def upload(content)
-      # While HTTPrb already sets the content-type, Amazon server seems to fail if we don't explicitly set it again
-      # here. A bit of a mystery; maybe it's the order of the headers that's screwing things up on their end?
-      HTTP.headers("Content-Type" => CONTENT_TYPE).put(url, json: content)
-    end
-
-    def initialize(api)
-      @api = api
-    end
-
-    def id
-      metadata.fetch("id")
-    end
-
-    def url
-      metadata.fetch("url")
-    end
-
-    private
-
-    def metadata
-      @metadata ||= @api.create_feed_document({ "contentType" => CONTENT_TYPE }).parse
-    end
-  end
-end