peddler 2.1.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e7134fb2dff4131780197cb98d282b481c650c9042b71c235557db707d02e10
-  data.tar.gz: 491ddd1e18e480cb2b4250eb1cee4422239cc511ff2c6c1ade32d2ec7717e89e
+  metadata.gz: 15634f7228f32bf92ba757d456f66a8c42e46082c0e516a65cf8e2b5e53c7ef6
+  data.tar.gz: bc20e8700266c6207f738ca7bc6fb2e9927eb07a6a2e1488f3011b062753231b
 SHA512:
-  metadata.gz: ed79ae488893ad0fd4e4fceebbbeb28074f1b8825dae4b23827db946e3d332b199ce29212de4d48970d2a54316a7aacf9121e9f58581aa57d3be7e75047dcad2
-  data.tar.gz: dbcc2289dcc8dafbd1dc157fdcfcdb6e11712c89a7c1f1ba35ddd280a54a33ef8e382cf5926da276286a24eeb5b15b766ff72be81b07d6bc914ab0677b75fbdb
+  metadata.gz: 307a816a9baaa8d1309f6f941e1a6ffa56010dc94a3efa237c32db8d0c9bd7f30765434ef1206b12048f938e676e1870d7815ccbe54b09383b7ac95979809b33
+  data.tar.gz: 9e2275da4ce370ae82a4d70f2080a676c30dcc7800f9323fdbd924048491ff45bf05ab33ce10dbc1248b8a925710c1b6d287cd12791d478900fca391f0fdbdbe

data/README.md

@@ -1,12 +1,12 @@
 # Peddler
 
-[![Build Status](https://travis-ci.org/hakanensari/peddler.svg)](https://travis-ci.org/hakanensari/peddler)
+[![Build](https://github.com/hakanensari/peddler/workflows/build/badge.svg)](https://github.com/hakanensari/peddler/actions)
 [![Maintainability](https://api.codeclimate.com/v1/badges/281e6176048f3c0a1ed3/maintainability)](https://codeclimate.com/github/hakanensari/peddler/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/281e6176048f3c0a1ed3/test_coverage)](https://codeclimate.com/github/hakanensari/peddler/test_coverage)
 
 **Peddler** is a Ruby interface to the [Amazon MWS API](https://developer.amazonservices.com/), a collection of web services that help Amazon sellers programmatically exchange data on their listings, orders, payments, reports, and more.
 
-To use Amazon MWS, you must have an eligible seller account and register as an [application developer](https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Registering.html#DG_Registering__RegisteringAsADeveloper).
+To use Amazon MWS, you must have an eligible seller account and [register as a developer](https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Registering.html#DG_Registering__RegisteringAsADeveloper). You can then access your own selling account using its merchant ID—note that Amazon also refers to this as seller ID or merchant token in different places.
 
 Amazon has [multiple regions](https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Endpoints.html). Each region requires application developers to register individually. Some MWS API sections may require additional authorisation from Amazon.
 
@@ -120,7 +120,7 @@ Read [tips on how to avoid throttling](https://docs.developer.amazonservices.com
 
 ### Debugging
 
-If you are having trouble with a request, read the [Amazon documentation](https://developer.amazonservices.com/gp/mws/docs.html). [Peddler's source](http://www.rubydoc.info/github/hakanensari/peddler) also links individual operations to their corresponding entries in the Amazon docs.
+If you are having trouble with a request, read the [Amazon documentation](https://developer.amazonservices.com/gp/mws/docs.html). [Peddler's source](https://www.rubydoc.info/github/hakanensari/peddler) also links individual operations to their corresponding entries in the Amazon docs.
 
 Note that some optional keywords have default values.
 
@@ -138,34 +138,41 @@ You can access the same attributes on `error.response`. See <a href="#throttling
 
 ## The APIs
 
+### Easy Ship
+
+With the Easy Ship API, you can build applications that help sellers in India manage and ship their Amazon Easy Ship orders. Your Amazon Easy Ship applications can get available pickup slots; schedule, reschedule, and cancel pickups; and print labels, invoices, and warranties.
+
+- [Amazon references](https://docs.developer.amazonservices.com/en_US/easy_ship/EasyShip_Overview.html)
+- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/EasyShip/Client)
+
 ### Feeds
 
 The MWS Feeds API lets you upload inventory and order data to Amazon. You can also use this API to get information about the processing of feeds.
 
-- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=bde&section=feeds)
-- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Feeds/Client)
+- [Amazon references](https://docs.developer.amazonservices.com/en_US/feeds/Feeds_Overview.html)
+- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Feeds/Client)
 - [XML schema docs](https://sellercentral.amazon.com/gp/help/help-page.html?itemID=1611)
 
 ### Finances
 
 The MWS Finances API enables you to obtain financial information relevant to your business with Amazon. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
 
-- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=finances&section=finances)
-- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Finances/Client)
+- [Amazon references](https://docs.developer.amazonservices.com/en_US/finances/Finances_Overview.html)
+- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Finances/Client)
 
 ### Fulfillment Inbound Shipment
 
 With the MWS Fulfillment Inbound Shipment API, you can create and update inbound shipments of inventory in the Amazon Fulfillment Network. You can also also request lists of inbound shipments or inbound shipment items based on criteria that you specify.
 
-- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=fulfillment&section=inbound)
-- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/FulfillmentInboundShipment/Client)
+- [Amazon references](https://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_Overview.html)
+- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/FulfillmentInboundShipment/Client)
 
 ### Fulfillment Inventory
 
 The MWS Fulfillment Inventory API can help you stay up-to-date on the availability of your inventory in the Amazon Fulfillment Network. The Fulfillment Inventory API reports real-time availability information for your Amazon Fulfillment Network inventory regardless of whether you are selling your inventory on Amazon's retail web site or through other retail channels.
 
-- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=fulfillment&section=inventory)
-- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/FulfillmentInventory/Client)
+- [Amazon references](https://docs.developer.amazonservices.com/en_US/fba_inventory/FBAInventory_Overview.html)
+- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/FulfillmentInventory/Client)
 
 ### Fulfillment Outbound Shipment
 
@@ -173,68 +180,63 @@ The MWS Fulfillment Outbound Shipment API enables you to fulfill orders placed t
 
 Support for creating and cancelling fulfillment orders has been implemented, but the rest of the API is not supported yet.
 
-- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=fulfillment&section=outbound)
-- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/FulfillmentOutboundShipment/Client)
+- [Amazon references](https://docs.developer.amazonservices.com/en_US/fba_outbound/FBAOutbound_Overview.html)
+- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/FulfillmentOutboundShipment/Client)
 
 ### Merchant Fulfillment
 
 The Merchant Fulfillment API provides programmatic access to Amazon’s fulfillment shipping services for sellers, including competitive rates with Amazon-partnered carriers. Sellers can find out what shipping services are available by submitting information about a proposed fulfillment shipment, such as package size and weight; shipment origin and destination; and delivery date requirements. Sellers can choose from the shipping service options returned by Amazon, and then receive shipping labels for fulfilling their orders.
 
-- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=merchantfulfillment&section=merchantfulfillment)
-- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/MerchantFulfillment/Client)
-
-### Off Amazon Payments
-
-The MWS Off-Amazon Payments API helps you to process payments for purchases made by buyers on your website using the Login and Pay with Amazon service. This API enables you to programmatically retrieve shipping and payment information provided by the buyer from their Amazon account. It allows you to authorize, capture, and refund payments, enabling a variety of payments scenarios.
-
-You can switch the client to the sandbox environment:
-
-```ruby
-client = MWS.off_amazon_payments.sandbox
-```
-
-- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=offamazonpayments&section=offamazonpayments)
-- [Official Ruby client](https://github.com/amzn/login-and-pay-with-amazon-sdk-ruby)
-- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/OffAmazonPayments/Client)
+- [Amazon references](https://docs.developer.amazonservices.com/en_US/merch_fulfill/MerchFulfill_Overview.html)
+- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/MerchantFulfillment/Client)
 
 ### Orders
 
 With the MWS Orders API, you can list orders created or updated during a time frame you specify or retrieve information about specific orders.
 
-- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=orders&section=orders)
-- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Orders/Client)
+- [Amazon references](https://docs.developer.amazonservices.com/en_US/orders-2013-09-01/Orders_Overview.html)
+- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Orders/Client)
 
 ### 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.
 
-- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=products&section=products)
-- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Products/Client)
+- [Amazon references](https://docs.developer.amazonservices.com/en_US/products/Products_Overview.html)
+- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Products/Client)
 
 ### 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.
 
-- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=recommendations&section=recommendations)
-- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Recommendations/Client)
+- [Amazon references](https://docs.developer.amazonservices.com/en_US/recommendations/Recommendations_Overview.html)
+- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Recommendations/Client)
 
 ### Reports
 
 The Reports API lets you request reports about your inventory and orders.
 
-- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=bde&section=reports)
-- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Reports/Client)
+- [Amazon references](https://docs.developer.amazonservices.com/en_US/reports/Reports_Overview.html)
+- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Reports/Client)
 
 ### Sellers
 
 The Sellers API lets sellers retrieve information about their seller account, such as the marketplaces they participate in.
 
-- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=sellers&section=sellers)
-- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Sellers/Client)
+- [Amazon references](https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_Overview.html)
+- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Sellers/Client)
+
+### Shipment Invoicing
+
+With the Shipment Invoicing API section (in conjunction with the FBAOutboundShipmentStatus notification), you can integrate invoicing into Amazon’s shipping process for a seller’s Fulfillment by Amazon (FBA) orders.
+
+This functionality is available only in the Brazil marketplace.
+
+- [Amazon references](https://docs.developer.amazonservices.com/en_US/shipment_invoicing/ShipmentInvoicing_Overview.html)
+- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/ShipmentInvoicing/Client)
 
 ### 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.
 
-- [Amazon references](https://developer.amazonservices.com/gp/mws/api.html?group=subscriptions&section=subscriptions)
-- [Peddler API docs](http://www.rubydoc.info/gems/peddler/MWS/Subscriptions/Client)
+- [Amazon references](https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_Overview.html)
+- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Subscriptions/Client)

data/lib/mws.rb

@@ -1,18 +1,19 @@
 # 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/off_amazon_payments'
 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.

data/lib/mws/easy_ship.rb

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

data/lib/mws/easy_ship/client.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'peddler/client'
+
+module MWS
+  module EasyShip
+    # With the Easy Ship API section, you can build applications that help
+    # sellers in India manage and ship their Amazon Easy Ship orders.
+    #
+    # @note This functionality is available only in the India marketplace.
+    class Client < ::Peddler::Client
+      self.version = '2018-09-01'
+      self.path = "/EasyShip/#{version}"
+
+      # Returns time slots for Amazon Easy Ship package pickup
+      #
+      # @see https://docs.developer.amazonservices.com/en_US/easy_ship/EasyShip_ListPickupSlots.html
+      # @param [String] marketplace_id
+      # @param [String] amazon_order_id
+      # @param [Struct, Hash] package_dimensions
+      # @param [Struct, Hash] package_weight
+      # @return [Peddler::XMLParser]
+      def list_pickup_slots(marketplace_id, amazon_order_id, package_dimensions,
+                            package_weight)
+        operation('ListPickupSlots')
+          .add('MarketplaceId' => marketplace_id,
+               'AmazonOrderId' => amazon_order_id,
+               'PackageDimensions' => package_dimensions,
+               'PackageWeight' => package_weight)
+
+        run
+      end
+
+      # Schedules an Amazon Easy Ship pickup slot
+      #
+      # @see https://docs.developer.amazonservices.com/en_US/easy_ship/EasyShip_CreateScheduledPackage.html
+      # @param [String] marketplace_id
+      # @param [String] amazon_order_id
+      # @param [Struct, Hash] package_request_details
+      # @return [Peddler::XMLParser]
+      def create_scheduled_package(marketplace_id, amazon_order_id,
+                                   package_request_details)
+        operation('CreateScheduledPackage')
+          .add('MarketplaceId' => marketplace_id,
+               'AmazonOrderId' => amazon_order_id,
+               'PackageRequestDetails' => package_request_details)
+
+        run
+      end
+
+      # Updates an Amazon Easy Ship pickup slot
+      #
+      # @see https://docs.developer.amazonservices.com/en_US/easy_ship/EasyShip_UpdateScheduledPackages.html
+      # @param [String] marketplace_id
+      # @param [Array<Struct, Hash>] scheduled_package_update_details_list
+      # @return [Peddler::XMLParser]
+      def update_scheduled_packages(marketplace_id,
+                                    scheduled_package_update_details_list)
+        operation('UpdateScheduledPackages')
+          .add('MarketplaceId' => marketplace_id,
+               'ScheduledPackageUpdateDetailsList' =>
+                 scheduled_package_update_details_list)
+          .structure!('ScheduledPackageUpdateDetailsList',
+                      'PackageUpdateDetails')
+
+        run
+      end
+
+      # Returns information about a scheduled package
+      #
+      # @see https://docs.developer.amazonservices.com/en_US/easy_ship/EasyShip_GetScheduledPackage.html
+      # @param [String] marketplace_id
+      # @param [Struct, Hash] scheduled_package_id
+      # @return [Peddler::XMLParser]
+      def get_scheduled_package(marketplace_id, scheduled_package_id)
+        operation('GetScheduledPackage')
+          .add('MarketplaceId' => marketplace_id,
+               'ScheduledPackageId' => scheduled_package_id)
+
+        run
+      end
+
+      # Returns 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/fulfillment_outbound_shipment/client.rb

@@ -32,7 +32,7 @@ module MWS
           .add(opts)
           .add('Address' => address, 'Items' => items)
           .structure!('Items', 'member')
-          .structure!('ShippingSpeedCategories')
+          .structure!('ShippingSpeedCategories', 'member')
 
         run
       end

data/lib/mws/orders/client.rb

@@ -15,7 +15,7 @@ module MWS
       # @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 https://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_ListOrders.html
+      # @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
@@ -53,7 +53,7 @@ module MWS
 
       # Lists the next page of orders
       #
-      # @see https://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)
@@ -65,7 +65,7 @@ module MWS
 
       # Gets one or more orders
       #
-      # @see https://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_GetOrder.html
+      # @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)
@@ -78,7 +78,7 @@ module MWS
 
       # Lists order items for an order
       #
-      # @see https://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)
@@ -90,7 +90,7 @@ module MWS
 
       # Lists the next page of order items for an order
       #
-      # @see https://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)
@@ -102,7 +102,7 @@ module MWS
 
       # Gets the service status of the API
       #
-      # @see https://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/shipment_invoicing.rb

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

data/lib/mws/shipment_invoicing/client.rb

@@ -0,0 +1,74 @@
+# 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/peddler/client.rb

@@ -16,7 +16,7 @@ module Peddler
     include Jeff
 
     class << self
-      # @api private
+      # @!visibility private
       attr_accessor :parser, :path, :version
 
       private
@@ -52,6 +52,7 @@ module Peddler
     attr_accessor :auth_token
 
     # The seller's Merchant ID
+    # @note Amazon also refers to this as Seller ID or Merchant Token
     # @return [String]
     attr_accessor :merchant_id
 
@@ -80,38 +81,38 @@ module Peddler
       str ? add_content(str) : clear_content!
     end
 
-    # @api private
+    # @!visibility private
     attr_writer :path
 
-    # @api private
+    # @!visibility private
     def path
       @path ||= self.class.path
     end
 
-    # @api private
+    # @!visibility private
     def defaults
       @defaults ||= { expects: 200 }
     end
 
-    # @api private
+    # @!visibility private
     def headers
       @headers ||= {}
     end
 
-    # @api private
+    # @!visibility private
     def aws_endpoint
       "https://#{host}#{path}"
     end
 
-    # @api private
+    # @!visibility private
     def operation(action = nil)
       action ? @operation = Operation.new(action) : @operation
     end
 
-    # @api private
-    def run
+    # @!visibility private
+    def run(&block)
       opts = build_options
-      opts.store(:response_block, Proc.new) if block_given?
+      opts.store(:response_block, block) if block_given?
       res = post(opts)
       self.body = nil if res.status == 200