peddler 1.2.0 → 1.3.0

data/lib/mws/fulfillment_inventory/client.rb

@@ -9,13 +9,13 @@ module MWS
     # selling your inventory on Amazon's retail web site or through other retail
     # channels.
     class Client < ::Peddler::Client
-      version "2010-10-01"
+      version '2010-10-01'
       path "/FulfillmentInventory/#{version}"
 
       # Returns information about the availability of a seller's inventory
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_inventory/FBAInventory_ListInventorySupply.html
-      # @param opts [Hash]
+      # @param [Hash] opts
       # @option opts [Array<String>, String] :seller_skus
       # @option opts [String, #iso8601] :query_start_date_time
       # @option opts [String] :response_group
@@ -32,7 +32,7 @@ module MWS
       # seller's inventory
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_inventory/FBAInventory_ListInventorySupplyByNextToken.html
-      # @param next_token [String]
+      # @param [String] next_token
       # @return [Peddler::XMLParser]
       def list_inventory_supply_by_next_token(next_token)
         operation('ListInventorySupplyByNextToken')

data/lib/mws/fulfillment_outbound_shipment/client.rb

@@ -13,15 +13,15 @@ module MWS
     # on when they were fulfilled and by the fulfillment method associated with
     # them.
     class Client < ::Peddler::Client
-      version "2010-10-01"
+      version '2010-10-01'
       path "/FulfillmentOutboundShipment/#{version}"
 
       # Lists fulfillment order previews
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_outbound/FBAOutbound_GetFulfillmentPreview.html
-      # @param address [Struct, Hash]
-      # @param items [Array<Struct, Hash>]
-      # @param opts [Hash]
+      # @param [Struct, Hash] address
+      # @param [Array<Struct, Hash>] items
+      # @param [Hash] opts
       # @option opts Array[String] :shipping_speed_categories
       # @option opts [Boolean] :include_cod_fulfillment_preview
       # @return [Peddler::XMLParser]
@@ -42,14 +42,14 @@ module MWS
       # Network inventory to a destination address
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_outbound/FBAOutbound_CreateFulfillmentOrder.html
-      # @param seller_fulfillment_order_id [String]
-      # @param displayable_order_id [String]
-      # @param displayable_order_date_time [String, #iso8601]
-      # @param displayable_order_comment [String]
-      # @param shipping_speed_category [String]
-      # @param destination_address [Struct, Hash]
-      # @param items [Array<Struct, Hash>]
-      # @param opts [Hash]
+      # @param [String] seller_fulfillment_order_id
+      # @param [String] displayable_order_id
+      # @param [String, #iso8601] displayable_order_date_time
+      # @param [String] displayable_order_comment
+      # @param [String] shipping_speed_category
+      # @param [Struct, Hash] destination_address
+      # @param [Array<Struct, Hash>] items
+      # @param [Hash] opts
       # @option opts [String] :fulfillment_action
       # @option opts [String] :fulfillment_policy
       # @option opts [Array<String>] :notification_email_list
@@ -82,8 +82,8 @@ module MWS
       # hold on it
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_outbound/FBAOutbound_UpdateFulfillmentOrder.html
-      # @param seller_fulfillment_order_id [String]
-      # @param opts [Hash]
+      # @param [String] seller_fulfillment_order_id
+      # @param [Hash] opts
       # @option opts [String] :fulfillment_action
       # @option opts [String] :displayable_order_id
       # @option opts [String, #iso8601] :displayable_order_date_time
@@ -106,7 +106,7 @@ module MWS
       # Gets a fulfillment order
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_outbound/FBAOutbound_GetFulfillmentOrder.html
-      # @param seller_fulfillment_order_id [String]
+      # @param [String] seller_fulfillment_order_id
       # @return [Peddler::XMLParser]
       def get_fulfillment_order(seller_fulfillment_order_id)
         operation('GetFulfillmentOrder')
@@ -118,7 +118,7 @@ module MWS
       # Returns a list of fulfillment orders fulfilled on or after a date
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_outbound/FBAOutbound_ListAllFulfillmentOrders.html
-      # @param query_start_date_time [String, #iso8601]
+      # @param [String, #iso8601] query_start_date_time
       # @return [Peddler::XMLParser]
       def list_all_fulfillment_orders(query_start_date_time = nil)
         opts = query_start_date_time ? { 'QueryStartDateTime' => query_start_date_time } : {}
@@ -130,7 +130,7 @@ module MWS
       # Returns the next page of fulfillment orders
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_outbound/FBAOutbound_ListAllFulfillmentOrdersByNextToken.html
-      # @param next_token [String]
+      # @param [String] next_token
       # @return [Peddler::XMLParser]
       def list_all_fulfillment_orders_by_next_token(next_token)
         operation('ListAllFulfillmentOrdersByNextToken')
@@ -149,7 +149,7 @@ module MWS
       # order
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_outbound/FBAOutbound_CancelFulfillmentOrder.html
-      # @param seller_fulfillment_order_id [String]
+      # @param [String] seller_fulfillment_order_id
       # @return [Peddler::XMLParser]
       def cancel_fulfillment_order(seller_fulfillment_order_id)
         operation('CancelFulfillmentOrder')

data/lib/mws/merchant_fulfillment.rb

@@ -0,0 +1 @@
+require 'mws/merchant_fulfillment/client'

data/lib/mws/merchant_fulfillment/client.rb

@@ -0,0 +1,88 @@
+require 'peddler/client'
+
+module MWS
+  module MerchantFulfillment
+    # The Merchant Fulfillment API provides programmatic access to Amazon's
+    # Shipping Services for sellers, including competitive rates from
+    # Amazon-partnered carriers. Sellers can find out what shipping service
+    # offers are available by submitting information about a proposed shipment,
+    # such as package size and weight, shipment origin, and delivery date
+    # requirements. Sellers can choose from the shipping service offers returned
+    # by Amazon, and then purchase shipping labels for fulfilling their orders.
+    class Client < ::Peddler::Client
+      version '2015-06-01'
+      path "/MerchantFulfillment/#{version}"
+
+      # Returns a list of shipping service offers that satisfy the shipment
+      # request details that you specify
+      #
+      # @see http://docs.developer.amazonservices.com/en_US/merch_fulfill/MerchFulfill_GetEligibleShippingServices.html
+      # @param [Struct, Hash] shipment_request_details
+      # @return [Peddler::XMLParser]
+      def get_eligible_shipping_services(shipment_request_details)
+        operation('GetEligibleShippingServices')
+          .add('ShipmentRequestDetails' => shipment_request_details)
+
+        run
+      end
+
+      # Purchases shipping and returns PNG or PDF document data for a shipping
+      # label
+      #
+      # @see http://docs.developer.amazonservices.com/en_US/merch_fulfill/MerchFulfill_CreateShipment.html
+      # @param [Struct, Hash] shipment_request_details
+      # @param [String] shipping_service_id
+      # @param [Hash] opts
+      # @option opts [String] :shipping_service_offer_id
+      # @return [Peddler::XMLParser]
+      def create_shipment(shipment_request_details, shipping_service_id, opts = {})
+        operation('CreateShipment')
+          .add(
+            'ShipmentRequestDetails' => shipment_request_details,
+            'ShippingServiceId' => shipping_service_id
+          )
+          .add(opts)
+
+        run
+      end
+
+      # Returns an existing shipment for the ShipmentId value that you specify
+      #
+      # @see http://docs.developer.amazonservices.com/en_US/merch_fulfill/MerchFulfill_GetShipment.html
+      # @params [String] shipment_id
+      # @return [Peddler::XMLParser]
+      def get_shipment(shipment_id)
+        operation('GetShipment')
+          .add(
+            'ShipmentId' => shipment_id
+          )
+
+        run
+      end
+
+      # Cancels an existing shipment and requests a refund for the ShipmentId
+      # value that you specify
+      #
+      # @see http://docs.developer.amazonservices.com/en_US/merch_fulfill/MerchFulfill_CancelShipment.html
+      # @params [String] shipment_id
+      # @return [Peddler::XMLParser]
+      def cancel_shipment(shipment_id)
+        operation('CancelShipment')
+          .add(
+            'ShipmentId' => shipment_id
+          )
+
+        run
+      end
+
+      # Gets the operational status of the API
+      #
+      # @see http://docs.developer.amazonservices.com/en_US/merch_fulfill/MWS_GetServiceStatus.html
+      # @return [Peddler::XMLParser]
+      def get_service_status
+        operation('GetServiceStatus')
+        run
+      end
+    end
+  end
+end

data/lib/mws/off_amazon_payments/client.rb

@@ -14,7 +14,7 @@ module MWS
     #   Payments. You cannot use this API section to process payments for Amazon
     #   Marketplace, Amazon Webstore, or Checkout by Amazon.
     class Client < ::Peddler::Client
-      version "2013-01-01"
+      version '2013-01-01'
       path "/OffAmazonPayments/#{version}/"
 
       # Switches the client to the sandbox environment
@@ -26,160 +26,159 @@ module MWS
         self
       end
 
-      # Creates an order reference for the given object
+      # Reserves a specified amount against the payment method(s) stored in the
+      # order reference
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_CreateOrderReferenceForId.html
-      # @param id [String]
-      # @param id_type [String]
-      # @param opts [Hash]
-      # @option opts [Boolean] :inherit_shipping_address
-      # @option opts [Boolean] :confirm_now
+      # @see https://payments.amazon.com/documentation/apireference/201752010
+      # @param [String] amazon_order_reference_id
+      # @param [String] authorization_reference_id
+      # @param [Struct, Hash] authorization_amount
+      # @param [Hash] opts
+      # @option opts [String] :seller_authorization_note
+      # @option opts [Integer] :transaction_timeout
+      # @option opts [Boolean] :capture_now
+      # @option opts [String] :soft_descriptor
       # @return [Peddler::XMLParser]
-      def create_order_reference_for_id(id, id_type, opts = {})
-        operation('CreateOrderReferenceForId')
+      def authorize(amazon_order_reference_id, authorization_reference_id, authorization_amount, opts = {})
+        operation('Authorize')
           .add(opts.update(
-                 'Id' => id,
-                 'IdType' => id_type
+                 'AmazonOrderReferenceId' => amazon_order_reference_id,
+                 'AuthorizationReferenceId' => authorization_reference_id,
+                 'AuthorizationAmount' => authorization_amount
           ))
 
         run
       end
 
-      # Returns details about the Billing Agreement object and its current state
+      # Cancels a previously confirmed order reference
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_GetBillingAgreementDetails.html
-      # @param amazon_billing_agreement_id [String]
-      # @param opts [Hash]
-      # @option opts [String] :address_consent_token
+      # @see https://payments.amazon.com/documentation/apireference/201751990
+      # @param [String] amazon_order_reference_id
+      # @param [Hash] opts
+      # @option opts [String] cancelation_reason
       # @return [Peddler::XMLParser]
-      def get_billing_agreement_details(amazon_billing_agreement_id, opts = {})
-        operation('GetBillingAgreementDetails')
+      def cancel_order_reference(amazon_order_reference_id, opts = {})
+        operation('CancelOrderReference')
+          .add(opts.update('AmazonOrderReferenceId' => amazon_order_reference_id))
+
+        run
+      end
+
+      # Captures funds from an authorized payment instrument
+      #
+      # @see https://payments.amazon.com/documentation/apireference/201752040
+      # @param [String] amazon_authorization_id
+      # @param [String] capture_reference_id
+      # @param [Struct, Hash] capture_amount
+      # @param [Hash] opts
+      # @option opts [String] :seller_capture_note
+      # @option opts [String] :soft_descriptor
+      # @return [Peddler::XMLParser]
+      def capture(amazon_authorization_id, capture_reference_id, capture_amount, opts = {})
+        operation('Capture')
           .add(opts.update(
-                 'AmazonBillingAgreementId' => amazon_billing_agreement_id
+                 'AmazonAuthorizationId' => amazon_authorization_id,
+                 'CaptureReferenceId' => capture_reference_id,
+                 'CaptureAmount' => capture_amount
           ))
 
         run
       end
 
-      # Sets billing agreement details such as a description of the agreement
-      # and other information about the seller
+      # Closes an authorization
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_SetBillingAgreementDetails.html
-      # @param amazon_billing_agreement_id [String]
-      # @param billing_agreement_attributes [Struct, Hash]
+      # @see https://payments.amazon.com/documentation/apireference/201752070
+      # @param [String] amazon_authorization_id
+      # @param [Hash] opts
+      # @option opts [String] closure_reason
       # @return [Peddler::XMLParser]
-      def set_billing_agreement_details(amazon_billing_agreement_id, billing_agreement_attributes)
-        operation('SetBillingAgreementDetails')
-          .add(
-            'AmazonBillingAgreementId' => amazon_billing_agreement_id,
-            'BillingAgreementAttributes' => billing_agreement_attributes
-          )
+      def close_authorization(amazon_authorization_id, opts = {})
+        operation('CloseAuthorization')
+          .add(opts.update('AmazonAuthorizationId' => amazon_authorization_id))
 
         run
       end
 
-      # Confirms that the billing agreement is free of constraints and all
-      # required information has been set on the billing agreement
+      # Confirms that an order reference has been fulfilled (fully or partially)
+      # and that you do not expect to create any new authorizations on this
+      # order reference
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_ConfirmBillingAgreement.html
-      # @param amazon_billing_agreement_id [String]
+      # @see https://payments.amazon.com/documentation/apireference/201752000
+      # @param [String] amazon_order_reference_id
+      # @param [Hash] opts
+      # @option opts [String] closure_reason
       # @return [Peddler::XMLParser]
-      def confirm_billing_agreement(amazon_billing_agreement_id)
-        operation('ConfirmBillingAgreement')
-          .add(
-            'AmazonBillingAgreementId' => amazon_billing_agreement_id
-          )
+      def close_order_reference(amazon_order_reference_id, opts = {})
+        operation('CloseOrderReference')
+          .add(opts.update('AmazonOrderReferenceId' => amazon_order_reference_id))
 
         run
       end
 
-      # Validates the status of the BillingAgreement object and the payment
-      # method associated with it
+      # Confirms that the order reference is free of constraints and all required
+      # information has been set on the order reference
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_ValidateBillingAgreement.html
-      # @param amazon_billing_agreement_id [String]
+      # @see https://payments.amazon.com/documentation/apireference/201751980
+      # @param [String] amazon_order_reference_id
       # @return [Peddler::XMLParser]
-      def validate_billing_agreement(amazon_billing_agreement_id)
-        operation('ValidateBillingAgreement')
-          .add(
-            'AmazonBillingAgreementId' => amazon_billing_agreement_id
-          )
+      def confirm_order_reference(amazon_order_reference_id)
+        operation('ConfirmOrderReference')
+          .add('AmazonOrderReferenceId' => amazon_order_reference_id)
 
         run
       end
 
-      # Reserves a specified amount against the payment method(s) stored in the
-      # billing agreement
+      # Creates an order reference for the given object
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_AuthorizeOnBillingAgreement.html
-      # @param amazon_billing_agreement_id [String]
-      # @param authorization_reference_id [String]
-      # @param authorization_amount [Hash, Struct]
-      # @param opts [Hash]
-      # @option opts [String] :seller_authorization_note
-      # @option opts [Integer] :transaction_timeout
-      # @option opts [Boolean] :capture_now
-      # @option opts [String] :soft_descriptor
-      # @option opts [String] :seller_note
-      # @option opts [String] :platform_id
-      # @option opts [Hash, Struct] :seller_order_attributes
+      # @see https://payments.amazon.com/documentation/apireference/201751670
+      # @param [String] id
+      # @param [String] id_type
+      # @param [Hash] opts
       # @option opts [Boolean] :inherit_shipping_address
+      # @option opts [Boolean] :confirm_now
+      # @option opts [Struct, Hash] :order_reference_attributes
       # @return [Peddler::XMLParser]
-      def authorize_on_billing_agreement(amazon_billing_agreement_id, authorization_reference_id, authorization_amount, opts = {})
-        operation('AuthorizeOnBillingAgreement')
+      def create_order_reference_for_id(id, id_type, opts = {})
+        operation('CreateOrderReferenceForId')
           .add(opts.update(
-                 'AmazonBillingAgreementId' => amazon_billing_agreement_id,
-                 'AuthorizationReferenceId' => authorization_reference_id,
-                 'AuthorizationAmount' => authorization_amount
+                 'Id' => id,
+                 'IdType' => id_type
           ))
 
         run
       end
 
-      # Confirms that you want to terminate the billing agreement with the buyer
-      # and that you do not expect to create any new order references or
-      # authorizations on this billing agreement
+      # Returns the status of a particular authorization and the total amount
+      # captured on the authorization
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_CloseBillingAgreement.html
-      # @param amazon_billing_agreement_id [String]
-      # @param opts [Hash]
-      # @option opts [String] :closure_reason
+      # @see https://payments.amazon.com/documentation/apireference/201752030
+      # @param [String] amazon_authorization_id
       # @return [Peddler::XMLParser]
-      def close_billing_agreement(amazon_billing_agreement_id, opts = {})
-        operation('CloseBillingAgreement')
-          .add(opts.update(
-                 'AmazonBillingAgreementId' => amazon_billing_agreement_id
-          ))
+      def get_authorization_details(amazon_authorization_id)
+        operation('GetAuthorizationDetails')
+          .add('AmazonAuthorizationId' => amazon_authorization_id)
 
         run
       end
 
-      # Sets order reference details such as the order total and a description
-      # for the order
+      # Returns the status of a particular capture and the total amount refunded
+      # on the capture
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_SetOrderReferenceDetails.html
-      # @param amazon_order_reference_id [String]
-      # @param order_total [Struct, Hash]
-      # @param opts [Hash]
-      # @option opts [String] :platform_id
-      # @option opts [String] :seller_note
-      # @option opts [Struct, Hash] :seller_order_attributes
+      # @see https://payments.amazon.com/documentation/apireference/201752060
+      # @param [String] amazon_capture_id
       # @return [Peddler::XMLParser]
-      def set_order_reference_details(amazon_order_reference_id, order_total, opts = {})
-        operation('SetOrderReferenceDetails')
-          .add(
-            'AmazonOrderReferenceId' => amazon_order_reference_id,
-            'OrderReferenceAttributes' => opts.update('OrderTotal' => order_total)
-          )
+      def get_capture_details(amazon_capture_id)
+        operation('GetCaptureDetails')
+          .add('AmazonCaptureId' => amazon_capture_id)
 
         run
       end
 
       # Returns details about the Order Reference object and its current state
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_GetOrderReferenceDetails.html
-      # @param amazon_order_reference_id [String]
-      # @param opts [Hash]
+      # @see https://payments.amazon.com/documentation/apireference/201751970
+      # @param [String] amazon_order_reference_id
+      # @param [Hash] opts
       # @option opts [String] address_consent_token
       # @return [Peddler::XMLParser]
       def get_order_reference_details(amazon_order_reference_id, opts = {})
@@ -189,173 +188,175 @@ module MWS
         run
       end
 
-      # Confirms that the order reference is free of constraints and all required
-      # information has been set on the order reference
-      #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_ConfirmOrderReference.html
-      # @param amazon_order_reference_id [String]
-      # @return [Peddler::XMLParser]
-      def confirm_order_reference(amazon_order_reference_id)
-        operation('ConfirmOrderReference')
-          .add('AmazonOrderReferenceId' => amazon_order_reference_id)
-
-        run
-      end
-
-      # Cancels a previously confirmed order reference
+      # Returns the status of a particular refund
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_CancelOrderReference.html
-      # @param amazon_order_reference_id [String]
-      # @param opts [Hash]
-      # @option opts [String] cancelation_reason
+      # @see https://payments.amazon.com/documentation/apireference/201752100
+      # @param [String] amazon_refund_id
       # @return [Peddler::XMLParser]
-      def cancel_order_reference(amazon_order_reference_id, opts = {})
-        operation('CancelOrderReference')
-          .add(opts.update('AmazonOrderReferenceId' => amazon_order_reference_id))
+      def get_refund_details(amazon_refund_id)
+        operation('GetRefundDetails')
+          .add('AmazonRefundId' => amazon_refund_id)
 
         run
       end
 
-      # Confirms that an order reference has been fulfilled (fully or partially)
-      # and that you do not expect to create any new authorizations on this
-      # order reference
+      # Gets the operational status of the API
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_CloseOrderReference.html
-      # @param amazon_order_reference_id [String]
-      # @param opts [Hash]
-      # @option opts [String] closure_reason
+      # @see https://payments.amazon.com/documentation/apireference/201752110
       # @return [Peddler::XMLParser]
-      def close_order_reference(amazon_order_reference_id, opts = {})
-        operation('CloseOrderReference')
-          .add(opts.update('AmazonOrderReferenceId' => amazon_order_reference_id))
-
+      def get_service_status
+        operation('GetServiceStatus')
         run
       end
 
-      # Reserves a specified amount against the payment method(s) stored in the
-      # order reference
+      # Refunds a previously captured amount
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_Authorize.html
-      # @param amazon_order_reference_id [String]
-      # @param authorization_reference_id [String]
-      # @param authorization_amount [Struct, Hash]
-      # @param opts [Hash]
-      # @option opts [String] :seller_authorization_note
-      # @option opts [Integer] :transaction_timeout
-      # @option opts [Boolean] :capture_now
+      # @see https://payments.amazon.com/documentation/apireference/201752080
+      # @param [String] amazon_capture_id
+      # @param [String] refund_reference_id
+      # @param [Struct, Hash] refund_amount
+      # @param [Hash] opts
+      # @option opts [String] :seller_refund_note
       # @option opts [String] :soft_descriptor
       # @return [Peddler::XMLParser]
-      def authorize(amazon_order_reference_id, authorization_reference_id, authorization_amount, opts = {})
-        operation('Authorize')
+      def refund(amazon_capture_id, refund_reference_id, refund_amount, opts = {})
+        operation('Refund')
           .add(opts.update(
-                 'AmazonOrderReferenceId' => amazon_order_reference_id,
-                 'AuthorizationReferenceId' => authorization_reference_id,
-                 'AuthorizationAmount' => authorization_amount
+                 'AmazonCaptureId' => amazon_capture_id,
+                 'RefundReferenceId' => refund_reference_id,
+                 'RefundAmount' => refund_amount
           ))
 
         run
       end
 
-      # Returns the status of a particular authorization and the total amount
-      # captured on the authorization
+      # Sets order reference details such as the order total and a description
+      # for the order
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_GetAuthorizationDetails.html
-      # @param amazon_authorization_id [String]
+      # @see https://payments.amazon.com/documentation/apireference/201751960
+      # @param [String] amazon_order_reference_id
+      # @param [Struct, Hash] order_total
+      # @param [Hash] opts
+      # @option opts [String] :platform_id
+      # @option opts [String] :seller_note
+      # @option opts [Struct, Hash] :seller_order_attributes
       # @return [Peddler::XMLParser]
-      def get_authorization_details(amazon_authorization_id)
-        operation('GetAuthorizationDetails')
-          .add('AmazonAuthorizationId' => amazon_authorization_id)
+      def set_order_reference_details(amazon_order_reference_id, order_total, opts = {})
+        operation('SetOrderReferenceDetails')
+          .add(
+            'AmazonOrderReferenceId' => amazon_order_reference_id,
+            'OrderReferenceAttributes' => opts.update('OrderTotal' => order_total)
+          )
 
         run
       end
 
-      # Captures funds from an authorized payment instrument
+      # Reserves a specified amount against the payment method(s) stored in the
+      # billing agreement
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_Capture.html
-      # @param amazon_authorization_id [String]
-      # @param capture_reference_id [String]
-      # @param capture_amount [Struct, Hash]
-      # @param opts [Hash]
-      # @option opts [String] :seller_capture_note
+      # @see https://payments.amazon.com/documentation/apireference/201751940
+      # @param [String] amazon_billing_agreement_id
+      # @param [String] authorization_reference_id
+      # @param [Hash, Struct] authorization_amount
+      # @param [Hash] opts
+      # @option opts [String] :seller_authorization_note
+      # @option opts [Integer] :transaction_timeout
+      # @option opts [Boolean] :capture_now
       # @option opts [String] :soft_descriptor
+      # @option opts [String] :seller_note
+      # @option opts [String] :platform_id
+      # @option opts [Hash, Struct] :seller_order_attributes
+      # @option opts [Boolean] :inherit_shipping_address
       # @return [Peddler::XMLParser]
-      def capture(amazon_authorization_id, capture_reference_id, capture_amount, opts = {})
-        operation('Capture')
+      def authorize_on_billing_agreement(amazon_billing_agreement_id, authorization_reference_id, authorization_amount, opts = {})
+        operation('AuthorizeOnBillingAgreement')
           .add(opts.update(
-                 'AmazonAuthorizationId' => amazon_authorization_id,
-                 'CaptureReferenceId' => capture_reference_id,
-                 'CaptureAmount' => capture_amount
+                 'AmazonBillingAgreementId' => amazon_billing_agreement_id,
+                 'AuthorizationReferenceId' => authorization_reference_id,
+                 'AuthorizationAmount' => authorization_amount
           ))
 
         run
       end
 
-      # Returns the status of a particular capture and the total amount refunded
-      # on the capture
+      # Confirms that you want to terminate the billing agreement with the buyer
+      # and that you do not expect to create any new order references or
+      # authorizations on this billing agreement
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_GetCaptureDetails.html
-      # @param amazon_capture_id [String]
+      # @see https://payments.amazon.com/documentation/apireference/201751950
+      # @param [String] amazon_billing_agreement_id
+      # @param [Hash] opts
+      # @option opts [String] :closure_reason
       # @return [Peddler::XMLParser]
-      def get_capture_details(amazon_capture_id)
-        operation('GetCaptureDetails')
-          .add('AmazonCaptureId' => amazon_capture_id)
+      def close_billing_agreement(amazon_billing_agreement_id, opts = {})
+        operation('CloseBillingAgreement')
+          .add(opts.update(
+                 'AmazonBillingAgreementId' => amazon_billing_agreement_id
+          ))
 
         run
       end
 
-      # Closes an authorization
+      # Confirms that the billing agreement is free of constraints and all
+      # required information has been set on the billing agreement
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_CloseAuthorization.html
-      # @param amazon_authorization_id [String]
-      # @param opts [Hash]
-      # @option opts [String] closure_reason
+      # @see https://payments.amazon.com/documentation/apireference/201751710
+      # @param [String] amazon_billing_agreement_id
       # @return [Peddler::XMLParser]
-      def close_authorization(amazon_authorization_id, opts = {})
-        operation('CloseAuthorization')
-          .add(opts.update('AmazonAuthorizationId' => amazon_authorization_id))
+      def confirm_billing_agreement(amazon_billing_agreement_id)
+        operation('ConfirmBillingAgreement')
+          .add(
+            'AmazonBillingAgreementId' => amazon_billing_agreement_id
+          )
 
         run
       end
 
-      # Refunds a previously captured amount
+      # Returns details about the Billing Agreement object and its current state
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_Refund.html
-      # @param amazon_capture_id [String]
-      # @param refund_reference_id [String]
-      # @param refund_amount [Struct, Hash]
-      # @param opts [Hash]
-      # @option opts [String] :seller_refund_note
-      # @option opts [String] :soft_descriptor
+      # @see https://payments.amazon.com/documentation/apireference/201751690
+      # @param [String] amazon_billing_agreement_id
+      # @param [Hash] opts
+      # @option opts [String] :address_consent_token
       # @return [Peddler::XMLParser]
-      def refund(amazon_capture_id, refund_reference_id, refund_amount, opts = {})
-        operation('Refund')
+      def get_billing_agreement_details(amazon_billing_agreement_id, opts = {})
+        operation('GetBillingAgreementDetails')
           .add(opts.update(
-                 'AmazonCaptureId' => amazon_capture_id,
-                 'RefundReferenceId' => refund_reference_id,
-                 'RefundAmount' => refund_amount
+                 'AmazonBillingAgreementId' => amazon_billing_agreement_id
           ))
 
         run
       end
 
-      # Returns the status of a particular refund
+      # Sets billing agreement details such as a description of the agreement
+      # and other information about the seller
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_GetRefundDetails.html
-      # @param amazon_refund_id [String]
+      # @see https://payments.amazon.com/documentation/apireference/201751700
+      # @param [String] amazon_billing_agreement_id
+      # @param [Struct, Hash] billing_agreement_attributes
       # @return [Peddler::XMLParser]
-      def get_refund_details(amazon_refund_id)
-        operation('GetRefundDetails')
-          .add('AmazonRefundId' => amazon_refund_id)
+      def set_billing_agreement_details(amazon_billing_agreement_id, billing_agreement_attributes)
+        operation('SetBillingAgreementDetails')
+          .add(
+            'AmazonBillingAgreementId' => amazon_billing_agreement_id,
+            'BillingAgreementAttributes' => billing_agreement_attributes
+          )
 
         run
       end
 
-      # Gets the operational status of the API
+      # Validates the status of the BillingAgreement object and the payment
+      # method associated with it
       #
-      # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_GetServiceStatus.html
+      # @see https://payments.amazon.com/documentation/apireference/201751720
+      # @param [String] amazon_billing_agreement_id
       # @return [Peddler::XMLParser]
-      def get_service_status
-        operation('GetServiceStatus')
+      def validate_billing_agreement(amazon_billing_agreement_id)
+        operation('ValidateBillingAgreement')
+          .add(
+            'AmazonBillingAgreementId' => amazon_billing_agreement_id
+          )
+
         run
       end
     end