straddle 0.3.0 → 0.5.0

data/lib/straddle/models/embed/accounts/capability_request_list_params.rb

@@ -9,6 +9,11 @@ module Straddle
           extend Straddle::Internal::Type::RequestParameters::Converter
           include Straddle::Internal::Type::RequestParameters
 
+          # @!attribute account_id
+          #
+          #   @return [String]
+          required :account_id, String
+
           # @!attribute category
           #   Filter capability requests by category.
           #
@@ -61,7 +66,9 @@ module Straddle
           #   @return [String, nil]
           optional :request_id, String
 
-          # @!method initialize(category: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, status: nil, type: nil, correlation_id: nil, request_id: nil, request_options: {})
+          # @!method initialize(account_id:, category: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, status: nil, type: nil, correlation_id: nil, request_id: nil, request_options: {})
+          #   @param account_id [String]
+          #
           #   @param category [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestListParams::Category] Filter capability requests by category.
           #
           #   @param page_number [Integer] Results page number. Starts at page 1.

data/lib/straddle/models/embed/accounts/capability_request_paged_v1.rb

@@ -68,6 +68,12 @@ module Straddle
             #   @return [Time]
             required :created_at, Time
 
+            # @!attribute enable
+            #   Whether this capability request is to enable or disable the capability.
+            #
+            #   @return [Boolean]
+            required :enable, Straddle::Internal::Type::Boolean
+
             # @!attribute status
             #   The current status of the capability request.
             #
@@ -94,7 +100,7 @@ module Straddle
                      Straddle::Internal::Type::HashOf[Straddle::Internal::Type::Unknown],
                      nil?: true
 
-            # @!method initialize(id:, account_id:, category:, created_at:, status:, type:, updated_at:, settings: nil)
+            # @!method initialize(id:, account_id:, category:, created_at:, enable:, status:, type:, updated_at:, settings: nil)
             #   Some parameter documentations has been truncated, see
             #   {Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data} for more
             #   details.
@@ -107,6 +113,8 @@ module Straddle
             #
             #   @param created_at [Time] Timestamp of when the capability request was created.
             #
+            #   @param enable [Boolean] Whether this capability request is to enable or disable the capability.
+            #
             #   @param status [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data::Status] The current status of the capability request.
             #
             #   @param type [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data::Type] The specific type of capability being requested within the category.

data/lib/straddle/models/embed/address_v1.rb

@@ -4,35 +4,29 @@ module Straddle
   module Models
     module Embed
       class AddressV1 < Straddle::Internal::Type::BaseModel
-        # @!attribute address1
-        #   Primary address line (e.g., street, PO Box).
-        #
-        #   @return [String]
-        required :address1, String
-
         # @!attribute city
         #   City, district, suburb, town, or village.
         #
         #   @return [String, nil]
         required :city, String, nil?: true
 
-        # @!attribute state
-        #   Two-letter state code.
+        # @!attribute line1
+        #   Primary address line (e.g., street, PO Box).
         #
         #   @return [String, nil]
-        required :state, String, nil?: true
+        required :line1, String, nil?: true
 
-        # @!attribute zip
-        #   Zip or postal code.
+        # @!attribute postal_code
+        #   Postal or ZIP code.
         #
-        #   @return [String]
-        required :zip, String
+        #   @return [String, nil]
+        required :postal_code, String, nil?: true
 
-        # @!attribute address2
-        #   Secondary address line (e.g., apartment, suite, unit, or building).
+        # @!attribute state
+        #   Two-letter state code.
         #
         #   @return [String, nil]
-        optional :address2, String, nil?: true
+        required :state, String, nil?: true
 
         # @!attribute country
         #   The country of the address, in ISO 3166-1 alpha-2 format.
@@ -40,44 +34,26 @@ module Straddle
         #   @return [String, nil]
         optional :country, String, nil?: true
 
-        # @!attribute line1
-        #   Primary address line (e.g., street, PO Box).
-        #
-        #   @return [String, nil]
-        optional :line1, String, nil?: true
-
         # @!attribute line2
         #   Secondary address line (e.g., apartment, suite, unit, or building).
         #
         #   @return [String, nil]
         optional :line2, String, nil?: true
 
-        # @!attribute postal_code
-        #   Postal or ZIP code.
-        #
-        #   @return [String, nil]
-        optional :postal_code, String, nil?: true
-
-        # @!method initialize(address1:, city:, state:, zip:, address2: nil, country: nil, line1: nil, line2: nil, postal_code: nil)
+        # @!method initialize(city:, line1:, postal_code:, state:, country: nil, line2: nil)
         #   The address object is optional. If provided, it must be a valid address.
         #
-        #   @param address1 [String] Primary address line (e.g., street, PO Box).
-        #
         #   @param city [String, nil] City, district, suburb, town, or village.
         #
-        #   @param state [String, nil] Two-letter state code.
+        #   @param line1 [String, nil] Primary address line (e.g., street, PO Box).
         #
-        #   @param zip [String] Zip or postal code.
+        #   @param postal_code [String, nil] Postal or ZIP code.
         #
-        #   @param address2 [String, nil] Secondary address line (e.g., apartment, suite, unit, or building).
+        #   @param state [String, nil] Two-letter state code.
         #
         #   @param country [String, nil] The country of the address, in ISO 3166-1 alpha-2 format.
         #
-        #   @param line1 [String, nil] Primary address line (e.g., street, PO Box).
-        #
         #   @param line2 [String, nil] Secondary address line (e.g., apartment, suite, unit, or building).
-        #
-        #   @param postal_code [String, nil] Postal or ZIP code.
       end
     end
   end

data/lib/straddle/models/embed/linked_bank_account_cancel_params.rb

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

data/lib/straddle/models/embed/linked_bank_account_get_params.rb

@@ -8,6 +8,11 @@ module Straddle
         extend Straddle::Internal::Type::RequestParameters::Converter
         include Straddle::Internal::Type::RequestParameters
 
+        # @!attribute linked_bank_account_id
+        #
+        #   @return [String]
+        required :linked_bank_account_id, String
+
         # @!attribute correlation_id
         #
         #   @return [String, nil]
@@ -18,7 +23,8 @@ module Straddle
         #   @return [String, nil]
         optional :request_id, String
 
-        # @!method initialize(correlation_id: nil, request_id: nil, request_options: {})
+        # @!method initialize(linked_bank_account_id:, correlation_id: nil, request_id: nil, request_options: {})
+        #   @param linked_bank_account_id [String]
         #   @param correlation_id [String]
         #   @param request_id [String]
         #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]

data/lib/straddle/models/embed/linked_bank_account_unmask_params.rb

@@ -8,6 +8,11 @@ module Straddle
         extend Straddle::Internal::Type::RequestParameters::Converter
         include Straddle::Internal::Type::RequestParameters
 
+        # @!attribute linked_bank_account_id
+        #
+        #   @return [String]
+        required :linked_bank_account_id, String
+
         # @!attribute correlation_id
         #
         #   @return [String, nil]
@@ -18,7 +23,8 @@ module Straddle
         #   @return [String, nil]
         optional :request_id, String
 
-        # @!method initialize(correlation_id: nil, request_id: nil, request_options: {})
+        # @!method initialize(linked_bank_account_id:, correlation_id: nil, request_id: nil, request_options: {})
+        #   @param linked_bank_account_id [String]
         #   @param correlation_id [String]
         #   @param request_id [String]
         #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]

data/lib/straddle/models/embed/linked_bank_account_update_params.rb

@@ -8,6 +8,11 @@ module Straddle
         extend Straddle::Internal::Type::RequestParameters::Converter
         include Straddle::Internal::Type::RequestParameters
 
+        # @!attribute linked_bank_account_id
+        #
+        #   @return [String]
+        required :linked_bank_account_id, String
+
         # @!attribute bank_account
         #
         #   @return [Straddle::Models::Embed::LinkedBankAccountUpdateParams::BankAccount]
@@ -35,10 +40,12 @@ module Straddle
         #   @return [String, nil]
         optional :request_id, String
 
-        # @!method initialize(bank_account:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+        # @!method initialize(linked_bank_account_id:, bank_account:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Straddle::Models::Embed::LinkedBankAccountUpdateParams} for more details.
         #
+        #   @param linked_bank_account_id [String]
+        #
         #   @param bank_account [Straddle::Models::Embed::LinkedBankAccountUpdateParams::BankAccount]
         #
         #   @param metadata [Hash{Symbol=>String, nil}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional

data/lib/straddle/models/embed/organization_get_params.rb

@@ -8,6 +8,11 @@ module Straddle
         extend Straddle::Internal::Type::RequestParameters::Converter
         include Straddle::Internal::Type::RequestParameters
 
+        # @!attribute organization_id
+        #
+        #   @return [String]
+        required :organization_id, String
+
         # @!attribute correlation_id
         #
         #   @return [String, nil]
@@ -18,7 +23,8 @@ module Straddle
         #   @return [String, nil]
         optional :request_id, String
 
-        # @!method initialize(correlation_id: nil, request_id: nil, request_options: {})
+        # @!method initialize(organization_id:, correlation_id: nil, request_id: nil, request_options: {})
+        #   @param organization_id [String]
         #   @param correlation_id [String]
         #   @param request_id [String]
         #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]

data/lib/straddle/models/embed/representative.rb

@@ -198,7 +198,7 @@ module Straddle
             required :control, Straddle::Internal::Type::Boolean
 
             # @!attribute owner
-            #   Whether the representative owns any percentage of of the equity interests of the
+            #   Whether the representative owns any percentage of the equity interests of the
             #   legal entity.
             #
             #   @return [Boolean]
@@ -233,7 +233,7 @@ module Straddle
             #
             #   @param control [Boolean] Whether the representative has significant responsibility to control, manage, or
             #
-            #   @param owner [Boolean] Whether the representative owns any percentage of of the equity interests of the
+            #   @param owner [Boolean] Whether the representative owns any percentage of the equity interests of the le
             #
             #   @param primary [Boolean] Whether the person is authorized as the primary representative of the account. T
             #

data/lib/straddle/models/embed/representative_create_params.rb

@@ -126,7 +126,7 @@ module Straddle
           required :control, Straddle::Internal::Type::Boolean
 
           # @!attribute owner
-          #   Whether the representative owns any percentage of of the equity interests of the
+          #   Whether the representative owns any percentage of the equity interests of the
           #   legal entity.
           #
           #   @return [Boolean]
@@ -162,7 +162,7 @@ module Straddle
           #
           #   @param control [Boolean] Whether the representative has significant responsibility to control, manage, or
           #
-          #   @param owner [Boolean] Whether the representative owns any percentage of of the equity interests of the
+          #   @param owner [Boolean] Whether the representative owns any percentage of the equity interests of the le
           #
           #   @param primary [Boolean] Whether the person is authorized as the primary representative of the account. T
           #

data/lib/straddle/models/embed/representative_get_params.rb

@@ -8,6 +8,11 @@ module Straddle
         extend Straddle::Internal::Type::RequestParameters::Converter
         include Straddle::Internal::Type::RequestParameters
 
+        # @!attribute representative_id
+        #
+        #   @return [String]
+        required :representative_id, String
+
         # @!attribute correlation_id
         #
         #   @return [String, nil]
@@ -18,7 +23,8 @@ module Straddle
         #   @return [String, nil]
         optional :request_id, String
 
-        # @!method initialize(correlation_id: nil, request_id: nil, request_options: {})
+        # @!method initialize(representative_id:, correlation_id: nil, request_id: nil, request_options: {})
+        #   @param representative_id [String]
         #   @param correlation_id [String]
         #   @param request_id [String]
         #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]

data/lib/straddle/models/embed/representative_paged.rb

@@ -197,7 +197,7 @@ module Straddle
             required :control, Straddle::Internal::Type::Boolean
 
             # @!attribute owner
-            #   Whether the representative owns any percentage of of the equity interests of the
+            #   Whether the representative owns any percentage of the equity interests of the
             #   legal entity.
             #
             #   @return [Boolean]
@@ -233,7 +233,7 @@ module Straddle
             #
             #   @param control [Boolean] Whether the representative has significant responsibility to control, manage, or
             #
-            #   @param owner [Boolean] Whether the representative owns any percentage of of the equity interests of the
+            #   @param owner [Boolean] Whether the representative owns any percentage of the equity interests of the le
             #
             #   @param primary [Boolean] Whether the person is authorized as the primary representative of the account. T
             #

data/lib/straddle/models/embed/representative_unmask_params.rb

@@ -8,6 +8,11 @@ module Straddle
         extend Straddle::Internal::Type::RequestParameters::Converter
         include Straddle::Internal::Type::RequestParameters
 
+        # @!attribute representative_id
+        #
+        #   @return [String]
+        required :representative_id, String
+
         # @!attribute correlation_id
         #
         #   @return [String, nil]
@@ -18,7 +23,8 @@ module Straddle
         #   @return [String, nil]
         optional :request_id, String
 
-        # @!method initialize(correlation_id: nil, request_id: nil, request_options: {})
+        # @!method initialize(representative_id:, correlation_id: nil, request_id: nil, request_options: {})
+        #   @param representative_id [String]
         #   @param correlation_id [String]
         #   @param request_id [String]
         #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]

data/lib/straddle/models/embed/representative_update_params.rb

@@ -8,6 +8,11 @@ module Straddle
         extend Straddle::Internal::Type::RequestParameters::Converter
         include Straddle::Internal::Type::RequestParameters
 
+        # @!attribute representative_id
+        #
+        #   @return [String]
+        required :representative_id, String
+
         # @!attribute dob
         #   The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD).
         #
@@ -78,10 +83,12 @@ module Straddle
         #   @return [String, nil]
         optional :request_id, String
 
-        # @!method initialize(dob:, email:, first_name:, last_name:, mobile_number:, relationship:, ssn_last4:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+        # @!method initialize(representative_id:, dob:, email:, first_name:, last_name:, mobile_number:, relationship:, ssn_last4:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Straddle::Models::Embed::RepresentativeUpdateParams} for more details.
         #
+        #   @param representative_id [String]
+        #
         #   @param dob [Date] The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD).
         #
         #   @param email [String] The email address of the representative.
@@ -118,7 +125,7 @@ module Straddle
           required :control, Straddle::Internal::Type::Boolean
 
           # @!attribute owner
-          #   Whether the representative owns any percentage of of the equity interests of the
+          #   Whether the representative owns any percentage of the equity interests of the
           #   legal entity.
           #
           #   @return [Boolean]
@@ -154,7 +161,7 @@ module Straddle
           #
           #   @param control [Boolean] Whether the representative has significant responsibility to control, manage, or
           #
-          #   @param owner [Boolean] Whether the representative owns any percentage of of the equity interests of the
+          #   @param owner [Boolean] Whether the representative owns any percentage of the equity interests of the le
           #
           #   @param primary [Boolean] Whether the person is authorized as the primary representative of the account. T
           #

data/lib/straddle/models/funding_event_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/funding_event_list_params.rb

@@ -63,6 +63,36 @@ module Straddle
       #   @return [Symbol, Straddle::Models::FundingEventListParams::SortOrder, nil]
       optional :sort_order, enum: -> { Straddle::FundingEventListParams::SortOrder }
 
+      # @!attribute status
+      #   Funding Event status.
+      #
+      #   @return [Array<Symbol, Straddle::Models::FundingEventListParams::Status>, nil]
+      optional :status,
+               -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::FundingEventListParams::Status] },
+               nil?: true
+
+      # @!attribute status_reason
+      #   Reason for latest payment status change.
+      #
+      #   @return [Array<Symbol, Straddle::Models::FundingEventListParams::StatusReason>, nil]
+      optional :status_reason,
+               -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::FundingEventListParams::StatusReason] },
+               nil?: true
+
+      # @!attribute status_source
+      #   Source of latest payment status change.
+      #
+      #   @return [Array<Symbol, Straddle::Models::FundingEventListParams::StatusSource>, nil]
+      optional :status_source,
+               -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::FundingEventListParams::StatusSource] },
+               nil?: true
+
+      # @!attribute trace_id
+      #   Trace Id.
+      #
+      #   @return [String, nil]
+      optional :trace_id, String, nil?: true
+
       # @!attribute trace_number
       #   Trace number.
       #
@@ -84,7 +114,7 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(created_from: nil, created_to: nil, direction: nil, event_type: nil, page_number: nil, page_size: nil, search_text: nil, sort_by: nil, sort_order: nil, trace_number: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(created_from: nil, created_to: nil, direction: nil, event_type: nil, page_number: nil, page_size: nil, search_text: nil, sort_by: nil, sort_order: nil, status: nil, status_reason: nil, status_source: nil, trace_id: nil, trace_number: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Straddle::Models::FundingEventListParams} for more details.
       #
@@ -106,6 +136,14 @@ module Straddle
       #
       #   @param sort_order [Symbol, Straddle::Models::FundingEventListParams::SortOrder] The order in which to sort the results.
       #
+      #   @param status [Array<Symbol, Straddle::Models::FundingEventListParams::Status>, nil] Funding Event status.
+      #
+      #   @param status_reason [Array<Symbol, Straddle::Models::FundingEventListParams::StatusReason>, nil] Reason for latest payment status change.
+      #
+      #   @param status_source [Array<Symbol, Straddle::Models::FundingEventListParams::StatusSource>, nil] Source of latest payment status change.
+      #
+      #   @param trace_id [String, nil] Trace Id.
+      #
       #   @param trace_number [String, nil] Trace number.
       #
       #   @param correlation_id [String]
@@ -164,6 +202,72 @@ module Straddle
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      # The current status of the `charge` or `payout`.
+      module Status
+        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
+
+      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