straddle 0.5.0 → 1.0.0

data/lib/straddle/models/payment_list_params.rb

@@ -8,90 +8,91 @@ module Straddle
       include Straddle::Internal::Type::RequestParameters
 
       # @!attribute customer_id
-      #   Search using the `customer_id` of a `charge` or `payout`.
+      #   Filter by the unique identifier of the customer.
       #
       #   @return [String, nil]
       optional :customer_id, String
 
       # @!attribute default_page_size
+      #   Default number of results returned per page.
       #
       #   @return [Integer, nil]
       optional :default_page_size, Integer
 
       # @!attribute default_sort
-      #   The field to sort the results by.
+      #   Default field used to sort the results.
       #
       #   @return [Symbol, Straddle::Models::PaymentListParams::DefaultSort, nil]
       optional :default_sort, enum: -> { Straddle::PaymentListParams::DefaultSort }
 
       # @!attribute default_sort_order
+      #   Default order in which to sort the results.
       #
-      #   @return [Symbol, Straddle::Models::PaymentListParams::DefaultSortOrder, nil]
-      optional :default_sort_order, enum: -> { Straddle::PaymentListParams::DefaultSortOrder }
+      #   @return [Symbol, Straddle::Models::SortOrder, nil]
+      optional :default_sort_order, enum: -> { Straddle::SortOrder }
 
       # @!attribute external_id
-      #   Search using the `external_id` of a `charge` or `payout`.
+      #   Filter by your external identifier for the payment.
       #
       #   @return [String, nil]
       optional :external_id, String
 
       # @!attribute funding_id
-      #   Search using the `funding_id` of a `charge` or `payout`.
+      #   Filter by the unique identifier of a funding event.
       #
       #   @return [String, nil]
       optional :funding_id, String
 
       # @!attribute has_refund
-      #   Has the payment been refunded by an associated payout (only applicable to
-      #   charges).
+      #   Filter charges by whether an associated payout has refunded them.
       #
       #   @return [Boolean, nil]
       optional :has_refund, Straddle::Internal::Type::Boolean
 
       # @!attribute has_resubmit
-      #   Has the payment been resubmitted.
+      #   Filter payments by whether they have been resubmitted.
       #
       #   @return [Boolean, nil]
       optional :has_resubmit, Straddle::Internal::Type::Boolean
 
       # @!attribute include_metadata
-      #   Include the metadata for payments in the returned data.
+      #   Whether to include metadata in each returned payment. Defaults to false.
       #
       #   @return [Boolean, nil]
       optional :include_metadata, Straddle::Internal::Type::Boolean
 
       # @!attribute is_refund
-      #   Is the payment a refund of an original charge (only applicable to payouts).
+      #   Filter payouts by whether they refund an original charge.
       #
       #   @return [Boolean, nil]
       optional :is_refund, Straddle::Internal::Type::Boolean
 
       # @!attribute is_resubmit
-      #   Is the payment a resubmit of an original payment.
+      #   Filter payments by whether they resubmit an original payment.
       #
       #   @return [Boolean, nil]
       optional :is_resubmit, Straddle::Internal::Type::Boolean
 
       # @!attribute max_amount
-      #   Search using a maximum `amount` of a `charge` or `payout`.
+      #   Filter to payments with an amount in cents less than or equal to this value.
       #
       #   @return [Integer, nil]
       optional :max_amount, Integer
 
       # @!attribute max_created_at
-      #   Search using the latest `created_at` date of a `charge` or `payout`.
+      #   Filter to payments created at or before this timestamp.
       #
       #   @return [Time, nil]
       optional :max_created_at, Time
 
       # @!attribute max_effective_at
-      #   Search using the latest `effective_date` of a `charge` or `payout`.
+      #   Filter to payments effective at or before this timestamp.
       #
       #   @return [Time, nil]
       optional :max_effective_at, Time
 
       # @!attribute max_payment_date
-      #   Search using the latest `payment_date` of a `charge` or `payout`.
+      #   Filter to payments with a payment date on or before this date.
       #
       #   @return [Date, nil]
       optional :max_payment_date, Date
@@ -103,25 +104,25 @@ module Straddle
       optional :max_updated_at, Time
 
       # @!attribute min_amount
-      #   Search using the minimum `amount of a `charge`or`payout`.
+      #   Filter to payments with an amount in cents greater than or equal to this value.
       #
       #   @return [Integer, nil]
       optional :min_amount, Integer
 
       # @!attribute min_created_at
-      #   Search using the earliest `created_at` date of a `charge` or `payout`.
+      #   Filter to payments created at or after this timestamp.
       #
       #   @return [Time, nil]
       optional :min_created_at, Time
 
       # @!attribute min_effective_at
-      #   Search using the earliest `effective_date` of a `charge` or `payout`.
+      #   Filter to payments effective at or after this timestamp.
       #
       #   @return [Time, nil]
       optional :min_effective_at, Time
 
       # @!attribute min_payment_date
-      #   Search using the earliest ` `of a `charge` or `payout`.
+      #   Filter to payments with a payment date on or after this date.
       #
       #   @return [Date, nil]
       optional :min_payment_date, Date
@@ -133,174 +134,170 @@ module Straddle
       optional :min_updated_at, Time
 
       # @!attribute page_number
-      #   Results page number. Starts at page 1.
+      #   Page number to return.
       #
       #   @return [Integer, nil]
       optional :page_number, Integer
 
       # @!attribute page_size
-      #   Results page size. Max value: 1000
+      #   Number of results to return per page.
       #
       #   @return [Integer, nil]
       optional :page_size, Integer
 
       # @!attribute paykey
-      #   Search using the `paykey` of a `charge` or `payout`.
+      #   Filter by the paykey token.
       #
       #   @return [String, nil]
       optional :paykey, String
 
       # @!attribute paykey_id
-      #   Search using the `paykey_id` of a `charge` or `payout`.
+      #   Filter by the unique identifier of the paykey.
       #
       #   @return [String, nil]
       optional :paykey_id, String
 
       # @!attribute payment_id
-      #   Search using the `id` of a `charge` or `payout`.
+      #   Filter by the payment's unique identifier.
       #
       #   @return [String, nil]
       optional :payment_id, String
 
       # @!attribute payment_status
-      #   Search by the status of a `charge` or `payout`.
+      #   Filter by payment status.
       #
-      #   @return [Array<Symbol, Straddle::Models::PaymentListParams::PaymentStatus>, nil]
-      optional :payment_status,
-               -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaymentListParams::PaymentStatus] }
+      #   @return [Array<Symbol, Straddle::Models::PaymentStatus>, nil]
+      optional :payment_status, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaymentStatus] }
 
       # @!attribute payment_type
-      #   Search by the type of a `charge` or `payout`.
+      #   Filter by payment type.
       #
-      #   @return [Array<Symbol, Straddle::Models::PaymentListParams::PaymentType>, nil]
-      optional :payment_type,
-               -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaymentListParams::PaymentType] }
+      #   @return [Array<Symbol, Straddle::Models::PaymentType>, nil]
+      optional :payment_type, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaymentType] }
 
       # @!attribute search_text
-      #   Search using a text string associated with a `charge` or `payout`.
+      #   Free-text search across payment fields.
       #
       #   @return [String, nil]
       optional :search_text, String
 
       # @!attribute sort_by
-      #   The field to sort the results by.
+      #   Field used to sort the results.
       #
       #   @return [Symbol, Straddle::Models::PaymentListParams::SortBy, nil]
       optional :sort_by, enum: -> { Straddle::PaymentListParams::SortBy }
 
       # @!attribute sort_order
+      #   Order in which to sort the results.
       #
-      #   @return [Symbol, Straddle::Models::PaymentListParams::SortOrder, nil]
-      optional :sort_order, enum: -> { Straddle::PaymentListParams::SortOrder }
+      #   @return [Symbol, Straddle::Models::SortOrder, nil]
+      optional :sort_order, enum: -> { Straddle::SortOrder }
 
       # @!attribute status_reason
-      #   Reason for latest payment status change.
+      #   Filter by the reason for the most recent payment status change.
       #
-      #   @return [Array<Symbol, Straddle::Models::PaymentListParams::StatusReason>, nil]
-      optional :status_reason,
-               -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaymentListParams::StatusReason] }
+      #   @return [Array<Symbol, Straddle::Models::PaymentStatusReason>, nil]
+      optional :status_reason, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaymentStatusReason] }
 
       # @!attribute status_source
-      #   Source of latest payment status change.
+      #   Filter by the source of the most recent payment status change.
       #
-      #   @return [Array<Symbol, Straddle::Models::PaymentListParams::StatusSource>, nil]
-      optional :status_source,
-               -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaymentListParams::StatusSource] }
+      #   @return [Array<Symbol, Straddle::Models::PaymentStatusSource>, nil]
+      optional :status_source, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaymentStatusSource] }
 
       # @!attribute correlation_id
+      #   Optional client-generated identifier for tracing a series of related requests.
       #
       #   @return [String, nil]
       optional :correlation_id, String
 
       # @!attribute request_id
+      #   Optional client-generated identifier for tracing one request.
       #
       #   @return [String, nil]
       optional :request_id, String
 
       # @!attribute straddle_account_id
+      #   For platform requests, the embedded account UUID that sets the request scope.
       #
       #   @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, has_refund: nil, has_resubmit: nil, include_metadata: nil, is_refund: nil, is_resubmit: nil, max_amount: nil, max_created_at: nil, max_effective_at: nil, max_payment_date: nil, max_updated_at: nil, min_amount: nil, min_created_at: nil, min_effective_at: nil, min_payment_date: nil, min_updated_at: 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: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Straddle::Models::PaymentListParams} for more details.
+      #   @param customer_id [String] Filter by the unique identifier of the customer.
       #
-      #   @param customer_id [String] Search using the `customer_id` of a `charge` or `payout`.
+      #   @param default_page_size [Integer] Default number of results returned per page.
       #
-      #   @param default_page_size [Integer]
+      #   @param default_sort [Symbol, Straddle::Models::PaymentListParams::DefaultSort] Default field used to sort the results.
       #
-      #   @param default_sort [Symbol, Straddle::Models::PaymentListParams::DefaultSort] The field to sort the results by.
+      #   @param default_sort_order [Symbol, Straddle::Models::SortOrder] Default order in which to sort the results.
       #
-      #   @param default_sort_order [Symbol, Straddle::Models::PaymentListParams::DefaultSortOrder]
+      #   @param external_id [String] Filter by your external identifier for the payment.
       #
-      #   @param external_id [String] Search using the `external_id` of a `charge` or `payout`.
+      #   @param funding_id [String] Filter by the unique identifier of a funding event.
       #
-      #   @param funding_id [String] Search using the `funding_id` of a `charge` or `payout`.
+      #   @param has_refund [Boolean] Filter charges by whether an associated payout has refunded them.
       #
-      #   @param has_refund [Boolean] Has the payment been refunded by an associated payout (only applicable to charge
+      #   @param has_resubmit [Boolean] Filter payments by whether they have been resubmitted.
       #
-      #   @param has_resubmit [Boolean] Has the payment been resubmitted.
+      #   @param include_metadata [Boolean] Whether to include metadata in each returned payment. Defaults to false.
       #
-      #   @param include_metadata [Boolean] Include the metadata for payments in the returned data.
+      #   @param is_refund [Boolean] Filter payouts by whether they refund an original charge.
       #
-      #   @param is_refund [Boolean] Is the payment a refund of an original charge (only applicable to payouts).
+      #   @param is_resubmit [Boolean] Filter payments by whether they resubmit an original payment.
       #
-      #   @param is_resubmit [Boolean] Is the payment a resubmit of an original payment.
+      #   @param max_amount [Integer] Filter to payments with an amount in cents less than or equal to this value.
       #
-      #   @param max_amount [Integer] Search using a maximum `amount` of a `charge` or `payout`.
+      #   @param max_created_at [Time] Filter to payments created at or before this timestamp.
       #
-      #   @param max_created_at [Time] Search using the latest `created_at` date of a `charge` or `payout`.
+      #   @param max_effective_at [Time] Filter to payments effective at or before this timestamp.
       #
-      #   @param max_effective_at [Time] Search using the latest `effective_date` of a `charge` or `payout`.
-      #
-      #   @param max_payment_date [Date] Search using the latest `payment_date` of a `charge` or `payout`.
+      #   @param max_payment_date [Date] Filter to payments with a payment date on or before this date.
       #
       #   @param max_updated_at [Time] Filter to payments last updated on or before this timestamp.
       #
-      #   @param min_amount [Integer] Search using the minimum `amount of a `charge`or`payout`.
+      #   @param min_amount [Integer] Filter to payments with an amount in cents greater than or equal to this value.
       #
-      #   @param min_created_at [Time] Search using the earliest `created_at` date of a `charge` or `payout`.
+      #   @param min_created_at [Time] Filter to payments created at or after this timestamp.
       #
-      #   @param min_effective_at [Time] Search using the earliest `effective_date` of a `charge` or `payout`.
+      #   @param min_effective_at [Time] Filter to payments effective at or after this timestamp.
       #
-      #   @param min_payment_date [Date] Search using the earliest ` `of a `charge` or `payout`.
+      #   @param min_payment_date [Date] Filter to payments with a payment date on or after this date.
       #
       #   @param min_updated_at [Time] Filter to payments last updated on or after this timestamp.
       #
-      #   @param page_number [Integer] Results page number. Starts at page 1.
+      #   @param page_number [Integer] Page number to return.
       #
-      #   @param page_size [Integer] Results page size. Max value: 1000
+      #   @param page_size [Integer] Number of results to return per page.
       #
-      #   @param paykey [String] Search using the `paykey` of a `charge` or `payout`.
+      #   @param paykey [String] Filter by the paykey token.
       #
-      #   @param paykey_id [String] Search using the `paykey_id` of a `charge` or `payout`.
+      #   @param paykey_id [String] Filter by the unique identifier of the paykey.
       #
-      #   @param payment_id [String] Search using the `id` of a `charge` or `payout`.
+      #   @param payment_id [String] Filter by the payment's unique identifier.
       #
-      #   @param payment_status [Array<Symbol, Straddle::Models::PaymentListParams::PaymentStatus>] Search by the status of a `charge` or `payout`.
+      #   @param payment_status [Array<Symbol, Straddle::Models::PaymentStatus>] Filter by payment status.
       #
-      #   @param payment_type [Array<Symbol, Straddle::Models::PaymentListParams::PaymentType>] Search by the type of a `charge` or `payout`.
+      #   @param payment_type [Array<Symbol, Straddle::Models::PaymentType>] Filter by payment type.
       #
-      #   @param search_text [String] Search using a text string associated with a `charge` or `payout`.
+      #   @param search_text [String] Free-text search across payment fields.
       #
-      #   @param sort_by [Symbol, Straddle::Models::PaymentListParams::SortBy] The field to sort the results by.
+      #   @param sort_by [Symbol, Straddle::Models::PaymentListParams::SortBy] Field used to sort the results.
       #
-      #   @param sort_order [Symbol, Straddle::Models::PaymentListParams::SortOrder]
+      #   @param sort_order [Symbol, Straddle::Models::SortOrder] Order in which to sort the results.
       #
-      #   @param status_reason [Array<Symbol, Straddle::Models::PaymentListParams::StatusReason>] Reason for latest payment status change.
+      #   @param status_reason [Array<Symbol, Straddle::Models::PaymentStatusReason>] Filter by the reason for the most recent payment status change.
       #
-      #   @param status_source [Array<Symbol, Straddle::Models::PaymentListParams::StatusSource>] Source of latest payment status change.
+      #   @param status_source [Array<Symbol, Straddle::Models::PaymentStatusSource>] Filter by the source of the most recent payment status change.
       #
-      #   @param correlation_id [String]
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
       #
-      #   @param request_id [String]
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
       #
-      #   @param straddle_account_id [String]
+      #   @param straddle_account_id [String] For platform requests, the embedded account UUID that sets the request scope.
       #
       #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
 
-      # The field to sort the results by.
       module DefaultSort
         extend Straddle::Internal::Type::Enum
 
@@ -315,46 +312,6 @@ module Straddle
         #   @return [Array<Symbol>]
       end
 
-      module DefaultSortOrder
-        extend Straddle::Internal::Type::Enum
-
-        ASC = :asc
-        DESC = :desc
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # The current status of the `charge` or `payout`.
-      module PaymentStatus
-        extend Straddle::Internal::Type::Enum
-
-        CREATED = :created
-        SCHEDULED = :scheduled
-        FAILED = :failed
-        CANCELLED = :cancelled
-        ON_HOLD = :on_hold
-        PENDING = :pending
-        PAID = :paid
-        REVERSED = :reversed
-        VALIDATING = :validating
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # The type of payment.
-      module PaymentType
-        extend Straddle::Internal::Type::Enum
-
-        CHARGE = :charge
-        PAYOUT = :payout
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # The field to sort the results by.
       module SortBy
         extend Straddle::Internal::Type::Enum
 
@@ -368,64 +325,6 @@ module Straddle
         # @!method self.values
         #   @return [Array<Symbol>]
       end
-
-      module SortOrder
-        extend Straddle::Internal::Type::Enum
-
-        ASC = :asc
-        DESC = :desc
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      module StatusReason
-        extend Straddle::Internal::Type::Enum
-
-        INSUFFICIENT_FUNDS = :insufficient_funds
-        CLOSED_BANK_ACCOUNT = :closed_bank_account
-        INVALID_BANK_ACCOUNT = :invalid_bank_account
-        INVALID_ROUTING = :invalid_routing
-        DISPUTED = :disputed
-        PAYMENT_STOPPED = :payment_stopped
-        OWNER_DECEASED = :owner_deceased
-        FROZEN_BANK_ACCOUNT = :frozen_bank_account
-        RISK_REVIEW = :risk_review
-        FRAUDULENT = :fraudulent
-        DUPLICATE_ENTRY = :duplicate_entry
-        INVALID_PAYKEY = :invalid_paykey
-        PAYMENT_BLOCKED = :payment_blocked
-        AMOUNT_TOO_LARGE = :amount_too_large
-        TOO_MANY_ATTEMPTS = :too_many_attempts
-        INTERNAL_SYSTEM_ERROR = :internal_system_error
-        USER_REQUEST = :user_request
-        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>]
-      end
-
-      module StatusSource
-        extend Straddle::Internal::Type::Enum
-
-        WATCHTOWER = :watchtower
-        BANK_DECLINE = :bank_decline
-        CUSTOMER_DISPUTE = :customer_dispute
-        USER_ACTION = :user_action
-        SYSTEM = :system
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/straddle/models/payment_rail.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # The payment rail used for the charge or payout.
+    module PaymentRail
+      extend Straddle::Internal::Type::Enum
+
+      ACH = :ach
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/straddle/models/payment_relationship.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module PaymentRelationship
+      extend Straddle::Internal::Type::Enum
+
+      ORIGINAL = :original
+      RESUBMIT = :resubmit
+      REFUND = :refund
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/straddle/models/payment_status.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # The current status of the `charge` or `payout`.
+    module PaymentStatus
+      extend Straddle::Internal::Type::Enum
+
+      CREATED = :created
+      SCHEDULED = :scheduled
+      FAILED = :failed
+      CANCELLED = :cancelled
+      ON_HOLD = :on_hold
+      PENDING = :pending
+      PAID = :paid
+      REVERSED = :reversed
+      VALIDATING = :validating
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/straddle/models/payment_status_details.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class PaymentStatusDetails < Straddle::Internal::Type::BaseModel
+      # @!attribute changed_at
+      #   Timestamp when the status changed.
+      #
+      #   @return [Time]
+      required :changed_at, Time
+
+      # @!attribute message
+      #   Human-readable status description.
+      #
+      #   @return [String]
+      required :message, String
+
+      # @!attribute reason
+      #   Machine-readable reason for the status.
+      #
+      #   @return [Symbol, Straddle::Models::PaymentStatusReason]
+      required :reason, enum: -> { Straddle::PaymentStatusReason }
+
+      # @!attribute source
+      #   Source of the status change.
+      #
+      #   @return [Symbol, Straddle::Models::PaymentStatusSource]
+      required :source, enum: -> { Straddle::PaymentStatusSource }
+
+      # @!attribute code
+      #   Status code, when available.
+      #
+      #   @return [String, nil]
+      optional :code, String, nil?: true
+
+      # @!method initialize(changed_at:, message:, reason:, source:, code: nil)
+      #   @param changed_at [Time] Timestamp when the status changed.
+      #
+      #   @param message [String] Human-readable status description.
+      #
+      #   @param reason [Symbol, Straddle::Models::PaymentStatusReason] Machine-readable reason for the status.
+      #
+      #   @param source [Symbol, Straddle::Models::PaymentStatusSource] Source of the status change.
+      #
+      #   @param code [String, nil] Status code, when available.
+    end
+  end
+end

data/lib/straddle/models/payment_status_history.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class PaymentStatusHistory < Straddle::Internal::Type::BaseModel
+      # @!attribute changed_at
+      #   Timestamp when the status changed.
+      #
+      #   @return [Time]
+      required :changed_at, Time
+
+      # @!attribute message
+      #   Human-readable status description.
+      #
+      #   @return [String]
+      required :message, String
+
+      # @!attribute reason
+      #   Machine-readable reason for the status.
+      #
+      #   @return [Symbol, Straddle::Models::PaymentStatusReason]
+      required :reason, enum: -> { Straddle::PaymentStatusReason }
+
+      # @!attribute source
+      #   Source of the status change.
+      #
+      #   @return [Symbol, Straddle::Models::PaymentStatusSource]
+      required :source, enum: -> { Straddle::PaymentStatusSource }
+
+      # @!attribute status
+      #   The current status of the `charge` or `payout`.
+      #
+      #   @return [Symbol, Straddle::Models::PaymentStatus]
+      required :status, enum: -> { Straddle::PaymentStatus }
+
+      # @!attribute code
+      #   Status code, when available.
+      #
+      #   @return [String, nil]
+      optional :code, String, nil?: true
+
+      # @!method initialize(changed_at:, message:, reason:, source:, status:, code: nil)
+      #   @param changed_at [Time] Timestamp when the status changed.
+      #
+      #   @param message [String] Human-readable status description.
+      #
+      #   @param reason [Symbol, Straddle::Models::PaymentStatusReason] Machine-readable reason for the status.
+      #
+      #   @param source [Symbol, Straddle::Models::PaymentStatusSource] Source of the status change.
+      #
+      #   @param status [Symbol, Straddle::Models::PaymentStatus] The current status of the `charge` or `payout`.
+      #
+      #   @param code [String, nil] Status code, when available.
+    end
+  end
+end