peddler 2.4.5 → 3.0.0

data/lib/mws/products/client.rb

@@ -1,268 +0,0 @@
-# frozen_string_literal: true
-
-require 'peddler/client'
-
-module MWS
-  module Products
-    # The MWS Products API helps you get information to match your products to
-    # existing product listings on Amazon Marketplace websites and to make
-    # sourcing and pricing decisions for listing those products on Amazon
-    # Marketplace websites.
-    class Client < ::Peddler::Client
-      self.version = '2011-10-01'
-      self.path = "/Products/#{version}"
-
-      # Lists products and their attributes, based on a search query
-      #
-      # @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(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 values
-      #
-      # @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(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, GCID,
-      #   SellerSKU, UPC, EAN, ISBN, and JAN values
-      #
-      # @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_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 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(marketplace_id, *seller_sku_list)
-        operation('GetCompetitivePricingForSKU')
-          .add('MarketplaceId' => marketplace_id,
-               'SellerSKUList' => seller_sku_list)
-          .structure!('SellerSKUList', 'SellerSKU')
-
-        run
-      end
-
-      # Gets the current competitive price of a product, identified by its ASIN
-      #
-      # @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(marketplace_id, *asin_list)
-        operation('GetCompetitivePricingForASIN')
-          .add('MarketplaceId' => marketplace_id, 'ASINList' => asin_list)
-          .structure!('ASINList', 'ASIN')
-
-        run
-      end
-
-      # Gets pricing information for the lowest-price active offer listings for
-      # a product, based on Seller SKU
-      #
-      # @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] :item_condition
-      #   @option opts [Boolean] :exclude_me
-      # @return [Peddler::XMLParser]
-      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('GetLowestOfferListingsForSKU')
-          .add(opts)
-          .add('MarketplaceId' => marketplace_id,
-               'SellerSKUList' => seller_sku_list)
-          .structure!('SellerSKUList', 'SellerSKU')
-
-        run
-      end
-
-      # Gets pricing information for the lowest-price active offer listings for
-      # a product, identified by its ASIN
-      #
-      # @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] :item_condition
-      #   @option opts [Boolean] :exclude_me
-      # @return [Peddler::XMLParser]
-      def get_lowest_offer_listings_for_asin(marketplace_id, *asin_list)
-        asin_list = asin_list.dup
-        opts = extract_options(asin_list)
-
-        operation('GetLowestOfferListingsForASIN')
-          .add(opts)
-          .add('MarketplaceId' => marketplace_id, 'ASINList' => asin_list)
-          .structure!('ASINList', 'ASIN')
-
-        run
-      end
-
-      # Gets lowest priced offers for a single product, based on SellerSKU
-      #
-      # @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(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 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(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 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')
-          .add('FeesEstimateRequestList' => fees_estimate_requests)
-          .structure!('FeesEstimateRequestList', 'FeesEstimateRequest')
-
-        run
-      end
-
-      # Gets pricing information for seller's own offer listings, based on
-      # Seller SKU
-      #
-      # @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] :item_condition
-      # @return [Peddler::XMLParser]
-      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('GetMyPriceForSKU')
-          .add(opts)
-          .add('MarketplaceId' => marketplace_id,
-               'SellerSKUList' => seller_sku_list)
-          .structure!('SellerSKUList', 'SellerSKU')
-
-        run
-      end
-
-      # Gets pricing information for seller's own offer listings, identified by
-      # its ASIN
-      #
-      # @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] :item_condition
-      # @return [Peddler::XMLParser]
-      def get_my_price_for_asin(marketplace_id, *asin_list)
-        asin_list = asin_list.dup
-        opts = extract_options(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
-      #
-      # @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(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 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(marketplace_id, asin)
-        operation('GetProductCategoriesForASIN')
-          .add('MarketplaceId' => marketplace_id, 'ASIN' => asin)
-
-        run
-      end
-
-      # Gets the service status of the API
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/products/Products_GetServiceStatus.html
-      # @return [Peddler::XMLParser]
-      def get_service_status
-        operation('GetServiceStatus')
-        run
-      end
-    end
-  end
-end

data/lib/mws/products.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require 'mws/products/client'

data/lib/mws/recommendations/client.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-require 'peddler/client'
-
-module MWS
-  module Recommendations
-    # The Recommendations API enables you to programmatically retrieve Amazon
-    # Selling Coach recommendations by recommendation category. A recommendation
-    # is an actionable, timely, and personalized opportunity to increase your
-    # sales and performance.
-    class Client < ::Peddler::Client
-      self.version = '2013-04-01'
-      self.path = "/Recommendations/#{version}"
-
-      # Checks whether there are active recommendations for each category for
-      # the given marketplace, and if there are, returns the time when
-      # recommendations were last updated for each category
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/recommendations/Recommendations_GetLastUpdatedTimeForRecommendations.html
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def get_last_updated_time_for_recommendations(marketplace_id)
-        operation('GetLastUpdatedTimeForRecommendations')
-          .add('MarketplaceId' => marketplace_id)
-
-        run
-      end
-
-      # Lists active recommendations for a specific category or for all
-      # categories for a specific marketplace
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/recommendations/Recommendations_ListRecommendations.html
-      # @param [String] marketplace_id
-      # @param [Hash] opts
-      # @option opts [String] :recommendation_category
-      # @option opts [Array<Struct, Hash>] :category_query_list
-      # @return [Peddler::XMLParser]
-      def list_recommendations(marketplace_id, opts = {})
-        operation('ListRecommendations')
-          .add(opts)
-          .add('MarketplaceId' => marketplace_id)
-          .structure!(
-            'CategoryQueryList', 'CategoryQuery', '1', 'FilterOptions',
-            'FilterOption'
-          )
-
-        run
-      end
-
-      # Lists the next page of active recommendations
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/recommendations/Recommendations_ListRecommendationsByNextToken.html
-      # @param [String] next_token
-      # @return [Peddler::XMLParser]
-      def list_recommendations_by_next_token(next_token)
-        operation('ListRecommendationsByNextToken')
-          .add('NextToken' => next_token)
-
-        run
-      end
-
-      # Gets the service status of the API
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/recommendations/Recommendations_GetServiceStatus.html
-      # @return [Peddler::XMLParser]
-      def get_service_status
-        operation('GetServiceStatus')
-        run
-      end
-    end
-  end
-end

data/lib/mws/recommendations.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require 'mws/recommendations/client'

data/lib/mws/reports/client.rb

@@ -1,236 +0,0 @@
-# frozen_string_literal: true
-
-require 'peddler/client'
-
-module MWS
-  module Reports
-    # The Reports API lets you request reports about your inventory and orders.
-    class Client < ::Peddler::Client
-      self.version = '2009-01-01'
-      self.path = "/Reports/#{version}"
-
-      # Creates a report request
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_RequestReport.html
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_ReportType.html
-      # @param [String] report_type
-      # @param [Hash] opts
-      # @option opts [String, #iso8601] :start_date
-      # @option opts [String, #iso8601] :end_date
-      # @option opts [String] :report_options
-      # @option opts [Array<String>, String] :marketplace_id_list
-      # @return [Peddler::XMLParser]
-      def request_report(report_type, opts = {})
-        operation('RequestReport')
-          .add(opts)
-          .add('ReportType' => report_type)
-          .structure!('MarketplaceIdList', 'Id')
-
-        run
-      end
-
-      # Lists report requests
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportRequestList.html
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_ReportType.html
-      # @param [Hash] opts
-      # @option opts [Array<String>, String] :report_request_id_list
-      # @option opts [Array<String>, String] :report_type_list
-      # @option opts [Array<String>, String] :report_processing_status_list
-      # @option opts [Integer] :max_count
-      # @option opts [String, #iso8601] :requested_from_date
-      # @option opts [String, #iso8601] :requested_to_date
-      # @return [Peddler::XMLParser]
-      def get_report_request_list(opts = {})
-        operation('GetReportRequestList')
-          .add(opts)
-          .structure!('ReportRequestIdList', 'Id')
-          .structure!('ReportTypeList', 'Type')
-          .structure!('ReportProcessingStatusList', 'Status')
-
-        run
-      end
-
-      # Lists the next page of the report requests
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportRequestListByNextToken.html
-      # @param [String] next_token
-      # @return [Peddler::XMLParser]
-      def get_report_request_list_by_next_token(next_token)
-        operation('GetReportRequestListByNextToken')
-          .add('NextToken' => next_token)
-
-        run
-      end
-
-      # Counts requested reports
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportRequestCount.html
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_ReportType.html
-      # @param [Hash] opts
-      # @option opts [Array<String>, String] :report_type_list
-      # @option opts [Array<String>, String] :report_processing_status_list
-      # @option opts [String, #iso8601] :requested_from_date
-      # @option opts [String, #iso8601] :requested_to_date
-      # @return [Peddler::XMLParser]
-      def get_report_request_count(opts = {})
-        operation('GetReportRequestCount')
-          .add(opts)
-          .structure!('ReportTypeList', 'Type')
-          .structure!('ReportProcessingStatusList', 'Status')
-
-        run
-      end
-
-      # Cancels one or more report requests
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_CancelReportRequests.html
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_ReportType.html
-      # @param [Hash] opts
-      # @option opts [Array<String>, String] :report_type_list
-      # @option opts [Array<String>, String] :report_processing_status_list
-      # @option opts [String, #iso8601] :requested_from_date
-      # @option opts [String, #iso8601] :requested_to_date
-      # @return [Peddler::XMLParser]
-      def cancel_report_requests(opts = {})
-        operation('CancelReportRequests')
-          .add(opts)
-          .structure!('ReportTypeList', 'Type')
-          .structure!('ReportProcessingStatusList', 'Status')
-
-        run
-      end
-
-      # Lists reports
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportList.html
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_ReportType.html
-      # @param [Hash] opts
-      # @option opts [Integer] :max_count
-      # @option opts [Array<String>, String] :report_type_list
-      # @option opts [Boolean] :acknowledged
-      # @option opts [String, #iso8601] :available_from_date
-      # @option opts [String, #iso8601] :available_to_date
-      # @option opts [Array<String>, String] :report_request_id_list
-      # @return [Peddler::XMLParser]
-      def get_report_list(opts = {})
-        operation('GetReportList')
-          .add(opts)
-          .structure!('ReportTypeList', 'Type')
-          .structure!('ReportRequestIdList', 'Id')
-
-        run
-      end
-
-      # Lists the next page of reports
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportListByNextToken.html
-      # @param [String] next_token
-      # @return [Peddler::XMLParser]
-      def get_report_list_by_next_token(next_token)
-        operation('GetReportListByNextToken')
-          .add('NextToken' => next_token)
-
-        run
-      end
-
-      # Counts reports
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportCount.html
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_ReportType.html
-      # @param [Hash] opts
-      # @option opts [Array<String>, String] :report_type_list
-      # @option opts [Boolean] :acknowledged
-      # @option opts [String, #iso8601] :available_from_date
-      # @option opts [String, #iso8601] :available_to_date
-      # @return [Peddler::XMLParser]
-      def get_report_count(opts = {})
-        operation('GetReportCount')
-          .add(opts)
-          .structure!('ReportTypeList', 'Type')
-
-        run
-      end
-
-      # Gets a report and its Content-MD5 header
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_GetReport.html
-      # @param [String] report_id
-      # @return [Peddler::XMLParser] if report is in XML format
-      # @return [Peddler::FlatFileParser] if report is a flat file
-      def get_report(report_id, &blk)
-        operation('GetReport')
-          .add('ReportId' => report_id)
-
-        run(&blk)
-      end
-
-      # Creates, updates, or deletes a report request schedule
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_ManageReportSchedule.html
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_ReportType.html
-      # @param [String] report_type
-      # @param [String] schedule
-      # @param [Hash] opts
-      # @option opts [String, #iso8601] :schedule_date
-      # @return [Peddler::XMLParser]
-      def manage_report_schedule(report_type, schedule, opts = {})
-        operation('ManageReportSchedule')
-          .add(opts)
-          .add('ReportType' => report_type, 'Schedule' => schedule)
-
-        run
-      end
-
-      # Lists scheduled reports
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportScheduleList.html
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_ReportType.html
-      # @param [Array<String>] report_type_list
-      # @return [Peddler::XMLParser]
-      def get_report_schedule_list(*report_type_list)
-        operation('GetReportScheduleList')
-          .add('ReportTypeList' => report_type_list)
-          .structure!('ReportTypeList', 'Type')
-
-        run
-      end
-
-      # Lists next page of scheduled reports
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportScheduleListByNextToken.html
-      # @raise [NotImplementedError]
-      def get_report_schedule_list_by_next_token(*)
-        raise NotImplementedError
-      end
-
-      # Counts scheduled reports
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportScheduleCount.html
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_ReportType.html
-      # @param [Array<String>] report_type_list
-      # @return [Peddler::XMLParser]
-      def get_report_schedule_count(*report_type_list)
-        operation('GetReportScheduleCount')
-          .add('ReportTypeList' => report_type_list)
-          .structure!('ReportTypeList', 'Type')
-
-        run
-      end
-
-      # Updates acknowledged status of one or more reports
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/reports/Reports_UpdateReportAcknowledgements.html
-      # @param [Boolean] acknowledged
-      # @param [Array<String>] report_id_list
-      # @return [Peddler::XMLParser]
-      def update_report_acknowledgements(acknowledged, *report_id_list)
-        operation('UpdateReportAcknowledgements')
-          .add('ReportIdList' => report_id_list, 'Acknowledged' => acknowledged)
-          .structure!('ReportIdList', 'Id')
-
-        run
-      end
-    end
-  end
-end

data/lib/mws/reports.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require 'mws/reports/client'

data/lib/mws/sellers/client.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require 'peddler/client'
-
-module MWS
-  module Sellers
-    # The Sellers API lets sellers retrieve information about their seller
-    # account, such as the marketplaces they participate in.
-    class Client < ::Peddler::Client
-      self.version = '2011-07-01'
-      self.path = "/Sellers/#{version}"
-
-      # Lists the marketplaces the seller participates in
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/sellers/Sellers_ListMarketplaceParticipations.html
-      # @return [Peddler::XMLParser]
-      def list_marketplace_participations
-        operation('ListMarketplaceParticipations')
-        run
-      end
-
-      # Lists the next page of marketplaces the seller participates in
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/sellers/Sellers_ListMarketplaceParticipationsByNextToken.html
-      # @param [String] next_token
-      # @return [Peddler::XMLParser]
-      def list_marketplace_participations_by_next_token(next_token)
-        operation('ListMarketplaceParticipationsByNextToken')
-          .add('NextToken' => next_token)
-
-        run
-      end
-
-      # Gets the service status of the API
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/sellers/Sellers_GetServiceStatus.html
-      # @return [Peddler::XMLParser]
-      def get_service_status
-        operation('GetServiceStatus')
-        run
-      end
-    end
-  end
-end

data/lib/mws/sellers.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require 'mws/sellers/client'