peddler 5.3.0 → 5.4.0

data/lib/peddler/apis/seller_wallet_2024_03_01/transaction_account.rb

@@ -9,26 +9,26 @@ module Peddler
     class SellerWallet20240301
       # Details of the bank account involved in the transaction.
       TransactionAccount = Structure.new do
-        # @return [String] The currency code in ISO 4217 format
-        attribute(:bank_account_currency, String, from: "bankAccountCurrency")
+        # @return [String] The currency code in ISO 4217 format.
+        attribute(:bank_account_currency, String, null: false, from: "bankAccountCurrency")
 
-        # @return [String] Bank account format
-        attribute(:bank_account_number_format, String, from: "bankAccountNumberFormat")
+        # @return [String] The format for the bank account number.
+        attribute(:bank_account_number_format, String, null: false, from: "bankAccountNumberFormat")
 
-        # @return [String] The name of the bank
-        attribute(:bank_name, String, from: "bankName")
+        # @return [String] The name of the bank.
+        attribute(:bank_name, String, null: false, from: "bankName")
 
-        # @return [String] The unique identifier provided by Amazon to identify the account
+        # @return [String] The unique identifier provided by Amazon to identify the account.
         attribute?(:account_id, String, from: "accountId")
 
-        # @return [String] The two digit country code, in ISO 3166 format. This field is OPTIONAL for
-        #   transactionSourceAccount object but is MANDATORY field for transactionDestinationAccount
+        # @return [String] The two-digit country code, in ISO 3166 format. This field is optional for
+        #   `transactionSourceAccount`, but is mandatory for `transactionDestinationAccount`.
         attribute?(:bank_account_country_code, String, from: "bankAccountCountryCode")
 
-        # @return [String] BankAccount holder's name
+        # @return [String] The account holder's name.
         attribute?(:bank_account_holder_name, String, from: "bankAccountHolderName")
 
-        # @return [String] Last 3 digit of the bank account number
+        # @return [String] The last three digits of the bank account number.
         attribute?(:bank_account_number_tail, String, from: "bankAccountNumberTail")
       end
     end

data/lib/peddler/apis/seller_wallet_2024_03_01/transaction_initiation_request.rb

@@ -8,29 +8,30 @@ require "time"
 module Peddler
   module APIs
     class SellerWallet20240301
-      # Request body to initiate a transaction from a SW bank account to another customer defined bank account
+      # Request body to initiate a transaction from a Seller Wallet bank account to another customer-defined bank
+      # account.
       TransactionInitiationRequest = Structure.new do
-        # @return [TransactionInstrumentDetails] Destination bank account details of the transaction request
-        attribute(:destination_transaction_instrument, TransactionInstrumentDetails, from: "destinationTransactionInstrument")
+        # @return [TransactionInstrumentDetails] Details of the destination bank account in the transaction request.
+        attribute(:destination_transaction_instrument, TransactionInstrumentDetails, null: false, from: "destinationTransactionInstrument")
 
-        # @return [Time] The transaction initiation request time in date-time format
-        attribute(:request_time, Time, from: "requestTime")
+        # @return [Time] The time at which the transaction was initiated in [ISO 8601 date time
+        #   format](https://developer-docs.amazon.com/sp-api/docs/iso-8601).
+        attribute(:request_time, Time, null: false, from: "requestTime")
 
-        # @return [String] The unique identifier of the source Amazon SW bank account from where the money needs to be
-        #   debited
-        attribute(:source_account_id, String, from: "sourceAccountId")
+        # @return [String] The unique identifier of the source Amazon Seller Wallet bank account from which the money is
+        #   debited.
+        attribute(:source_account_id, String, null: false, from: "sourceAccountId")
 
         # @return [Money] The transaction amount in the source account's currency format. Requests that use a currency
         #   other than the source bank account currency fail.
-        attribute(:source_amount, Money, from: "sourceAmount")
+        attribute(:source_amount, Money, null: false, from: "sourceAmount")
 
         # @return [String] If the payment is for VAT (Value-Added-Tax) then enter VAT identification number in this
         #   field which will be mandatory. The length constraint is 140 characters and do not allow user to enter any
         #   sensitive information other than VAT-ID.
         attribute?(:customer_payment_reference, String, from: "customerPaymentReference")
 
-        # @return [String] Optional field to specify the unique identifier of the destination bank account where the
-        #   money needs to be deposited
+        # @return [String] The unique identifier of the destination bank account where the money is deposited.
         attribute?(:destination_account_id, String, from: "destinationAccountId")
 
         # @return [PayeeContactInformation] The contact information of a payee.

data/lib/peddler/apis/seller_wallet_2024_03_01/transaction_instrument_details.rb

@@ -7,23 +7,22 @@ require "structure"
 module Peddler
   module APIs
     class SellerWallet20240301
-      # Request body to create transaction instrument, Amazon performs validation and screening (anti-money laundering
-      # measuers) on all the transaction instruments before executing a transaction thus it requires transaction
-      # instrument holder's contact details as well
+      # Details of the destination bank account in the transaction request.
       TransactionInstrumentDetails = Structure.new do
         # @return [String] The bank account holder's name (expected to be an Amazon customer).
         #
         # **Note:** This field is encrypted before Amazon receives it, so should not be used to generate
         #   `destAccountDigitalSignature`, and should not be included in the request signature.
-        attribute(:account_holder_name, String, from: "accountHolderName")
+        attribute(:account_holder_name, String, null: false, from: "accountHolderName")
 
-        # @return [BankAccount] Specifies the destination bank account details where the money needs to be deposited
-        attribute(:bank_account, BankAccount, from: "bankAccount")
+        # @return [BankAccount] Details of the destination bank account.
+        attribute(:bank_account, BankAccount, null: false, from: "bankAccount")
 
-        # @return [String] This field would be used to populate the bank account number of the destination payment
-        #   method. The field is intentionally not included in any other Schemas since Amazon internal systems will
-        #   never receive it in unencrypted format, so field won't be part of the request signature
-        attribute(:bank_account_number, String, from: "bankAccountNumber")
+        # @return [String] The bank account number of the destination payment method.
+        #
+        # **Note:** This field is encrypted before Amazon receives it, so should not be used to generate
+        #   `destAccountDigitalSignature`, and should not be included in the request signature.
+        attribute(:bank_account_number, String, null: false, from: "bankAccountNumber")
       end
     end
   end

data/lib/peddler/apis/seller_wallet_2024_03_01/transaction_listing.rb

@@ -7,14 +7,15 @@ require "structure"
 module Peddler
   module APIs
     class SellerWallet20240301
-      # Struct that holds collection of transactions.
+      # A list of transactions.
       TransactionListing = Structure.new do
-        # @return [Array<Transaction>] Collection that holds Transaction
-        attribute(:transactions, [Transaction])
+        # @return [Array<Transaction>] A list of transactions.
+        attribute(:transactions, [Transaction], null: false)
 
-        # @return [String] If present, use this pagination token to retrieve the next page of supply sources, if not
-        #   provided the API will return same response. The field will only be provided when the list is greater than
-        #   100.
+        # @return [String] A token that you use to retrieve the next page of results. The response includes
+        #   `nextPageToken` when the number of results exceeds 100. To get the next page of results, call the operation
+        #   with this token and include the same arguments as the call that produced the token. To get a complete list,
+        #   call this operation until `nextPageToken` is null. Note that this operation can return empty pages.
         attribute?(:next_page_token, String, from: "nextPageToken")
       end
     end

data/lib/peddler/apis/seller_wallet_2024_03_01/transfer_rate_preview.rb

@@ -18,17 +18,18 @@ module Peddler
       # In the preceding expressions, **fees** is equal to the sum of all `feeAmount.currencyAmount` values in the
       # `fees` array.
       TransferRatePreview = Structure.new do
-        # @return [Money] Base amount of the transaction.
-        attribute(:base_amount, Money, from: "baseAmount")
+        # @return [Money] The base amount of the transaction.
+        attribute(:base_amount, Money, null: false, from: "baseAmount")
 
-        # @return [Array<Fee>] List of fees
-        attribute(:fees, [Fee])
+        # @return [Array<Fee>] A list of fees.
+        attribute(:fees, [Fee], null: false)
 
         # @return [FxRateDetails] The foreign exchange rate value of the transaction.
-        attribute(:fx_rate_details, FxRateDetails, from: "fxRateDetails")
+        attribute(:fx_rate_details, FxRateDetails, null: false, from: "fxRateDetails")
 
-        # @return [Money] The final amount reflects both the fee deduction and currency conversion rate exchange
-        attribute(:transfer_amount, Money, from: "transferAmount")
+        # @return [Money] The final amount transferred, which includes both the fee deduction and currency conversion
+        #   rate.
+        attribute(:transfer_amount, Money, null: false, from: "transferAmount")
       end
     end
   end

data/lib/peddler/apis/seller_wallet_2024_03_01/transfer_schedule.rb

@@ -9,33 +9,32 @@ module Peddler
     class SellerWallet20240301
       # Transfer schedule details and related historical details.
       TransferSchedule = Structure.new do
-        # @return [TransactionAccount] Destination bank account details in the scheduled transfer. Here
-        #   bankAccountCountryCode is a MANDATORY field
-        attribute(:transaction_destination_account, TransactionAccount, from: "transactionDestinationAccount")
+        # @return [TransactionAccount] Details of the destination bank account in the scheduled transfer. Here
+        #   `bankAccountCountryCode` is a required field.
+        attribute(:transaction_destination_account, TransactionAccount, null: false, from: "transactionDestinationAccount")
 
-        # @return [String] Type of the transfer
-        attribute(:transaction_type, String, from: "transactionType")
+        # @return [String] The type of transfer.
+        attribute(:transaction_type, String, null: false, from: "transactionType")
 
-        # @return [Array<TransferScheduleFailures>] Collection that holds Transfer Schedules that has been cancelled or
-        #   failed due to certain reasons.
-        attribute(:transfer_schedule_failures, [TransferScheduleFailures], from: "transferScheduleFailures")
+        # @return [Array<TransferScheduleFailures>] A list of transfer schedule failures.
+        attribute(:transfer_schedule_failures, [TransferScheduleFailures], null: false, from: "transferScheduleFailures")
 
-        # @return [String] The unique identifier provided by Amazon to the scheduled transfer
-        attribute(:transfer_schedule_id, String, from: "transferScheduleId")
+        # @return [String] The unique identifier provided by Amazon to the scheduled transfer.
+        attribute(:transfer_schedule_id, String, null: false, from: "transferScheduleId")
 
-        # @return [TransferScheduleInformation] Fields required for the scheduled transfer. This information can be
-        #   modified when updating a transfer schedule.
-        attribute(:transfer_schedule_information, TransferScheduleInformation, from: "transferScheduleInformation")
+        # @return [TransferScheduleInformation] The fields required for the scheduled transfer. This information can be
+        #   modified when you update a transfer schedule.
+        attribute(:transfer_schedule_information, TransferScheduleInformation, null: false, from: "transferScheduleInformation")
 
-        # @return [String] Type of the transfer schedule. This information can be modified when updating a transfer
+        # @return [String] The type of transfer schedule. This information can be modified when you update a transfer
         #   schedule.
-        attribute(:transfer_schedule_status, String, from: "transferScheduleStatus")
+        attribute(:transfer_schedule_status, String, null: false, from: "transferScheduleStatus")
 
-        # @return [PaymentPreference] Payment preference of the scheduled transfer. This information can be modified
-        #   when updating a transfer schedule.
+        # @return [PaymentPreference] The payment preference of the scheduled transfer. This information can be modified
+        #   when you update a transfer schedule.
         attribute?(:payment_preference, PaymentPreference, from: "paymentPreference")
 
-        # @return [TransactionAccount] Source bank account details in the scheduled transfer
+        # @return [TransactionAccount] Details of the source bank account in the scheduled transfer.
         attribute?(:transaction_source_account, TransactionAccount, from: "transactionSourceAccount")
       end
     end

data/lib/peddler/apis/seller_wallet_2024_03_01/transfer_schedule_failures.rb

@@ -8,13 +8,13 @@ require "time"
 module Peddler
   module APIs
     class SellerWallet20240301
-      # Specifies the balance amount in the Amazon SW bank account
+      # The time of and reason for the transfer schedule failure.
       TransferScheduleFailures = Structure.new do
-        # @return [Time] The transfer schedule cancellation date
-        attribute(:transfer_schedule_failure_date, Time, from: "transferScheduleFailureDate")
+        # @return [Time] The transfer schedule failure date.
+        attribute(:transfer_schedule_failure_date, Time, null: false, from: "transferScheduleFailureDate")
 
-        # @return [String] The statement/reasoning listed for the cancellation of the transfer schedule
-        attribute(:transfer_schedule_failure_reason, String, from: "transferScheduleFailureReason")
+        # @return [String] The reason listed for the failure of the transfer schedule.
+        attribute(:transfer_schedule_failure_reason, String, null: false, from: "transferScheduleFailureReason")
       end
     end
   end

data/lib/peddler/apis/seller_wallet_2024_03_01/transfer_schedule_information.rb

@@ -8,19 +8,18 @@ require "time"
 module Peddler
   module APIs
     class SellerWallet20240301
-      # Parameters containing information required for initiating a schedule transfer
+      # Mandatory information for initiating a schedule transfer.
       TransferScheduleInformation = Structure.new do
-        # @return [Time] Field to specify end date of the scheduled transfer
+        # @return [Time] The end date of the scheduled transfer.
         attribute?(:schedule_end_date, Time, from: "scheduleEndDate")
 
-        # @return [ScheduleExpression] Field to specify expression for how often the schedule transfer repeats. Refer to
-        #   this documentation: https://docs.aws.amazon.com/scheduler/latest/APIReference/API_CreateSchedule.html
+        # @return [ScheduleExpression] How often the scheduled transfer repeats.
         attribute?(:schedule_expression, ScheduleExpression, from: "scheduleExpression")
 
-        # @return [Time] Field to specify start date of the scheduled transfer
+        # @return [Time] The start date of the scheduled transfer.
         attribute?(:schedule_start_date, Time, from: "scheduleStartDate")
 
-        # @return [String] Field to specify type of the transfer being scheduled
+        # @return [String] The type of schedule.
         attribute?(:schedule_type, String, from: "scheduleType")
       end
     end

data/lib/peddler/apis/seller_wallet_2024_03_01/transfer_schedule_listing.rb

@@ -7,14 +7,15 @@ require "structure"
 module Peddler
   module APIs
     class SellerWallet20240301
-      # Struct that holds collection of transfer schedules.
+      # A list of transfer schedules.
       TransferScheduleListing = Structure.new do
-        # @return [Array<TransferSchedule>] Collection that holds list of Transfer Schedules
-        attribute(:transfer_schedules, [TransferSchedule], from: "transferSchedules")
+        # @return [Array<TransferSchedule>] A list of transfer schedules.
+        attribute(:transfer_schedules, [TransferSchedule], null: false, from: "transferSchedules")
 
-        # @return [String] If present, use this pagination token to retrieve the next page of supply sources, if not
-        #   provided the API will return same response. The field will only be provided when the list is greater than
-        #   100.
+        # @return [String] A token that you use to retrieve the next page of results. The response includes
+        #   `nextPageToken` when the number of results exceeds 100. To get the next page of results, call the operation
+        #   with this token and include the same arguments as the call that produced the token. To get a complete list,
+        #   call this operation until `nextPageToken` is null. Note that this operation can return empty pages.
         attribute?(:next_page_token, String, from: "nextPageToken")
       end
     end

data/lib/peddler/apis/seller_wallet_2024_03_01/transfer_schedule_request.rb

@@ -7,34 +7,32 @@ require "structure"
 module Peddler
   module APIs
     class SellerWallet20240301
-      # Request body to initiate a scheduled transfer from a SW bank account to another customer defined bank account
+      # Request body to initiate a scheduled transfer from a Seller Wallet bank account to another customer-defined bank
+      # account.
       TransferScheduleRequest = Structure.new do
-        # @return [String] Optional field to specify the unique identifier of the destination bank account where the
-        #   money needs to be deposited
-        attribute(:destination_account_id, String, from: "destinationAccountId")
+        # @return [String] The unique identifier of the destination bank account where the money is deposited.
+        attribute(:destination_account_id, String, null: false, from: "destinationAccountId")
 
-        # @return [TransactionInstrumentDetails] Destination bank account details of the transaction request
-        attribute(:destination_transaction_instrument, TransactionInstrumentDetails, from: "destinationTransactionInstrument")
+        # @return [TransactionInstrumentDetails] Details of the destination bank account in the transaction request.
+        attribute(:destination_transaction_instrument, TransactionInstrumentDetails, null: false, from: "destinationTransactionInstrument")
 
-        # @return [PaymentPreference] Payment preference of the scheduled transfer
-        attribute(:payment_preference, PaymentPreference, from: "paymentPreference")
+        # @return [PaymentPreference] The payment preference of the scheduled transfer.
+        attribute(:payment_preference, PaymentPreference, null: false, from: "paymentPreference")
 
-        # @return [String] The unique identifier of the source Amazon SW bank account from where the money needs to be
-        #   debited
-        attribute(:source_account_id, String, from: "sourceAccountId")
+        # @return [String] The unique identifier of the source Amazon Seller Wallet bank account from which money is
+        #   debited.
+        attribute(:source_account_id, String, null: false, from: "sourceAccountId")
 
-        # @return [String] Represents 3 letter currency code in ISO 4217 standard format of the source payment method
-        #   country
-        attribute(:source_currency_code, String, from: "sourceCurrencyCode")
+        # @return [String] The three-letter currency code of the source payment method country, in ISO 4217 format.
+        attribute(:source_currency_code, String, null: false, from: "sourceCurrencyCode")
 
-        # @return [String] Type of the scheduled transaction
-        attribute(:transaction_type, String, from: "transactionType")
+        # @return [String] The type of the scheduled transaction.
+        attribute(:transaction_type, String, null: false, from: "transactionType")
 
-        # @return [TransferScheduleInformation] Fields required for the scheduled transfer
-        attribute(:transfer_schedule_information, TransferScheduleInformation, from: "transferScheduleInformation")
+        # @return [TransferScheduleInformation] The configuration of the scheduled transfer.
+        attribute(:transfer_schedule_information, TransferScheduleInformation, null: false, from: "transferScheduleInformation")
 
-        # @return [String] Type of the transaction schedule which is mandatory field in request body if a transfer
-        #   schedule needs to be updated
+        # @return [String] The type of transaction schedule. This field is required when you update a transfer schedule.
         attribute?(:transfer_schedule_status, String, from: "transferScheduleStatus")
       end
     end

data/lib/peddler/apis/seller_wallet_2024_03_01.rb

@@ -4,10 +4,7 @@
 
 module Peddler
   module APIs
-    # The Selling Partner API for Amazon Seller Wallet Open Banking API Spec.
-    #
-    # For more information, refer to the [Seller Wallet Open Banking API Use Case
-    # Guide](doc:seller-wallet-open-banking-api-v2024-03-01-use-case-guide).
+    # The Selling Partner API for Amazon Seller Wallet Open Banking API
     #
     # The Selling Partner API for Seller Wallet (Seller Wallet API) provides financial information that is relevant to a
     # seller's Seller Wallet account. You can obtain financial events, balances, and transfer schedules for Seller
@@ -18,7 +15,9 @@ module Peddler
       # Get Seller Wallet accounts for a seller.
       #
       # @note This operation can make a static sandbox call.
-      # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace for which items are returned.
+      # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally
+      #   unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace
+      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
       # @return [Peddler::Response] The API response
       def list_accounts(marketplace_id)
         path = "/finances/transfers/wallet/2024-03-01/accounts"
@@ -32,7 +31,7 @@ module Peddler
       # Retrieve a Seller Wallet bank account by Amazon account identifier.
       #
       # @note This operation can make a static sandbox call.
-      # @param account_id [String] ID of the Amazon SW account
+      # @param account_id [String] The ID of the Amazon Seller Wallet account.
       # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally
       #   unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace
       #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
@@ -49,7 +48,7 @@ module Peddler
       # Retrieve the balance in a given Seller Wallet bank account.
       #
       # @note This operation can make a static sandbox call.
-      # @param account_id [String] ID of the Amazon SW account
+      # @param account_id [String] The ID of the Amazon Seller Wallet account.
       # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally
       #   unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace
       #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
@@ -63,19 +62,15 @@ module Peddler
         get(path, params:, parser:)
       end
 
-      # Returns list of potential fees on a transaction based on the source and destination country currency code
+      # Retrieve a list of potential fees on a transaction.
       #
       # @note This operation can make a static sandbox call.
-      # @param source_country_code [String] Represents 2 character country code of source transaction account in ISO
-      #   3166 standard format.
-      # @param source_currency_code [String] Represents 3 letter currency code in ISO 4217 standard format of the source
-      #   transaction country.
-      # @param destination_country_code [String] Represents 2 character country code of destination transaction account
-      #   in ISO 3166 standard format.
-      # @param destination_currency_code [String] Represents 3 letter currency code in ISO 4217 standard format of the
-      #   destination transaction country.
-      # @param base_amount [Number] Represents the base transaction amount without any markup fees, rates that will be
-      #   used to get the transfer preview.
+      # @param source_country_code [String] Country code of the source transaction account in ISO 3166 format.
+      # @param source_currency_code [String] Currency code of the source transaction country in ISO 4217 format.
+      # @param destination_country_code [String] Country code of the destination transaction account in ISO 3166 format.
+      # @param destination_currency_code [String] Currency code of the destination transaction country in ISO 4217
+      #   format.
+      # @param base_amount [Number] The base transaction amount without any markup fees.
       # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally
       #   unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace
       #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
@@ -98,8 +93,11 @@ module Peddler
       # Retrieve a list of transactions for a given Seller Wallet bank account.
       #
       # @note This operation can make a static sandbox call.
-      # @param account_id [String] ID of the Amazon SW account
-      # @param next_page_token [String] Pagination token to retrieve a specific page of results.
+      # @param account_id [String] The ID of the Amazon Seller Wallet account.
+      # @param next_page_token [String] A token that you use to retrieve the next page of results. The response includes
+      #   `nextPageToken` when the number of results exceeds 100. To get the next page of results, call the operation
+      #   with this token and include the same arguments as the call that produced the token. To get a complete list,
+      #   call this operation until `nextPageToken` is null. Note that this operation can return empty pages.
       # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally
       #   unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace
       #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
@@ -118,7 +116,7 @@ module Peddler
       # Create a transaction request from a Seller Wallet account to another customer-provided account.
       #
       # @note This operation can make a static sandbox call.
-      # @param body [Hash] Defines the actual payload of the request
+      # @param body [Hash] The payload of the request
       # @param dest_account_digital_signature [String] Digital signature for the destination bank account details. For
       #   more information, refer to [Third-Party Provider Signature
       #   Guidance](https://developer-docs.amazon.com/sp-api/docs/tpp-registration-signature-guidance).
@@ -139,10 +137,10 @@ module Peddler
         post(path, body:, params:, parser:)
       end
 
-      # Returns a transaction
+      # Find a transaction by the Amazon transaction identifier.
       #
       # @note This operation can make a static sandbox call.
-      # @param transaction_id [String] ID of the Amazon SW transaction
+      # @param transaction_id [String] The ID of the Amazon Seller Wallet transaction.
       # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally
       #   unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace
       #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
@@ -159,11 +157,15 @@ module Peddler
       # Retrieve transfer schedules of a Seller Wallet bank account.
       #
       # @note This operation can make a static sandbox call.
-      # @param account_id [String] ID of the Amazon SW account
+      # @param account_id [String] The ID of the Amazon Seller Wallet account.
       # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally
       #   unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace
       #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
-      # @param next_page_token [String] Pagination token to retrieve a specific page of results.
+      # @param next_page_token [String] A token that you use to retrieve the next page of results. The response includes
+      #   `nextPageToken` when the number of results exceeds the specified `pageSize` value. To get the next page of
+      #   results, call the operation with this token and include the same arguments as the call that produced the
+      #   token. To get a complete list, call this operation until `nextPageToken` is null. Note that this operation can
+      #   return empty pages.
       # @return [Peddler::Response] The API response
       def list_transfer_schedules(account_id, marketplace_id, next_page_token: nil)
         path = "/finances/transfers/wallet/2024-03-01/transferSchedules"
@@ -179,7 +181,7 @@ module Peddler
       # Create a transfer schedule request from a Seller Wallet account to another customer-provided account.
       #
       # @note This operation can make a static sandbox call.
-      # @param body [Hash] Defines the actual payload of the request
+      # @param body [Hash] The payload of the request.
       # @param dest_account_digital_signature [String] Digital signature for the destination bank account details.
       # @param amount_digital_signature [String] Digital signature for the source currency transaction amount.
       # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally
@@ -195,10 +197,10 @@ module Peddler
         post(path, body:, params:, parser:)
       end
 
-      # Returns a transfer belonging to the updated scheduled transfer request
+      # Update transfer schedule information. Returns a transfer belonging to the updated scheduled transfer request.
       #
       # @note This operation can make a static sandbox call.
-      # @param body [Hash] Defines the actual payload of the scheduled transfer request that is to be updated.
+      # @param body [Hash] The payload of the scheduled transfer request that is to be updated.
       # @param dest_account_digital_signature [String] Digital signature for the destination bank account details.
       # @param amount_digital_signature [String] Digital signature for the source currency transaction amount.
       # @param marketplace_id [String] The marketplace for which items are returned. The marketplace ID is the globally

data/lib/peddler/apis/sellers_v1/account.rb

@@ -10,13 +10,13 @@ module Peddler
       # The response schema for the `getAccount` operation.
       Account = Structure.new do
         # @return [String] The type of business registered for the seller account.
-        attribute(:business_type, String, from: "businessType")
+        attribute(:business_type, String, null: false, from: "businessType")
 
         # @return [Array<MarketplaceParticipation>]
-        attribute(:marketplace_participation_list, [MarketplaceParticipation], from: "marketplaceParticipationList")
+        attribute(:marketplace_participation_list, [MarketplaceParticipation], null: false, from: "marketplaceParticipationList")
 
         # @return [String] The selling plan details.
-        attribute(:selling_plan, String, from: "sellingPlan")
+        attribute(:selling_plan, String, null: false, from: "sellingPlan")
 
         # @return [Business]
         attribute?(:business, Business)

data/lib/peddler/apis/sellers_v1/address.rb

@@ -10,10 +10,10 @@ module Peddler
       # Represents an address
       Address = Structure.new do
         # @return [String] Street address information.
-        attribute(:address_line1, String, from: "addressLine1")
+        attribute(:address_line1, String, null: false, from: "addressLine1")
 
         # @return [String] The country code in two-character ISO 3166-1 alpha-2 format.
-        attribute(:country_code, String, from: "countryCode")
+        attribute(:country_code, String, null: false, from: "countryCode")
 
         # @return [String] Additional street address information.
         attribute?(:address_line2, String, from: "addressLine2")

data/lib/peddler/apis/sellers_v1/business.rb

@@ -10,10 +10,10 @@ module Peddler
       # Information about the seller's business. Certain fields may be omitted depending on the seller's `businessType`.
       Business = Structure.new do
         # @return [String] The registered business name.
-        attribute(:name, String)
+        attribute(:name, String, null: false)
 
         # @return [Address] The registered business address.
-        attribute(:registered_business_address, Address, from: "registeredBusinessAddress")
+        attribute(:registered_business_address, Address, null: false, from: "registeredBusinessAddress")
 
         # @return [String] The seller's company registration number, if applicable. This field will be absent for
         #   individual sellers and sole proprietorships.

data/lib/peddler/apis/sellers_v1/error.rb

@@ -10,10 +10,10 @@ module Peddler
       # Error response returned when the request is unsuccessful.
       Error = Structure.new do
         # @return [String] An error code that identifies the type of error that occurred.
-        attribute(:code, String)
+        attribute(:code, String, null: false)
 
         # @return [String] A message that describes the error condition in a human-readable form.
-        attribute(:message, String)
+        attribute(:message, String, null: false)
 
         # @return [String] Additional details that can help you understand or fix the issue.
         attribute?(:details, String)

data/lib/peddler/apis/sellers_v1/marketplace.rb

@@ -10,22 +10,22 @@ module Peddler
       # Information about an Amazon marketplace where a seller can list items and customers can view and purchase items.
       Marketplace = Structure.new do
         # @return [String] The ISO 3166-1 alpha-2 format country code of the marketplace.
-        attribute(:country_code, String, from: "countryCode")
+        attribute(:country_code, String, null: false, from: "countryCode")
 
         # @return [String] The ISO 4217 format currency code of the marketplace.
-        attribute(:default_currency_code, String, from: "defaultCurrencyCode")
+        attribute(:default_currency_code, String, null: false, from: "defaultCurrencyCode")
 
         # @return [String] The ISO 639-1 format language code of the marketplace.
-        attribute(:default_language_code, String, from: "defaultLanguageCode")
+        attribute(:default_language_code, String, null: false, from: "defaultLanguageCode")
 
         # @return [String] The domain name of the marketplace.
-        attribute(:domain_name, String, from: "domainName")
+        attribute(:domain_name, String, null: false, from: "domainName")
 
         # @return [String] The encrypted marketplace value.
-        attribute(:id, String)
+        attribute(:id, String, null: false)
 
         # @return [String] The marketplace name.
-        attribute(:name, String)
+        attribute(:name, String, null: false)
       end
     end
   end

data/lib/peddler/apis/sellers_v1/marketplace_participation.rb

@@ -9,13 +9,13 @@ module Peddler
     class SellersV1
       MarketplaceParticipation = Structure.new do
         # @return [Marketplace]
-        attribute(:marketplace, Marketplace)
+        attribute(:marketplace, Marketplace, null: false)
 
         # @return [Participation]
-        attribute(:participation, Participation)
+        attribute(:participation, Participation, null: false)
 
         # @return [String] The name of the seller's store as displayed in the marketplace.
-        attribute(:store_name, String, from: "storeName")
+        attribute(:store_name, String, null: false, from: "storeName")
       end
     end
   end

data/lib/peddler/apis/sellers_v1/participation.rb

@@ -11,10 +11,10 @@ module Peddler
       Participation = Structure.new do
         # @return [:boolean] Specifies if the seller has suspended listings. `true` if the seller Listing Status is set
         #   to Inactive, otherwise `false`.
-        attribute(:has_suspended_listings, :boolean, from: "hasSuspendedListings")
+        attribute(:has_suspended_listings, :boolean, null: false, from: "hasSuspendedListings")
 
         # @return [:boolean] If `true`, the seller participates in the marketplace. Otherwise `false`.
-        attribute(:participating, :boolean, from: "isParticipating")
+        attribute(:participating, :boolean, null: false, from: "isParticipating")
       end
     end
   end