peddler 4.1.1 → 4.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +116 -296
  3. data/lib/peddler/api.rb +3 -2
  4. data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09.rb +119 -2
  5. data/lib/peddler/apis/aplus_content_2020_11_01.rb +59 -49
  6. data/lib/peddler/apis/catalog_items_2022_04_01.rb +34 -33
  7. data/lib/peddler/apis/catalog_items_v0.rb +0 -62
  8. data/lib/peddler/apis/easy_ship_2022_03_23.rb +19 -18
  9. data/lib/peddler/apis/feeds_2021_06_30.rb +1 -1
  10. data/lib/peddler/apis/finances_2024_06_01.rb +53 -0
  11. data/lib/peddler/apis/finances_2024_06_19.rb +14 -17
  12. data/lib/peddler/apis/fulfillment_inbound_2024_03_20.rb +10 -5
  13. data/lib/peddler/apis/fulfillment_inbound_v0.rb +2 -170
  14. data/lib/peddler/apis/listings_items_2021_08_01.rb +77 -5
  15. data/lib/peddler/apis/messaging_v1.rb +50 -49
  16. data/lib/peddler/apis/orders_v0.rb +1 -1
  17. data/lib/peddler/apis/product_pricing_v0.rb +3 -2
  18. data/lib/peddler/apis/reports_2021_06_30.rb +1 -1
  19. data/lib/peddler/apis/seller_wallet_2024_03_01.rb +195 -0
  20. data/lib/peddler/apis/sellers_v1.rb +1 -1
  21. data/lib/peddler/apis/shipping_v1.rb +12 -12
  22. data/lib/peddler/apis/shipping_v2.rb +46 -20
  23. data/lib/peddler/apis/uploads_2020_11_01.rb +9 -8
  24. data/lib/peddler/apis/vehicles_2024_11_01.rb +40 -0
  25. data/lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28.rb +40 -27
  26. data/lib/peddler/apis/vendor_invoices_v1.rb +1 -1
  27. data/lib/peddler/apis/vendor_shipments_v1.rb +40 -1
  28. data/lib/peddler/error.rb +11 -1
  29. data/lib/peddler/parsers/openapi_parser_generator.rb +550 -0
  30. data/lib/peddler/parsers/smart_parser.rb +199 -0
  31. data/lib/peddler/token.rb +12 -12
  32. data/lib/peddler/version.rb +1 -1
  33. data/lib/peddler.rb +3 -0
  34. metadata +8 -8
  35. data/lib/peddler/json_feed_document.rb +0 -31
@@ -24,8 +24,8 @@ module Peddler
24
24
  # @note This operation can make a static sandbox call.
25
25
  # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which you want a list
26
26
  # of available message types.
27
- # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
28
- # order was placed. Only one marketplace can be specified.
27
+ # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
28
+ # order was placed. You can only specify one marketplace.
29
29
  # @param rate_limit [Float] Requests per second
30
30
  # @return [Peddler::Response] The API response
31
31
  def get_messaging_actions_for_order(amazon_order_id, marketplace_ids, rate_limit: 1.0)
@@ -41,11 +41,11 @@ module Peddler
41
41
  # initials, etc.
42
42
  #
43
43
  # @note This operation can make a static sandbox call.
44
- # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
44
+ # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
45
45
  # sent.
46
- # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
47
- # order was placed. Only one marketplace can be specified.
48
- # @param body [Hash]
46
+ # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
47
+ # order was placed. You can only specify one marketplace.
48
+ # @param body [Hash] This contains the message body for a message.
49
49
  # @param rate_limit [Float] Requests per second
50
50
  # @return [Peddler::Response] The API response
51
51
  def confirm_customization_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
@@ -60,11 +60,11 @@ module Peddler
60
60
  # Sends a message to a buyer to arrange a delivery or to confirm contact information for making a delivery.
61
61
  #
62
62
  # @note This operation can make a static sandbox call.
63
- # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
63
+ # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
64
64
  # sent.
65
- # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
66
- # order was placed. Only one marketplace can be specified.
67
- # @param body [Hash]
65
+ # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
66
+ # order was placed. You can only specify one marketplace.
67
+ # @param body [Hash] This contains the message body for a message.
68
68
  # @param rate_limit [Float] Requests per second
69
69
  # @return [Peddler::Response] The API response
70
70
  def create_confirm_delivery_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
@@ -80,11 +80,11 @@ module Peddler
80
80
  # This message should only be used to deliver documents that are required by law.
81
81
  #
82
82
  # @note This operation can make a static sandbox call.
83
- # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
83
+ # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
84
84
  # sent.
85
- # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
86
- # order was placed. Only one marketplace can be specified.
87
- # @param body [Hash]
85
+ # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
86
+ # order was placed. You can only specify one marketplace.
87
+ # @param body [Hash] This contains the message body for a message.
88
88
  # @param rate_limit [Float] Requests per second
89
89
  # @return [Peddler::Response] The API response
90
90
  def create_legal_disclosure(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
@@ -100,10 +100,10 @@ module Peddler
100
100
  # sent after the seller has resolved the buyer's problem.
101
101
  #
102
102
  # @note This operation can make a static sandbox call.
103
- # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
103
+ # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
104
104
  # sent.
105
- # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
106
- # order was placed. Only one marketplace can be specified.
105
+ # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
106
+ # order was placed. You can only specify one marketplace.
107
107
  # @param rate_limit [Float] Requests per second
108
108
  # @return [Peddler::Response] The API response
109
109
  def create_negative_feedback_removal(amazon_order_id, marketplace_ids, rate_limit: 1.0)
@@ -118,11 +118,11 @@ module Peddler
118
118
  # Sends a message to ask a buyer an order-related question prior to shipping their order.
119
119
  #
120
120
  # @note This operation can make a static sandbox call.
121
- # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
121
+ # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
122
122
  # sent.
123
- # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
124
- # order was placed. Only one marketplace can be specified.
125
- # @param body [Hash]
123
+ # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
124
+ # order was placed. You can only specify one marketplace.
125
+ # @param body [Hash] This contains the message body for a message.
126
126
  # @param rate_limit [Float] Requests per second
127
127
  # @return [Peddler::Response] The API response
128
128
  def create_confirm_order_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
@@ -138,11 +138,11 @@ module Peddler
138
138
  # service call.
139
139
  #
140
140
  # @note This operation can make a static sandbox call.
141
- # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
141
+ # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
142
142
  # sent.
143
- # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
144
- # order was placed. Only one marketplace can be specified.
145
- # @param body [Hash]
143
+ # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
144
+ # order was placed. You can only specify one marketplace.
145
+ # @param body [Hash] This contains the message body for a message.
146
146
  # @param rate_limit [Float] Requests per second
147
147
  # @return [Peddler::Response] The API response
148
148
  def create_confirm_service_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
@@ -158,11 +158,11 @@ module Peddler
158
158
  # Amazon Motors sellers.
159
159
  #
160
160
  # @note This operation can make a static sandbox call.
161
- # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
161
+ # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
162
162
  # sent.
163
- # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
164
- # order was placed. Only one marketplace can be specified.
165
- # @param body [Hash]
163
+ # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
164
+ # order was placed. You can only specify one marketplace.
165
+ # @param body [Hash] This contains the message body for a message.
166
166
  # @param rate_limit [Float] Requests per second
167
167
  # @return [Peddler::Response] The API response
168
168
  def create_amazon_motors(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
@@ -177,11 +177,11 @@ module Peddler
177
177
  # Sends a message to a buyer to provide details about warranty information on a purchase in their order.
178
178
  #
179
179
  # @note This operation can make a static sandbox call.
180
- # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
180
+ # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
181
181
  # sent.
182
- # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
183
- # order was placed. Only one marketplace can be specified.
184
- # @param body [Hash]
182
+ # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
183
+ # order was placed. You can only specify one marketplace.
184
+ # @param body [Hash] This contains the message body for a message.
185
185
  # @param rate_limit [Float] Requests per second
186
186
  # @return [Peddler::Response] The API response
187
187
  def create_warranty(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
@@ -196,10 +196,10 @@ module Peddler
196
196
  # Returns a response containing attributes related to an order. This includes buyer preferences.
197
197
  #
198
198
  # @note This operation can make a static sandbox call.
199
- # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
199
+ # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
200
200
  # sent.
201
- # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
202
- # order was placed. Only one marketplace can be specified.
201
+ # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
202
+ # order was placed. You can only specify one marketplace.
203
203
  # @param rate_limit [Float] Requests per second
204
204
  # @return [Peddler::Response] The API response
205
205
  def get_attributes(amazon_order_id, marketplace_ids, rate_limit: 1.0)
@@ -211,14 +211,15 @@ module Peddler
211
211
  meter(rate_limit).get(path, params:)
212
212
  end
213
213
 
214
- # Sends a message to a buyer to share a digital access key needed to utilize digital content in their order.
214
+ # Sends a buyer a message to share a digital access key that is required to utilize digital content in their
215
+ # order.
215
216
  #
216
217
  # @note This operation can make a static sandbox call.
217
- # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
218
+ # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
218
219
  # sent.
219
- # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
220
- # order was placed. Only one marketplace can be specified.
221
- # @param body [Hash]
220
+ # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
221
+ # order was placed. You can only specify one marketplace.
222
+ # @param body [Hash] This contains the message body for a message.
222
223
  # @param rate_limit [Float] Requests per second
223
224
  # @return [Peddler::Response] The API response
224
225
  def create_digital_access_key(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
@@ -234,11 +235,11 @@ module Peddler
234
235
  # order.
235
236
  #
236
237
  # @note This operation can make a static sandbox call.
237
- # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
238
+ # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
238
239
  # sent.
239
- # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
240
- # order was placed. Only one marketplace can be specified.
241
- # @param body [Hash]
240
+ # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
241
+ # order was placed. You can only specify one marketplace.
242
+ # @param body [Hash] This contains the message body for a message.
242
243
  # @param rate_limit [Float] Requests per second
243
244
  # @return [Peddler::Response] The API response
244
245
  def create_unexpected_problem(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
@@ -253,11 +254,11 @@ module Peddler
253
254
  # Sends a message providing the buyer an invoice
254
255
  #
255
256
  # @note This operation can make a static sandbox call.
256
- # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
257
+ # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
257
258
  # sent.
258
- # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
259
- # order was placed. Only one marketplace can be specified.
260
- # @param body [Hash]
259
+ # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
260
+ # order was placed. You can only specify one marketplace.
261
+ # @param body [Hash] This contains the message body for a message.
261
262
  # @return [Peddler::Response] The API response
262
263
  def send_invoice(amazon_order_id, marketplace_ids, body)
263
264
  path = "/messaging/v1/orders/#{amazon_order_id}/messages/invoice"
@@ -10,7 +10,7 @@ module Peddler
10
10
  end
11
11
 
12
12
  module APIs
13
- # Orders v0
13
+ # Selling Partner API for Orders
14
14
  #
15
15
  # Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop
16
16
  # fast, flexible, and custom applications to manage order synchronization, perform order research, and create
@@ -135,7 +135,7 @@ module Peddler
135
135
  # Returns the lowest priced offers for a batch of items based on ASIN.
136
136
  #
137
137
  # @note This operation can make a static sandbox call.
138
- # @param get_item_offers_batch_request_body [Hash]
138
+ # @param get_item_offers_batch_request_body [Hash] The request associated with the `getItemOffersBatch` API call.
139
139
  # @param rate_limit [Float] Requests per second
140
140
  # @return [Peddler::Response] The API response
141
141
  def get_item_offers_batch(get_item_offers_batch_request_body, rate_limit: 0.1)
@@ -148,7 +148,8 @@ module Peddler
148
148
  # Returns the lowest priced offers for a batch of listings by SKU.
149
149
  #
150
150
  # @note This operation can make a static sandbox call.
151
- # @param get_listing_offers_batch_request_body [Hash]
151
+ # @param get_listing_offers_batch_request_body [Hash] The request associated with the `getListingOffersBatch` API
152
+ # call.
152
153
  # @param rate_limit [Float] Requests per second
153
154
  # @return [Peddler::Response] The API response
154
155
  def get_listing_offers_batch(get_listing_offers_batch_request_body, rate_limit: 0.5)
@@ -10,7 +10,7 @@ module Peddler
10
10
  end
11
11
 
12
12
  module APIs
13
- # Report v2021-06-30
13
+ # Selling Partner API for Reports
14
14
  #
15
15
  # The Selling Partner API for Reports lets you retrieve and manage a variety of reports that can help selling
16
16
  # partners manage their businesses.
@@ -0,0 +1,195 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "peddler/api"
4
+
5
+ module Peddler
6
+ class << self
7
+ def seller_wallet_2024_03_01(...)
8
+ APIs::SellerWallet20240301.new(...)
9
+ end
10
+ end
11
+
12
+ module APIs
13
+ # The Selling Partner API for Amazon Seller Wallet Open Banking API
14
+ #
15
+ # The Selling Partner API for Seller Wallet (Seller Wallet API) provides financial information that is relevant to a
16
+ # seller's Seller Wallet account. You can obtain financial events, balances, and transfer schedules for Seller
17
+ # Wallet accounts. You can also schedule and initiate transactions.
18
+ class SellerWallet20240301 < API
19
+ # Get all Seller Wallet accounts for a given seller.
20
+ #
21
+ # @note This operation can make a static sandbox call.
22
+ # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally
23
+ # unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace
24
+ # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
25
+ # @return [Peddler::Response] The API response
26
+ def list_accounts(marketplace_id)
27
+ path = "/finances/transfers/wallet/2024-03-01/accounts"
28
+ params = {
29
+ "marketplaceId" => marketplace_id,
30
+ }.compact
31
+
32
+ get(path, params:)
33
+ end
34
+
35
+ # Retrieve an Amazon Seller Wallet bank account by Amazon account identifier.
36
+ #
37
+ # @note This operation can make a static sandbox call.
38
+ # @param account_id [String] The ID of the Amazon Seller Wallet account.
39
+ # @return [Peddler::Response] The API response
40
+ def get_account(account_id)
41
+ path = "/finances/transfers/wallet/2024-03-01/accounts/#{account_id}"
42
+
43
+ get(path)
44
+ end
45
+
46
+ # Retrieve the balance in a given Amazon Seller Wallet bank account.
47
+ #
48
+ # @note This operation can make a static sandbox call.
49
+ # @param account_id [String] The ID of the Amazon Seller Wallet account.
50
+ # @return [Peddler::Response] The API response
51
+ def list_account_balances(account_id)
52
+ path = "/finances/transfers/wallet/2024-03-01/accounts/#{account_id}/balance"
53
+
54
+ get(path)
55
+ end
56
+
57
+ # Retrieve a list of potential fees on a transaction.
58
+ #
59
+ # @note This operation can make a static sandbox call.
60
+ # @param source_country_code [String] Country code of the source transaction account in ISO 3166 format.
61
+ # @param source_currency_code [String] Currency code of the source transaction country in ISO 4217 format.
62
+ # @param destination_country_code [String] Country code of the destination transaction account in ISO 3166 format.
63
+ # @param destination_currency_code [String] Currency code of the destination transaction country in ISO 4217
64
+ # format.
65
+ # @param base_amount [Number] The base transaction amount without any markup fees.
66
+ # @return [Peddler::Response] The API response
67
+ def get_transfer_preview(source_country_code, source_currency_code, destination_country_code,
68
+ destination_currency_code, base_amount)
69
+ path = "/finances/transfers/wallet/2024-03-01/transferPreview"
70
+ params = {
71
+ "sourceCountryCode" => source_country_code,
72
+ "sourceCurrencyCode" => source_currency_code,
73
+ "destinationCountryCode" => destination_country_code,
74
+ "destinationCurrencyCode" => destination_currency_code,
75
+ "baseAmount" => base_amount,
76
+ }.compact
77
+
78
+ get(path, params:)
79
+ end
80
+
81
+ # Retrieve a list of transactions for a given Amazon Seller Wallet bank account.
82
+ #
83
+ # @note This operation can make a static sandbox call.
84
+ # @param account_id [String] The ID of the Amazon Seller Wallet account.
85
+ # @param next_page_token [String] A token that you use to retrieve the next page of results. The response includes
86
+ # `nextPageToken` when the number of results exceeds 100. To get the next page of results, call the operation
87
+ # with this token and include the same arguments as the call that produced the token. To get a complete list,
88
+ # call this operation until `nextPageToken` is null. Note that this operation can return empty pages.
89
+ # @return [Peddler::Response] The API response
90
+ def list_account_transactions(account_id, next_page_token: nil)
91
+ path = "/finances/transfers/wallet/2024-03-01/transactions"
92
+ params = {
93
+ "accountId" => account_id,
94
+ "nextPageToken" => next_page_token,
95
+ }.compact
96
+
97
+ get(path, params:)
98
+ end
99
+
100
+ # Create a transaction request from an Amazon Seller Wallet account to another customer-provided account.
101
+ #
102
+ # @note This operation can make a static sandbox call.
103
+ # @param body [Hash] The payload of the request
104
+ # @param dest_account_digital_signature [String] Digital signature for the destination bank account details.
105
+ # @param amount_digital_signature [String] Digital signature for the source currency transaction amount.
106
+ # @return [Peddler::Response] The API response
107
+ def create_transaction(body, dest_account_digital_signature, amount_digital_signature)
108
+ path = "/finances/transfers/wallet/2024-03-01/transactions"
109
+
110
+ post(path, body:)
111
+ end
112
+
113
+ # Find a transaction by the Amazon transaction identifier.
114
+ #
115
+ # @note This operation can make a static sandbox call.
116
+ # @param transaction_id [String] The ID of the Amazon Seller Wallet transaction.
117
+ # @return [Peddler::Response] The API response
118
+ def get_transaction(transaction_id)
119
+ path = "/finances/transfers/wallet/2024-03-01/transactions/#{transaction_id}"
120
+
121
+ get(path)
122
+ end
123
+
124
+ # Returns all transfer schedules of a given Amazon Seller Wallet bank account with the schedule ID in response if
125
+ # present.
126
+ #
127
+ # @note This operation can make a static sandbox call.
128
+ # @param account_id [String] The ID of the Amazon Seller Wallet account.
129
+ # @param next_page_token [String] A token that you use to retrieve the next page of results. The response includes
130
+ # `nextPageToken` when the number of results exceeds the specified `pageSize` value. To get the next page of
131
+ # results, call the operation with this token and include the same arguments as the call that produced the
132
+ # token. To get a complete list, call this operation until `nextPageToken` is null. Note that this operation can
133
+ # return empty pages.
134
+ # @return [Peddler::Response] The API response
135
+ def list_transfer_schedules(account_id, next_page_token: nil)
136
+ path = "/finances/transfers/wallet/2024-03-01/transferSchedules"
137
+ params = {
138
+ "accountId" => account_id,
139
+ "nextPageToken" => next_page_token,
140
+ }.compact
141
+
142
+ get(path, params:)
143
+ end
144
+
145
+ # Create a transfer schedule request from an Amazon Seller Wallet account to another customer-provided account.
146
+ #
147
+ # @note This operation can make a static sandbox call.
148
+ # @param body [Hash] The payload of the request.
149
+ # @param dest_account_digital_signature [String] Digital signature for the destination bank account details.
150
+ # @param amount_digital_signature [String] Digital signature for the source currency transaction amount.
151
+ # @return [Peddler::Response] The API response
152
+ def create_transfer_schedule(body, dest_account_digital_signature, amount_digital_signature)
153
+ path = "/finances/transfers/wallet/2024-03-01/transferSchedules"
154
+
155
+ post(path, body:)
156
+ end
157
+
158
+ # Update transfer schedule information. Returns a transfer belonging to the updated scheduled transfer request.
159
+ #
160
+ # @note This operation can make a static sandbox call.
161
+ # @param body [Hash] The payload of the scheduled transfer request that is to be updated.
162
+ # @param dest_account_digital_signature [String] Digital signature for the destination bank account details.
163
+ # @param amount_digital_signature [String] Digital signature for the source currency transaction amount.
164
+ # @return [Peddler::Response] The API response
165
+ def update_transfer_schedule(body, dest_account_digital_signature, amount_digital_signature)
166
+ path = "/finances/transfers/wallet/2024-03-01/transferSchedules"
167
+
168
+ put(path, body:)
169
+ end
170
+
171
+ # Find a particular Amazon Seller Wallet account transfer schedule.
172
+ #
173
+ # @note This operation can make a static sandbox call.
174
+ # @param transfer_schedule_id [String] The schedule ID of the Amazon Seller Wallet transfer.
175
+ # @return [Peddler::Response] The API response
176
+ def get_transfer_schedule(transfer_schedule_id)
177
+ path = "/finances/transfers/wallet/2024-03-01/transferSchedules/#{transfer_schedule_id}"
178
+
179
+ get(path)
180
+ end
181
+
182
+ # Delete a transaction request that is scheduled from Amazon Seller Wallet account to another customer-provided
183
+ # account.
184
+ #
185
+ # @note This operation can make a static sandbox call.
186
+ # @param transfer_schedule_id [String] A unique reference ID for a scheduled transfer.
187
+ # @return [Peddler::Response] The API response
188
+ def delete_schedule_transaction(transfer_schedule_id)
189
+ path = "/finances/transfers/wallet/2024-03-01/transferSchedules/#{transfer_schedule_id}"
190
+
191
+ delete(path)
192
+ end
193
+ end
194
+ end
195
+ end
@@ -10,7 +10,7 @@ module Peddler
10
10
  end
11
11
 
12
12
  module APIs
13
- # Selling Partner API for Sellers
13
+ # The Selling Partner API for Sellers
14
14
  #
15
15
  # The [Selling Partner API for Sellers](https://developer-docs.amazon.com/sp-api/docs/sellers-api-v1-reference)
16
16
  # (Sellers API) provides essential information about seller accounts, such as: - The marketplaces a seller can list
@@ -21,7 +21,7 @@ module Peddler
21
21
  # Create a new shipment.
22
22
  #
23
23
  # @note This operation can make a static sandbox call.
24
- # @param body [Hash]
24
+ # @param body [Hash] CreateShipmentRequest Body
25
25
  # @param rate_limit [Float] Requests per second
26
26
  # @return [Peddler::Response] The API response
27
27
  def create_shipment(body, rate_limit: 5.0)
@@ -33,7 +33,7 @@ module Peddler
33
33
  # Return the entire shipment object for the shipmentId.
34
34
  #
35
35
  # @note This operation can make a static sandbox call.
36
- # @param shipment_id [String]
36
+ # @param shipment_id [String] Shipment id to return the entire shipment object
37
37
  # @param rate_limit [Float] Requests per second
38
38
  # @return [Peddler::Response] The API response
39
39
  def get_shipment(shipment_id, rate_limit: 5.0)
@@ -45,7 +45,7 @@ module Peddler
45
45
  # Cancel a shipment by the given shipmentId.
46
46
  #
47
47
  # @note This operation can make a static sandbox call.
48
- # @param shipment_id [String]
48
+ # @param shipment_id [String] Shipment Id to cancel a shipment
49
49
  # @param rate_limit [Float] Requests per second
50
50
  # @return [Peddler::Response] The API response
51
51
  def cancel_shipment(shipment_id, rate_limit: 5.0)
@@ -57,8 +57,8 @@ module Peddler
57
57
  # Purchase shipping labels based on a given rate.
58
58
  #
59
59
  # @note This operation can make a static sandbox call.
60
- # @param shipment_id [String]
61
- # @param body [Hash]
60
+ # @param shipment_id [String] Shipment id for purchase shipping label
61
+ # @param body [Hash] PurchaseShippingLabelRequest body
62
62
  # @param rate_limit [Float] Requests per second
63
63
  # @return [Peddler::Response] The API response
64
64
  def purchase_labels(shipment_id, body, rate_limit: 5.0)
@@ -70,9 +70,9 @@ module Peddler
70
70
  # Retrieve shipping label based on the shipment id and tracking id.
71
71
  #
72
72
  # @note This operation can make a static sandbox call.
73
- # @param shipment_id [String]
74
- # @param tracking_id [String]
75
- # @param body [Hash]
73
+ # @param shipment_id [String] Shipment Id to retreive label
74
+ # @param tracking_id [String] Tracking Id
75
+ # @param body [Hash] RetrieveShippingLabelRequest body
76
76
  # @param rate_limit [Float] Requests per second
77
77
  # @return [Peddler::Response] The API response
78
78
  def retrieve_shipping_label(shipment_id, tracking_id, body, rate_limit: 5.0)
@@ -84,7 +84,7 @@ module Peddler
84
84
  # Purchase shipping labels.
85
85
  #
86
86
  # @note This operation can make a static sandbox call.
87
- # @param body [Hash]
87
+ # @param body [Hash] PurchaseShipmentRequest body
88
88
  # @param rate_limit [Float] Requests per second
89
89
  # @return [Peddler::Response] The API response
90
90
  def purchase_shipment(body, rate_limit: 5.0)
@@ -95,8 +95,8 @@ module Peddler
95
95
 
96
96
  # Get service rates.
97
97
  #
98
- # @note This operation can make a static sandbox call.
99
- # @param body [Hash]
98
+ # @note This operation can make a dynamic sandbox call.
99
+ # @param body [Hash] GetRatesRequest body
100
100
  # @param rate_limit [Float] Requests per second
101
101
  # @return [Peddler::Response] The API response
102
102
  def get_rates(body, rate_limit: 5.0)
@@ -119,7 +119,7 @@ module Peddler
119
119
  # Return the tracking information of a shipment.
120
120
  #
121
121
  # @note This operation can make a static sandbox call.
122
- # @param tracking_id [String]
122
+ # @param tracking_id [String] Tracking Id
123
123
  # @param rate_limit [Float] Requests per second
124
124
  # @return [Peddler::Response] The API response
125
125
  def get_tracking_information(tracking_id, rate_limit: 1.0)