peddler 3.0.0 → 4.0.1

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 (67) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -10
  3. data/lib/peddler/api.rb +32 -17
  4. data/lib/peddler/{api → apis}/amazon_warehousing_and_distribution_2024_05_09.rb +5 -5
  5. data/lib/peddler/{api → apis}/aplus_content_2020_11_01.rb +12 -12
  6. data/lib/peddler/{api → apis}/application_integrations_2024_04_01.rb +5 -5
  7. data/lib/peddler/{api → apis}/application_management_2023_11_30.rb +3 -3
  8. data/lib/peddler/{api → apis}/catalog_items_2020_12_01.rb +4 -4
  9. data/lib/peddler/{api → apis}/catalog_items_2022_04_01.rb +5 -5
  10. data/lib/peddler/{api → apis}/catalog_items_v0.rb +5 -5
  11. data/lib/peddler/{api → apis}/data_kiosk_2023_11_15.rb +7 -7
  12. data/lib/peddler/{api → apis}/easy_ship_2022_03_23.rb +20 -21
  13. data/lib/peddler/{api → apis}/fba_inbound_eligibility_v1.rb +3 -3
  14. data/lib/peddler/{api → apis}/fba_inventory_v1.rb +6 -6
  15. data/lib/peddler/{api → apis}/feeds_2021_06_30.rb +12 -9
  16. data/lib/peddler/{api → apis}/finances_2024_06_19.rb +3 -3
  17. data/lib/peddler/apis/finances_v0.rb +135 -0
  18. data/lib/peddler/{api → apis}/fulfillment_inbound_2024_03_20.rb +84 -54
  19. data/lib/peddler/{api → apis}/fulfillment_inbound_v0.rb +27 -20
  20. data/lib/peddler/{api → apis}/fulfillment_outbound_2020_07_01.rb +16 -16
  21. data/lib/peddler/{api → apis}/invoices_2024_06_19.rb +9 -9
  22. data/lib/peddler/{api → apis}/listings_items_2020_09_01.rb +5 -5
  23. data/lib/peddler/{api → apis}/listings_items_2021_08_01.rb +7 -41
  24. data/lib/peddler/{api → apis}/listings_restrictions_2021_08_01.rb +3 -3
  25. data/lib/peddler/{api → apis}/merchant_fulfillment_v0.rb +14 -14
  26. data/lib/peddler/{api → apis}/messaging_v1.rb +15 -15
  27. data/lib/peddler/{api → apis}/notifications_v1.rb +10 -10
  28. data/lib/peddler/{api → apis}/orders_v0.rb +13 -13
  29. data/lib/peddler/{api → apis}/product_fees_v0.rb +5 -5
  30. data/lib/peddler/{api → apis}/product_pricing_2022_05_01.rb +8 -8
  31. data/lib/peddler/{api → apis}/product_pricing_v0.rb +8 -8
  32. data/lib/peddler/{api → apis}/product_type_definitions_2020_09_01.rb +4 -4
  33. data/lib/peddler/{api → apis}/replenishment_2022_11_07.rb +5 -5
  34. data/lib/peddler/{api → apis}/reports_2021_06_30.rb +12 -12
  35. data/lib/peddler/{api → apis}/sales_v1.rb +3 -3
  36. data/lib/peddler/{api → apis}/sellers_v1.rb +4 -4
  37. data/lib/peddler/{api → apis}/services_v1.rb +19 -19
  38. data/lib/peddler/{api → apis}/shipment_invoicing_v0.rb +5 -5
  39. data/lib/peddler/{api → apis}/shipping_v1.rb +11 -11
  40. data/lib/peddler/{api → apis}/shipping_v2.rb +19 -19
  41. data/lib/peddler/{api → apis}/solicitations_v1.rb +4 -4
  42. data/lib/peddler/{api → apis}/supply_sources_2020_07_01.rb +8 -8
  43. data/lib/peddler/{api → apis}/tokens_2021_03_01.rb +3 -3
  44. data/lib/peddler/{api → apis}/uploads_2020_11_01.rb +3 -3
  45. data/lib/peddler/{api → apis}/vendor_direct_fulfillment_inventory_v1.rb +4 -4
  46. data/lib/peddler/{api → apis}/vendor_direct_fulfillment_orders_2021_12_28.rb +5 -5
  47. data/lib/peddler/{api → apis}/vendor_direct_fulfillment_orders_v1.rb +6 -6
  48. data/lib/peddler/{api → apis}/vendor_direct_fulfillment_payments_v1.rb +4 -4
  49. data/lib/peddler/{api → apis}/vendor_direct_fulfillment_sandbox_test_data_2021_10_28.rb +9 -9
  50. data/lib/peddler/{api → apis}/vendor_direct_fulfillment_shipping_2021_12_28.rb +17 -17
  51. data/lib/peddler/{api → apis}/vendor_direct_fulfillment_shipping_v1.rb +30 -30
  52. data/lib/peddler/{api → apis}/vendor_direct_fulfillment_transactions_2021_12_28.rb +4 -4
  53. data/lib/peddler/{api → apis}/vendor_direct_fulfillment_transactions_v1.rb +4 -4
  54. data/lib/peddler/{api → apis}/vendor_invoices_v1.rb +4 -4
  55. data/lib/peddler/{api → apis}/vendor_orders_v1.rb +7 -7
  56. data/lib/peddler/{api → apis}/vendor_shipments_v1.rb +6 -6
  57. data/lib/peddler/{api → apis}/vendor_transaction_status_v1.rb +3 -3
  58. data/lib/peddler/endpoint.rb +2 -2
  59. data/lib/peddler/error.rb +21 -12
  60. data/lib/peddler/helpers/feeds_2021_06_30.rb +26 -0
  61. data/lib/peddler/json_feed_document.rb +31 -0
  62. data/lib/peddler/marketplace.rb +46 -2
  63. data/lib/peddler/response.rb +46 -0
  64. data/lib/peddler/version.rb +1 -1
  65. data/lib/peddler.rb +54 -55
  66. metadata +59 -56
  67. data/lib/peddler/api/finances_v0.rb +0 -148
@@ -5,11 +5,11 @@ require "peddler/api"
5
5
  module Peddler
6
6
  class << self
7
7
  def shipment_invoicing_v0(...)
8
- API::ShipmentInvoicingV0.new(...)
8
+ APIs::ShipmentInvoicingV0.new(...)
9
9
  end
10
10
  end
11
11
 
12
- class API
12
+ module APIs
13
13
  # Selling Partner API for Shipment Invoicing
14
14
  #
15
15
  # The Selling Partner API for Shipment Invoicing helps you programmatically retrieve shipment invoice information in
@@ -23,7 +23,7 @@ module Peddler
23
23
  # {https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide Notifications API Use Case
24
24
  # Guide}.
25
25
  # @param rate_limit [Float] Requests per second
26
- # @return [Hash] The API response
26
+ # @return [Peddler::Response] The API response
27
27
  def get_shipment_details(shipment_id, rate_limit: 1.133)
28
28
  path = "/fba/outbound/brazil/v0/shipments/#{shipment_id}"
29
29
 
@@ -36,7 +36,7 @@ module Peddler
36
36
  # @param shipment_id [String] The identifier for the shipment.
37
37
  # @param body [Hash]
38
38
  # @param rate_limit [Float] Requests per second
39
- # @return [Hash] The API response
39
+ # @return [Peddler::Response] The API response
40
40
  def submit_invoice(shipment_id, body, rate_limit: 1.133)
41
41
  path = "/fba/outbound/brazil/v0/shipments/#{shipment_id}/invoice"
42
42
 
@@ -48,7 +48,7 @@ module Peddler
48
48
  # @note This operation can make a static sandbox call.
49
49
  # @param shipment_id [String] The shipment identifier for the shipment.
50
50
  # @param rate_limit [Float] Requests per second
51
- # @return [Hash] The API response
51
+ # @return [Peddler::Response] The API response
52
52
  def get_invoice_status(shipment_id, rate_limit: 1.133)
53
53
  path = "/fba/outbound/brazil/v0/shipments/#{shipment_id}/invoice/status"
54
54
 
@@ -5,11 +5,11 @@ require "peddler/api"
5
5
  module Peddler
6
6
  class << self
7
7
  def shipping_v1(...)
8
- API::ShippingV1.new(...)
8
+ APIs::ShippingV1.new(...)
9
9
  end
10
10
  end
11
11
 
12
- class API
12
+ module APIs
13
13
  # Selling Partner API for Shipping
14
14
  #
15
15
  # Provides programmatic access to Amazon Shipping APIs. **Note:** If you are new to the Amazon Shipping API, refer
@@ -23,7 +23,7 @@ module Peddler
23
23
  # @note This operation can make a static sandbox call.
24
24
  # @param body [Hash]
25
25
  # @param rate_limit [Float] Requests per second
26
- # @return [Hash] The API response
26
+ # @return [Peddler::Response] The API response
27
27
  def create_shipment(body, rate_limit: 5.0)
28
28
  path = "/shipping/v1/shipments"
29
29
 
@@ -35,7 +35,7 @@ module Peddler
35
35
  # @note This operation can make a static sandbox call.
36
36
  # @param shipment_id [String]
37
37
  # @param rate_limit [Float] Requests per second
38
- # @return [Hash] The API response
38
+ # @return [Peddler::Response] The API response
39
39
  def get_shipment(shipment_id, rate_limit: 5.0)
40
40
  path = "/shipping/v1/shipments/#{shipment_id}"
41
41
 
@@ -47,7 +47,7 @@ module Peddler
47
47
  # @note This operation can make a static sandbox call.
48
48
  # @param shipment_id [String]
49
49
  # @param rate_limit [Float] Requests per second
50
- # @return [Hash] The API response
50
+ # @return [Peddler::Response] The API response
51
51
  def cancel_shipment(shipment_id, rate_limit: 5.0)
52
52
  path = "/shipping/v1/shipments/#{shipment_id}/cancel"
53
53
 
@@ -60,7 +60,7 @@ module Peddler
60
60
  # @param shipment_id [String]
61
61
  # @param body [Hash]
62
62
  # @param rate_limit [Float] Requests per second
63
- # @return [Hash] The API response
63
+ # @return [Peddler::Response] The API response
64
64
  def purchase_labels(shipment_id, body, rate_limit: 5.0)
65
65
  path = "/shipping/v1/shipments/#{shipment_id}/purchaseLabels"
66
66
 
@@ -74,7 +74,7 @@ module Peddler
74
74
  # @param tracking_id [String]
75
75
  # @param body [Hash]
76
76
  # @param rate_limit [Float] Requests per second
77
- # @return [Hash] The API response
77
+ # @return [Peddler::Response] The API response
78
78
  def retrieve_shipping_label(shipment_id, tracking_id, body, rate_limit: 5.0)
79
79
  path = "/shipping/v1/shipments/#{shipment_id}/containers/#{tracking_id}/label"
80
80
 
@@ -86,7 +86,7 @@ module Peddler
86
86
  # @note This operation can make a static sandbox call.
87
87
  # @param body [Hash]
88
88
  # @param rate_limit [Float] Requests per second
89
- # @return [Hash] The API response
89
+ # @return [Peddler::Response] The API response
90
90
  def purchase_shipment(body, rate_limit: 5.0)
91
91
  path = "/shipping/v1/purchaseShipment"
92
92
 
@@ -98,7 +98,7 @@ module Peddler
98
98
  # @note This operation can make a static sandbox call.
99
99
  # @param body [Hash]
100
100
  # @param rate_limit [Float] Requests per second
101
- # @return [Hash] The API response
101
+ # @return [Peddler::Response] The API response
102
102
  def get_rates(body, rate_limit: 5.0)
103
103
  path = "/shipping/v1/rates"
104
104
 
@@ -109,7 +109,7 @@ module Peddler
109
109
  #
110
110
  # @note This operation can make a static sandbox call.
111
111
  # @param rate_limit [Float] Requests per second
112
- # @return [Hash] The API response
112
+ # @return [Peddler::Response] The API response
113
113
  def get_account(rate_limit: 5.0)
114
114
  path = "/shipping/v1/account"
115
115
 
@@ -121,7 +121,7 @@ module Peddler
121
121
  # @note This operation can make a static sandbox call.
122
122
  # @param tracking_id [String]
123
123
  # @param rate_limit [Float] Requests per second
124
- # @return [Hash] The API response
124
+ # @return [Peddler::Response] The API response
125
125
  def get_tracking_information(tracking_id, rate_limit: 1.0)
126
126
  path = "/shipping/v1/tracking/#{tracking_id}"
127
127
 
@@ -5,11 +5,11 @@ require "peddler/api"
5
5
  module Peddler
6
6
  class << self
7
7
  def shipping_v2(...)
8
- API::ShippingV2.new(...)
8
+ APIs::ShippingV2.new(...)
9
9
  end
10
10
  end
11
11
 
12
- class API
12
+ module APIs
13
13
  # Amazon Shipping API
14
14
  #
15
15
  # The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on
@@ -23,7 +23,7 @@ module Peddler
23
23
  # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
24
24
  # AmazonShipping_UK.
25
25
  # @param rate_limit [Float] Requests per second
26
- # @return [Hash] The API response
26
+ # @return [Peddler::Response] The API response
27
27
  def get_rates(body, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
28
28
  path = "/shipping/v2/shipments/rates"
29
29
 
@@ -42,7 +42,7 @@ module Peddler
42
42
  # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
43
43
  # AmazonShipping_UK.
44
44
  # @param rate_limit [Float] Requests per second
45
- # @return [Hash] The API response
45
+ # @return [Peddler::Response] The API response
46
46
  def direct_purchase_shipment(body, x_amzn_idempotency_key: nil, locale: nil, x_amzn_shipping_business_id: nil,
47
47
  rate_limit: 80.0)
48
48
  cannot_sandbox!
@@ -64,7 +64,7 @@ module Peddler
64
64
  # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
65
65
  # AmazonShipping_UK.
66
66
  # @param rate_limit [Float] Requests per second
67
- # @return [Hash] The API response
67
+ # @return [Peddler::Response] The API response
68
68
  def purchase_shipment(body, x_amzn_idempotency_key: nil, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
69
69
  path = "/shipping/v2/shipments"
70
70
 
@@ -78,7 +78,7 @@ module Peddler
78
78
  # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
79
79
  # AmazonShipping_UK.
80
80
  # @param rate_limit [Float] Requests per second
81
- # @return [Hash] The API response
81
+ # @return [Peddler::Response] The API response
82
82
  def one_click_shipment(body, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
83
83
  path = "/shipping/v2/oneClickShipment"
84
84
 
@@ -95,7 +95,7 @@ module Peddler
95
95
  # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
96
96
  # AmazonShipping_UK.
97
97
  # @param rate_limit [Float] Requests per second
98
- # @return [Hash] The API response
98
+ # @return [Peddler::Response] The API response
99
99
  def get_tracking(tracking_id, carrier_id, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
100
100
  path = "/shipping/v2/tracking"
101
101
  params = {
@@ -119,7 +119,7 @@ module Peddler
119
119
  # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
120
120
  # AmazonShipping_UK.
121
121
  # @param rate_limit [Float] Requests per second
122
- # @return [Hash] The API response
122
+ # @return [Peddler::Response] The API response
123
123
  def get_shipment_documents(shipment_id, package_client_reference_id, format: nil, dpi: nil,
124
124
  x_amzn_shipping_business_id: nil, rate_limit: 80.0)
125
125
  path = "/shipping/v2/shipments/#{shipment_id}/documents"
@@ -139,7 +139,7 @@ module Peddler
139
139
  # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
140
140
  # AmazonShipping_UK.
141
141
  # @param rate_limit [Float] Requests per second
142
- # @return [Hash] The API response
142
+ # @return [Peddler::Response] The API response
143
143
  def cancel_shipment(shipment_id, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
144
144
  path = "/shipping/v2/shipments/#{shipment_id}/cancel"
145
145
 
@@ -157,7 +157,7 @@ module Peddler
157
157
  # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
158
158
  # AmazonShipping_UK.
159
159
  # @param rate_limit [Float] Requests per second
160
- # @return [Hash] The API response
160
+ # @return [Peddler::Response] The API response
161
161
  def get_additional_inputs(request_token, rate_id, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
162
162
  path = "/shipping/v2/shipments/additionalInputs/schema"
163
163
  params = {
@@ -173,7 +173,7 @@ module Peddler
173
173
  # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
174
174
  # AmazonShipping_UK.
175
175
  # @param rate_limit [Float] Requests per second
176
- # @return [Hash] The API response
176
+ # @return [Peddler::Response] The API response
177
177
  def get_carrier_account_form_inputs(x_amzn_shipping_business_id: nil, rate_limit: 80.0)
178
178
  cannot_sandbox!
179
179
 
@@ -188,7 +188,7 @@ module Peddler
188
188
  # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
189
189
  # AmazonShipping_UK.
190
190
  # @param rate_limit [Float] Requests per second
191
- # @return [Hash] The API response
191
+ # @return [Peddler::Response] The API response
192
192
  def get_carrier_accounts(body, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
193
193
  cannot_sandbox!
194
194
 
@@ -204,7 +204,7 @@ module Peddler
204
204
  # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
205
205
  # AmazonShipping_UK.
206
206
  # @param rate_limit [Float] Requests per second
207
- # @return [Hash] The API response
207
+ # @return [Peddler::Response] The API response
208
208
  def link_carrier_account(carrier_id, body, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
209
209
  cannot_sandbox!
210
210
 
@@ -220,7 +220,7 @@ module Peddler
220
220
  # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
221
221
  # AmazonShipping_UK.
222
222
  # @param rate_limit [Float] Requests per second
223
- # @return [Hash] The API response
223
+ # @return [Peddler::Response] The API response
224
224
  def unlink_carrier_account(carrier_id, body, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
225
225
  cannot_sandbox!
226
226
 
@@ -237,7 +237,7 @@ module Peddler
237
237
  # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
238
238
  # AmazonShipping_UK.
239
239
  # @param rate_limit [Float] Requests per second
240
- # @return [Hash] The API response
240
+ # @return [Peddler::Response] The API response
241
241
  def generate_collection_form(body, x_amzn_idempotency_key: nil, x_amzn_shipping_business_id: nil,
242
242
  rate_limit: 80.0)
243
243
  cannot_sandbox!
@@ -253,7 +253,7 @@ module Peddler
253
253
  # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
254
254
  # AmazonShipping_UK.
255
255
  # @param rate_limit [Float] Requests per second
256
- # @return [Hash] The API response
256
+ # @return [Peddler::Response] The API response
257
257
  def get_collection_form_history(body, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
258
258
  cannot_sandbox!
259
259
 
@@ -269,7 +269,7 @@ module Peddler
269
269
  # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
270
270
  # AmazonShipping_UK.
271
271
  # @param rate_limit [Float] Requests per second
272
- # @return [Hash] The API response
272
+ # @return [Peddler::Response] The API response
273
273
  def get_unmanifested_shipments(body, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
274
274
  cannot_sandbox!
275
275
 
@@ -284,7 +284,7 @@ module Peddler
284
284
  # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
285
285
  # AmazonShipping_UK.
286
286
  # @param rate_limit [Float] Requests per second
287
- # @return [Hash] The API response
287
+ # @return [Peddler::Response] The API response
288
288
  def get_collection_form(collection_form_id, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
289
289
  cannot_sandbox!
290
290
 
@@ -302,7 +302,7 @@ module Peddler
302
302
  # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
303
303
  # AmazonShipping_UK.
304
304
  # @param rate_limit [Float] Requests per second
305
- # @return [Hash] The API response
305
+ # @return [Peddler::Response] The API response
306
306
  def get_access_points(access_point_types, country_code, postal_code, x_amzn_shipping_business_id: nil,
307
307
  rate_limit: 80.0)
308
308
  path = "/shipping/v2/accessPoints"
@@ -5,11 +5,11 @@ require "peddler/api"
5
5
  module Peddler
6
6
  class << self
7
7
  def solicitations_v1(...)
8
- API::SolicitationsV1.new(...)
8
+ APIs::SolicitationsV1.new(...)
9
9
  end
10
10
  end
11
11
 
12
- class API
12
+ module APIs
13
13
  # Selling Partner API for Solicitations
14
14
  #
15
15
  # With the Solicitations API you can build applications that send non-critical solicitations to buyers. You can get
@@ -30,7 +30,7 @@ module Peddler
30
30
  # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
31
31
  # order was placed. Only one marketplace can be specified.
32
32
  # @param rate_limit [Float] Requests per second
33
- # @return [Hash] The API response
33
+ # @return [Peddler::Response] The API response
34
34
  def get_solicitation_actions_for_order(amazon_order_id, marketplace_ids, rate_limit: 1.0)
35
35
  path = "/solicitations/v1/orders/#{amazon_order_id}"
36
36
  params = {
@@ -49,7 +49,7 @@ module Peddler
49
49
  # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
50
50
  # order was placed. Only one marketplace can be specified.
51
51
  # @param rate_limit [Float] Requests per second
52
- # @return [Hash] The API response
52
+ # @return [Peddler::Response] The API response
53
53
  def create_product_review_and_seller_feedback_solicitation(amazon_order_id, marketplace_ids, rate_limit: 1.0)
54
54
  path = "/solicitations/v1/orders/#{amazon_order_id}/solicitations/productReviewAndSellerFeedback"
55
55
  params = {
@@ -5,11 +5,11 @@ require "peddler/api"
5
5
  module Peddler
6
6
  class << self
7
7
  def supply_sources_2020_07_01(...)
8
- API::SupplySources20200701.new(...)
8
+ APIs::SupplySources20200701.new(...)
9
9
  end
10
10
  end
11
11
 
12
- class API
12
+ module APIs
13
13
  # Selling Partner API for Supply Sources
14
14
  #
15
15
  # Manage configurations and capabilities of seller supply sources.
@@ -20,7 +20,7 @@ module Peddler
20
20
  # @param next_page_token [String] The pagination token to retrieve a specific page of results.
21
21
  # @param page_size [Number] The number of supply sources to return per paginated request.
22
22
  # @param rate_limit [Float] Requests per second
23
- # @return [Hash] The API response
23
+ # @return [Peddler::Response] The API response
24
24
  def get_supply_sources(next_page_token: nil, page_size: 10, rate_limit: nil)
25
25
  path = "/supplySources/2020-07-01/supplySources"
26
26
  params = {
@@ -36,7 +36,7 @@ module Peddler
36
36
  # @note This operation can make a static sandbox call.
37
37
  # @param payload [Hash] A request to create a supply source.
38
38
  # @param rate_limit [Float] Requests per second
39
- # @return [Hash] The API response
39
+ # @return [Peddler::Response] The API response
40
40
  def create_supply_source(payload, rate_limit: nil)
41
41
  path = "/supplySources/2020-07-01/supplySources"
42
42
  body = payload
@@ -49,7 +49,7 @@ module Peddler
49
49
  # @note This operation can make a static sandbox call.
50
50
  # @param supply_source_id [String] The unique identifier of a supply source.
51
51
  # @param rate_limit [Float] Requests per second
52
- # @return [Hash] The API response
52
+ # @return [Peddler::Response] The API response
53
53
  def get_supply_source(supply_source_id, rate_limit: nil)
54
54
  path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}"
55
55
 
@@ -62,7 +62,7 @@ module Peddler
62
62
  # @param supply_source_id [String] The unique identitier of a supply source.
63
63
  # @param payload [Hash]
64
64
  # @param rate_limit [Float] Requests per second
65
- # @return [Hash] The API response
65
+ # @return [Peddler::Response] The API response
66
66
  def update_supply_source(supply_source_id, payload: nil, rate_limit: nil)
67
67
  path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}"
68
68
  body = payload
@@ -75,7 +75,7 @@ module Peddler
75
75
  # @note This operation can make a static sandbox call.
76
76
  # @param supply_source_id [String] The unique identifier of a supply source.
77
77
  # @param rate_limit [Float] Requests per second
78
- # @return [Hash] The API response
78
+ # @return [Peddler::Response] The API response
79
79
  def archive_supply_source(supply_source_id, rate_limit: nil)
80
80
  path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}"
81
81
 
@@ -88,7 +88,7 @@ module Peddler
88
88
  # @param supply_source_id [String] The unique identifier of a supply source.
89
89
  # @param payload [Hash]
90
90
  # @param rate_limit [Float] Requests per second
91
- # @return [Hash] The API response
91
+ # @return [Peddler::Response] The API response
92
92
  def update_supply_source_status(supply_source_id, payload: nil, rate_limit: nil)
93
93
  path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}/status"
94
94
  body = payload
@@ -5,11 +5,11 @@ require "peddler/api"
5
5
  module Peddler
6
6
  class << self
7
7
  def tokens_2021_03_01(...)
8
- API::Tokens20210301.new(...)
8
+ APIs::Tokens20210301.new(...)
9
9
  end
10
10
  end
11
11
 
12
- class API
12
+ module APIs
13
13
  # Selling Partner API for Tokens
14
14
  #
15
15
  # The Selling Partner API for Tokens provides a secure way to access a customer's PII (Personally Identifiable
@@ -27,7 +27,7 @@ module Peddler
27
27
  # @note This operation can make a static sandbox call.
28
28
  # @param body [Hash] The restricted data token request details.
29
29
  # @param rate_limit [Float] Requests per second
30
- # @return [Hash] The API response
30
+ # @return [Peddler::Response] The API response
31
31
  def create_restricted_data_token(body, rate_limit: 1.0)
32
32
  path = "/tokens/2021-03-01/restrictedDataToken"
33
33
 
@@ -5,11 +5,11 @@ require "peddler/api"
5
5
  module Peddler
6
6
  class << self
7
7
  def uploads_2020_11_01(...)
8
- API::Uploads20201101.new(...)
8
+ APIs::Uploads20201101.new(...)
9
9
  end
10
10
  end
11
11
 
12
- class API
12
+ module APIs
13
13
  # Selling Partner API for Uploads
14
14
  #
15
15
  # The Uploads API lets you upload files that you can programmatically access using other Selling Partner APIs, such
@@ -31,7 +31,7 @@ module Peddler
31
31
  # `/uploads/v1/uploadDestinations/aplus/2020-11-01/contentDocuments`.
32
32
  # @param content_type [String] The content type of the file to be uploaded.
33
33
  # @param rate_limit [Float] Requests per second
34
- # @return [Hash] The API response
34
+ # @return [Peddler::Response] The API response
35
35
  def create_upload_destination_for_resource(marketplace_ids, content_md5, resource, content_type: nil,
36
36
  rate_limit: 10.0)
37
37
  cannot_sandbox!
@@ -5,11 +5,11 @@ require "peddler/api"
5
5
  module Peddler
6
6
  class << self
7
7
  def vendor_direct_fulfillment_inventory_v1(...)
8
- API::VendorDirectFulfillmentInventoryV1.new(...)
8
+ APIs::VendorDirectFulfillmentInventoryV1.new(...)
9
9
  end
10
10
  end
11
11
 
12
- class API
12
+ module APIs
13
13
  # Selling Partner API for Direct Fulfillment Inventory Updates
14
14
  #
15
15
  # The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct
@@ -18,10 +18,10 @@ module Peddler
18
18
  # Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items.
19
19
  #
20
20
  # @note This operation can make a static sandbox call.
21
- # @param body [Hash] The request body that contains the inventory update data to submit.
21
+ # @param body [Hash] The request body containing the inventory update data to submit.
22
22
  # @param warehouse_id [String] Identifier for the warehouse for which to update inventory.
23
23
  # @param rate_limit [Float] Requests per second
24
- # @return [Hash] The API response
24
+ # @return [Peddler::Response] The API response
25
25
  def submit_inventory_update(body, warehouse_id, rate_limit: 10.0)
26
26
  path = "/vendor/directFulfillment/inventory/v1/warehouses/#{warehouse_id}/items"
27
27
 
@@ -5,11 +5,11 @@ require "peddler/api"
5
5
  module Peddler
6
6
  class << self
7
7
  def vendor_direct_fulfillment_orders_2021_12_28(...)
8
- API::VendorDirectFulfillmentOrders20211228.new(...)
8
+ APIs::VendorDirectFulfillmentOrders20211228.new(...)
9
9
  end
10
10
  end
11
11
 
12
- class API
12
+ module APIs
13
13
  # Selling Partner API for Direct Fulfillment Orders
14
14
  #
15
15
  # The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment
@@ -37,7 +37,7 @@ module Peddler
37
37
  # @param include_details [String] When true, returns the complete purchase order details. Otherwise, only purchase
38
38
  # order numbers are returned.
39
39
  # @param rate_limit [Float] Requests per second
40
- # @return [Hash] The API response
40
+ # @return [Peddler::Response] The API response
41
41
  def get_orders(created_after, created_before, ship_from_party_id: nil, status: nil, limit: nil, sort_order: nil,
42
42
  next_token: nil, include_details: "true", rate_limit: 10.0)
43
43
  path = "/vendor/directFulfillment/orders/2021-12-28/purchaseOrders"
@@ -61,7 +61,7 @@ module Peddler
61
61
  # @param purchase_order_number [String] The order identifier for the purchase order that you want. Formatting
62
62
  # Notes: alpha-numeric code.
63
63
  # @param rate_limit [Float] Requests per second
64
- # @return [Hash] The API response
64
+ # @return [Peddler::Response] The API response
65
65
  def get_order(purchase_order_number, rate_limit: 10.0)
66
66
  path = "/vendor/directFulfillment/orders/2021-12-28/purchaseOrders/#{purchase_order_number}"
67
67
 
@@ -73,7 +73,7 @@ module Peddler
73
73
  # @note This operation can make a dynamic sandbox call.
74
74
  # @param body [Hash] The request body containing the acknowledgement to an order
75
75
  # @param rate_limit [Float] Requests per second
76
- # @return [Hash] The API response
76
+ # @return [Peddler::Response] The API response
77
77
  def submit_acknowledgement(body, rate_limit: 10.0)
78
78
  path = "/vendor/directFulfillment/orders/2021-12-28/acknowledgements"
79
79
 
@@ -5,11 +5,11 @@ require "peddler/api"
5
5
  module Peddler
6
6
  class << self
7
7
  def vendor_direct_fulfillment_orders_v1(...)
8
- API::VendorDirectFulfillmentOrdersV1.new(...)
8
+ APIs::VendorDirectFulfillmentOrdersV1.new(...)
9
9
  end
10
10
  end
11
11
 
12
- class API
12
+ module APIs
13
13
  # Selling Partner API for Direct Fulfillment Orders
14
14
  #
15
15
  # The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment
@@ -37,7 +37,7 @@ module Peddler
37
37
  # @param include_details [String] When true, returns the complete purchase order details. Otherwise, only purchase
38
38
  # order numbers are returned.
39
39
  # @param rate_limit [Float] Requests per second
40
- # @return [Hash] The API response
40
+ # @return [Peddler::Response] The API response
41
41
  def get_orders(created_after, created_before, ship_from_party_id: nil, status: nil, limit: nil, sort_order: nil,
42
42
  next_token: nil, include_details: "true", rate_limit: 10.0)
43
43
  path = "/vendor/directFulfillment/orders/v1/purchaseOrders"
@@ -61,7 +61,7 @@ module Peddler
61
61
  # @param purchase_order_number [String] The order identifier for the purchase order that you want. Formatting
62
62
  # Notes: alpha-numeric code.
63
63
  # @param rate_limit [Float] Requests per second
64
- # @return [Hash] The API response
64
+ # @return [Peddler::Response] The API response
65
65
  def get_order(purchase_order_number, rate_limit: 10.0)
66
66
  path = "/vendor/directFulfillment/orders/v1/purchaseOrders/#{purchase_order_number}"
67
67
 
@@ -71,9 +71,9 @@ module Peddler
71
71
  # Submits acknowledgements for one or more purchase orders.
72
72
  #
73
73
  # @note This operation can make a static sandbox call.
74
- # @param body [Hash] The request body that contains the order acknowledgement.
74
+ # @param body [Hash] The request body containing the acknowledgement to an order.
75
75
  # @param rate_limit [Float] Requests per second
76
- # @return [Hash] The API response
76
+ # @return [Peddler::Response] The API response
77
77
  def submit_acknowledgement(body, rate_limit: 10.0)
78
78
  path = "/vendor/directFulfillment/orders/v1/acknowledgements"
79
79
 
@@ -5,11 +5,11 @@ require "peddler/api"
5
5
  module Peddler
6
6
  class << self
7
7
  def vendor_direct_fulfillment_payments_v1(...)
8
- API::VendorDirectFulfillmentPaymentsV1.new(...)
8
+ APIs::VendorDirectFulfillmentPaymentsV1.new(...)
9
9
  end
10
10
  end
11
11
 
12
- class API
12
+ module APIs
13
13
  # Selling Partner API for Direct Fulfillment Payments
14
14
  #
15
15
  # The Selling Partner API for Direct Fulfillment Payments provides programmatic access to a direct fulfillment
@@ -18,9 +18,9 @@ module Peddler
18
18
  # Submits one or more invoices for a vendor's direct fulfillment orders.
19
19
  #
20
20
  # @note This operation can make a static sandbox call.
21
- # @param body [Hash] The request body that contains one or more invoices for vendor orders.
21
+ # @param body [Hash] The request body containing one or more invoices for vendor orders.
22
22
  # @param rate_limit [Float] Requests per second
23
- # @return [Hash] The API response
23
+ # @return [Peddler::Response] The API response
24
24
  def submit_invoice(body, rate_limit: 10.0)
25
25
  path = "/vendor/directFulfillment/payments/v1/invoices"
26
26
 
@@ -5,11 +5,11 @@ require "peddler/api"
5
5
  module Peddler
6
6
  class << self
7
7
  def vendor_direct_fulfillment_sandbox_test_data_2021_10_28(...)
8
- API::VendorDirectFulfillmentSandboxTestData20211028.new(...)
8
+ APIs::VendorDirectFulfillmentSandboxTestData20211028.new(...)
9
9
  end
10
10
  end
11
11
 
12
- class API
12
+ module APIs
13
13
  # Selling Partner API for Vendor Direct Fulfillment Sandbox Test Data
14
14
  #
15
15
  # The Selling Partner API for Vendor Direct Fulfillment Sandbox Test Data provides programmatic access to vendor
@@ -18,23 +18,23 @@ module Peddler
18
18
  # Submits a request to generate test order data for Vendor Direct Fulfillment API entities.
19
19
  #
20
20
  # @note This operation can make a dynamic sandbox call.
21
- # @param body [Hash] The request payload that contain parameters to generate test order data scenarios.
21
+ # @param body [Hash] The request payload containing parameters for generating test order data scenarios.
22
22
  # @param rate_limit [Float] Requests per second
23
- # @return [Hash] The API response
23
+ # @return [Peddler::Response] The API response
24
24
  def generate_order_scenarios(body, rate_limit: nil)
25
25
  path = "/vendor/directFulfillment/sandbox/2021-10-28/orders"
26
26
 
27
27
  post(path, body:)
28
28
  end
29
29
 
30
- # Retrieves the transaction status identified by the specified `transactionId`, and returns the requested test
31
- # order data if the transaction is successful.
30
+ # Returns the status of the transaction indicated by the specified transactionId. If the transaction was
31
+ # successful, also returns the requested test order data.
32
32
  #
33
33
  # @note This operation can make a dynamic sandbox call.
34
- # @param transaction_id [String] The transaction identifier returned in the response for the
35
- # `generateOrderScenarios` operation.
34
+ # @param transaction_id [String] The transaction identifier returned in the response to the generateOrderScenarios
35
+ # operation.
36
36
  # @param rate_limit [Float] Requests per second
37
- # @return [Hash] The API response
37
+ # @return [Peddler::Response] The API response
38
38
  def get_order_scenarios(transaction_id, rate_limit: nil)
39
39
  path = "/vendor/directFulfillment/sandbox/2021-10-28/transactions/#{transaction_id}"
40
40