peddler 5.3.1 → 5.4.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 (114) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +55 -11
  3. data/lib/peddler/api.rb +3 -3
  4. data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/address.rb +4 -1
  5. data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/distance.rb +20 -0
  6. data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/geocodes.rb +23 -0
  7. data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/handover_location.rb +23 -0
  8. data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/ship_label_metadata.rb +4 -0
  9. data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/shipment_info.rb +3 -0
  10. data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/shipping_options.rb +4 -0
  11. data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11.rb +1 -1
  12. data/lib/peddler/apis/feeds_2021_06_30.rb +8 -2
  13. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/amount.rb +2 -2
  14. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/delivery_document.rb +2 -2
  15. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/delivery_information.rb +2 -1
  16. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/delivery_preferences.rb +1 -1
  17. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/delivery_window.rb +3 -4
  18. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/drop_off_location.rb +9 -7
  19. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/feature_settings.rb +5 -1
  20. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/feature_sku.rb +1 -1
  21. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_order.rb +2 -2
  22. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_preview_shipment.rb +6 -6
  23. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_shipment_package.rb +3 -4
  24. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/get_feature_inventory_response.rb +1 -1
  25. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/get_feature_sku_result.rb +12 -3
  26. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/origin.rb +2 -1
  27. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/tracking_event.rb +1 -2
  28. data/lib/peddler/apis/orders_2026_01_01/associated_order_item.rb +27 -0
  29. data/lib/peddler/apis/orders_2026_01_01/item_packing.rb +3 -0
  30. data/lib/peddler/apis/orders_2026_01_01/item_picking.rb +1 -1
  31. data/lib/peddler/apis/orders_2026_01_01/item_proceeds_detailed_breakdown.rb +1 -1
  32. data/lib/peddler/apis/orders_2026_01_01/item_tax.rb +20 -0
  33. data/lib/peddler/apis/orders_2026_01_01/item_tax_calculation_breakdown.rb +21 -0
  34. data/lib/peddler/apis/orders_2026_01_01/item_tax_collection.rb +24 -0
  35. data/lib/peddler/apis/orders_2026_01_01/order.rb +8 -1
  36. data/lib/peddler/apis/orders_2026_01_01/order_item.rb +7 -0
  37. data/lib/peddler/apis/orders_2026_01_01/order_payment.rb +17 -0
  38. data/lib/peddler/apis/orders_2026_01_01/order_tax.rb +20 -0
  39. data/lib/peddler/apis/orders_2026_01_01/order_tax_invoicing.rb +34 -0
  40. data/lib/peddler/apis/orders_2026_01_01/order_tax_registration.rb +39 -0
  41. data/lib/peddler/apis/orders_2026_01_01/package_status.rb +4 -3
  42. data/lib/peddler/apis/orders_2026_01_01/pagination.rb +5 -5
  43. data/lib/peddler/apis/orders_2026_01_01/payment_execution.rb +39 -0
  44. data/lib/peddler/apis/orders_2026_01_01/search_orders_response.rb +10 -11
  45. data/lib/peddler/apis/orders_2026_01_01/serial_number_requirement.rb +19 -0
  46. data/lib/peddler/apis/orders_2026_01_01/tax_registration_attribute.rb +22 -0
  47. data/lib/peddler/apis/orders_2026_01_01.rb +15 -13
  48. data/lib/peddler/apis/orders_v0/address.rb +3 -3
  49. data/lib/peddler/apis/orders_v0/address_extended_fields.rb +9 -2
  50. data/lib/peddler/apis/orders_v0/buyer_info.rb +3 -0
  51. data/lib/peddler/apis/orders_v0/geo_coordinates.rb +20 -0
  52. data/lib/peddler/apis/orders_v0/order_buyer_info.rb +3 -0
  53. data/lib/peddler/apis/orders_v0.rb +6 -2
  54. data/lib/peddler/apis/product_pricing_2022_05_01/competitive_summary_response_body.rb +3 -0
  55. data/lib/peddler/apis/product_pricing_2022_05_01/item.rb +17 -0
  56. data/lib/peddler/apis/product_pricing_2022_05_01/points.rb +1 -1
  57. data/lib/peddler/apis/product_pricing_2022_05_01/similar_items.rb +17 -0
  58. data/lib/peddler/apis/replenishment_2022_11_07/deliveries_condition.rb +22 -0
  59. data/lib/peddler/apis/replenishment_2022_11_07/forecast_deliveries.rb +26 -0
  60. data/lib/peddler/apis/replenishment_2022_11_07/get_selling_partner_metrics_request.rb +3 -3
  61. data/lib/peddler/apis/replenishment_2022_11_07/get_selling_partner_metrics_response_metric.rb +5 -1
  62. data/lib/peddler/apis/replenishment_2022_11_07/list_offer_metrics_request_filters.rb +1 -1
  63. data/lib/peddler/apis/replenishment_2022_11_07/list_offer_metrics_response_offer.rb +30 -23
  64. data/lib/peddler/apis/replenishment_2022_11_07/list_offers_request_filters.rb +7 -3
  65. data/lib/peddler/apis/replenishment_2022_11_07/list_offers_response_offer.rb +27 -1
  66. data/lib/peddler/apis/replenishment_2022_11_07/offer_program_configuration.rb +1 -1
  67. data/lib/peddler/apis/replenishment_2022_11_07/time_interval.rb +1 -1
  68. data/lib/peddler/apis/reports_2021_06_30.rb +8 -2
  69. data/lib/peddler/apis/seller_wallet_2024_03_01/balance.rb +6 -6
  70. data/lib/peddler/apis/seller_wallet_2024_03_01/balance_listing.rb +2 -2
  71. data/lib/peddler/apis/seller_wallet_2024_03_01/bank_account.rb +5 -5
  72. data/lib/peddler/apis/seller_wallet_2024_03_01/bank_account_listing.rb +2 -2
  73. data/lib/peddler/apis/seller_wallet_2024_03_01/delete_transfer_schedule.rb +3 -2
  74. data/lib/peddler/apis/seller_wallet_2024_03_01/fee.rb +4 -7
  75. data/lib/peddler/apis/seller_wallet_2024_03_01/fx_rate_details.rb +6 -6
  76. data/lib/peddler/apis/seller_wallet_2024_03_01/payee_contact_information.rb +5 -5
  77. data/lib/peddler/apis/seller_wallet_2024_03_01/payment_preference.rb +2 -3
  78. data/lib/peddler/apis/seller_wallet_2024_03_01/schedule_expression.rb +4 -5
  79. data/lib/peddler/apis/seller_wallet_2024_03_01/transaction.rb +13 -14
  80. data/lib/peddler/apis/seller_wallet_2024_03_01/transaction_account.rb +8 -8
  81. data/lib/peddler/apis/seller_wallet_2024_03_01/transaction_initiation_request.rb +8 -7
  82. data/lib/peddler/apis/seller_wallet_2024_03_01/transaction_instrument_details.rb +6 -7
  83. data/lib/peddler/apis/seller_wallet_2024_03_01/transaction_listing.rb +6 -5
  84. data/lib/peddler/apis/seller_wallet_2024_03_01/transfer_rate_preview.rb +4 -3
  85. data/lib/peddler/apis/seller_wallet_2024_03_01/transfer_schedule.rb +11 -12
  86. data/lib/peddler/apis/seller_wallet_2024_03_01/transfer_schedule_failures.rb +3 -3
  87. data/lib/peddler/apis/seller_wallet_2024_03_01/transfer_schedule_information.rb +5 -6
  88. data/lib/peddler/apis/seller_wallet_2024_03_01/transfer_schedule_listing.rb +6 -5
  89. data/lib/peddler/apis/seller_wallet_2024_03_01/transfer_schedule_request.rb +11 -13
  90. data/lib/peddler/apis/seller_wallet_2024_03_01.rb +30 -28
  91. data/lib/peddler/apis/services_v1/money_amount.rb +20 -0
  92. data/lib/peddler/apis/services_v1/payment.rb +20 -0
  93. data/lib/peddler/apis/services_v1/service_job.rb +3 -0
  94. data/lib/peddler/apis/services_v1.rb +1 -1
  95. data/lib/peddler/apis/shipment_invoicing_v0/payment_information.rb +6 -6
  96. data/lib/peddler/apis/shipment_invoicing_v0/payment_information_list.rb +1 -1
  97. data/lib/peddler/data_kiosk/economics20240315.json +6 -6
  98. data/lib/peddler/data_kiosk/sales_and_traffic20231115.json +6 -6
  99. data/lib/peddler/data_kiosk/sales_and_traffic20240424.json +6 -6
  100. data/lib/peddler/data_kiosk/vendor_analytics20240930.json +6 -6
  101. data/lib/peddler/errors.rb +1 -0
  102. data/lib/peddler/version.rb +1 -1
  103. data/sig/peddler/api.rbs +1 -1
  104. data/sig/peddler/apis/external_fulfillment_shipments_2024_09_11.rbs +85 -28
  105. data/sig/peddler/apis/feeds_2021_06_30.rbs +1 -1
  106. data/sig/peddler/apis/fulfillment_outbound_2020_07_01.rbs +11 -8
  107. data/sig/peddler/apis/orders_2026_01_01.rbs +220 -23
  108. data/sig/peddler/apis/orders_v0.rbs +42 -22
  109. data/sig/peddler/apis/product_pricing_2022_05_01.rbs +40 -7
  110. data/sig/peddler/apis/replenishment_2022_11_07.rbs +76 -28
  111. data/sig/peddler/apis/reports_2021_06_30.rbs +1 -1
  112. data/sig/peddler/apis/services_v1.rbs +42 -7
  113. data/sig/peddler/errors.rbs +3 -0
  114. metadata +32 -5
@@ -9,26 +9,26 @@ module Peddler
9
9
  class SellerWallet20240301
10
10
  # Details of the bank account involved in the transaction.
11
11
  TransactionAccount = Structure.new do
12
- # @return [String] The currency code in ISO 4217 format
12
+ # @return [String] The currency code in ISO 4217 format.
13
13
  attribute(:bank_account_currency, String, null: false, from: "bankAccountCurrency")
14
14
 
15
- # @return [String] Bank account format
15
+ # @return [String] The format for the bank account number.
16
16
  attribute(:bank_account_number_format, String, null: false, from: "bankAccountNumberFormat")
17
17
 
18
- # @return [String] The name of the bank
18
+ # @return [String] The name of the bank.
19
19
  attribute(:bank_name, String, null: false, from: "bankName")
20
20
 
21
- # @return [String] The unique identifier provided by Amazon to identify the account
21
+ # @return [String] The unique identifier provided by Amazon to identify the account.
22
22
  attribute?(:account_id, String, from: "accountId")
23
23
 
24
- # @return [String] The two digit country code, in ISO 3166 format. This field is OPTIONAL for
25
- # transactionSourceAccount object but is MANDATORY field for transactionDestinationAccount
24
+ # @return [String] The two-digit country code, in ISO 3166 format. This field is optional for
25
+ # `transactionSourceAccount`, but is mandatory for `transactionDestinationAccount`.
26
26
  attribute?(:bank_account_country_code, String, from: "bankAccountCountryCode")
27
27
 
28
- # @return [String] BankAccount holder's name
28
+ # @return [String] The account holder's name.
29
29
  attribute?(:bank_account_holder_name, String, from: "bankAccountHolderName")
30
30
 
31
- # @return [String] Last 3 digit of the bank account number
31
+ # @return [String] The last three digits of the bank account number.
32
32
  attribute?(:bank_account_number_tail, String, from: "bankAccountNumberTail")
33
33
  end
34
34
  end
@@ -8,16 +8,18 @@ require "time"
8
8
  module Peddler
9
9
  module APIs
10
10
  class SellerWallet20240301
11
- # Request body to initiate a transaction from a SW bank account to another customer defined bank account
11
+ # Request body to initiate a transaction from a Seller Wallet bank account to another customer-defined bank
12
+ # account.
12
13
  TransactionInitiationRequest = Structure.new do
13
- # @return [TransactionInstrumentDetails] Destination bank account details of the transaction request
14
+ # @return [TransactionInstrumentDetails] Details of the destination bank account in the transaction request.
14
15
  attribute(:destination_transaction_instrument, TransactionInstrumentDetails, null: false, from: "destinationTransactionInstrument")
15
16
 
16
- # @return [Time] The transaction initiation request time in date-time format
17
+ # @return [Time] The time at which the transaction was initiated in [ISO 8601 date time
18
+ # format](https://developer-docs.amazon.com/sp-api/docs/iso-8601).
17
19
  attribute(:request_time, Time, null: false, from: "requestTime")
18
20
 
19
- # @return [String] The unique identifier of the source Amazon SW bank account from where the money needs to be
20
- # debited
21
+ # @return [String] The unique identifier of the source Amazon Seller Wallet bank account from which the money is
22
+ # debited.
21
23
  attribute(:source_account_id, String, null: false, from: "sourceAccountId")
22
24
 
23
25
  # @return [Money] The transaction amount in the source account's currency format. Requests that use a currency
@@ -29,8 +31,7 @@ module Peddler
29
31
  # sensitive information other than VAT-ID.
30
32
  attribute?(:customer_payment_reference, String, from: "customerPaymentReference")
31
33
 
32
- # @return [String] Optional field to specify the unique identifier of the destination bank account where the
33
- # money needs to be deposited
34
+ # @return [String] The unique identifier of the destination bank account where the money is deposited.
34
35
  attribute?(:destination_account_id, String, from: "destinationAccountId")
35
36
 
36
37
  # @return [PayeeContactInformation] The contact information of a payee.
@@ -7,9 +7,7 @@ require "structure"
7
7
  module Peddler
8
8
  module APIs
9
9
  class SellerWallet20240301
10
- # Request body to create transaction instrument, Amazon performs validation and screening (anti-money laundering
11
- # measuers) on all the transaction instruments before executing a transaction thus it requires transaction
12
- # instrument holder's contact details as well
10
+ # Details of the destination bank account in the transaction request.
13
11
  TransactionInstrumentDetails = Structure.new do
14
12
  # @return [String] The bank account holder's name (expected to be an Amazon customer).
15
13
  #
@@ -17,12 +15,13 @@ module Peddler
17
15
  # `destAccountDigitalSignature`, and should not be included in the request signature.
18
16
  attribute(:account_holder_name, String, null: false, from: "accountHolderName")
19
17
 
20
- # @return [BankAccount] Specifies the destination bank account details where the money needs to be deposited
18
+ # @return [BankAccount] Details of the destination bank account.
21
19
  attribute(:bank_account, BankAccount, null: false, from: "bankAccount")
22
20
 
23
- # @return [String] This field would be used to populate the bank account number of the destination payment
24
- # method. The field is intentionally not included in any other Schemas since Amazon internal systems will
25
- # never receive it in unencrypted format, so field won't be part of the request signature
21
+ # @return [String] The bank account number of the destination payment method.
22
+ #
23
+ # **Note:** This field is encrypted before Amazon receives it, so should not be used to generate
24
+ # `destAccountDigitalSignature`, and should not be included in the request signature.
26
25
  attribute(:bank_account_number, String, null: false, from: "bankAccountNumber")
27
26
  end
28
27
  end
@@ -7,14 +7,15 @@ require "structure"
7
7
  module Peddler
8
8
  module APIs
9
9
  class SellerWallet20240301
10
- # Struct that holds collection of transactions.
10
+ # A list of transactions.
11
11
  TransactionListing = Structure.new do
12
- # @return [Array<Transaction>] Collection that holds Transaction
12
+ # @return [Array<Transaction>] A list of transactions.
13
13
  attribute(:transactions, [Transaction], null: false)
14
14
 
15
- # @return [String] If present, use this pagination token to retrieve the next page of supply sources, if not
16
- # provided the API will return same response. The field will only be provided when the list is greater than
17
- # 100.
15
+ # @return [String] A token that you use to retrieve the next page of results. The response includes
16
+ # `nextPageToken` when the number of results exceeds 100. To get the next page of results, call the operation
17
+ # with this token and include the same arguments as the call that produced the token. To get a complete list,
18
+ # call this operation until `nextPageToken` is null. Note that this operation can return empty pages.
18
19
  attribute?(:next_page_token, String, from: "nextPageToken")
19
20
  end
20
21
  end
@@ -18,16 +18,17 @@ module Peddler
18
18
  # In the preceding expressions, **fees** is equal to the sum of all `feeAmount.currencyAmount` values in the
19
19
  # `fees` array.
20
20
  TransferRatePreview = Structure.new do
21
- # @return [Money] Base amount of the transaction.
21
+ # @return [Money] The base amount of the transaction.
22
22
  attribute(:base_amount, Money, null: false, from: "baseAmount")
23
23
 
24
- # @return [Array<Fee>] List of fees
24
+ # @return [Array<Fee>] A list of fees.
25
25
  attribute(:fees, [Fee], null: false)
26
26
 
27
27
  # @return [FxRateDetails] The foreign exchange rate value of the transaction.
28
28
  attribute(:fx_rate_details, FxRateDetails, null: false, from: "fxRateDetails")
29
29
 
30
- # @return [Money] The final amount reflects both the fee deduction and currency conversion rate exchange
30
+ # @return [Money] The final amount transferred, which includes both the fee deduction and currency conversion
31
+ # rate.
31
32
  attribute(:transfer_amount, Money, null: false, from: "transferAmount")
32
33
  end
33
34
  end
@@ -9,33 +9,32 @@ module Peddler
9
9
  class SellerWallet20240301
10
10
  # Transfer schedule details and related historical details.
11
11
  TransferSchedule = Structure.new do
12
- # @return [TransactionAccount] Destination bank account details in the scheduled transfer. Here
13
- # bankAccountCountryCode is a MANDATORY field
12
+ # @return [TransactionAccount] Details of the destination bank account in the scheduled transfer. Here
13
+ # `bankAccountCountryCode` is a required field.
14
14
  attribute(:transaction_destination_account, TransactionAccount, null: false, from: "transactionDestinationAccount")
15
15
 
16
- # @return [String] Type of the transfer
16
+ # @return [String] The type of transfer.
17
17
  attribute(:transaction_type, String, null: false, from: "transactionType")
18
18
 
19
- # @return [Array<TransferScheduleFailures>] Collection that holds Transfer Schedules that has been cancelled or
20
- # failed due to certain reasons.
19
+ # @return [Array<TransferScheduleFailures>] A list of transfer schedule failures.
21
20
  attribute(:transfer_schedule_failures, [TransferScheduleFailures], null: false, from: "transferScheduleFailures")
22
21
 
23
- # @return [String] The unique identifier provided by Amazon to the scheduled transfer
22
+ # @return [String] The unique identifier provided by Amazon to the scheduled transfer.
24
23
  attribute(:transfer_schedule_id, String, null: false, from: "transferScheduleId")
25
24
 
26
- # @return [TransferScheduleInformation] Fields required for the scheduled transfer. This information can be
27
- # modified when updating a transfer schedule.
25
+ # @return [TransferScheduleInformation] The fields required for the scheduled transfer. This information can be
26
+ # modified when you update a transfer schedule.
28
27
  attribute(:transfer_schedule_information, TransferScheduleInformation, null: false, from: "transferScheduleInformation")
29
28
 
30
- # @return [String] Type of the transfer schedule. This information can be modified when updating a transfer
29
+ # @return [String] The type of transfer schedule. This information can be modified when you update a transfer
31
30
  # schedule.
32
31
  attribute(:transfer_schedule_status, String, null: false, from: "transferScheduleStatus")
33
32
 
34
- # @return [PaymentPreference] Payment preference of the scheduled transfer. This information can be modified
35
- # when updating a transfer schedule.
33
+ # @return [PaymentPreference] The payment preference of the scheduled transfer. This information can be modified
34
+ # when you update a transfer schedule.
36
35
  attribute?(:payment_preference, PaymentPreference, from: "paymentPreference")
37
36
 
38
- # @return [TransactionAccount] Source bank account details in the scheduled transfer
37
+ # @return [TransactionAccount] Details of the source bank account in the scheduled transfer.
39
38
  attribute?(:transaction_source_account, TransactionAccount, from: "transactionSourceAccount")
40
39
  end
41
40
  end
@@ -8,12 +8,12 @@ require "time"
8
8
  module Peddler
9
9
  module APIs
10
10
  class SellerWallet20240301
11
- # Specifies the balance amount in the Amazon SW bank account
11
+ # The time of and reason for the transfer schedule failure.
12
12
  TransferScheduleFailures = Structure.new do
13
- # @return [Time] The transfer schedule cancellation date
13
+ # @return [Time] The transfer schedule failure date.
14
14
  attribute(:transfer_schedule_failure_date, Time, null: false, from: "transferScheduleFailureDate")
15
15
 
16
- # @return [String] The statement/reasoning listed for the cancellation of the transfer schedule
16
+ # @return [String] The reason listed for the failure of the transfer schedule.
17
17
  attribute(:transfer_schedule_failure_reason, String, null: false, from: "transferScheduleFailureReason")
18
18
  end
19
19
  end
@@ -8,19 +8,18 @@ require "time"
8
8
  module Peddler
9
9
  module APIs
10
10
  class SellerWallet20240301
11
- # Parameters containing information required for initiating a schedule transfer
11
+ # Mandatory information for initiating a schedule transfer.
12
12
  TransferScheduleInformation = Structure.new do
13
- # @return [Time] Field to specify end date of the scheduled transfer
13
+ # @return [Time] The end date of the scheduled transfer.
14
14
  attribute?(:schedule_end_date, Time, from: "scheduleEndDate")
15
15
 
16
- # @return [ScheduleExpression] Field to specify expression for how often the schedule transfer repeats. Refer to
17
- # this documentation: https://docs.aws.amazon.com/scheduler/latest/APIReference/API_CreateSchedule.html
16
+ # @return [ScheduleExpression] How often the scheduled transfer repeats.
18
17
  attribute?(:schedule_expression, ScheduleExpression, from: "scheduleExpression")
19
18
 
20
- # @return [Time] Field to specify start date of the scheduled transfer
19
+ # @return [Time] The start date of the scheduled transfer.
21
20
  attribute?(:schedule_start_date, Time, from: "scheduleStartDate")
22
21
 
23
- # @return [String] Field to specify type of the transfer being scheduled
22
+ # @return [String] The type of schedule.
24
23
  attribute?(:schedule_type, String, from: "scheduleType")
25
24
  end
26
25
  end
@@ -7,14 +7,15 @@ require "structure"
7
7
  module Peddler
8
8
  module APIs
9
9
  class SellerWallet20240301
10
- # Struct that holds collection of transfer schedules.
10
+ # A list of transfer schedules.
11
11
  TransferScheduleListing = Structure.new do
12
- # @return [Array<TransferSchedule>] Collection that holds list of Transfer Schedules
12
+ # @return [Array<TransferSchedule>] A list of transfer schedules.
13
13
  attribute(:transfer_schedules, [TransferSchedule], null: false, from: "transferSchedules")
14
14
 
15
- # @return [String] If present, use this pagination token to retrieve the next page of supply sources, if not
16
- # provided the API will return same response. The field will only be provided when the list is greater than
17
- # 100.
15
+ # @return [String] A token that you use to retrieve the next page of results. The response includes
16
+ # `nextPageToken` when the number of results exceeds 100. To get the next page of results, call the operation
17
+ # with this token and include the same arguments as the call that produced the token. To get a complete list,
18
+ # call this operation until `nextPageToken` is null. Note that this operation can return empty pages.
18
19
  attribute?(:next_page_token, String, from: "nextPageToken")
19
20
  end
20
21
  end
@@ -7,34 +7,32 @@ require "structure"
7
7
  module Peddler
8
8
  module APIs
9
9
  class SellerWallet20240301
10
- # Request body to initiate a scheduled transfer from a SW bank account to another customer defined bank account
10
+ # Request body to initiate a scheduled transfer from a Seller Wallet bank account to another customer-defined bank
11
+ # account.
11
12
  TransferScheduleRequest = Structure.new do
12
- # @return [String] Optional field to specify the unique identifier of the destination bank account where the
13
- # money needs to be deposited
13
+ # @return [String] The unique identifier of the destination bank account where the money is deposited.
14
14
  attribute(:destination_account_id, String, null: false, from: "destinationAccountId")
15
15
 
16
- # @return [TransactionInstrumentDetails] Destination bank account details of the transaction request
16
+ # @return [TransactionInstrumentDetails] Details of the destination bank account in the transaction request.
17
17
  attribute(:destination_transaction_instrument, TransactionInstrumentDetails, null: false, from: "destinationTransactionInstrument")
18
18
 
19
- # @return [PaymentPreference] Payment preference of the scheduled transfer
19
+ # @return [PaymentPreference] The payment preference of the scheduled transfer.
20
20
  attribute(:payment_preference, PaymentPreference, null: false, from: "paymentPreference")
21
21
 
22
- # @return [String] The unique identifier of the source Amazon SW bank account from where the money needs to be
23
- # debited
22
+ # @return [String] The unique identifier of the source Amazon Seller Wallet bank account from which money is
23
+ # debited.
24
24
  attribute(:source_account_id, String, null: false, from: "sourceAccountId")
25
25
 
26
- # @return [String] Represents 3 letter currency code in ISO 4217 standard format of the source payment method
27
- # country
26
+ # @return [String] The three-letter currency code of the source payment method country, in ISO 4217 format.
28
27
  attribute(:source_currency_code, String, null: false, from: "sourceCurrencyCode")
29
28
 
30
- # @return [String] Type of the scheduled transaction
29
+ # @return [String] The type of the scheduled transaction.
31
30
  attribute(:transaction_type, String, null: false, from: "transactionType")
32
31
 
33
- # @return [TransferScheduleInformation] Fields required for the scheduled transfer
32
+ # @return [TransferScheduleInformation] The configuration of the scheduled transfer.
34
33
  attribute(:transfer_schedule_information, TransferScheduleInformation, null: false, from: "transferScheduleInformation")
35
34
 
36
- # @return [String] Type of the transaction schedule which is mandatory field in request body if a transfer
37
- # schedule needs to be updated
35
+ # @return [String] The type of transaction schedule. This field is required when you update a transfer schedule.
38
36
  attribute?(:transfer_schedule_status, String, from: "transferScheduleStatus")
39
37
  end
40
38
  end
@@ -4,10 +4,7 @@
4
4
 
5
5
  module Peddler
6
6
  module APIs
7
- # The Selling Partner API for Amazon Seller Wallet Open Banking API Spec.
8
- #
9
- # For more information, refer to the [Seller Wallet Open Banking API Use Case
10
- # Guide](doc:seller-wallet-open-banking-api-v2024-03-01-use-case-guide).
7
+ # The Selling Partner API for Amazon Seller Wallet Open Banking API
11
8
  #
12
9
  # The Selling Partner API for Seller Wallet (Seller Wallet API) provides financial information that is relevant to a
13
10
  # seller's Seller Wallet account. You can obtain financial events, balances, and transfer schedules for Seller
@@ -18,7 +15,9 @@ module Peddler
18
15
  # Get Seller Wallet accounts for a seller.
19
16
  #
20
17
  # @note This operation can make a static sandbox call.
21
- # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace for which items are returned.
18
+ # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally
19
+ # unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace
20
+ # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
22
21
  # @return [Peddler::Response] The API response
23
22
  def list_accounts(marketplace_id)
24
23
  path = "/finances/transfers/wallet/2024-03-01/accounts"
@@ -32,7 +31,7 @@ module Peddler
32
31
  # Retrieve a Seller Wallet bank account by Amazon account identifier.
33
32
  #
34
33
  # @note This operation can make a static sandbox call.
35
- # @param account_id [String] ID of the Amazon SW account
34
+ # @param account_id [String] The ID of the Amazon Seller Wallet account.
36
35
  # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally
37
36
  # unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace
38
37
  # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
@@ -49,7 +48,7 @@ module Peddler
49
48
  # Retrieve the balance in a given Seller Wallet bank account.
50
49
  #
51
50
  # @note This operation can make a static sandbox call.
52
- # @param account_id [String] ID of the Amazon SW account
51
+ # @param account_id [String] The ID of the Amazon Seller Wallet account.
53
52
  # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally
54
53
  # unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace
55
54
  # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
@@ -63,19 +62,15 @@ module Peddler
63
62
  get(path, params:, parser:)
64
63
  end
65
64
 
66
- # Returns list of potential fees on a transaction based on the source and destination country currency code
65
+ # Retrieve a list of potential fees on a transaction.
67
66
  #
68
67
  # @note This operation can make a static sandbox call.
69
- # @param source_country_code [String] Represents 2 character country code of source transaction account in ISO
70
- # 3166 standard format.
71
- # @param source_currency_code [String] Represents 3 letter currency code in ISO 4217 standard format of the source
72
- # transaction country.
73
- # @param destination_country_code [String] Represents 2 character country code of destination transaction account
74
- # in ISO 3166 standard format.
75
- # @param destination_currency_code [String] Represents 3 letter currency code in ISO 4217 standard format of the
76
- # destination transaction country.
77
- # @param base_amount [Number] Represents the base transaction amount without any markup fees, rates that will be
78
- # used to get the transfer preview.
68
+ # @param source_country_code [String] Country code of the source transaction account in ISO 3166 format.
69
+ # @param source_currency_code [String] Currency code of the source transaction country in ISO 4217 format.
70
+ # @param destination_country_code [String] Country code of the destination transaction account in ISO 3166 format.
71
+ # @param destination_currency_code [String] Currency code of the destination transaction country in ISO 4217
72
+ # format.
73
+ # @param base_amount [Number] The base transaction amount without any markup fees.
79
74
  # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally
80
75
  # unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace
81
76
  # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
@@ -98,8 +93,11 @@ module Peddler
98
93
  # Retrieve a list of transactions for a given Seller Wallet bank account.
99
94
  #
100
95
  # @note This operation can make a static sandbox call.
101
- # @param account_id [String] ID of the Amazon SW account
102
- # @param next_page_token [String] Pagination token to retrieve a specific page of results.
96
+ # @param account_id [String] The ID of the Amazon Seller Wallet account.
97
+ # @param next_page_token [String] A token that you use to retrieve the next page of results. The response includes
98
+ # `nextPageToken` when the number of results exceeds 100. To get the next page of results, call the operation
99
+ # with this token and include the same arguments as the call that produced the token. To get a complete list,
100
+ # call this operation until `nextPageToken` is null. Note that this operation can return empty pages.
103
101
  # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally
104
102
  # unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace
105
103
  # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
@@ -118,7 +116,7 @@ module Peddler
118
116
  # Create a transaction request from a Seller Wallet account to another customer-provided account.
119
117
  #
120
118
  # @note This operation can make a static sandbox call.
121
- # @param body [Hash] Defines the actual payload of the request
119
+ # @param body [Hash] The payload of the request
122
120
  # @param dest_account_digital_signature [String] Digital signature for the destination bank account details. For
123
121
  # more information, refer to [Third-Party Provider Signature
124
122
  # Guidance](https://developer-docs.amazon.com/sp-api/docs/tpp-registration-signature-guidance).
@@ -139,10 +137,10 @@ module Peddler
139
137
  post(path, body:, params:, parser:)
140
138
  end
141
139
 
142
- # Returns a transaction
140
+ # Find a transaction by the Amazon transaction identifier.
143
141
  #
144
142
  # @note This operation can make a static sandbox call.
145
- # @param transaction_id [String] ID of the Amazon SW transaction
143
+ # @param transaction_id [String] The ID of the Amazon Seller Wallet transaction.
146
144
  # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally
147
145
  # unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace
148
146
  # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
@@ -159,11 +157,15 @@ module Peddler
159
157
  # Retrieve transfer schedules of a Seller Wallet bank account.
160
158
  #
161
159
  # @note This operation can make a static sandbox call.
162
- # @param account_id [String] ID of the Amazon SW account
160
+ # @param account_id [String] The ID of the Amazon Seller Wallet account.
163
161
  # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally
164
162
  # unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace
165
163
  # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
166
- # @param next_page_token [String] Pagination token to retrieve a specific page of results.
164
+ # @param next_page_token [String] A token that you use to retrieve the next page of results. The response includes
165
+ # `nextPageToken` when the number of results exceeds the specified `pageSize` value. To get the next page of
166
+ # results, call the operation with this token and include the same arguments as the call that produced the
167
+ # token. To get a complete list, call this operation until `nextPageToken` is null. Note that this operation can
168
+ # return empty pages.
167
169
  # @return [Peddler::Response] The API response
168
170
  def list_transfer_schedules(account_id, marketplace_id, next_page_token: nil)
169
171
  path = "/finances/transfers/wallet/2024-03-01/transferSchedules"
@@ -179,7 +181,7 @@ module Peddler
179
181
  # Create a transfer schedule request from a Seller Wallet account to another customer-provided account.
180
182
  #
181
183
  # @note This operation can make a static sandbox call.
182
- # @param body [Hash] Defines the actual payload of the request
184
+ # @param body [Hash] The payload of the request.
183
185
  # @param dest_account_digital_signature [String] Digital signature for the destination bank account details.
184
186
  # @param amount_digital_signature [String] Digital signature for the source currency transaction amount.
185
187
  # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally
@@ -195,10 +197,10 @@ module Peddler
195
197
  post(path, body:, params:, parser:)
196
198
  end
197
199
 
198
- # Returns a transfer belonging to the updated scheduled transfer request
200
+ # Update transfer schedule information. Returns a transfer belonging to the updated scheduled transfer request.
199
201
  #
200
202
  # @note This operation can make a static sandbox call.
201
- # @param body [Hash] Defines the actual payload of the scheduled transfer request that is to be updated.
203
+ # @param body [Hash] The payload of the scheduled transfer request that is to be updated.
202
204
  # @param dest_account_digital_signature [String] Digital signature for the destination bank account details.
203
205
  # @param amount_digital_signature [String] Digital signature for the source currency transaction amount.
204
206
  # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ # This file is generated. Do not edit.
4
+
5
+ require "structure"
6
+
7
+ module Peddler
8
+ module APIs
9
+ class ServicesV1
10
+ # The monetary amount and type of currency.
11
+ MoneyAmount = Structure.new do
12
+ # @return [String] The currency code in ISO 4217 format.
13
+ attribute(:currency, String, null: false)
14
+
15
+ # @return [Float] The monetary value.
16
+ attribute(:value, Float, null: false)
17
+ end
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ # This file is generated. Do not edit.
4
+
5
+ require "structure"
6
+
7
+ module Peddler
8
+ module APIs
9
+ class ServicesV1
10
+ # Payment information for the service job.
11
+ Payment = Structure.new do
12
+ # @return [MoneyAmount] The payment amount.
13
+ attribute?(:amount, MoneyAmount)
14
+
15
+ # @return [String] The payment instrument used for the transaction.
16
+ attribute?(:instrument, String)
17
+ end
18
+ end
19
+ end
20
+ end
@@ -25,6 +25,9 @@ module Peddler
25
25
  # @return [String] The marketplace identifier.
26
26
  attribute?(:marketplace_id, String, from: "marketplaceId")
27
27
 
28
+ # @return [Array<Payment>] A list that contains payment information for the service job.
29
+ attribute?(:payments, [Payment])
30
+
28
31
  # @return [Array<AppointmentTime>] A list of appointment windows preferred by the buyer. Included only if the
29
32
  # buyer selected appointment windows when creating the order.
30
33
  attribute?(:preferred_appointment_times, [AppointmentTime], from: "preferredAppointmentTimes")
@@ -148,7 +148,7 @@ module Peddler
148
148
  # @param service_job_id [String] An Amazon-defined service job identifier. Get this value by calling the
149
149
  # `getServiceJobs` operation of the Services API.
150
150
  # @param appointment_id [String] An Amazon-defined identifier of active service job appointment.
151
- # @param body [Hash]
151
+ # @param body [Hash] Input containing the resource details to be assigned to the appointment.
152
152
  # @param rate_limit [Float] Requests per second
153
153
  # @return [Peddler::Response] The API response
154
154
  def assign_appointment_resources(service_job_id, appointment_id, body, rate_limit: 1.0)
@@ -7,21 +7,21 @@ require "structure"
7
7
  module Peddler
8
8
  module APIs
9
9
  class ShipmentInvoicingV0
10
- # Payment transaction information
10
+ # Information about a payment transaction.
11
11
  PaymentInformation = Structure.new do
12
- # @return [String] Government ID of acquirer
12
+ # @return [String] The government ID of the acquirer.
13
13
  attribute?(:acquirer_id, String, from: "AcquirerId")
14
14
 
15
- # @return [String] Authorization code for this payment
15
+ # @return [String] The authorization code of this payment.
16
16
  attribute?(:authorization_code, String, from: "AuthorizationCode")
17
17
 
18
- # @return [String] Credit card brand (if payment method is CreditCard)
18
+ # @return [String] The credit card brand if the payment method is `CreditCard`.
19
19
  attribute?(:card_brand, String, from: "CardBrand")
20
20
 
21
- # @return [String] Payment method name
21
+ # @return [String] The name of the payment method.
22
22
  attribute?(:payment_method, String, from: "PaymentMethod")
23
23
 
24
- # @return [Money] Amount paid in this payment
24
+ # @return [Money] The amount paid in this payment.
25
25
  attribute?(:payment_value, Money, from: "PaymentValue")
26
26
  end
27
27
  end
@@ -5,7 +5,7 @@
5
5
  module Peddler
6
6
  module APIs
7
7
  class ShipmentInvoicingV0
8
- # List of payment transactions
8
+ # A list of payment transactions.
9
9
  class PaymentInformationList < Array
10
10
  class << self
11
11
  def parse(array)
@@ -2035,6 +2035,12 @@
2035
2035
  "isDeprecated": false,
2036
2036
  "deprecationReason": null
2037
2037
  },
2038
+ {
2039
+ "name": "VARIABLE_DEFINITION",
2040
+ "description": "Location adjacent to a variable definition.",
2041
+ "isDeprecated": false,
2042
+ "deprecationReason": null
2043
+ },
2038
2044
  {
2039
2045
  "name": "SCHEMA",
2040
2046
  "description": "Location adjacent to a schema definition.",
@@ -2100,12 +2106,6 @@
2100
2106
  "description": "Location adjacent to an input object field definition.",
2101
2107
  "isDeprecated": false,
2102
2108
  "deprecationReason": null
2103
- },
2104
- {
2105
- "name": "VARIABLE_DEFINITION",
2106
- "description": "Location adjacent to a variable definition.",
2107
- "isDeprecated": false,
2108
- "deprecationReason": null
2109
2109
  }
2110
2110
  ],
2111
2111
  "possibleTypes": null
@@ -1900,6 +1900,12 @@
1900
1900
  "isDeprecated": false,
1901
1901
  "deprecationReason": null
1902
1902
  },
1903
+ {
1904
+ "name": "VARIABLE_DEFINITION",
1905
+ "description": "Location adjacent to a variable definition.",
1906
+ "isDeprecated": false,
1907
+ "deprecationReason": null
1908
+ },
1903
1909
  {
1904
1910
  "name": "SCHEMA",
1905
1911
  "description": "Location adjacent to a schema definition.",
@@ -1965,12 +1971,6 @@
1965
1971
  "description": "Location adjacent to an input object field definition.",
1966
1972
  "isDeprecated": false,
1967
1973
  "deprecationReason": null
1968
- },
1969
- {
1970
- "name": "VARIABLE_DEFINITION",
1971
- "description": "Location adjacent to a variable definition.",
1972
- "isDeprecated": false,
1973
- "deprecationReason": null
1974
1974
  }
1975
1975
  ],
1976
1976
  "possibleTypes": null