straddle 0.4.0 → 1.0.0

data/lib/straddle/models/account_onboard_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Accounts#onboard
+    class AccountOnboardParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute terms_of_service
+      #
+      #   @return [Straddle::Models::TermsOfService]
+      required :terms_of_service, -> { Straddle::TermsOfService }
+
+      # @!attribute correlation_id
+      #   Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute idempotency_key
+      #   Optional client-generated key for an idempotent request.
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute request_id
+      #   Optional client-generated identifier for tracing one request.
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!method initialize(account_id:, terms_of_service:, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+      #   @param account_id [String]
+      #
+      #   @param terms_of_service [Straddle::Models::TermsOfService]
+      #
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @param idempotency_key [String] Optional client-generated key for an idempotent request.
+      #
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/straddle/models/account_payment_capabilities.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountPaymentCapabilities < Straddle::Internal::Type::BaseModel
+      # @!attribute charges
+      #
+      #   @return [Straddle::Models::AccountCapability]
+      required :charges, -> { Straddle::AccountCapability }
+
+      # @!attribute payouts
+      #
+      #   @return [Straddle::Models::AccountCapability]
+      required :payouts, -> { Straddle::AccountCapability }
+
+      # @!method initialize(charges:, payouts:)
+      #   @param charges [Straddle::Models::AccountCapability]
+      #   @param payouts [Straddle::Models::AccountCapability]
+    end
+  end
+end

data/lib/straddle/models/account_payment_settings.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountPaymentSettings < Straddle::Internal::Type::BaseModel
+      # @!attribute charges
+      #
+      #   @return [Straddle::Models::AccountChargeSettings]
+      required :charges, -> { Straddle::AccountChargeSettings }
+
+      # @!attribute payouts
+      #
+      #   @return [Straddle::Models::AccountPayoutSettings]
+      required :payouts, -> { Straddle::AccountPayoutSettings }
+
+      # @!method initialize(charges:, payouts:)
+      #   @param charges [Straddle::Models::AccountChargeSettings]
+      #   @param payouts [Straddle::Models::AccountPayoutSettings]
+    end
+  end
+end

data/lib/straddle/models/account_payment_type_settings.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountPaymentTypeSettings < Straddle::Internal::Type::BaseModel
+      # @!attribute charges
+      #   Status of charge support for the account.
+      #
+      #   @return [Symbol, Straddle::Models::AccountPaymentTypeSettings::Charges]
+      required :charges, enum: -> { Straddle::AccountPaymentTypeSettings::Charges }
+
+      # @!attribute payouts
+      #   Status of payout support for the account.
+      #
+      #   @return [Symbol, Straddle::Models::AccountPaymentTypeSettings::Payouts]
+      required :payouts, enum: -> { Straddle::AccountPaymentTypeSettings::Payouts }
+
+      # @!method initialize(charges:, payouts:)
+      #   @param charges [Symbol, Straddle::Models::AccountPaymentTypeSettings::Charges] Status of charge support for the account.
+      #
+      #   @param payouts [Symbol, Straddle::Models::AccountPaymentTypeSettings::Payouts] Status of payout support for the account.
+
+      # Status of charge support for the account.
+      #
+      # @see Straddle::Models::AccountPaymentTypeSettings#charges
+      module Charges
+        extend Straddle::Internal::Type::Enum
+
+        ACTIVE = :active
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Status of payout support for the account.
+      #
+      # @see Straddle::Models::AccountPaymentTypeSettings#payouts
+      module Payouts
+        extend Straddle::Internal::Type::Enum
+
+        ACTIVE = :active
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/account_payout_settings.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountPayoutSettings < Straddle::Internal::Type::BaseModel
+      # @!attribute daily_amount
+      #   Daily payout amount limit in cents.
+      #
+      #   @return [Integer]
+      required :daily_amount, Integer
+
+      # @!attribute funding_time
+      #   Funding schedule for payouts. Straddle sets this value.
+      #
+      #   @return [Symbol, Straddle::Models::AccountPayoutSettings::FundingTime]
+      required :funding_time, enum: -> { Straddle::AccountPayoutSettings::FundingTime }
+
+      # @!attribute linked_bank_account_id
+      #   ID of the linked bank account used for payout settlement.
+      #
+      #   @return [String]
+      required :linked_bank_account_id, String
+
+      # @!attribute max_amount
+      #   Maximum amount in cents for one payout.
+      #
+      #   @return [Integer]
+      required :max_amount, Integer
+
+      # @!attribute monthly_amount
+      #   Monthly payout amount limit in cents.
+      #
+      #   @return [Integer]
+      required :monthly_amount, Integer
+
+      # @!attribute monthly_count
+      #   Maximum number of payouts per calendar month.
+      #
+      #   @return [Integer]
+      required :monthly_count, Integer
+
+      # @!method initialize(daily_amount:, funding_time:, linked_bank_account_id:, max_amount:, monthly_amount:, monthly_count:)
+      #   @param daily_amount [Integer] Daily payout amount limit in cents.
+      #
+      #   @param funding_time [Symbol, Straddle::Models::AccountPayoutSettings::FundingTime] Funding schedule for payouts. Straddle sets this value.
+      #
+      #   @param linked_bank_account_id [String] ID of the linked bank account used for payout settlement.
+      #
+      #   @param max_amount [Integer] Maximum amount in cents for one payout.
+      #
+      #   @param monthly_amount [Integer] Monthly payout amount limit in cents.
+      #
+      #   @param monthly_count [Integer] Maximum number of payouts per calendar month.
+
+      # Funding schedule for payouts. Straddle sets this value.
+      #
+      # @see Straddle::Models::AccountPayoutSettings#funding_time
+      module FundingTime
+        extend Straddle::Internal::Type::Enum
+
+        IMMEDIATE = :immediate
+        NEXT_DAY = :next_day
+        ONE_DAY = :one_day
+        TWO_DAY = :two_day
+        THREE_DAY = :three_day
+        FOUR_DAY = :four_day
+        FIVE_DAY = :five_day
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/account_policy_controls.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountPolicyControls < Straddle::Internal::Type::BaseModel
+      # @!attribute allow_customer_identity_skip
+      #   Whether customer identity verification can be skipped.
+      #
+      #   @return [Boolean]
+      required :allow_customer_identity_skip, Straddle::Internal::Type::Boolean
+
+      # @!attribute allow_data_unmask
+      #   Whether the account can retrieve unmasked sensitive fields.
+      #
+      #   @return [Boolean]
+      required :allow_data_unmask, Straddle::Internal::Type::Boolean
+
+      # @!attribute allow_duplicate_email
+      #   Whether multiple customers can share one email address.
+      #
+      #   @return [Boolean]
+      required :allow_duplicate_email, Straddle::Internal::Type::Boolean
+
+      # @!attribute allow_paykey_verification_skip
+      #   Whether paykey verification can be skipped.
+      #
+      #   @return [Boolean]
+      required :allow_paykey_verification_skip, Straddle::Internal::Type::Boolean
+
+      # @!method initialize(allow_customer_identity_skip:, allow_data_unmask:, allow_duplicate_email:, allow_paykey_verification_skip:)
+      #   @param allow_customer_identity_skip [Boolean] Whether customer identity verification can be skipped.
+      #
+      #   @param allow_data_unmask [Boolean] Whether the account can retrieve unmasked sensitive fields.
+      #
+      #   @param allow_duplicate_email [Boolean] Whether multiple customers can share one email address.
+      #
+      #   @param allow_paykey_verification_skip [Boolean] Whether paykey verification can be skipped.
+    end
+  end
+end

data/lib/straddle/models/account_response.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Accounts#create
+    class AccountResponse < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::Account]
+      required :data, -> { Straddle::Account }
+
+      # @!attribute meta
+      #   Metadata for an API request.
+      #
+      #   @return [Straddle::Models::ResponseMetadata]
+      required :meta, -> { Straddle::ResponseMetadata }
+
+      # @!attribute response_type
+      #   Indicates how the response content is structured.
+      #
+      #   - `object` means `data` contains one JSON object.
+      #   - `array` means `data` contains an array of objects.
+      #   - `error` means `error` contains error details.
+      #   - `none` means the response has no data.
+      #
+      #   @return [Symbol, Straddle::Models::AccountResponse::ResponseType]
+      required :response_type, enum: -> { Straddle::AccountResponse::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::AccountResponse} for more details.
+      #
+      #   @param data [Straddle::Models::Account]
+      #
+      #   @param meta [Straddle::Models::ResponseMetadata] Metadata for an API request.
+      #
+      #   @param response_type [Symbol, Straddle::Models::AccountResponse::ResponseType] Indicates how the response content is structured.
+
+      # Indicates how the response content is structured.
+      #
+      # - `object` means `data` contains one JSON object.
+      # - `array` means `data` contains an array of objects.
+      # - `error` means `error` contains error details.
+      # - `none` means the response has no data.
+      #
+      # @see Straddle::Models::AccountResponse#response_type
+      module ResponseType
+        extend Straddle::Internal::Type::Enum
+
+        OBJECT = :object
+        ARRAY = :array
+        ERROR = :error
+        NONE = :none
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/account_retrieve_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Accounts#retrieve
+    class AccountRetrieveParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!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
+
+      # @!method initialize(account_id:, correlation_id: nil, request_id: nil, request_options: {})
+      #   @param account_id [String]
+      #
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/straddle/models/account_setting_retrieve_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::AccountSettings#retrieve
+    class AccountSettingRetrieveParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!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
+
+      # @!method initialize(account_id:, correlation_id: nil, request_id: nil, request_options: {})
+      #   @param account_id [String]
+      #
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/straddle/models/account_settings.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountSettingsAPI < Straddle::Internal::Type::BaseModel
+      # @!attribute charges
+      #
+      #   @return [Straddle::Models::ChargeSettings]
+      required :charges, -> { Straddle::ChargeSettings }
+
+      # @!attribute configuration
+      #
+      #   @return [Straddle::Models::AccountPolicyControls]
+      required :configuration, -> { Straddle::AccountPolicyControls }
+
+      # @!attribute consent_types
+      #
+      #   @return [Straddle::Models::AccountConsentSettings]
+      required :consent_types, -> { Straddle::AccountConsentSettings }
+
+      # @!attribute customer_types
+      #
+      #   @return [Straddle::Models::AccountCustomerTypeSettings]
+      required :customer_types, -> { Straddle::AccountCustomerTypeSettings }
+
+      # @!attribute payment_types
+      #
+      #   @return [Straddle::Models::AccountPaymentTypeSettings]
+      required :payment_types, -> { Straddle::AccountPaymentTypeSettings }
+
+      # @!attribute payouts
+      #
+      #   @return [Straddle::Models::PayoutSettings]
+      required :payouts, -> { Straddle::PayoutSettings }
+
+      # @!attribute statement_settings
+      #
+      #   @return [Straddle::Models::AccountStatementSettings]
+      required :statement_settings, -> { Straddle::AccountStatementSettings }
+
+      # @!method initialize(charges:, configuration:, consent_types:, customer_types:, payment_types:, payouts:, statement_settings:)
+      #   @param charges [Straddle::Models::ChargeSettings]
+      #   @param configuration [Straddle::Models::AccountPolicyControls]
+      #   @param consent_types [Straddle::Models::AccountConsentSettings]
+      #   @param customer_types [Straddle::Models::AccountCustomerTypeSettings]
+      #   @param payment_types [Straddle::Models::AccountPaymentTypeSettings]
+      #   @param payouts [Straddle::Models::PayoutSettings]
+      #   @param statement_settings [Straddle::Models::AccountStatementSettings]
+    end
+  end
+end

data/lib/straddle/models/account_settings_response.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::AccountSettings#retrieve
+    class AccountSettingsResponse < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::AccountSettingsAPI]
+      required :data, -> { Straddle::AccountSettingsAPI }
+
+      # @!attribute meta
+      #   Metadata for an API request.
+      #
+      #   @return [Straddle::Models::ResponseMetadata]
+      required :meta, -> { Straddle::ResponseMetadata }
+
+      # @!attribute response_type
+      #   Indicates how the response content is structured.
+      #
+      #   - `object` means `data` contains one JSON object.
+      #   - `array` means `data` contains an array of objects.
+      #   - `error` means `error` contains error details.
+      #   - `none` means the response has no data.
+      #
+      #   @return [Symbol, Straddle::Models::AccountSettingsResponse::ResponseType]
+      required :response_type, enum: -> { Straddle::AccountSettingsResponse::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::AccountSettingsResponse} for more details.
+      #
+      #   @param data [Straddle::Models::AccountSettingsAPI]
+      #
+      #   @param meta [Straddle::Models::ResponseMetadata] Metadata for an API request.
+      #
+      #   @param response_type [Symbol, Straddle::Models::AccountSettingsResponse::ResponseType] Indicates how the response content is structured.
+
+      # Indicates how the response content is structured.
+      #
+      # - `object` means `data` contains one JSON object.
+      # - `array` means `data` contains an array of objects.
+      # - `error` means `error` contains error details.
+      # - `none` means the response has no data.
+      #
+      # @see Straddle::Models::AccountSettingsResponse#response_type
+      module ResponseType
+        extend Straddle::Internal::Type::Enum
+
+        OBJECT = :object
+        ARRAY = :array
+        ERROR = :error
+        NONE = :none
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/account_simulate_onboarding_params.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Accounts#simulate_onboarding
+    class AccountSimulateOnboardingParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute final_status
+      #   Final account status to produce in the sandbox simulation.
+      #
+      #   @return [Symbol, Straddle::Models::AccountSimulateOnboardingParams::FinalStatus, nil]
+      optional :final_status, enum: -> { Straddle::AccountSimulateOnboardingParams::FinalStatus }
+
+      # @!attribute correlation_id
+      #   Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute idempotency_key
+      #   Optional client-generated key for an idempotent request.
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute request_id
+      #   Optional client-generated identifier for tracing one request.
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!method initialize(account_id:, final_status: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+      #   @param account_id [String]
+      #
+      #   @param final_status [Symbol, Straddle::Models::AccountSimulateOnboardingParams::FinalStatus] Final account status to produce in the sandbox simulation.
+      #
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @param idempotency_key [String] Optional client-generated key for an idempotent request.
+      #
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+
+      module FinalStatus
+        extend Straddle::Internal::Type::Enum
+
+        ONBOARDING = :onboarding
+        ACTIVE = :active
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/account_statement_settings.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountStatementSettings < Straddle::Internal::Type::BaseModel
+      # @!attribute company_id
+      #   Company identifier used in ACH records.
+      #
+      #   @return [String, nil]
+      optional :company_id, String, nil?: true
+
+      # @!attribute company_name
+      #   Company name used in statement records.
+      #
+      #   @return [String, nil]
+      optional :company_name, String, nil?: true
+
+      # @!attribute default_descriptor
+      #   Default descriptor for account payments.
+      #
+      #   @return [String, nil]
+      optional :default_descriptor, String, nil?: true
+
+      # @!method initialize(company_id: nil, company_name: nil, default_descriptor: nil)
+      #   @param company_id [String, nil] Company identifier used in ACH records.
+      #
+      #   @param company_name [String, nil] Company name used in statement records.
+      #
+      #   @param default_descriptor [String, nil] Default descriptor for account payments.
+    end
+  end
+end

data/lib/straddle/models/account_status_detail.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountStatusDetail < Straddle::Internal::Type::BaseModel
+      # @!attribute code
+      #   Machine-readable status code from the source.
+      #
+      #   @return [String]
+      required :code, String
+
+      # @!attribute message
+      #   Human-readable description of the account's status.
+      #
+      #   @return [String]
+      required :message, String
+
+      # @!attribute reason
+      #   Machine-readable reason for the account's status.
+      #
+      #   @return [Symbol, Straddle::Models::AccountStatusDetail::Reason]
+      required :reason, enum: -> { Straddle::AccountStatusDetail::Reason }
+
+      # @!attribute source
+      #   System that produced the account status detail.
+      #
+      #   @return [Symbol, Straddle::Models::AccountStatusDetail::Source]
+      required :source, enum: -> { Straddle::AccountStatusDetail::Source }
+
+      # @!method initialize(code:, message:, reason:, source:)
+      #   @param code [String] Machine-readable status code from the source.
+      #
+      #   @param message [String] Human-readable description of the account's status.
+      #
+      #   @param reason [Symbol, Straddle::Models::AccountStatusDetail::Reason] Machine-readable reason for the account's status.
+      #
+      #   @param source [Symbol, Straddle::Models::AccountStatusDetail::Source] System that produced the account status detail.
+
+      # Machine-readable reason for the account's status.
+      #
+      # @see Straddle::Models::AccountStatusDetail#reason
+      module Reason
+        extend Straddle::Internal::Type::Enum
+
+        UNVERIFIED = :unverified
+        IN_REVIEW = :in_review
+        PENDING = :pending
+        STUCK = :stuck
+        VERIFIED = :verified
+        FAILED_VERIFICATION = :failed_verification
+        DISABLED = :disabled
+        TERMINATED = :terminated
+        NEW = :new
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # System that produced the account status detail.
+      #
+      # @see Straddle::Models::AccountStatusDetail#source
+      module Source
+        extend Straddle::Internal::Type::Enum
+
+        WATCHTOWER = :watchtower
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end