straddle 0.4.0 → 1.0.0

data/rbi/straddle/models/linked_bank_account_status_detail.rbi

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

data/rbi/straddle/models/linked_bank_account_update_params.rbi

@@ -0,0 +1,153 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class LinkedBankAccountUpdateParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::LinkedBankAccountUpdateParams,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :linked_bank_account_id
+
+      sig { returns(Straddle::LinkedBankAccountUpdateParams::BankAccount) }
+      attr_reader :bank_account
+
+      sig do
+        params(
+          bank_account:
+            Straddle::LinkedBankAccountUpdateParams::BankAccount::OrHash
+        ).void
+      end
+      attr_writer :bank_account
+
+      # 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(
+          linked_bank_account_id: String,
+          bank_account:
+            Straddle::LinkedBankAccountUpdateParams::BankAccount::OrHash,
+          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(
+        linked_bank_account_id:,
+        bank_account:,
+        # 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(
+          {
+            linked_bank_account_id: String,
+            bank_account: Straddle::LinkedBankAccountUpdateParams::BankAccount,
+            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
+
+      class BankAccount < Straddle::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::LinkedBankAccountUpdateParams::BankAccount,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        # Account holder name as it appears on the bank account. This is usually the
+        # business's legal name.
+        sig { returns(String) }
+        attr_accessor :account_holder
+
+        # The bank account number.
+        sig { returns(String) }
+        attr_accessor :account_number
+
+        # Nine-digit ABA routing number.
+        sig { returns(String) }
+        attr_accessor :routing_number
+
+        sig do
+          params(
+            account_holder: String,
+            account_number: String,
+            routing_number: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Account holder name as it appears on the bank account. This is usually the
+          # business's legal name.
+          account_holder:,
+          # The bank account number.
+          account_number:,
+          # Nine-digit ABA routing number.
+          routing_number:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              account_holder: String,
+              account_number: String,
+              routing_number: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/masked_customer_device.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class MaskedCustomerDevice < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::MaskedCustomerDevice, Straddle::Internal::AnyHash)
+        end
+
+      # Masked IP address of the customer's device at the time of profile creation.
+      sig { returns(String) }
+      attr_accessor :ip_address
+
+      sig { params(ip_address: String).returns(T.attached_class) }
+      def self.new(
+        # Masked IP address of the customer's device at the time of profile creation.
+        ip_address:
+      )
+      end
+
+      sig { override.returns({ ip_address: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/masked_linked_bank_account_details.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class MaskedLinkedBankAccountDetails < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::MaskedLinkedBankAccountDetails,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      # Name of the account holder as it appears on the bank account.
+      sig { returns(String) }
+      attr_accessor :account_holder
+
+      # Last four digits of the bank account number.
+      sig { returns(String) }
+      attr_accessor :account_mask
+
+      # Name of the financial institution.
+      sig { returns(String) }
+      attr_accessor :institution_name
+
+      # Nine-digit ABA routing number for the bank account.
+      sig { returns(String) }
+      attr_accessor :routing_number
+
+      sig do
+        params(
+          account_holder: String,
+          account_mask: String,
+          institution_name: String,
+          routing_number: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Name of the account holder as it appears on the bank account.
+        account_holder:,
+        # Last four digits of the bank account number.
+        account_mask:,
+        # Name of the financial institution.
+        institution_name:,
+        # Nine-digit ABA routing number for the bank account.
+        routing_number:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_holder: String,
+            account_mask: String,
+            institution_name: String,
+            routing_number: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/masked_payment_device.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class MaskedPaymentDevice < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::MaskedPaymentDevice, Straddle::Internal::AnyHash)
+        end
+
+      # Masked IP address of the device used when the customer authorized the charge or
+      # payout.
+      sig { returns(String) }
+      attr_accessor :ip_address
+
+      sig { params(ip_address: String).returns(T.attached_class) }
+      def self.new(
+        # Masked IP address of the device used when the customer authorized the charge or
+        # payout.
+        ip_address:
+      )
+      end
+
+      sig { override.returns({ ip_address: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/organization.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class Organization < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::Organization, Straddle::Internal::AnyHash)
+        end
+
+      # Straddle's unique ID for the organization.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Date and time when Straddle created the organization.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The name of the organization.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Date and time of the most recent organization update.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # Your unique ID for the organization.
+      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
+
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          name: String,
+          updated_at: Time,
+          external_id: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Straddle's unique ID for the organization.
+        id:,
+        # Date and time when Straddle created the organization.
+        created_at:,
+        # The name of the organization.
+        name:,
+        # Date and time of the most recent organization update.
+        updated_at:,
+        # Your unique ID for the organization.
+        external_id: nil,
+        # Up to 20 user-defined key-value pairs.
+        metadata: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            name: String,
+            updated_at: Time,
+            external_id: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/organization_create_params.rbi

@@ -0,0 +1,92 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class OrganizationCreateParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::OrganizationCreateParams, Straddle::Internal::AnyHash)
+        end
+
+      # Organization name.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Your unique ID for the organization.
+      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(
+          name: String,
+          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(
+        # Organization name.
+        name:,
+        # Your unique ID for the organization.
+        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(
+          {
+            name: String,
+            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/organization_list.rbi

@@ -0,0 +1,100 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class OrganizationList < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::OrganizationList, Straddle::Internal::AnyHash)
+        end
+
+      # Organizations returned for this page.
+      sig { returns(T::Array[Straddle::Organization]) }
+      attr_accessor :data
+
+      # Metadata for an API request and a page of results.
+      sig { returns(Straddle::PageMetadata) }
+      attr_reader :meta
+
+      sig { params(meta: Straddle::PageMetadata::OrHash).void }
+      attr_writer :meta
+
+      # 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.
+      sig { returns(Straddle::OrganizationList::ResponseType::TaggedSymbol) }
+      attr_accessor :response_type
+
+      sig do
+        params(
+          data: T::Array[Straddle::Organization::OrHash],
+          meta: Straddle::PageMetadata::OrHash,
+          response_type: Straddle::OrganizationList::ResponseType::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Organizations returned for this page.
+        data:,
+        # Metadata for an API request and a page of results.
+        meta:,
+        # 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.
+        response_type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T::Array[Straddle::Organization],
+            meta: Straddle::PageMetadata,
+            response_type:
+              Straddle::OrganizationList::ResponseType::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # 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.
+      module ResponseType
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::OrganizationList::ResponseType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        OBJECT =
+          T.let(:object, Straddle::OrganizationList::ResponseType::TaggedSymbol)
+        ARRAY =
+          T.let(:array, Straddle::OrganizationList::ResponseType::TaggedSymbol)
+        ERROR =
+          T.let(:error, Straddle::OrganizationList::ResponseType::TaggedSymbol)
+        NONE =
+          T.let(:none, Straddle::OrganizationList::ResponseType::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Straddle::OrganizationList::ResponseType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end