peddler 1.6.7 → 2.0.0

data/lib/mws/orders/client.rb

@@ -7,36 +7,40 @@ module MWS
     # With the MWS Orders API, you can list orders created or updated during a
     # time frame you specify or retrieve information about specific orders.
     class Client < ::Peddler::Client
-      version '2013-09-01'
-      path "/Orders/#{version}"
+      self.version = '2013-09-01'
+      self.path = "/Orders/#{version}"
 
       # Lists orders
       #
       # @note When calling this operation, you must specify a time frame using
       #   either created_after or last_updated_after. When requesting orders by
       #   "Unshipped" status you must also request "PartiallyShipped" orders.
-      # @see http://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_ListOrders.html
-      # @param [Hash] opts
-      # @option opts [String, #iso8601] :created_after
-      # @option opts [String, #iso8601] :created_before
-      # @option opts [String, #iso8601] :last_updated_after
-      # @option opts [String, #iso8601] :last_updated_before
-      # @option opts [Array<String>, String] :order_status
-      # @option opts [Array<String>, String] :marketplace_id
-      # @option opts [Array<String>, String] :fulfillment_channel
-      # @option opts [Array<String>, String] :payment_method
-      # @option opts [String] :buyer_email
-      # @option opts [String] :seller_order_id
-      # @option opts [String] :max_results_per_page
-      # @option opts [String] :tfm_shipment_status
+      # @see https://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_ListOrders.html
+      # @overload list_orders(*marketplace_id, opts = {})
+      #   @param [Array<String>] marketplace_id
+      #   @param [Hash] opts
+      #   @option opts [String, #iso8601] :created_after
+      #   @option opts [String, #iso8601] :created_before
+      #   @option opts [String, #iso8601] :last_updated_after
+      #   @option opts [String, #iso8601] :last_updated_before
+      #   @option opts [Array<String>, String] :order_status
+      #   @option opts [Array<String>, String] :fulfillment_channel
+      #   @option opts [Array<String>, String] :payment_method
+      #   @option opts [String] :buyer_email
+      #   @option opts [String] :seller_order_id
+      #   @option opts [String] :max_results_per_page
+      #   @option opts [String] :tfm_shipment_status
       # @return [Peddler::XMLParser]
-      def list_orders(opts = {})
-        opts[:marketplace_id] ||= primary_marketplace_id
+      def list_orders(*marketplace_id)
+        marketplace_id = marketplace_id.dup
+        opts = extract_options(marketplace_id)
         if opts.key?(:tfm_shipment_status)
           opts['TFMShipmentStatus'] = opts.delete(:tfm_shipment_status)
         end
+
         operation('ListOrders')
           .add(opts)
+          .add('MarketplaceId' => marketplace_id)
           .structure!('OrderStatus', 'Status')
           .structure!('FulfillmentChannel', 'Channel')
           .structure!('MarketplaceId', 'Id')
@@ -49,7 +53,7 @@ module MWS
 
       # Lists the next page of orders
       #
-      # @see http://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_ListOrdersByNextToken.html
+      # @see https://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_ListOrdersByNextToken.html
       # @param [String] next_token
       # @return [Peddler::XMLParser]
       def list_orders_by_next_token(next_token)
@@ -61,8 +65,8 @@ module MWS
 
       # Gets one or more orders
       #
-      # @see http://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_GetOrder.html
-      # @param [String] amazon_order_id one or more amazon_order_ids
+      # @see https://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_GetOrder.html
+      # @param [Array<String>] amazon_order_ids
       # @return [Peddler::XMLParser]
       def get_order(*amazon_order_ids)
         operation('GetOrder')
@@ -74,7 +78,7 @@ module MWS
 
       # Lists order items for an order
       #
-      # @see http://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_ListOrderItems.html
+      # @see https://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_ListOrderItems.html
       # @param [String] amazon_order_id
       # @return [Peddler::XMLParser]
       def list_order_items(amazon_order_id)
@@ -86,7 +90,7 @@ module MWS
 
       # Lists the next page of order items for an order
       #
-      # @see http://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_ListOrderItemsByNextToken.html
+      # @see https://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_ListOrderItemsByNextToken.html
       # @param [String] next_token
       # @return [Peddler::XMLParser]
       def list_order_items_by_next_token(next_token)
@@ -98,7 +102,7 @@ module MWS
 
       # Gets the service status of the API
       #
-      # @see http://docs.developer.amazonservices.com/en_US/orders/2013-09-01/MWS_GetServiceStatus.html
+      # @see https://docs.developer.amazonservices.com/en_US/orders/2013-09-01/MWS_GetServiceStatus.html
       # @return [Peddler::XMLParser]
       def get_service_status
         operation('GetServiceStatus')

data/lib/mws/products/client.rb

@@ -9,80 +9,66 @@ module MWS
     # sourcing and pricing decisions for listing those products on Amazon
     # Marketplace websites.
     class Client < ::Peddler::Client
-      version '2011-10-01'
-      path "/Products/#{version}"
+      self.version = '2011-10-01'
+      self.path = "/Products/#{version}"
 
       # Lists products and their attributes, based on a search query
       #
-      # @see http://docs.developer.amazonservices.com/en_US/products/Products_ListMatchingProducts.html
-      # @overload list_matching_products(query, opts = { marketplace_id:
-      #   primary_marketplace_id })
-      #   @param [String] query
-      #   @param [Hash] opts
-      #   @option opts [String] :marketplace_id
-      #   @option opts [String] :query_context_id
+      # @see https://docs.developer.amazonservices.com/en_US/products/Products_ListMatchingProducts.html
+      # @param [String] marketplace_id
+      # @param [String] query
+      # @param [Hash] opts
+      # @option opts [String] :query_context_id
       # @return [Peddler::XMLParser]
-      def list_matching_products(query, opts = {})
-        operation_with_marketplace('ListMatchingProducts')
-          .add(opts.update('Query' => query))
+      def list_matching_products(marketplace_id, query, opts = {})
+        operation('ListMatchingProducts')
+          .add(opts)
+          .add('MarketplaceId' => marketplace_id, 'Query' => query)
 
         run
       end
 
-      # Lists products and their attributes, based on a list of ASIN, GCID,
-      #   SellerSKU, UPC, EAN, ISBN, and JAN values
+      # Lists products and their attributes, based on a list of ASIN values
       #
-      # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetMatchingProduct.html
-      # @overload get_matching_product_for_id(id_type, *ids, opts = {
-      #   marketplace_id: primary_marketplace_id })
-      #   @param [String] id_type
-      #   @param [String] id one or more ids
-      #   @param [Hash] opts
-      #   @option opts [String] :marketplace_id
+      # @see https://docs.developer.amazonservices.com/en_US/products/Products_GetMatchingProductForId.html
+      # @param [String] marketplace_id
+      # @param [Array<String>] asin_list
       # @return [Peddler::XMLParser]
-      def get_matching_product_for_id(id_type, *id_list)
-        opts = extract_options(id_list)
-
-        operation_with_marketplace('GetMatchingProductForId')
-          .add(opts.update('IdType' => id_type, 'IdList' => id_list))
-          .structure!('IdList', 'Id')
+      def get_matching_product(marketplace_id, *asin_list)
+        operation('GetMatchingProduct')
+          .add('MarketplaceId' => marketplace_id, 'ASINList' => asin_list)
+          .structure!('ASINList', 'ASIN')
 
         run
       end
 
-      # Lists products and their attributes, based on a list of ASIN values
+      # Lists products and their attributes, based on a list of ASIN, GCID,
+      #   SellerSKU, UPC, EAN, ISBN, and JAN values
       #
-      # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetMatchingProductForId.html
-      # @overload get_matching_product(*asins, opts = { marketplace_id:
-      #   primary_marketplace_id })
-      #   @param [String] asin one or more asins
-      #   @param [Hash] opts
-      #   @option opts [String] :marketplace_id
+      # @see https://docs.developer.amazonservices.com/en_US/products/Products_GetMatchingProduct.html
+      # @param [String] marketplace_id
+      # @param [String] id_type
+      # @param [Array<String>] id_list
       # @return [Peddler::XMLParser]
-      def get_matching_product(*asin_list)
-        opts = extract_options(asin_list)
-
-        operation_with_marketplace('GetMatchingProduct')
-          .add(opts.update('ASINList' => asin_list))
-          .structure!('ASINList', 'ASIN')
+      def get_matching_product_for_id(marketplace_id, id_type, *id_list)
+        operation('GetMatchingProductForId')
+          .add('MarketplaceId' => marketplace_id, 'IdType' => id_type,
+               'IdList' => id_list)
+          .structure!('IdList', 'Id')
 
         run
       end
 
       # Gets the current competitive price of a product, based on Seller SKU
       #
-      # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetCompetitivePricingForSKU.html
-      # @overload get_competitive_pricing_for_sku(*seller_skus, opts = {
-      #   marketplace_id: primary_marketplace_id })
-      #   @param [String] seller_sku one or more seller_skus
-      #   @param [Hash] opts
-      #   @option opts [String] :marketplace_id
+      # @see https://docs.developer.amazonservices.com/en_US/products/Products_GetCompetitivePricingForSKU.html
+      # @param [String] marketplace_id
+      # @param [Array<String>] seller_sku_list
       # @return [Peddler::XMLParser]
-      def get_competitive_pricing_for_sku(*seller_sku_list)
-        opts = extract_options(seller_sku_list)
-
-        operation_with_marketplace('GetCompetitivePricingForSKU')
-          .add(opts.update('SellerSKUList' => seller_sku_list))
+      def get_competitive_pricing_for_sku(marketplace_id, *seller_sku_list)
+        operation('GetCompetitivePricingForSKU')
+          .add('MarketplaceId' => marketplace_id,
+               'SellerSKUList' => seller_sku_list)
           .structure!('SellerSKUList', 'SellerSKU')
 
         run
@@ -90,18 +76,13 @@ module MWS
 
       # Gets the current competitive price of a product, identified by its ASIN
       #
-      # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetCompetitivePricingForASIN.html
-      # @overload get_competitive_pricing_for_asin(*asins, opts = {
-      #   marketplace_id: primary_marketplace_id })
-      #   @param [String] asin one or more asins
-      #   @param [Hash] opts
-      #   @option opts [String] :marketplace_id
+      # @see https://docs.developer.amazonservices.com/en_US/products/Products_GetCompetitivePricingForASIN.html
+      # @param [String] marketplace_id
+      # @param [Array<String>] asin_list
       # @return [Peddler::XMLParser]
-      def get_competitive_pricing_for_asin(*asin_list)
-        opts = extract_options(asin_list)
-
-        operation_with_marketplace('GetCompetitivePricingForASIN')
-          .add(opts.update('ASINList' => asin_list))
+      def get_competitive_pricing_for_asin(marketplace_id, *asin_list)
+        operation('GetCompetitivePricingForASIN')
+          .add('MarketplaceId' => marketplace_id, 'ASINList' => asin_list)
           .structure!('ASINList', 'ASIN')
 
         run
@@ -110,20 +91,22 @@ module MWS
       # Gets pricing information for the lowest-price active offer listings for
       # a product, based on Seller SKU
       #
-      # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetLowestOfferListingsForSKU.html
-      # @overload get_lowest_offer_listings_for_sku(*seller_skus, opts = {
-      #   marketplace_id: primary_marketplace_id })
-      #   @param [String] seller_sku one or more seller_skus
+      # @see https://docs.developer.amazonservices.com/en_US/products/Products_GetLowestOfferListingsForSKU.html
+      # @overload get_lowest_offer_listings_for_sku(marketplace_id, *seller_sku_list, opts = {})
+      #   @param [String] marketplace_id
+      #   @param [Array<String>] seller_sku_list
       #   @param [Hash] opts
-      #   @option opts [String] :marketplace_id
       #   @option opts [String] :item_condition
       #   @option opts [Boolean] :exclude_me
       # @return [Peddler::XMLParser]
-      def get_lowest_offer_listings_for_sku(*seller_sku_list)
+      def get_lowest_offer_listings_for_sku(marketplace_id, *seller_sku_list)
+        seller_sku_list = seller_sku_list.dup
         opts = extract_options(seller_sku_list)
 
-        operation_with_marketplace('GetLowestOfferListingsForSKU')
-          .add(opts.update('SellerSKUList' => seller_sku_list))
+        operation('GetLowestOfferListingsForSKU')
+          .add(opts)
+          .add('MarketplaceId' => marketplace_id,
+               'SellerSKUList' => seller_sku_list)
           .structure!('SellerSKUList', 'SellerSKU')
 
         run
@@ -132,20 +115,21 @@ module MWS
       # Gets pricing information for the lowest-price active offer listings for
       # a product, identified by its ASIN
       #
-      # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetLowestOfferListingsForASIN.html
-      # @overload get_lowest_offer_listings_for_asin(*asins, opts = {
-      #   marketplace_id: primary_marketplace_id })
-      #   @param [String] asin one or more asins
+      # @see https://docs.developer.amazonservices.com/en_US/products/Products_GetLowestOfferListingsForASIN.html
+      # @overload get_lowest_offers_listings_for_asin(marketplace_id, *asin_list, opts = {})
+      #   @param [String] marketplace_id
+      #   @param [Array<String>] asin_list
       #   @param [Hash] opts
-      #   @option opts [String] :marketplace_id
       #   @option opts [String] :item_condition
       #   @option opts [Boolean] :exclude_me
       # @return [Peddler::XMLParser]
-      def get_lowest_offer_listings_for_asin(*asin_list)
+      def get_lowest_offer_listings_for_asin(marketplace_id, *asin_list)
+        asin_list = asin_list.dup
         opts = extract_options(asin_list)
 
-        operation_with_marketplace('GetLowestOfferListingsForASIN')
-          .add(opts.update('ASINList' => asin_list))
+        operation('GetLowestOfferListingsForASIN')
+          .add(opts)
+          .add('MarketplaceId' => marketplace_id, 'ASINList' => asin_list)
           .structure!('ASINList', 'ASIN')
 
         run
@@ -153,52 +137,41 @@ module MWS
 
       # Gets lowest priced offers for a single product, based on SellerSKU
       #
-      # @see http://docs.developer.amazonservices.com/en_MX/products/Products_GetLowestPricedOffersForSKU.html
-      # @overload get_lowest_priced_offers_for_sku(seller_sku, item_condition,
-      #   opts = { marketplace_id: primary_marketplace_id })
-      #   @param [String] seller_sku
-      #   @param [String] item_condition
-      #   @param [Hash] opts
-      #   @option opts [String] :marketplace_id
+      # @see https://docs.developer.amazonservices.com/en_MX/products/Products_GetLowestPricedOffersForSKU.html
+      # @param [String] marketplace_id
+      # @param [String] seller_sku
+      # @param [String] item_condition
       # @return [Peddler::XMLParser]
-      def get_lowest_priced_offers_for_sku(seller_sku, item_condition,
-                                           opts = {})
-        opts.update(
-          'SellerSKU' => seller_sku,
-          'ItemCondition' => item_condition
-        )
-        operation_with_marketplace('GetLowestPricedOffersForSKU')
-          .add(opts)
+      def get_lowest_priced_offers_for_sku(marketplace_id, seller_sku,
+                                           item_condition)
+        operation('GetLowestPricedOffersForSKU')
+          .add('MarketplaceId' => marketplace_id, 'SellerSKU' => seller_sku,
+               'ItemCondition' => item_condition)
 
         run
       end
 
       # Gets lowest priced offers for a single product, based on ASIN
       #
-      # @see http://docs.developer.amazonservices.com/en_MX/products/Products_GetLowestPricedOffersForASIN.html
-      # @overload get_lowest_priced_offers_for_asin(asin, item_condition, opts =
-      #   { marketplace_id: primary_marketplace_id })
-      #   @param [String] asin
-      #   @param [String] item_condition
-      #   @param [Hash] opts
-      #   @option opts [String] :marketplace_id
+      # @see https://docs.developer.amazonservices.com/en_MX/products/Products_GetLowestPricedOffersForASIN.html
+      # @param [String] marketplace_id
+      # @param [String] asin
+      # @param [String] item_condition
       # @return [Peddler::XMLParser]
-      def get_lowest_priced_offers_for_asin(asin, item_condition, opts = {})
-        opts.update(
-          'ASIN' => asin,
-          'ItemCondition' => item_condition
-        )
-        operation_with_marketplace('GetLowestPricedOffersForASIN')
-          .add(opts)
+      def get_lowest_priced_offers_for_asin(marketplace_id, asin,
+                                            item_condition)
+        operation('GetLowestPricedOffersForASIN')
+          .add('MarketplaceId' => marketplace_id, 'ASIN' => asin,
+               'ItemCondition' => item_condition)
 
         run
       end
 
       # Gets the estimated fees for a list of products.
       #
-      # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetMyFeesEstimate.html
-      # @see http://docs.developer.amazonservices.com/en_US/products/Products_Datatypes.html#FeesEstimateRequest
-      # @param [Hash] fees_estimate_request one or more fees estimate requests
+      # @see https://docs.developer.amazonservices.com/en_US/products/Products_GetMyFeesEstimate.html
+      # @see https://docs.developer.amazonservices.com/en_US/products/Products_Datatypes.html#FeesEstimateRequest
+      # @param [Array<Struct, Hash>] fees_estimate_requests
       # @return [Peddler::XMLParser]
       def get_my_fees_estimate(*fees_estimate_requests)
         operation('GetMyFeesEstimate')
@@ -211,19 +184,22 @@ module MWS
       # Gets pricing information for seller's own offer listings, based on
       # Seller SKU
       #
-      # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetMyPriceForSKU.html
-      # @overload get_my_price_for_sku(*seller_skus, opts = { marketplace_id:
-      #   primary_marketplace_id })
-      #   @param [String] seller_sku one or more seller_skus
+      # @see https://docs.developer.amazonservices.com/en_US/products/Products_GetMyPriceForSKU.html
+      # @overload get_my_price_for_sku(marketplace_id, *seller_sku_list,
+      #   opts = {})
+      #   @param [String] marketplace_id
+      #   @param [Array<String>] seller_sku_list
       #   @param [Hash] opts
-      #   @option opts [String] :marketplace_id
       #   @option opts [String] :item_condition
       # @return [Peddler::XMLParser]
-      def get_my_price_for_sku(*seller_sku_list)
+      def get_my_price_for_sku(marketplace_id, *seller_sku_list)
+        seller_sku_list = seller_sku_list.dup
         opts = extract_options(seller_sku_list)
 
-        operation_with_marketplace('GetMyPriceForSKU')
-          .add(opts.update('SellerSKUList' => seller_sku_list))
+        operation('GetMyPriceForSKU')
+          .add(opts)
+          .add('MarketplaceId' => marketplace_id,
+               'SellerSKUList' => seller_sku_list)
           .structure!('SellerSKUList', 'SellerSKU')
 
         run
@@ -232,72 +208,61 @@ module MWS
       # Gets pricing information for seller's own offer listings, identified by
       # its ASIN
       #
-      # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetMyPriceForASIN.html
-      # @overload get_my_price_for_asin(*asins, opts = { marketplace_id:
-      #   primary_marketplace_id })
-      #   @param [String] asin one or more asins
+      # @see https://docs.developer.amazonservices.com/en_US/products/Products_GetMyPriceForASIN.html
+      # @overload get_my_price_for_asin(marketplace_id, *asin_list, opts = {})
+      #   @param [String] marketplace_id
+      #   @param [Array<String>] asin_list
       #   @param [Hash] opts
-      #   @option opts [String] :marketplace_id
       #   @option opts [String] :item_condition
       # @return [Peddler::XMLParser]
-      def get_my_price_for_asin(*asin_list)
+      def get_my_price_for_asin(marketplace_id, *asin_list)
+        asin_list = asin_list.dup
         opts = extract_options(asin_list)
 
-        operation_with_marketplace('GetMyPriceForASIN')
-          .add(opts.update('ASINList' => asin_list))
+        operation('GetMyPriceForASIN')
+          .add(opts)
+          .add('MarketplaceId' => marketplace_id,
+               'ASINList' => asin_list)
           .structure!('ASINList', 'ASIN')
 
         run
       end
 
       # Gets parent product categories that a product belongs to, based on
-      # Seller`SKU
+      # Seller SKU
       #
-      # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetProductCategoriesForSKU.html
-      # @overload get_product_categories_for_sku(sku, opts = { marketplace_id:
-      #   primary_marketplace_id })
-      #   @param [String] seller_sku
-      #   @param [Hash] opts
-      #   @option opts [String] :marketplace_id
+      # @see https://docs.developer.amazonservices.com/en_US/products/Products_GetProductCategoriesForSKU.html
+      # @param [String] marketplace_id
+      # @param [String] seller_sku
       # @return [Peddler::XMLParser]
-      def get_product_categories_for_sku(seller_sku, opts = {})
-        operation_with_marketplace('GetProductCategoriesForSKU')
-          .add(opts.update('SellerSKU' => seller_sku))
+      def get_product_categories_for_sku(marketplace_id, seller_sku)
+        operation('GetProductCategoriesForSKU')
+          .add('MarketplaceId' => marketplace_id, 'SellerSKU' => seller_sku)
 
         run
       end
 
       # Gets parent product categories that a product belongs to, based on ASIN
       #
-      # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetProductCategoriesForASIN.html
-      # @overload get_product_categories_for_asin(asin, opts = { marketplace_id:
-      #   primary_marketplace_id })
-      #   @param [String] asin
-      #   @param [Hash] opts
-      #   @option opts [String] :marketplace_id
+      # @see https://docs.developer.amazonservices.com/en_US/products/Products_GetProductCategoriesForASIN.html
+      # @param [String] marketplace_id
+      # @param [String] asin
       # @return [Peddler::XMLParser]
-      def get_product_categories_for_asin(asin, opts = {})
-        operation_with_marketplace('GetProductCategoriesForASIN')
-          .add(opts.update('ASIN' => asin))
+      def get_product_categories_for_asin(marketplace_id, asin)
+        operation('GetProductCategoriesForASIN')
+          .add('MarketplaceId' => marketplace_id, 'ASIN' => asin)
 
         run
       end
 
       # Gets the service status of the API
       #
-      # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetServiceStatus.html
+      # @see https://docs.developer.amazonservices.com/en_US/products/Products_GetServiceStatus.html
       # @return [Peddler::XMLParser]
       def get_service_status
         operation('GetServiceStatus')
         run
       end
-
-      # @api private
-      def operation_with_marketplace(action)
-        operation(action).tap do |opts|
-          opts.store('MarketplaceId', primary_marketplace_id)
-        end
-      end
     end
   end
 end