straddle 0.4.0 → 1.0.0

data/rbi/straddle/models/account_simulate_onboarding_params.rbi

@@ -0,0 +1,135 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class AccountSimulateOnboardingParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::AccountSimulateOnboardingParams,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      # Final account status to produce in the sandbox simulation.
+      sig do
+        returns(
+          T.nilable(
+            Straddle::AccountSimulateOnboardingParams::FinalStatus::OrSymbol
+          )
+        )
+      end
+      attr_reader :final_status
+
+      sig do
+        params(
+          final_status:
+            Straddle::AccountSimulateOnboardingParams::FinalStatus::OrSymbol
+        ).void
+      end
+      attr_writer :final_status
+
+      # Optional client-generated identifier for tracing a series of related requests.
+      sig { returns(T.nilable(String)) }
+      attr_reader :correlation_id
+
+      sig { params(correlation_id: String).void }
+      attr_writer :correlation_id
+
+      # Optional client-generated key for an idempotent request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      # Optional client-generated identifier for tracing one request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :request_id
+
+      sig { params(request_id: String).void }
+      attr_writer :request_id
+
+      sig do
+        params(
+          account_id: String,
+          final_status:
+            Straddle::AccountSimulateOnboardingParams::FinalStatus::OrSymbol,
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        account_id:,
+        # Final account status to produce in the sandbox simulation.
+        final_status: nil,
+        # Optional client-generated identifier for tracing a series of related requests.
+        correlation_id: nil,
+        # Optional client-generated key for an idempotent request.
+        idempotency_key: nil,
+        # Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            final_status:
+              Straddle::AccountSimulateOnboardingParams::FinalStatus::OrSymbol,
+            correlation_id: String,
+            idempotency_key: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module FinalStatus
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Straddle::AccountSimulateOnboardingParams::FinalStatus
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ONBOARDING =
+          T.let(
+            :onboarding,
+            Straddle::AccountSimulateOnboardingParams::FinalStatus::TaggedSymbol
+          )
+        ACTIVE =
+          T.let(
+            :active,
+            Straddle::AccountSimulateOnboardingParams::FinalStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Straddle::AccountSimulateOnboardingParams::FinalStatus::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/account_statement_settings.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class AccountStatementSettings < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::AccountStatementSettings, Straddle::Internal::AnyHash)
+        end
+
+      # Company identifier used in ACH records.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :company_id
+
+      # Company name used in statement records.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :company_name
+
+      # Default descriptor for account payments.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :default_descriptor
+
+      sig do
+        params(
+          company_id: T.nilable(String),
+          company_name: T.nilable(String),
+          default_descriptor: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Company identifier used in ACH records.
+        company_id: nil,
+        # Company name used in statement records.
+        company_name: nil,
+        # Default descriptor for account payments.
+        default_descriptor: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            company_id: T.nilable(String),
+            company_name: T.nilable(String),
+            default_descriptor: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/account_status_detail.rbi

@@ -0,0 +1,128 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class AccountStatusDetail < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::AccountStatusDetail, Straddle::Internal::AnyHash)
+        end
+
+      # Machine-readable status code from the source.
+      sig { returns(String) }
+      attr_accessor :code
+
+      # Human-readable description of the account's status.
+      sig { returns(String) }
+      attr_accessor :message
+
+      # Machine-readable reason for the account's status.
+      sig { returns(Straddle::AccountStatusDetail::Reason::TaggedSymbol) }
+      attr_accessor :reason
+
+      # System that produced the account status detail.
+      sig { returns(Straddle::AccountStatusDetail::Source::TaggedSymbol) }
+      attr_accessor :source
+
+      sig do
+        params(
+          code: String,
+          message: String,
+          reason: Straddle::AccountStatusDetail::Reason::OrSymbol,
+          source: Straddle::AccountStatusDetail::Source::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Machine-readable status code from the source.
+        code:,
+        # Human-readable description of the account's status.
+        message:,
+        # Machine-readable reason for the account's status.
+        reason:,
+        # System that produced the account status detail.
+        source:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            code: String,
+            message: String,
+            reason: Straddle::AccountStatusDetail::Reason::TaggedSymbol,
+            source: Straddle::AccountStatusDetail::Source::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Machine-readable reason for the account's status.
+      module Reason
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Straddle::AccountStatusDetail::Reason) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        UNVERIFIED =
+          T.let(
+            :unverified,
+            Straddle::AccountStatusDetail::Reason::TaggedSymbol
+          )
+        IN_REVIEW =
+          T.let(:in_review, Straddle::AccountStatusDetail::Reason::TaggedSymbol)
+        PENDING =
+          T.let(:pending, Straddle::AccountStatusDetail::Reason::TaggedSymbol)
+        STUCK =
+          T.let(:stuck, Straddle::AccountStatusDetail::Reason::TaggedSymbol)
+        VERIFIED =
+          T.let(:verified, Straddle::AccountStatusDetail::Reason::TaggedSymbol)
+        FAILED_VERIFICATION =
+          T.let(
+            :failed_verification,
+            Straddle::AccountStatusDetail::Reason::TaggedSymbol
+          )
+        DISABLED =
+          T.let(:disabled, Straddle::AccountStatusDetail::Reason::TaggedSymbol)
+        TERMINATED =
+          T.let(
+            :terminated,
+            Straddle::AccountStatusDetail::Reason::TaggedSymbol
+          )
+        NEW = T.let(:new, Straddle::AccountStatusDetail::Reason::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Straddle::AccountStatusDetail::Reason::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # System that produced the account status detail.
+      module Source
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Straddle::AccountStatusDetail::Source) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        WATCHTOWER =
+          T.let(
+            :watchtower,
+            Straddle::AccountStatusDetail::Source::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Straddle::AccountStatusDetail::Source::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/account_support_channels.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class AccountSupportChannels < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::AccountSupportChannels, Straddle::Internal::AnyHash)
+        end
+
+      # Email address for customer support.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :email
+
+      # Customer support phone number in E.164 format.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone
+
+      # URL of the business's customer support page or contact form.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :url
+
+      sig do
+        params(
+          email: T.nilable(String),
+          phone: T.nilable(String),
+          url: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Email address for customer support.
+        email: nil,
+        # Customer support phone number in E.164 format.
+        phone: nil,
+        # URL of the business's customer support page or contact form.
+        url: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            email: T.nilable(String),
+            phone: T.nilable(String),
+            url: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/account_type.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module AccountType
+      extend Straddle::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Straddle::AccountType) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      CHECKING = T.let(:checking, Straddle::AccountType::TaggedSymbol)
+      SAVINGS = T.let(:savings, Straddle::AccountType::TaggedSymbol)
+
+      sig { override.returns(T::Array[Straddle::AccountType::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/straddle/models/account_update_params.rbi

@@ -0,0 +1,101 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class AccountUpdateParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::AccountUpdateParams, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      sig { returns(Straddle::AccountBusinessProfile) }
+      attr_reader :business_profile
+
+      sig do
+        params(business_profile: Straddle::AccountBusinessProfile::OrHash).void
+      end
+      attr_writer :business_profile
+
+      # Your unique ID for the account.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :external_id
+
+      # Up to 20 user-defined key-value pairs.
+      sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
+      attr_accessor :metadata
+
+      # Optional client-generated identifier for tracing a series of related requests.
+      sig { returns(T.nilable(String)) }
+      attr_reader :correlation_id
+
+      sig { params(correlation_id: String).void }
+      attr_writer :correlation_id
+
+      # Optional client-generated key for an idempotent request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      # Optional client-generated identifier for tracing one request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :request_id
+
+      sig { params(request_id: String).void }
+      attr_writer :request_id
+
+      sig do
+        params(
+          account_id: String,
+          business_profile: Straddle::AccountBusinessProfile::OrHash,
+          external_id: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        account_id:,
+        business_profile:,
+        # Your unique ID for the account.
+        external_id: nil,
+        # Up to 20 user-defined key-value pairs.
+        metadata: nil,
+        # Optional client-generated identifier for tracing a series of related requests.
+        correlation_id: nil,
+        # Optional client-generated key for an idempotent request.
+        idempotency_key: nil,
+        # Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            business_profile: Straddle::AccountBusinessProfile,
+            external_id: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            correlation_id: String,
+            idempotency_key: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/balance_check_mode.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module BalanceCheckMode
+      extend Straddle::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Straddle::BalanceCheckMode) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      REQUIRED = T.let(:required, Straddle::BalanceCheckMode::TaggedSymbol)
+      ENABLED = T.let(:enabled, Straddle::BalanceCheckMode::TaggedSymbol)
+      DISABLED = T.let(:disabled, Straddle::BalanceCheckMode::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[Straddle::BalanceCheckMode::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/straddle/models/bridge_create_bank_account_paykey_params.rbi

@@ -0,0 +1,137 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class BridgeCreateBankAccountPaykeyParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::BridgeCreateBankAccountPaykeyParams,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      # Bank account number.
+      sig { returns(String) }
+      attr_accessor :account_number
+
+      sig { returns(Straddle::AccountType::OrSymbol) }
+      attr_accessor :account_type
+
+      # Unique identifier for the customer associated with the paykey.
+      sig { returns(String) }
+      attr_accessor :customer_id
+
+      # Bank routing number.
+      sig { returns(String) }
+      attr_accessor :routing_number
+
+      sig { returns(T.nilable(Straddle::PaykeyConfiguration)) }
+      attr_reader :config
+
+      sig { params(config: Straddle::PaykeyConfiguration::OrHash).void }
+      attr_writer :config
+
+      # Unique identifier for the paykey in your system.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :external_id
+
+      # Up to 20 user-defined key-value pairs associated with the paykey.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :metadata
+
+      # Optional client-generated identifier for tracing a series of related requests.
+      sig { returns(T.nilable(String)) }
+      attr_reader :correlation_id
+
+      sig { params(correlation_id: String).void }
+      attr_writer :correlation_id
+
+      # Optional client-generated key for an idempotent request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      # Optional client-generated identifier for tracing one request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :request_id
+
+      sig { params(request_id: String).void }
+      attr_writer :request_id
+
+      # For platform requests, the embedded account UUID that sets the request scope.
+      sig { returns(T.nilable(String)) }
+      attr_reader :straddle_account_id
+
+      sig { params(straddle_account_id: String).void }
+      attr_writer :straddle_account_id
+
+      sig do
+        params(
+          account_number: String,
+          account_type: Straddle::AccountType::OrSymbol,
+          customer_id: String,
+          routing_number: String,
+          config: Straddle::PaykeyConfiguration::OrHash,
+          external_id: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Bank account number.
+        account_number:,
+        account_type:,
+        # Unique identifier for the customer associated with the paykey.
+        customer_id:,
+        # Bank routing number.
+        routing_number:,
+        config: nil,
+        # Unique identifier for the paykey in your system.
+        external_id: nil,
+        # Up to 20 user-defined key-value pairs associated with the paykey.
+        metadata: nil,
+        # Optional client-generated identifier for tracing a series of related requests.
+        correlation_id: nil,
+        # Optional client-generated key for an idempotent request.
+        idempotency_key: nil,
+        # Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        # For platform requests, the embedded account UUID that sets the request scope.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_number: String,
+            account_type: Straddle::AccountType::OrSymbol,
+            customer_id: String,
+            routing_number: String,
+            config: Straddle::PaykeyConfiguration,
+            external_id: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            correlation_id: String,
+            idempotency_key: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end