straddle 0.3.0 → 0.4.0

data/lib/straddle/models/paykey_get_params.rb

@@ -7,6 +7,11 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute correlation_id
       #
       #   @return [String, nil]
@@ -22,7 +27,8 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
       #   @param correlation_id [String]
       #   @param request_id [String]
       #   @param straddle_account_id [String]

data/lib/straddle/models/paykey_list_params.rb

@@ -25,6 +25,12 @@ module Straddle
       #   @return [Integer, nil]
       optional :page_size, Integer
 
+      # @!attribute search_text
+      #   General search term to filter paykeys.
+      #
+      #   @return [String, nil]
+      optional :search_text, String
+
       # @!attribute sort_by
       #
       #   @return [Symbol, Straddle::Models::PaykeyListParams::SortBy, nil]
@@ -47,6 +53,15 @@ module Straddle
       #   @return [Array<Symbol, Straddle::Models::PaykeyListParams::Status>, nil]
       optional :status, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaykeyListParams::Status] }
 
+      # @!attribute unblock_eligible
+      #   Filter paykeys by unblock eligibility. When true, returns only blocked paykeys
+      #   eligible for client-initiated unblocking (blocked due to R29 returns and not
+      #   previously unblocked). When false, returns only blocked paykeys that are not
+      #   eligible for unblocking.
+      #
+      #   @return [Boolean, nil]
+      optional :unblock_eligible, Straddle::Internal::Type::Boolean
+
       # @!attribute correlation_id
       #
       #   @return [String, nil]
@@ -62,13 +77,18 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(customer_id: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, source: nil, status: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(customer_id: nil, page_number: nil, page_size: nil, search_text: nil, sort_by: nil, sort_order: nil, source: nil, status: nil, unblock_eligible: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::PaykeyListParams} for more details.
+      #
       #   @param customer_id [String] Filter paykeys by related customer ID.
       #
       #   @param page_number [Integer] Page number for paginated results. Starts at 1.
       #
       #   @param page_size [Integer] Number of results per page. Maximum: 1000.
       #
+      #   @param search_text [String] General search term to filter paykeys.
+      #
       #   @param sort_by [Symbol, Straddle::Models::PaykeyListParams::SortBy]
       #
       #   @param sort_order [Symbol, Straddle::Models::PaykeyListParams::SortOrder]
@@ -77,6 +97,8 @@ module Straddle
       #
       #   @param status [Array<Symbol, Straddle::Models::PaykeyListParams::Status>] Filter paykeys by their current status.
       #
+      #   @param unblock_eligible [Boolean] Filter paykeys by unblock eligibility. When true, returns only blocked paykeys e
+      #
       #   @param correlation_id [String]
       #
       #   @param request_id [String]
@@ -128,6 +150,7 @@ module Straddle
         INACTIVE = :inactive
         REJECTED = :rejected
         REVIEW = :review
+        BLOCKED = :blocked
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/straddle/models/paykey_reveal_params.rb

@@ -7,6 +7,11 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute correlation_id
       #
       #   @return [String, nil]
@@ -22,7 +27,8 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
       #   @param correlation_id [String]
       #   @param request_id [String]
       #   @param straddle_account_id [String]

data/lib/straddle/models/paykey_reveal_response.rb

@@ -237,6 +237,7 @@ module Straddle
           INACTIVE = :inactive
           REJECTED = :rejected
           REVIEW = :review
+          BLOCKED = :blocked
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -388,6 +389,13 @@ module Straddle
             OK = :ok
             OTHER_NETWORK_RETURN = :other_network_return
             PAYOUT_REFUSED = :payout_refused
+            CANCEL_REQUEST = :cancel_request
+            FAILED_VERIFICATION = :failed_verification
+            REQUIRE_REVIEW = :require_review
+            BLOCKED_BY_SYSTEM = :blocked_by_system
+            WATCHTOWER_REVIEW = :watchtower_review
+            VALIDATING = :validating
+            AUTO_HOLD = :auto_hold
 
             # @!method self.values
             #   @return [Array<Symbol>]

data/lib/straddle/models/paykey_summary_paged_v1.rb

@@ -118,7 +118,15 @@ module Straddle
         #   @return [Straddle::Models::PaykeySummaryPagedV1::Data::StatusDetails, nil]
         optional :status_details, -> { Straddle::PaykeySummaryPagedV1::Data::StatusDetails }
 
-        # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, status_details: nil)
+        # @!attribute unblock_eligible
+        #   Indicates whether this paykey is eligible for client-initiated unblocking. Only
+        #   present for blocked paykeys. True when blocked due to R29 returns and not
+        #   previously unblocked, false otherwise. Null when paykey is not blocked.
+        #
+        #   @return [Boolean, nil]
+        optional :unblock_eligible, Straddle::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, status_details: nil, unblock_eligible: nil)
         #   Some parameter documentations has been truncated, see
         #   {Straddle::Models::PaykeySummaryPagedV1::Data} for more details.
         #
@@ -149,6 +157,8 @@ module Straddle
         #   @param institution_name [String, nil] Name of the financial institution.
         #
         #   @param status_details [Straddle::Models::PaykeySummaryPagedV1::Data::StatusDetails]
+        #
+        #   @param unblock_eligible [Boolean, nil] Indicates whether this paykey is eligible for client-initiated unblocking. Only
 
         # @see Straddle::Models::PaykeySummaryPagedV1::Data#config
         class Config < Straddle::Internal::Type::BaseModel
@@ -216,6 +226,7 @@ module Straddle
           INACTIVE = :inactive
           REJECTED = :rejected
           REVIEW = :review
+          BLOCKED = :blocked
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -328,6 +339,13 @@ module Straddle
             OK = :ok
             OTHER_NETWORK_RETURN = :other_network_return
             PAYOUT_REFUSED = :payout_refused
+            CANCEL_REQUEST = :cancel_request
+            FAILED_VERIFICATION = :failed_verification
+            REQUIRE_REVIEW = :require_review
+            BLOCKED_BY_SYSTEM = :blocked_by_system
+            WATCHTOWER_REVIEW = :watchtower_review
+            VALIDATING = :validating
+            AUTO_HOLD = :auto_hold
 
             # @!method self.values
             #   @return [Array<Symbol>]

data/lib/straddle/models/paykey_unmasked_params.rb

@@ -7,6 +7,11 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute correlation_id
       #
       #   @return [String, nil]
@@ -22,7 +27,8 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
       #   @param correlation_id [String]
       #   @param request_id [String]
       #   @param straddle_account_id [String]

data/lib/straddle/models/paykey_unmasked_v1.rb

@@ -234,6 +234,7 @@ module Straddle
           INACTIVE = :inactive
           REJECTED = :rejected
           REVIEW = :review
+          BLOCKED = :blocked
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -381,6 +382,13 @@ module Straddle
             OK = :ok
             OTHER_NETWORK_RETURN = :other_network_return
             PAYOUT_REFUSED = :payout_refused
+            CANCEL_REQUEST = :cancel_request
+            FAILED_VERIFICATION = :failed_verification
+            REQUIRE_REVIEW = :require_review
+            BLOCKED_BY_SYSTEM = :blocked_by_system
+            WATCHTOWER_REVIEW = :watchtower_review
+            VALIDATING = :validating
+            AUTO_HOLD = :auto_hold
 
             # @!method self.values
             #   @return [Array<Symbol>]

data/lib/straddle/models/paykey_update_balance_params.rb

@@ -7,6 +7,11 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute correlation_id
       #
       #   @return [String, nil]
@@ -27,7 +32,8 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(id:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
       #   @param correlation_id [String]
       #   @param idempotency_key [String]
       #   @param request_id [String]

data/lib/straddle/models/paykey_v1.rb

@@ -132,7 +132,15 @@ module Straddle
         #   @return [Straddle::Models::PaykeyV1::Data::StatusDetails, nil]
         optional :status_details, -> { Straddle::PaykeyV1::Data::StatusDetails }
 
-        # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, balance: nil, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, metadata: nil, status_details: nil)
+        # @!attribute unblock_eligible
+        #   Indicates whether this paykey is eligible for client-initiated unblocking. Only
+        #   present for blocked paykeys. True when blocked due to R29 returns and not
+        #   previously unblocked, false otherwise. Null when paykey is not blocked.
+        #
+        #   @return [Boolean, nil]
+        optional :unblock_eligible, Straddle::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, balance: nil, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, metadata: nil, status_details: nil, unblock_eligible: nil)
         #   Some parameter documentations has been truncated, see
         #   {Straddle::Models::PaykeyV1::Data} for more details.
         #
@@ -167,6 +175,8 @@ module Straddle
         #   @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
         #
         #   @param status_details [Straddle::Models::PaykeyV1::Data::StatusDetails]
+        #
+        #   @param unblock_eligible [Boolean, nil] Indicates whether this paykey is eligible for client-initiated unblocking. Only
 
         # @see Straddle::Models::PaykeyV1::Data#config
         class Config < Straddle::Internal::Type::BaseModel
@@ -234,6 +244,7 @@ module Straddle
           INACTIVE = :inactive
           REJECTED = :rejected
           REVIEW = :review
+          BLOCKED = :blocked
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -385,6 +396,13 @@ module Straddle
             OK = :ok
             OTHER_NETWORK_RETURN = :other_network_return
             PAYOUT_REFUSED = :payout_refused
+            CANCEL_REQUEST = :cancel_request
+            FAILED_VERIFICATION = :failed_verification
+            REQUIRE_REVIEW = :require_review
+            BLOCKED_BY_SYSTEM = :blocked_by_system
+            WATCHTOWER_REVIEW = :watchtower_review
+            VALIDATING = :validating
+            AUTO_HOLD = :auto_hold
 
             # @!method self.values
             #   @return [Array<Symbol>]

data/lib/straddle/models/paykeys/review_decision_params.rb

@@ -8,6 +8,11 @@ module Straddle
         extend Straddle::Internal::Type::RequestParameters::Converter
         include Straddle::Internal::Type::RequestParameters
 
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
         # @!attribute status
         #
         #   @return [Symbol, Straddle::Models::Paykeys::ReviewDecisionParams::Status]
@@ -33,7 +38,8 @@ module Straddle
         #   @return [String, nil]
         optional :straddle_account_id, String
 
-        # @!method initialize(status:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        # @!method initialize(id:, status:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        #   @param id [String]
         #   @param status [Symbol, Straddle::Models::Paykeys::ReviewDecisionParams::Status]
         #   @param correlation_id [String]
         #   @param idempotency_key [String]

data/lib/straddle/models/paykeys/review_get_params.rb

@@ -8,6 +8,11 @@ module Straddle
         extend Straddle::Internal::Type::RequestParameters::Converter
         include Straddle::Internal::Type::RequestParameters
 
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
         # @!attribute correlation_id
         #
         #   @return [String, nil]
@@ -23,7 +28,8 @@ module Straddle
         #   @return [String, nil]
         optional :straddle_account_id, String
 
-        # @!method initialize(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        # @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        #   @param id [String]
         #   @param correlation_id [String]
         #   @param request_id [String]
         #   @param straddle_account_id [String]

data/lib/straddle/models/paykeys/review_get_response.rb

@@ -151,7 +151,15 @@ module Straddle
             optional :status_details,
                      -> { Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails }
 
-            # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, balance: nil, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, metadata: nil, status_details: nil)
+            # @!attribute unblock_eligible
+            #   Indicates whether this paykey is eligible for client-initiated unblocking. Only
+            #   present for blocked paykeys. True when blocked due to R29 returns and not
+            #   previously unblocked, false otherwise. Null when paykey is not blocked.
+            #
+            #   @return [Boolean, nil]
+            optional :unblock_eligible, Straddle::Internal::Type::Boolean, nil?: true
+
+            # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, balance: nil, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, metadata: nil, status_details: nil, unblock_eligible: nil)
             #   Some parameter documentations has been truncated, see
             #   {Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails} for more
             #   details.
@@ -187,6 +195,8 @@ module Straddle
             #   @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
             #
             #   @param status_details [Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails]
+            #
+            #   @param unblock_eligible [Boolean, nil] Indicates whether this paykey is eligible for client-initiated unblocking. Only
 
             # @see Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails#config
             class Config < Straddle::Internal::Type::BaseModel
@@ -256,6 +266,7 @@ module Straddle
               INACTIVE = :inactive
               REJECTED = :rejected
               REVIEW = :review
+              BLOCKED = :blocked
 
               # @!method self.values
               #   @return [Array<Symbol>]
@@ -412,6 +423,13 @@ module Straddle
                 OK = :ok
                 OTHER_NETWORK_RETURN = :other_network_return
                 PAYOUT_REFUSED = :payout_refused
+                CANCEL_REQUEST = :cancel_request
+                FAILED_VERIFICATION = :failed_verification
+                REQUIRE_REVIEW = :require_review
+                BLOCKED_BY_SYSTEM = :blocked_by_system
+                WATCHTOWER_REVIEW = :watchtower_review
+                VALIDATING = :validating
+                AUTO_HOLD = :auto_hold
 
                 # @!method self.values
                 #   @return [Array<Symbol>]
@@ -529,7 +547,6 @@ module Straddle
                 module Decision
                   extend Straddle::Internal::Type::Enum
 
-                  UNKNOWN = :unknown
                   ACCEPT = :accept
                   REJECT = :reject
                   REVIEW = :review
@@ -590,7 +607,6 @@ module Straddle
                 module Decision
                   extend Straddle::Internal::Type::Enum
 
-                  UNKNOWN = :unknown
                   ACCEPT = :accept
                   REJECT = :reject
                   REVIEW = :review
@@ -605,7 +621,6 @@ module Straddle
             module Decision
               extend Straddle::Internal::Type::Enum
 
-              UNKNOWN = :unknown
               ACCEPT = :accept
               REJECT = :reject
               REVIEW = :review

data/lib/straddle/models/paykeys/review_refresh_review_params.rb

@@ -8,6 +8,11 @@ module Straddle
         extend Straddle::Internal::Type::RequestParameters::Converter
         include Straddle::Internal::Type::RequestParameters
 
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
         # @!attribute correlation_id
         #
         #   @return [String, nil]
@@ -28,7 +33,8 @@ module Straddle
         #   @return [String, nil]
         optional :straddle_account_id, String
 
-        # @!method initialize(correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        # @!method initialize(id:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        #   @param id [String]
         #   @param correlation_id [String]
         #   @param idempotency_key [String]
         #   @param request_id [String]

data/lib/straddle/models/payment_list_params.rb

@@ -41,6 +41,12 @@ module Straddle
       #   @return [String, nil]
       optional :funding_id, String
 
+      # @!attribute include_metadata
+      #   Include the metadata for payments in the returned data.
+      #
+      #   @return [Boolean, nil]
+      optional :include_metadata, Straddle::Internal::Type::Boolean
+
       # @!attribute max_amount
       #   Search using a maximum `amount` of a `charge` or `payout`.
       #
@@ -179,7 +185,7 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(customer_id: nil, default_page_size: nil, default_sort: nil, default_sort_order: nil, external_id: nil, funding_id: nil, max_amount: nil, max_created_at: nil, max_effective_at: nil, max_payment_date: nil, min_amount: nil, min_created_at: nil, min_effective_at: nil, min_payment_date: nil, page_number: nil, page_size: nil, paykey: nil, paykey_id: nil, payment_id: nil, payment_status: nil, payment_type: nil, search_text: nil, sort_by: nil, sort_order: nil, status_reason: nil, status_source: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(customer_id: nil, default_page_size: nil, default_sort: nil, default_sort_order: nil, external_id: nil, funding_id: nil, include_metadata: nil, max_amount: nil, max_created_at: nil, max_effective_at: nil, max_payment_date: nil, min_amount: nil, min_created_at: nil, min_effective_at: nil, min_payment_date: nil, page_number: nil, page_size: nil, paykey: nil, paykey_id: nil, payment_id: nil, payment_status: nil, payment_type: nil, search_text: nil, sort_by: nil, sort_order: nil, status_reason: nil, status_source: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #   @param customer_id [String] Search using the `customer_id` of a `charge` or `payout`.
       #
       #   @param default_page_size [Integer]
@@ -192,6 +198,8 @@ module Straddle
       #
       #   @param funding_id [String] Search using the `funding_id` of a `charge` or `payout`.
       #
+      #   @param include_metadata [Boolean] Include the metadata for payments in the returned data.
+      #
       #   @param max_amount [Integer] Search using a maximum `amount` of a `charge` or `payout`.
       #
       #   @param max_created_at [Time] Search using the latest `created_at` date of a `charge` or `payout`.
@@ -276,6 +284,7 @@ module Straddle
         PENDING = :pending
         PAID = :paid
         REVERSED = :reversed
+        VALIDATING = :validating
 
         # @!method self.values
         #   @return [Array<Symbol>]
@@ -339,6 +348,13 @@ module Straddle
         OK = :ok
         OTHER_NETWORK_RETURN = :other_network_return
         PAYOUT_REFUSED = :payout_refused
+        CANCEL_REQUEST = :cancel_request
+        FAILED_VERIFICATION = :failed_verification
+        REQUIRE_REVIEW = :require_review
+        BLOCKED_BY_SYSTEM = :blocked_by_system
+        WATCHTOWER_REVIEW = :watchtower_review
+        VALIDATING = :validating
+        AUTO_HOLD = :auto_hold
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/straddle/models/payment_summary_paged_v1.rb

@@ -63,8 +63,8 @@ module Straddle
         # @!attribute description
         #   An arbitrary description for the `charge` or `payout`.
         #
-        #   @return [String]
-        required :description, String
+        #   @return [String, nil]
+        required :description, String, nil?: true
 
         # @!attribute external_id
         #   Unique identifier for the `charge` or `payout` in your database. This value must
@@ -144,13 +144,19 @@ module Straddle
         #   @return [String, nil]
         optional :funding_id, String, nil?: true
 
+        # @!attribute metadata
+        #   Metadata for payment - only included if requested.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true
+
         # @!attribute paykey_details
         #   Information about the paykey used for the `charge` or `payout`.
         #
         #   @return [Straddle::Models::PaykeyDetailsV1, nil]
         optional :paykey_details, -> { Straddle::PaykeyDetailsV1 }
 
-        # @!method initialize(id:, amount:, created_at:, currency:, description:, external_id:, funding_ids:, paykey:, payment_date:, payment_type:, status:, status_details:, trace_ids:, updated_at:, customer_details: nil, effective_at: nil, funding_id: nil, paykey_details: nil)
+        # @!method initialize(id:, amount:, created_at:, currency:, description:, external_id:, funding_ids:, paykey:, payment_date:, payment_type:, status:, status_details:, trace_ids:, updated_at:, customer_details: nil, effective_at: nil, funding_id: nil, metadata: nil, paykey_details: nil)
         #   Some parameter documentations has been truncated, see
         #   {Straddle::Models::PaymentSummaryPagedV1::Data} for more details.
         #
@@ -162,7 +168,7 @@ module Straddle
         #
         #   @param currency [String] The currency of the `charge` or `payout`. Only USD is supported.
         #
-        #   @param description [String] An arbitrary description for the `charge` or `payout`.
+        #   @param description [String, nil] An arbitrary description for the `charge` or `payout`.
         #
         #   @param external_id [String] Unique identifier for the `charge` or `payout` in your database. This value must
         #
@@ -188,6 +194,8 @@ module Straddle
         #
         #   @param funding_id [String, nil] Unique identifier for the funding event associated with the `charge` or `payout`
         #
+        #   @param metadata [Hash{Symbol=>String}, nil] Metadata for payment - only included if requested.
+        #
         #   @param paykey_details [Straddle::Models::PaykeyDetailsV1] Information about the paykey used for the `charge` or `payout`.
 
         # The type of payment. Valid values are `charge` or `payout`.
@@ -217,6 +225,7 @@ module Straddle
           PENDING = :pending
           PAID = :paid
           REVERSED = :reversed
+          VALIDATING = :validating
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/straddle/models/payout_cancel_params.rb

@@ -7,6 +7,11 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute reason
       #   Details about why the payout status was updated.
       #
@@ -33,7 +38,9 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(id:, reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
+      #
       #   @param reason [String] Details about why the payout status was updated.
       #
       #   @param correlation_id [String]

data/lib/straddle/models/payout_create_params.rb

@@ -22,8 +22,8 @@ module Straddle
       # @!attribute description
       #   An arbitrary description for the payout.
       #
-      #   @return [String]
-      required :description, String
+      #   @return [String, nil]
+      required :description, String, nil?: true
 
       # @!attribute device
       #   Information about the device used when the customer authorized the payout.
@@ -91,7 +91,7 @@ module Straddle
       #
       #   @param currency [String] The currency of the payout. Only USD is supported.
       #
-      #   @param description [String] An arbitrary description for the payout.
+      #   @param description [String, nil] An arbitrary description for the payout.
       #
       #   @param device [Straddle::Models::DeviceInfoV1] Information about the device used when the customer authorized the payout.
       #
@@ -116,13 +116,29 @@ module Straddle
       #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
 
       class Config < Straddle::Internal::Type::BaseModel
+        # @!attribute auto_hold
+        #   Defines whether to automatically place this charge on hold after being created.
+        #
+        #   @return [Boolean, nil]
+        optional :auto_hold, Straddle::Internal::Type::Boolean, nil?: true
+
+        # @!attribute auto_hold_message
+        #   The reason the payout is being automatically held on creation.
+        #
+        #   @return [String, nil]
+        optional :auto_hold_message, String, nil?: true
+
         # @!attribute sandbox_outcome
         #   Payment will simulate processing if not Standard.
         #
         #   @return [Symbol, Straddle::Models::PayoutCreateParams::Config::SandboxOutcome, nil]
         optional :sandbox_outcome, enum: -> { Straddle::PayoutCreateParams::Config::SandboxOutcome }
 
-        # @!method initialize(sandbox_outcome: nil)
+        # @!method initialize(auto_hold: nil, auto_hold_message: nil, sandbox_outcome: nil)
+        #   @param auto_hold [Boolean, nil] Defines whether to automatically place this charge on hold after being created.
+        #
+        #   @param auto_hold_message [String, nil] The reason the payout is being automatically held on creation.
+        #
         #   @param sandbox_outcome [Symbol, Straddle::Models::PayoutCreateParams::Config::SandboxOutcome] Payment will simulate processing if not Standard.
 
         # Payment will simulate processing if not Standard.

data/lib/straddle/models/payout_get_params.rb

@@ -7,6 +7,11 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute correlation_id
       #
       #   @return [String, nil]
@@ -22,7 +27,8 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
       #   @param correlation_id [String]
       #   @param request_id [String]
       #   @param straddle_account_id [String]

data/lib/straddle/models/payout_hold_params.rb

@@ -7,6 +7,11 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute reason
       #   Details about why the payout status was updated.
       #
@@ -33,7 +38,9 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(id:, reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
+      #
       #   @param reason [String] Details about why the payout status was updated.
       #
       #   @param correlation_id [String]