peddler 2.4.5 → 3.0.0.beta1

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'

data/lib/mws/shipment_invoicing/client.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-require 'peddler/client'
-
-module MWS
-  module ShipmentInvoicing
-    # With the Shipment Invoicing API section, you can integrate invoicing into
-    # Amazon's shipping process for a seller's FBA order.
-    #
-    # @note This functionality is available only in the Brazil marketplace.
-    class Client < ::Peddler::Client
-      self.version = '2018-09-01'
-      self.path = "/ShipmentInvoicing/#{version}"
-
-      # Returns the information required to generate an invoice for the shipment
-      # of a Fulfillment by Amazon order
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/shipment_invoicing/ShipmentInvoicing_GetFBAOutboundShipmentDetail.html
-      # @param [String] marketplace_id
-      # @param [String] amazon_shipment_id
-      # @return [Peddler::XMLParser]
-      def get_fba_outbound_shipment_detail(marketplace_id, amazon_shipment_id)
-        operation('GetFBAOutboundShipmentDetail')
-          .add('MarketplaceId' => marketplace_id,
-               'AmazonShipmentId' => amazon_shipment_id)
-
-        run
-      end
-
-      # Submits shipment invoice data for a given shipment
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/shipment_invoicing/ShipmentInvoicing_SubmitFBAOutboundShipmentInvoice.html
-      # @param [String] marketplace_id
-      # @param [String] amazon_shipment_id
-      # @param [String] invoice_content
-      # @return [Peddler::XMLParser]
-      def submit_fba_outbound_shipment_invoice(marketplace_id,
-                                               amazon_shipment_id,
-                                               invoice_content)
-        self.body = invoice_content
-
-        operation('SubmitFBAOutboundShipmentInvoice')
-          .add('MarketplaceId' => marketplace_id,
-               'AmazonShipmentId' => amazon_shipment_id)
-
-        run
-      end
-
-      # Gets the invoice processing status for the shipments that you specify
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/shipment_invoicing/ShipmentInvoicing_GetFBAOutboundShipmentInvoiceStatus.html
-      # @param [String] marketplace_id
-      # @param [String] amazon_shipment_id
-      # @return [Peddler::XMLParser]
-      def get_fba_outbound_shipment_invoice_status(marketplace_id,
-                                                   amazon_shipment_id)
-        operation('GetFBAOutboundShipmentInvoiceStatus')
-          .add('MarketplaceId' => marketplace_id,
-               'AmazonShipmentId' => amazon_shipment_id)
-
-        run
-      end
-
-      # Gets the operational status of the API
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/shipment_invoicing/ShipmentInvoicing_GetServiceStatus.html
-      # @return [Peddler::XMLParser]
-      def get_service_status
-        operation('GetServiceStatus')
-        run
-      end
-    end
-  end
-end

data/lib/mws/shipment_invoicing.rb

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

data/lib/mws/subscriptions/client.rb

@@ -1,179 +0,0 @@
-# frozen_string_literal: true
-
-require 'peddler/client'
-
-module MWS
-  module Subscriptions
-    # The Amazon MWS Subscriptions API section enables you to subscribe to
-    # receive notifications that are relevant to your business with Amazon. With
-    # the operations in the Subscriptions API section, you can register to
-    # receive important information from Amazon without having to poll the
-    # Amazon MWS service. Instead, the information is sent directly to you when
-    # an event occurs to which you are subscribed.
-    class Client < ::Peddler::Client
-      self.version = '2013-07-01'
-      self.path = "/Subscriptions/#{version}"
-
-      # Registers a new destination to receive notifications
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_RegisterDestination.html
-      # @param [String] sqs_queue_url
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def register_destination(sqs_queue_url, marketplace_id)
-        operation('RegisterDestination')
-          .add('MarketplaceId' => marketplace_id)
-          .add(build_destination(sqs_queue_url))
-
-        run
-      end
-
-      # Removes an existing destination from the list of registered destinations
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_DeregisterDestination.html
-      # @param [String] sqs_queue_url
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def deregister_destination(sqs_queue_url, marketplace_id)
-        operation('DeregisterDestination')
-          .add('MarketplaceId' => marketplace_id)
-          .add(build_destination(sqs_queue_url))
-
-        run
-      end
-
-      # Lists all registered destinations
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_ListRegisteredDestinations.html
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def list_registered_destinations(marketplace_id)
-        operation('ListRegisteredDestinations')
-          .add('MarketplaceId' => marketplace_id)
-
-        run
-      end
-
-      # Sends a test notification to an existing destination
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_SendTestNotificationToDestination.html
-      # @param [String] sqs_queue_url
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def send_test_notification_to_destination(sqs_queue_url, marketplace_id)
-        operation('SendTestNotificationToDestination')
-          .add('MarketplaceId' => marketplace_id)
-          .add(build_destination(sqs_queue_url))
-
-        run
-      end
-
-      # Creates a new subscription
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_CreateSubscription.html
-      # @param [String] notification_type
-      # @param [String] sqs_queue_url
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def create_subscription(notification_type, sqs_queue_url, marketplace_id)
-        operation('CreateSubscription')
-          .add('MarketplaceId' => marketplace_id)
-          .add(build_subscription(notification_type, sqs_queue_url))
-
-        run
-      end
-
-      # Gets a subscription
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_GetSubscription.html
-      # @param [String] notification_type
-      # @param [String] sqs_queue_url
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def get_subscription(notification_type, sqs_queue_url, marketplace_id)
-        operation('GetSubscription')
-          .add('MarketplaceId' => marketplace_id,
-               'NotificationType' => notification_type)
-          .add(build_destination(sqs_queue_url))
-
-        run
-      end
-
-      # Deletes a subscription
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_DeleteSubscription.html
-      # @param [String] notification_type
-      # @param [String] sqs_queue_url
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def delete_subscription(notification_type, sqs_queue_url, marketplace_id)
-        operation('DeleteSubscription')
-          .add('MarketplaceId' => marketplace_id,
-               'NotificationType' => notification_type)
-          .add(build_destination(sqs_queue_url))
-
-        run
-      end
-
-      # Lists current subscriptions
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_ListSubscriptions.html
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def list_subscriptions(marketplace_id)
-        operation('ListSubscriptions')
-          .add('MarketplaceId' => marketplace_id)
-
-        run
-      end
-
-      # Updates a subscription
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_UpdateSubscription.html
-      # @param [String] notification_type
-      # @param [String] sqs_queue_url
-      # @param [Boolean] enabled
-      # @param [String] marketplace_id
-      # @return [Peddler::XMLParser]
-      def update_subscription(notification_type, sqs_queue_url, enabled,
-                              marketplace_id)
-        operation('UpdateSubscription')
-          .add('MarketplaceId' => marketplace_id)
-          .add(build_subscription(notification_type, sqs_queue_url, enabled: enabled))
-
-        run
-      end
-
-      # Gets the service status of the API
-      #
-      # @see https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_GetServiceStatus.html
-      # @return [Peddler::XMLParser]
-      def get_service_status
-        operation('GetServiceStatus')
-        run
-      end
-
-      private
-
-      def build_destination(sqs_queue_url)
-        {
-          'Destination.DeliveryChannel' => 'SQS',
-          'Destination.AttributeList.member.1.Key' => 'sqsQueueUrl',
-          'Destination.AttributeList.member.1.Value' => sqs_queue_url
-        }
-      end
-
-      def build_subscription(notification_type, sqs_queue_url, enabled: true)
-        {
-          'Subscription.IsEnabled' => enabled,
-          'Subscription.NotificationType' => notification_type,
-          'Subscription.Destination.DeliveryChannel' => 'SQS',
-          'Subscription.Destination.AttributeList.member.1.Key' =>
-            'sqsQueueUrl',
-          'Subscription.Destination.AttributeList.member.1.Value' =>
-            sqs_queue_url
-        }
-      end
-    end
-  end
-end

data/lib/mws/subscriptions.rb

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

data/lib/mws.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require 'forwardable'
-require 'mws/easy_ship'
-require 'mws/feeds'
-require 'mws/finances'
-require 'mws/fulfillment_inbound_shipment'
-require 'mws/fulfillment_inventory'
-require 'mws/fulfillment_outbound_shipment'
-require 'mws/merchant_fulfillment'
-require 'mws/orders'
-require 'mws/products'
-require 'mws/recommendations'
-require 'mws/reports'
-require 'mws/sellers'
-require 'mws/shipment_invoicing'
-require 'mws/subscriptions'
-
-# The various Amazon MWS API sections.
-module MWS
-  class << self
-    extend Forwardable
-
-    MWS.constants.each do |klass|
-      method_name = klass.to_s.gsub(/(.)([A-Z])/, '\1_\2').downcase
-      def_delegator MWS.const_get(klass).const_get(:Client), :new, method_name
-    end
-  end
-end