muffin_man 2.4.9 → 2.4.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bf958ab9a38a6e686f7c2439c1bfe9c3e3ac1264b4d809ca569ae83fc93edab
-  data.tar.gz: f98710b2d26bc4c10672a037025362812186f715e8e1c8cce6b961424581daed
+  metadata.gz: 33f0611029142ad77dfc45fd3554b68b0579c9ab5aa9aec1764e9e21a208ded2
+  data.tar.gz: 378875142894a576c71e69628786f473eb83a14f2abc94bc147eceaf0c836a81
 SHA512:
-  metadata.gz: 0caa54a781067e8a7d9ec9ecceea77b03f606e2be9091b060b4bbd568827d65121ca03141e4065b8062e8f269d3246b8078c266fcd985464ac0aefd48237a9cf
-  data.tar.gz: 41d32878a81281c5ae5a485fb56e39a58165ee3281f7d52e416b1bc482627ce8e3ead221815738dfba613c620b89da4a09ecba4b56ad082db394c9693e42abc3
+  metadata.gz: ad19739230189a856576ad94d39d41e2c058f97f962f3f718f8d634f2976cbc2b7361ad2648d68ee487f8106f626eaeb977b8adcba3a5d9657a53d59429af6c8
+  data.tar.gz: 17da668a051fe58d4415b76b4f2b89164ed0e9a23b634ecea84195ec249ba59081e53b85a98d041475a28f4788bad558ac5902db48033c71d558b36309c4b8f2

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 2.4.11
+
+- Application Management API v2023-11-30 [#88](https://github.com/patterninc/muffin_man/pull/88)
+
+# 2.4.10
+
+- Sellers API v1 [#87](https://github.com/patterninc/muffin_man/pull/87)
+- Listings API v20210801 searchListingsItem [#87](https://github.com/patterninc/muffin_man/pull/87)
+
 # 2.4.8
 
 - Customer Feedback v2024-06-01 [#80] (https://github.com/patterninc/muffin_man/pull/80)

data/README.md

@@ -25,6 +25,7 @@ As of now, this gem only supports portions of the following APIs with more to co
 - `Product Pricing API v0`
 - `Reports API v2021-06-30`
 - `Solicitations API v1`
+- `Sellers API v1`
 - `Tokens API v2021-03-01`
 - `Vendor Direct Fulfillment Transactions API v1`
 - `Vendor Direct Fulfillment Orders API v2021-12-28`
@@ -35,6 +36,9 @@ As of now, this gem only supports portions of the following APIs with more to co
 - `Vendor Orders API v1`
 - `Vendor Shipments API v1`
 - `Vendor Transaction Status API v1`
+- `Uploads API v2020-11-01`
+- `A+ API v2020-11-01`
+- `Application Management API v2023-11-30`
 
 ## Installation
 
@@ -123,6 +127,18 @@ auth_code = resp['payload']['authorizationCode']
 refresh_token = MuffinMan::Lwa::AuthHelper.get_refresh_token(CLIENT_ID, CLIENT_SECRET, auth_code)
 ```
 
+### Retrieiving the access token
+To retrieve the access token, you can use the LWA helper:
+```ruby
+access_token = MuffinMan::Lwa::AuthHelper.get_access_token(scope, client_id, client_secret)
+```
+
+### Rotating application client secret
+To rotate client secret for application
+```ruby
+MuffinMan::ApplicationManagement::V20231130.rotate_application_client_secret(access_token)
+```
+
 ### Debugging
 
 To use Typheous' verbose mode set env variable `MUFFIN_MAN_DEBUG=true`

data/lib/muffin_man/aplus_content/v20201101.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module MuffinMan
+  module AplusContent
+    class V20201101 < SpApiClient
+      # Create content document
+      #
+      # This API is used to upload A+ Content documents.
+      # The content document is the container for all A+ modules in a specific language.
+      # It is required for creating content in A+ Content Manager.
+      # @param marketplace_id The identifier for the marketplace where the A+ Content is published.
+      # @param content_document_payload The content document request payload.
+      # Refer to the A+ Content API documentation for more information.
+      # @return [Hash]
+      #   The response from the API, which includes the signed upload URL and additional metadata.
+      # @raise [StandardError]
+      #   Raises an error if the API request fails.
+      #
+      # @example
+      #   client = MuffinMan::AplusContent::V20201101.new
+      #   response = client.create_content_documents(
+      #     "ATVPDKIKX0DER",
+      #     { "contentDocument" => {
+      #        "name" => "My Content Document",
+      #        "contentType" => "STANDARD",
+      #        "locale" => "en_US",
+      #        "contentModuleList" => "< ContentModule > array"
+      #        }
+      #     }
+      #   )
+      #   puts response
+      def create_content_documents(marketplace_id, content_document_payload)
+        @local_var_path = "/aplus/2020-11-01/contentDocuments"
+        @query_params = { "marketplaceId" => marketplace_id }
+        @request_body = content_document_payload
+        @request_type = "POST"
+
+        call_api
+      end
+
+      # Create content document asin relations
+      #
+      # This API is used to associate ASINs with a content document.
+      # The content document is the container for all A+ modules in a specific language.
+      # It is required for creating content in A+ Content Manager.
+      # @param marketplace_id The identifier for the marketplace where the A+ Content is published.
+      # @param content_reference_key The unique reference key for the content document.
+      # @param asin_set The set of ASINs.
+      # @return [Hash]
+      #   The response from the API, which includes the signed upload URL and additional metadata.
+      # @raise [StandardError]
+      #   Raises an error if the API request fails.
+      #
+      # @example
+      #   client = MuffinMan::AplusContent::V20201101.new
+      #   response = client.post_content_document_asin_relations(
+      #     "ATVPDKIKX0DER",
+      #     "contentReferenceKey",
+      #     ["B07H8QMZWV", "B07H8QMZWV"]
+      #   )
+      #   puts response
+      def post_content_document_asin_relations(marketplace_id, content_reference_key, asin_set)
+        @local_var_path = "/aplus/2020-11-01/contentDocuments/#{content_reference_key}/asins"
+        @query_params = { "marketplaceId" => marketplace_id }
+        @request_body = { "asinSet" => asin_set }
+        @request_type = "POST"
+
+        call_api
+      end
+
+      # validate content document asin relations
+      #
+      # This API is used to validate the content document ASINs.
+      # The content document is the container for all A+ modules in a specific language.
+      # It is required for creating content in A+ Content Manager.
+      # @param marketplace_id The identifier for the marketplace where the A+ Content is published.
+      # @param asin_set The set of ASINs.
+      # @param content_document_payload The content document request payload.
+      # Refer to the A+ Content API documentation for more information.
+      # @return [Hash]
+      #   The response from the API, which includes the signed upload URL and additional metadata.
+      # @raise [StandardError]
+      #   Raises an error if the API request fails.
+      #
+      # @example
+      #   client = MuffinMan::AplusContent::V20201101.new
+      #   response = client.validate_content_document_asin_relations(
+      #     "ATVPDKIKX0DER",
+      #     ["B07H8QMZWV", "B07H8QMZWV"],
+      #     { "contentDocument" => {
+      #        "name" => "My Content Document",
+      #        "contentType" => "STANDARD",
+      #        "locale" => "en_US",
+      #        "contentModuleList" => "< ContentModule > array"
+      #        }
+      #     }
+      #   )
+      #   puts response
+      def validate_content_document_asin_relations(marketplace_id, asin_set, content_document_payload)
+        @local_var_path = "/aplus/2020-11-01/contentAsinValidations"
+        @query_params = { "marketplaceId" => marketplace_id, "asinSet" => asin_set.join(",") }
+        @request_body = content_document_payload
+        @request_type = "POST"
+
+        call_api
+      end
+    end
+  end
+end

data/lib/muffin_man/application_management/v20231130.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module MuffinMan
+  module ApplicationManagement
+    class V20231130
+      def self.rotate_application_client_secret(access_token)
+        Typhoeus.post(
+          "https://sellingpartnerapi-na.amazon.com/applications/2023-11-30/clientSecret",
+          headers: { "x-amz-access-token" => access_token }
+        )
+      end
+    end
+  end
+end

data/lib/muffin_man/listings/v20210801.rb

@@ -65,6 +65,21 @@ module MuffinMan
         @request_type = "PATCH"
         call_api
       end
+
+      def search_listings_items(seller_id, marketplace_ids, **optional_query)
+        @local_var_path = "/listings/2021-08-01/items/#{seller_id}"
+        @marketplace_ids = marketplace_ids.is_a?(Array) ? marketplace_ids : [marketplace_ids]
+        @query_params = {
+          "marketplaceIds" =>  @marketplace_ids.join(",")
+        }
+        optional_query.each do |key, value|
+          camel_key = key.to_s.camelize(:lower).to_sym
+          string_value = value.is_a?(Array) ? value.join(",") : value
+          @query_params[camel_key] = string_value
+        end
+        @request_type = "GET"
+        call_api
+      end
     end
   end
 end

data/lib/muffin_man/lwa/auth_helper.rb

@@ -23,5 +23,28 @@ module MuffinMan::Lwa
       end
       JSON.parse(response.body)["refresh_token"]
     end
+
+    def self.get_access_token(scope, client_id, client_secret)
+      body = {
+        grant_type: "client_credentials",
+        scope: scope,
+        client_id: client_id,
+        client_secret: client_secret
+      }
+
+      response = Typhoeus.post(
+        ACCESS_TOKEN_URL,
+        body: URI.encode_www_form(body),
+        headers: {
+          "Content-Type" => "application/x-www-form-urlencoded;charset=UTF-8"
+        }
+      )
+      if response.code != 200
+        error_body = JSON.parse(response.body)
+        error = "#{error_body["error"]}: #{error_body["error_description"]}"
+        raise MuffinMan::Error, error
+      end
+      JSON.parse(response.body)["access_token"]
+    end
   end
 end

data/lib/muffin_man/sellers/v1.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module MuffinMan
+  module Sellers
+    class V1 < SpApiClient
+      # This is only available in the EU region.
+      def account
+        @local_var_path = "/sellers/v1/account"
+        @request_type = "GET"
+        call_api
+      end
+
+      def marketplace_participations
+        @local_var_path = "/sellers/v1/marketplaceParticipations"
+        @request_type = "GET"
+        call_api
+      end
+    end
+  end
+end

data/lib/muffin_man/sp_api_client.rb

@@ -108,7 +108,7 @@ module MuffinMan
           "Content-Type" => "application/x-www-form-urlencoded;charset=UTF-8"
         }
       )
-      raise SpApiAuthError, response if response.failure?
+      raise SpApiAuthError, response unless response.success?
 
       JSON.parse(response.body)
     end

data/lib/muffin_man/uploads/v20201101.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module MuffinMan
+  module Uploads
+    class V20201101 < SpApiClient
+      # Creates a new upload destination for a resource.
+      #
+      # This method generates a signed upload destination URL for a specific resource
+      # that you can use to upload files to Amazon SP-API.
+      #
+      # @param [String] marketplace_id
+      #   The identifier of the marketplace for the request (e.g., 'ATVPDKIKX0DER').
+      # @param [String] resource
+      #   The resource type and path, such as:
+      #   - `/messaging/v1/orders/{amazonOrderId}/messages/legalDisclosure`
+      #   - `aplus/2020-11-01/contentDocuments`.
+      # @param [String] content_md5
+      #   The MD5 hash of the file's content. Use `Digest::MD5.file(file_path).hexdigest` to calculate this.
+      # @param [String] content_type (optional)
+      #   The content type of the file (e.g., 'application/pdf').
+      # @return [Hash]
+      #   The response from the API, which includes the signed upload URL and additional metadata.
+      # @raise [StandardError]
+      #   Raises an error if the API request fails.
+      #
+      # @example
+      #   client = MuffinMan::Uploads::V20201101.new
+      #   response = client.create_upload_destination_for_resource(
+      #     "ATVPDKIKX0DER",
+      #     "aplus/2020-11-01/contentDocuments",
+      #     "510700ca1b152c729b62f2fd13c8dbbe",
+      #     "application/pdf"
+      #   )
+      #   puts response
+      def create_upload_destination_for_resource(marketplace_id, resource, content_md5, content_type: nil)
+        @local_var_path = "/uploads/2020-11-01/uploadDestinations/#{resource}"
+        @query_params = { "marketplaceIds" => marketplace_id, "contentMD5" => content_md5 }
+        @query_params["contentType"] = content_type if content_type
+        @request_type = "POST"
+
+        call_api
+      end
+    end
+  end
+end

data/lib/muffin_man/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MuffinMan
-  VERSION = "2.4.9"
+  VERSION = "2.4.11"
 end

data/lib/muffin_man.rb

@@ -26,6 +26,7 @@ require "muffin_man/feeds/v20210630"
 require "muffin_man/notifications/v1"
 require "muffin_man/merchant_fulfillment/v0"
 require "muffin_man/awd/v20240509"
+require "muffin_man/sellers/v1"
 require "muffin_man/vendor_direct_fulfillment_inventory/v1"
 require "muffin_man/vendor_direct_fulfillment_orders/v20211228"
 require "muffin_man/vendor_direct_fulfillment_payments/v1"
@@ -36,6 +37,9 @@ require "muffin_man/vendor_orders/v1"
 require "muffin_man/vendor_shipments/v1"
 require "muffin_man/vendor_transaction_status/v1"
 require "muffin_man/customer_feedback/v20240601"
+require "muffin_man/uploads/v20201101"
+require "muffin_man/aplus_content/v20201101"
+require "muffin_man/application_management/v20231130"
 
 module MuffinMan
   class Error < StandardError; end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: muffin_man
 version: !ruby/object:Gem::Version
-  version: 2.4.9
+  version: 2.4.11
 platform: ruby
 authors:
 - Gavin
 - Jason
 - Nate
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-13 00:00:00.000000000 Z
+date: 2025-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -130,7 +130,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - gavin@pattern.com
 - jason@pattern.com
@@ -153,6 +153,8 @@ files:
 - bin/console
 - bin/setup
 - lib/muffin_man.rb
+- lib/muffin_man/aplus_content/v20201101.rb
+- lib/muffin_man/application_management/v20231130.rb
 - lib/muffin_man/authorization/v1.rb
 - lib/muffin_man/awd/v20240509.rb
 - lib/muffin_man/catalog_items/base_api.rb
@@ -188,9 +190,11 @@ files:
 - lib/muffin_man/request_helpers/outbound_fulfillment/item.rb
 - lib/muffin_man/request_helpers/outbound_fulfillment/v20200701.rb
 - lib/muffin_man/sandbox_helpers/merchant_fulfillment/create_shipment_body.json
+- lib/muffin_man/sellers/v1.rb
 - lib/muffin_man/solicitations/v1.rb
 - lib/muffin_man/sp_api_client.rb
 - lib/muffin_man/tokens/v20210301.rb
+- lib/muffin_man/uploads/v20201101.rb
 - lib/muffin_man/vendor_direct_fulfillment_inventory/v1.rb
 - lib/muffin_man/vendor_direct_fulfillment_orders/v20211228.rb
 - lib/muffin_man/vendor_direct_fulfillment_payments/v1.rb
@@ -207,7 +211,7 @@ homepage: https://github.com/patterninc/muffin_man
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -222,8 +226,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Amazon Selling Partner API client
 test_files: []