peddler 5.3.1 → 5.4.0

data/lib/peddler/apis/replenishment_2022_11_07/forecast_deliveries.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Replenishment20221107
+      # An object which contains the projected subscriber demand for the offer over different time horizons.
+      ForecastDeliveries = Structure.new do
+        # @return [Integer] The projected number of subscriber deliveries in the next 15 days.
+        attribute?(:next15_days_deliveries, Integer, from: "next15DaysDeliveries")
+
+        # @return [Integer] The projected number of subscriber deliveries in the next 30 days.
+        attribute?(:next30_days_deliveries, Integer, from: "next30DaysDeliveries")
+
+        # @return [Integer] The projected number of subscriber deliveries in the next 60 days.
+        attribute?(:next60_days_deliveries, Integer, from: "next60DaysDeliveries")
+
+        # @return [Integer] The projected number of subscriber deliveries in the next 90 days.
+        attribute?(:next90_days_deliveries, Integer, from: "next90DaysDeliveries")
+      end
+    end
+  end
+end

data/lib/peddler/apis/replenishment_2022_11_07/get_selling_partner_metrics_request.rb

@@ -11,7 +11,7 @@ module Peddler
       # The request body for the `getSellingPartnerMetrics` operation.
       GetSellingPartnerMetricsRequest = Structure.new do
         # @return [String] The marketplace identifier. The supported marketplaces for both sellers and vendors are US,
-        #   CA, ES, UK, FR, IT, IN, DE and JP. The supported marketplaces for vendors only are BR, AU, MX, AE and NL.
+        #   CA, ES, UK, FR, IT, IN, DE, and JP. The supported marketplaces for vendors only are BR, AU, MX, AE, and NL.
         #   Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) to find the
         #   identifier for the marketplace.
         attribute(:marketplace_id, String, null: false, from: "marketplaceId")
@@ -28,8 +28,8 @@ module Peddler
         # @return [String]
         attribute?(:aggregation_frequency, String, from: "aggregationFrequency")
 
-        # @return [Array<Metric>] The list of metrics requested. If no metric value is provided, data for all of the
-        #   metrics will be returned.
+        # @return [Array<Metric>] The list of metrics requested. If no metric value is provided, data for all metrics
+        #   will be returned.
         attribute?(:metrics, Array)
       end
     end

data/lib/peddler/apis/replenishment_2022_11_07/get_selling_partner_metrics_response_metric.rb

@@ -58,7 +58,7 @@ module Peddler
         attribute?(:non_subscriber_average_revenue, Float, from: "nonSubscriberAverageRevenue")
 
         # @return [Float] Total revenue from customers who have made purchases from your catalog but have never
-        #   subscribed to any products
+        #   subscribed to any products.
         attribute?(:non_subscriber_life_time_value_from_otp, Float, from: "nonSubscriberLifeTimeValueFromOTP")
 
         # @return [Float] The percentage of items that were not shipped out of the total shipped units over a period of
@@ -77,6 +77,10 @@ module Peddler
         #   12 months. Applicable to `PERFORMANCE` `timePeriodType`.
         attribute?(:revenue_from_subscriptions_with_multiple_deliveries, Float, from: "revenueFromSubscriptionsWithMultipleDeliveries")
 
+        # @return [Float] The percentage of total program revenue out of total product revenue over a period of time.
+        #   Applicable to `PERFORMANCE` `timePeriodType`.
+        attribute?(:revenue_penetration, Float, from: "revenuePenetration")
+
         # @return [Float] The percentage of subscription revenue generated by offers with 0% seller-funded discount over
         #   the last 12 months. Applicable to `PERFORMANCE` `timePeriodType`.
         attribute?(:revenue_penetration_for0_percent_seller_funding, Float, from: "revenuePenetrationFor0PercentSellerFunding")

data/lib/peddler/apis/replenishment_2022_11_07/list_offer_metrics_request_filters.rb

@@ -12,7 +12,7 @@ module Peddler
       # an array, the result must match at least one element in the provided array.
       ListOfferMetricsRequestFilters = Structure.new do
         # @return [String] The marketplace identifier. The supported marketplaces for both sellers and vendors are US,
-        #   CA, ES, UK, FR, IT, IN, DE and JP. The supported marketplaces for vendors only are BR, AU, MX, AE and NL.
+        #   CA, ES, UK, FR, IT, IN, DE, and JP. The supported marketplaces for vendors only are BR, AU, MX, AE, and NL.
         #   Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) to find the
         #   identifier for the marketplace.
         attribute(:marketplace_id, String, null: false, from: "marketplaceId")

data/lib/peddler/apis/replenishment_2022_11_07/list_offer_metrics_response_offer.rb

@@ -10,68 +10,75 @@ module Peddler
     class Replenishment20221107
       # An object which contains offer metrics.
       ListOfferMetricsResponseOffer = Structure.new do
-        # @return [Float] The number of active subscriptions present at the end of the period. Applicable to `FORECAST`
-        #   `timePeriodType`.
+        # @return [Float] The number of active subscriptions present at the end of the period. Applicable to
+        #   `PERFORMANCE` `timePeriodType`.
         attribute?(:active_subscriptions, Float, from: "activeSubscriptions")
 
         # @return [String] The Amazon Standard Identification Number (ASIN).
         attribute?(:asin, String)
 
         # @return [Float] The percentage of revenue from ASINs with coupons out of total revenue from all ASINs.
-        #   Applicable to `FORECAST` `timePeriodType`.
+        #   Applicable to `PERFORMANCE` `timePeriodType`.
         attribute?(:coupons_revenue_penetration, Float, from: "couponsRevenuePenetration")
 
         # @return [String] The currency code in ISO 4217 format.
         attribute?(:currency_code, String, from: "currencyCode")
 
+        # @return [String] The fulfillment channel type of an offer. This property is only supported for sellers and not
+        #   for vendors.
+        attribute?(:fulfillment_channel_type, String, from: "fulfillmentChannelType")
+
         # @return [Float] The revenue that would have been generated had there not been out of stock. Applicable to
-        #   `FORECAST` `timePeriodType`.
+        #   `PERFORMANCE` `timePeriodType`.
         attribute?(:lost_revenue_due_to_oos, Float, from: "lostRevenueDueToOOS")
 
-        # @return [Float] The forecasted shipped subscription units for the next 30 days. Applicable to FORECAST
-        #   timePeriodType.
+        # @return [Float] The forecasted shipped subscription units for the next 30 days. Applicable to `FORECAST`
+        #   `timePeriodType`.
         attribute?(:next30_day_shipped_subscription_units, Float, from: "next30DayShippedSubscriptionUnits")
 
-        # @return [Float] The forecasted total subscription revenue for the next 30 days. Applicable to FORECAST
-        #   timePeriodType.
+        # @return [Float] The forecasted total subscription revenue for the next 30 days. Applicable to `FORECAST`
+        #   `timePeriodType`.
         attribute?(:next30_day_total_subscriptions_revenue, Float, from: "next30DayTotalSubscriptionsRevenue")
 
-        # @return [Float] The forecasted shipped subscription units for the next 60 days. Applicable to FORECAST
-        #   timePeriodType.
+        # @return [Float] The forecasted shipped subscription units for the next 60 days. Applicable to `FORECAST`
+        #   `timePeriodType`.
         attribute?(:next60_day_shipped_subscription_units, Float, from: "next60DayShippedSubscriptionUnits")
 
-        # @return [Float] The forecasted total subscription revenue for the next 60 days. Applicable to FORECAST
-        #   timePeriodType.
+        # @return [Float] The forecasted total subscription revenue for the next 60 days. Applicable to `FORECAST`
+        #   `timePeriodType`.
         attribute?(:next60_day_total_subscriptions_revenue, Float, from: "next60DayTotalSubscriptionsRevenue")
 
-        # @return [Float] The forecasted shipped subscription units for the next 90 days. Applicable to FORECAST
-        #   timePeriodType.
+        # @return [Float] The forecasted shipped subscription units for the next 90 days. Applicable to `FORECAST`
+        #   `timePeriodType`.
         attribute?(:next90_day_shipped_subscription_units, Float, from: "next90DayShippedSubscriptionUnits")
 
-        # @return [Float] The forecasted total subscription revenue for the next 90 days. Applicable to FORECAST
-        #   timePeriodType.
+        # @return [Float] The forecasted total subscription revenue for the next 90 days. Applicable to `FORECAST`
+        #   `timePeriodType`.
         attribute?(:next90_day_total_subscriptions_revenue, Float, from: "next90DayTotalSubscriptionsRevenue")
 
         # @return [Float] The percentage of items that were not shipped out of the total shipped units over a period of
-        #   time due to being out of stock. Applicable to `FORECAST` `timePeriodType`.
+        #   time due to being out of stock. Applicable to `PERFORMANCE` `timePeriodType`.
         attribute?(:not_delivered_due_to_oos, Float, from: "notDeliveredDueToOOS")
 
-        # @return [Float] The percentage of total program revenue out of total product revenue. Applicable to `FORECAST`
-        #   `timePeriodType`.
+        # @return [Float] The percentage of total program revenue out of total product revenue. Applicable to
+        #   `PERFORMANCE` `timePeriodType`.
         attribute?(:revenue_penetration, Float, from: "revenuePenetration")
 
-        # @return [Float] The percentage of new subscriptions acquired through coupons. Applicable to `FORECAST`
+        # @return [Float] The percentage of new subscriptions acquired through coupons. Applicable to `PERFORMANCE`
         #   `timePeriodType`.
         attribute?(:share_of_coupon_subscriptions, Float, from: "shareOfCouponSubscriptions")
 
-        # @return [Float] The number of units shipped to the subscribers over a period of time. Applicable to `FORECAST`
-        #   `timePeriodType`.
+        # @return [Float] The number of units shipped to the subscribers over a period of time. Applicable to
+        #   `PERFORMANCE` `timePeriodType`.
         attribute?(:shipped_subscription_units, Float, from: "shippedSubscriptionUnits")
 
+        # @return [String] The SKU. This property is only supported for sellers and not for vendors.
+        attribute?(:sku, String)
+
         # @return [TimeInterval] A time interval used to compute metrics.
         attribute?(:time_interval, TimeInterval, from: "timeInterval")
 
-        # @return [Float] The revenue generated from subscriptions over a period of time. Applicable to `FORECAST`
+        # @return [Float] The revenue generated from subscriptions over a period of time. Applicable to `PERFORMANCE`
         #   `timePeriodType`.
         attribute?(:total_subscriptions_revenue, Float, from: "totalSubscriptionsRevenue")
       end

data/lib/peddler/apis/replenishment_2022_11_07/list_offers_request_filters.rb

@@ -7,11 +7,11 @@ require "structure"
 module Peddler
   module APIs
     class Replenishment20221107
-      # Use these parameters to filter results. Any result must match all of the provided parameters. For any parameter
-      # that is an array, the result must match at least one element in the provided array.
+      # Use these parameters to filter results. Any result must match all provided parameters. For any parameter that is
+      # an array, the result must match at least one element in the provided array.
       ListOffersRequestFilters = Structure.new do
         # @return [String] The marketplace identifier. The supported marketplaces for both sellers and vendors are US,
-        #   CA, ES, UK, FR, IT, IN, DE and JP. The supported marketplaces for vendors only are BR, AU, MX, AE and NL.
+        #   CA, ES, UK, FR, IT, IN, DE, and JP. The supported marketplaces for vendors only are BR, AU, MX, AE, and NL.
         #   Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) to find the
         #   identifier for the marketplace.
         attribute(:marketplace_id, String, null: false, from: "marketplaceId")
@@ -22,6 +22,10 @@ module Peddler
         # @return [Array<String>] A list of Amazon Standard Identification Numbers (ASINs).
         attribute?(:asins, [String])
 
+        # @return [Array<String>] A list of delivery condition types to filter the results by. Results are filtered to
+        #   only include offers with the specified delivery conditions.
+        attribute?(:deliveries_conditions, [String], from: "deliveriesConditions")
+
         # @return [Array<EligibilityStatus>] A list of eligibilities associated with an offer.
         attribute?(:eligibilities, Array)
 

data/lib/peddler/apis/replenishment_2022_11_07/list_offers_response_offer.rb

@@ -12,11 +12,25 @@ module Peddler
         # @return [String] The Amazon Standard Identification Number (ASIN).
         attribute?(:asin, String)
 
+        # @return [Array<DeliveriesCondition>] A list of delivery conditions for the offer, indicating the health of
+        #   upcoming deliveries. Each condition describes the quantity of upcoming deliveries associated with a
+        #   particular delivery condition type.
+        attribute?(:deliveries_conditions, [DeliveriesCondition], from: "deliveriesConditions")
+
         # @return [String] The offer eligibility status.
         attribute?(:eligibility, String)
 
+        # @return [ForecastDeliveries] The projected subscriber demand for the offer over different time horizons.
+        attribute?(:forecast_deliveries, ForecastDeliveries, from: "forecastDeliveries")
+
+        # @return [String] The fulfillment network identifier type for the offer, indicating how the offer is fulfilled.
+        attribute?(:fulfillment_network_id_type, String, from: "fulfillmentNetworkIDType")
+
+        # @return [Integer] The available inventory count for the offer.
+        attribute?(:inventory, Integer)
+
         # @return [String] The marketplace identifier. The supported marketplaces for both sellers and vendors are US,
-        #   CA, ES, UK, FR, IT, IN, DE and JP. The supported marketplaces for vendors only are BR, AU, MX, AE and NL.
+        #   CA, ES, UK, FR, IT, IN, DE, and JP. The supported marketplaces for vendors only are BR, AU, MX, AE, and NL.
         #   Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) to find the
         #   identifier for the marketplace.
         attribute?(:marketplace_id, String, from: "marketplaceId")
@@ -24,12 +38,24 @@ module Peddler
         # @return [OfferProgramConfiguration]
         attribute?(:offer_program_configuration, OfferProgramConfiguration, from: "offerProgramConfiguration")
 
+        # @return [Float] The current price of the offer. This is the listed price amount for the item.
+        attribute?(:price, Float)
+
+        # @return [String] The currency code in ISO 4217 format for the price. For example, `USD` for US dollars.
+        attribute?(:price_currency_code, String, from: "priceCurrencyCode")
+
         # @return [String] The replenishment program for the offer.
         attribute?(:program_type, String, from: "programType")
 
         # @return [String] The SKU. This property is only supported for sellers and not for vendors.
         attribute?(:sku, String)
 
+        # @return [String] The stock risk level of the offer, indicating the risk of the offer going out of stock.
+        attribute?(:stock_risk, String, from: "stockRisk")
+
+        # @return [Integer] The number of active subscriptions for the offer.
+        attribute?(:subscriptions, Integer)
+
         # @return [Array<String>] A list of vendor codes associated with the offer.
         attribute?(:vendor_codes, [String], from: "vendorCodes")
       end

data/lib/peddler/apis/replenishment_2022_11_07/offer_program_configuration.rb

@@ -10,7 +10,7 @@ module Peddler
       # The offer program configuration contains a set of program properties for an offer.
       OfferProgramConfiguration = Structure.new do
         # @return [String] Determines whether the offer was automatically or manually enrolled in the program. This
-        #   property is only supported for sellers and not vendors.
+        #   property is only supported for sellers, not for vendors.
         attribute?(:enrollment_method, String, from: "enrollmentMethod")
 
         # @return [OfferProgramConfigurationPreferences] An object which contains the preferences applied to the offer.

data/lib/peddler/apis/replenishment_2022_11_07/time_interval.rb

@@ -10,7 +10,7 @@ module Peddler
     class Replenishment20221107
       # A date-time interval in ISO 8601 format which is used to compute metrics. Only the date is required, but you
       # must pass the complete date and time value. For example, November 11, 2022 should be passed as
-      # "2022-11-07T00:00:00Z". Note that only data for the trailing 2 years is supported.
+      # "2022-11-11T00:00:00Z". Note that only data for the trailing 2 years is supported.
       #
       # **Note**: The `listOfferMetrics` operation only supports a time interval which covers a single unit of the
       # aggregation frequency. For example, for a MONTH aggregation frequency, the duration of the interval between the

data/lib/peddler/apis/reports_2021_06_30.rb

@@ -147,12 +147,18 @@ module Peddler
       #
       # @note This operation can make a static sandbox call.
       # @param report_document_id [String] The identifier for the report document.
+      # @param enable_content_encoding_url_header [Boolean] When `true`, the Content-Encoding header on the returned URL
+      #   is set to `gzip` instead of the default `identity` when `compressionAlgorithm` is `GZIP`. This allows
+      #   automatic decompression by HTTP clients.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def get_report_document(report_document_id, rate_limit: 0.0167)
+      def get_report_document(report_document_id, enable_content_encoding_url_header: nil, rate_limit: 0.0167)
         path = "/reports/2021-06-30/documents/#{percent_encode(report_document_id)}"
+        params = {
+          "enableContentEncodingUrlHeader" => enable_content_encoding_url_header,
+        }.compact
         parser = -> { ReportDocument }
-        get(path, rate_limit:, parser:)
+        get(path, params:, rate_limit:, parser:)
       end
     end
   end

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

@@ -8,21 +8,21 @@ require "time"
 module Peddler
   module APIs
     class SellerWallet20240301
-      # Specifies the balance amount in the Amazon SW bank account
+      # The balance amount in the Amazon Seller Wallet bank account.
       Balance = Structure.new do
-        # @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, null: false, from: "accountId")
 
-        # @return [Float] The balance amount in number format
+        # @return [Float] The balance amount in number format.
         attribute(:balance_amount, Float, null: false, from: "balanceAmount")
 
-        # @return [String] The Amazon SW bank account currency code in ISO 4217 format
+        # @return [String] The Amazon Seller Wallet bank account currency code in ISO 4217 format.
         attribute(:balance_currency, String, null: false, from: "balanceCurrency")
 
-        # @return [Time] The last update date on the account balance
+        # @return [Time] The date of the most recent account balance update.
         attribute(:last_update_date, Time, null: false, from: "lastUpdateDate")
 
-        # @return [String] Type of the balance
+        # @return [String] The type of balance.
         attribute?(:balance_type, String, from: "balanceType")
       end
     end

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

@@ -7,9 +7,9 @@ require "structure"
 module Peddler
   module APIs
     class SellerWallet20240301
-      # Struct that holds list of balances on the seller account.
+      # A list of balances in the seller account.
       BalanceListing = Structure.new do
-        # @return [Array<Balance>] Collection that holds list of balances on the account
+        # @return [Array<Balance>] A list of balances in the seller account.
         attribute?(:balances, [Balance])
       end
     end

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

@@ -10,14 +10,14 @@ module Peddler
       # Details of an Amazon Seller Wallet bank account. This account is used to hold the money that a Seller Wallet
       # customer earns by selling items.
       BankAccount = Structure.new do
-        # @return [String] The two digit country code, in ISO 3166 format.
+        # @return [String] The two-digit country code in ISO 3166 format.
         attribute(:account_country_code, String, null: false, from: "accountCountryCode")
 
-        # @return [String] BankAccount currency code in ISO 4217 format
+        # @return [String] Bank account currency code in ISO 4217 format.
         attribute(:account_currency, String, null: false, from: "accountCurrency")
 
-        # @return [String] Last 3 digit of the bank account number, for all Amazon Seller Wallet account the value will
-        #   be three consecutive 0's
+        # @return [String] The last 3 digit of the bank account number. This value is three consecutive zeros for Amazon
+        #   Seller Wallet accounts.
         attribute(:bank_account_number_tail, String, null: false, from: "bankAccountNumberTail")
 
         # @return [String] Type of ownership of the bank account. This value is `SELF` for Amazon Seller Wallet
@@ -35,7 +35,7 @@ module Peddler
         #   is required.
         attribute?(:account_id, String, from: "accountId")
 
-        # @return [String] Bank account holder compliance status
+        # @return [String] The compliance status of the bank account holder.
         attribute?(:bank_account_holder_status, String, from: "bankAccountHolderStatus")
 
         # @return [String] The format in which the bank account number is provided for `THIRD_PARTY` transaction

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

@@ -7,9 +7,9 @@ require "structure"
 module Peddler
   module APIs
     class SellerWallet20240301
-      # Struct that holds collection of accounts.
+      # A list of bank accounts.
       BankAccountListing = Structure.new do
-        # @return [Array<BankAccount>] Collection that holds BankAccount
+        # @return [Array<BankAccount>] A list of bank accounts.
         attribute(:accounts, [BankAccount], null: false)
       end
     end

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

@@ -7,9 +7,10 @@ require "structure"
 module Peddler
   module APIs
     class SellerWallet20240301
-      # Response returned when the schedule transfer's delete request is successful.
+      # The response returned when the schedule transfer's delete request is successful.
       DeleteTransferSchedule = Structure.new do
-        # @return [String] A success code that specifies the delete operation was successful. eg:HTTP 200.
+        # @return [String] A success code that specifies that the delete operation was successful. For example, HTTP
+        #   200.
         attribute(:code, String, null: false)
 
         # @return [String] A message that describes the success condition of the delete schedule transaction.

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

@@ -7,21 +7,18 @@ require "structure"
 module Peddler
   module APIs
     class SellerWallet20240301
-      # If the fees is in baseAmount (sourceAccount) currency, effectiveRate = (baseAmount -
-      # sum(fees.feeAmount.currencyAmount)) * baseRate) / baseAmount. If the fees is in transferAmount
-      # (destinationAccount) currency, effectiveRate = (( baseAmount * baseRate ) - sum(fees.feeAmount.currencyAmount ))
-      # / baseAmount
+      # Details of the fee.
       Fee = Structure.new do
-        # @return [Money] Displays actual value of the fee in numeric format.
+        # @return [Money] The actual value of the fee in numeric format.
         attribute(:fee_amount, Money, null: false, from: "feeAmount")
 
-        # @return [String] Unique identifier assigned to the Fee.
+        # @return [String] The unique identifier assigned to the fee.
         attribute(:fee_id, String, null: false, from: "feeId")
 
         # @return [String] The value of the fee in percentage format.
         attribute(:fee_rate_value, String, null: false, from: "feeRateValue")
 
-        # @return [String] Displays type of the Fee.
+        # @return [String] The type of the fee.
         attribute(:fee_type, String, null: false, from: "feeType")
       end
     end

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

@@ -7,19 +7,19 @@ require "structure"
 module Peddler
   module APIs
     class SellerWallet20240301
-      # Foreign exchange rate details displayed when transfer preview is requested.
+      # Foreign exchange rate details.
       FxRateDetails = Structure.new do
-        # @return [Float] This is the rate that will be market foreign exchange rate. For example: 1USD -> 86.0 INR.
+        # @return [Float] The market foreign exchange rate.
         attribute(:base_rate, Float, null: false, from: "baseRate")
 
-        # @return [Float] Displays the foreign exchange rate which will be all rates and fees baked in (i.e; markup
-        #   fees), example: market fx rate and international transaction fee.
+        # @return [Float] The total rate applied to the money transfer. This includes all exchange rates, markups, and
+        #   fees.
         attribute(:effective_fx_rate, Float, null: false, from: "effectiveFxRate")
 
-        # @return [String] Unique identifier assigned to the fees/foreign exchange Rate of a transaction.
+        # @return [String] The unique identifier assigned to the fees / foreign exchange rate of a transaction.
         attribute(:fx_rate_id, String, null: false, from: "fxRateId")
 
-        # @return [String] Rate Direction can refer to the way final amount is calculated.
+        # @return [String] Whether the customer is buying or selling the source currency.
         attribute(:rate_direction, String, null: false, from: "rateDirection")
       end
     end

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

@@ -10,10 +10,10 @@ module Peddler
       # The contact information of the payee. This field is required when the request `bankAccountOwnershipType` is
       # `THIRD_PARTY`. The contact information is used for payee verification and registration purposes.
       PayeeContactInformation = Structure.new do
-        # @return [String] Address Line 1 of the public address
+        # @return [String] Address Line 1 of the public address.
         attribute(:address_line1, String, null: false, from: "addressLine1")
 
-        # @return [String] City name of the public address
+        # @return [String] City name of the public address.
         attribute(:city, String, null: false)
 
         # @return [String] The two digit country code, in ISO 3166 format.
@@ -34,16 +34,16 @@ module Peddler
         # @return [String] Valid phone number of the payee.
         attribute(:phone_number, String, null: false, from: "phoneNumber")
 
-        # @return [String] Postal code of the public address
+        # @return [String] Postal code of the public address.
         attribute(:postal_code, String, null: false, from: "postalCode")
 
         # @return [String] State name of the public address. This is the state or region for China-based addresses.
         attribute(:state, String, null: false)
 
-        # @return [String] Address Line 2 of the public address
+        # @return [String] Address Line 2 of the public address.
         attribute?(:address_line2, String, from: "addressLine2")
 
-        # @return [String] Country name of the public address
+        # @return [String] Country name of the public address.
         attribute?(:country, String)
 
         # @return [String] Middle name of the payee. There is a 50 character limit.

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

@@ -7,10 +7,9 @@ require "structure"
 module Peddler
   module APIs
     class SellerWallet20240301
-      # Payment preference type in which transfer is being scheduled
+      # The type of payment preference in which the transfer is being scheduled.
       PaymentPreference = Structure.new do
-        # @return [String] Specifies the preferred payment type for the scheduled transaction eg:PERCENTAGE of certain
-        #   total amount in account
+        # @return [String] The preferred payment type for the scheduled transaction. Can be `PERCENTAGE` or `AMOUNT`.
         attribute(:payment_preference_payment_type, String, null: false, from: "paymentPreferencePaymentType")
 
         # @return [Float] The value of the payment preference.

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

@@ -7,14 +7,13 @@ require "structure"
 module Peddler
   module APIs
     class SellerWallet20240301
-      # Parameters containing information of the expression that defines when the schedule runs. The following formats
-      # are supported.
+      # The configuration of the schedule.
       ScheduleExpression = Structure.new do
-        # @return [String] Field to specify type of the scheduled transfer
+        # @return [String] The type of the scheduled transfer.
         attribute(:schedule_expression_type, String, null: false, from: "scheduleExpressionType")
 
-        # @return [String] Field to specify recurrence of the scheduled transfer. Recurring frequency is mandatory if
-        #   scheduleExpressionType is set as RECURRING otherwise it should be empty field.
+        # @return [String] How often the scheduled transfer happens. This field is required if `scheduleExpressionType`
+        #   is `RECURRING`; otherwise it should be empty.
         attribute?(:recurring_frequency, String, from: "recurringFrequency")
       end
     end

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

@@ -14,20 +14,20 @@ module Peddler
         #   debited.
         attribute(:account_id, String, null: false, from: "accountId")
 
-        # @return [Time] The last update date on the transaction
+        # @return [Time] The date of the most recent account balance update.
         attribute(:last_update_date, Time, null: false, from: "lastUpdateDate")
 
         # @return [String] A description of the transaction that the requester provides when they initiate the
         #   transaction.
         attribute(:transaction_description, String, null: false, from: "transactionDescription")
 
-        # @return [TransactionAccount] Destination bank account details in the transaction
+        # @return [TransactionAccount] The destination bank account details in the transaction.
         attribute(:transaction_destination_account, TransactionAccount, null: false, from: "transactionDestinationAccount")
 
-        # @return [String] The unique identifier provided by Amazon to the transaction
+        # @return [String] The unique identifier provided by Amazon to the transaction.
         attribute(:transaction_id, String, null: false, from: "transactionId")
 
-        # @return [Money] Specifies the amount for which the transfer was initiated
+        # @return [Money] The amount for which the transfer was initiated.
         attribute(:transaction_request_amount, Money, null: false, from: "transactionRequestAmount")
 
         # @return [Time] The date when the transaction was initiated.
@@ -37,33 +37,32 @@ module Peddler
         #   the customer used to start the transaction.
         attribute(:transaction_requester_source, String, null: false, from: "transactionRequesterSource")
 
-        # @return [String] Execution Status of the transaction
+        # @return [String] The status of the transaction.
         attribute(:transaction_status, String, null: false, from: "transactionStatus")
 
-        # @return [String] Type of the transaction
+        # @return [String] The type of the transaction.
         attribute(:transaction_type, String, null: false, from: "transactionType")
 
         # @return [TransferRatePreview] The fees and rates that apply to the transaction, as applicable.
         attribute(:transfer_rate_details, TransferRatePreview, null: false, from: "transferRateDetails")
 
-        # @return [Time] Expected completion date of a transaction, for existing active Payees (Trusted Beneficiaries)
-        #   it will be 24 hours but for new destination bank accounts the value could go up to 5 days
+        # @return [Time] The expected completion date of the transaction.
         attribute?(:expected_completion_date, Time, from: "expectedCompletionDate")
 
-        # @return [String] Amazon SW customer who requested the transaction
+        # @return [String] The Amazon Seller Wallet customer who requested the transaction.
         attribute?(:requester_name, String, from: "requesterName")
 
-        # @return [Time] Transaction completion date
+        # @return [Time] The transaction's completion date.
         attribute?(:transaction_actual_completion_date, Time, from: "transactionActualCompletionDate")
 
-        # @return [String] Description in case the transaction fails before completion
+        # @return [String] The reason the transaction failed, if applicable.
         attribute?(:transaction_failure_reason, String, from: "transactionFailureReason")
 
-        # @return [Money] Specifies the amount of completed transaction in the destination account currency, this will
-        #   be populated only for international transactions
+        # @return [Money] The amount of completed transaction in the destination account currency. This value is only
+        #   populated for international transactions
         attribute?(:transaction_final_amount, Money, from: "transactionFinalAmount")
 
-        # @return [TransactionAccount] Source bank account details in the transaction
+        # @return [TransactionAccount] The source bank account details in the transaction.
         attribute?(:transaction_source_account, TransactionAccount, from: "transactionSourceAccount")
       end
     end