straddle 0.5.0 → 1.0.0

data/rbi/straddle/models/linked_bank_account.rbi

@@ -0,0 +1,183 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class LinkedBankAccount < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::LinkedBankAccount, Straddle::Internal::AnyHash)
+        end
+
+      # Straddle's unique ID for the linked bank account.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # ID of the related account, if this is an account-level linked bank account.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :account_id
+
+      sig { returns(Straddle::MaskedLinkedBankAccountDetails) }
+      attr_reader :bank_account
+
+      sig do
+        params(
+          bank_account: Straddle::MaskedLinkedBankAccountDetails::OrHash
+        ).void
+      end
+      attr_writer :bank_account
+
+      # Date and time when Straddle created the linked bank account.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Payment purposes assigned to the linked bank account.
+      sig do
+        returns(T::Array[Straddle::LinkedBankAccount::Purpose::TaggedSymbol])
+      end
+      attr_accessor :purposes
+
+      # Status of the linked bank account.
+      sig { returns(Straddle::LinkedBankAccount::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      sig { returns(Straddle::LinkedBankAccountStatusDetail) }
+      attr_reader :status_detail
+
+      sig do
+        params(
+          status_detail: Straddle::LinkedBankAccountStatusDetail::OrHash
+        ).void
+      end
+      attr_writer :status_detail
+
+      # Date and time of the most recent linked bank account update.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # Your description for the linked bank account.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Up to 20 user-defined key-value pairs.
+      sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
+      attr_accessor :metadata
+
+      # ID of the related platform, if this is a platform-level linked bank account.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :platform_id
+
+      sig do
+        params(
+          id: String,
+          account_id: T.nilable(String),
+          bank_account: Straddle::MaskedLinkedBankAccountDetails::OrHash,
+          created_at: Time,
+          purposes: T::Array[Straddle::LinkedBankAccount::Purpose::OrSymbol],
+          status: Straddle::LinkedBankAccount::Status::OrSymbol,
+          status_detail: Straddle::LinkedBankAccountStatusDetail::OrHash,
+          updated_at: Time,
+          description: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          platform_id: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Straddle's unique ID for the linked bank account.
+        id:,
+        # ID of the related account, if this is an account-level linked bank account.
+        account_id:,
+        bank_account:,
+        # Date and time when Straddle created the linked bank account.
+        created_at:,
+        # Payment purposes assigned to the linked bank account.
+        purposes:,
+        # Status of the linked bank account.
+        status:,
+        status_detail:,
+        # Date and time of the most recent linked bank account update.
+        updated_at:,
+        # Your description for the linked bank account.
+        description: nil,
+        # Up to 20 user-defined key-value pairs.
+        metadata: nil,
+        # ID of the related platform, if this is a platform-level linked bank account.
+        platform_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            account_id: T.nilable(String),
+            bank_account: Straddle::MaskedLinkedBankAccountDetails,
+            created_at: Time,
+            purposes:
+              T::Array[Straddle::LinkedBankAccount::Purpose::TaggedSymbol],
+            status: Straddle::LinkedBankAccount::Status::TaggedSymbol,
+            status_detail: Straddle::LinkedBankAccountStatusDetail,
+            updated_at: Time,
+            description: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            platform_id: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Purpose
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Straddle::LinkedBankAccount::Purpose) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CHARGES =
+          T.let(:charges, Straddle::LinkedBankAccount::Purpose::TaggedSymbol)
+        PAYOUTS =
+          T.let(:payouts, Straddle::LinkedBankAccount::Purpose::TaggedSymbol)
+        BILLING =
+          T.let(:billing, Straddle::LinkedBankAccount::Purpose::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Straddle::LinkedBankAccount::Purpose::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Status of the linked bank account.
+      module Status
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Straddle::LinkedBankAccount::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CREATED =
+          T.let(:created, Straddle::LinkedBankAccount::Status::TaggedSymbol)
+        ONBOARDING =
+          T.let(:onboarding, Straddle::LinkedBankAccount::Status::TaggedSymbol)
+        ACTIVE =
+          T.let(:active, Straddle::LinkedBankAccount::Status::TaggedSymbol)
+        REJECTED =
+          T.let(:rejected, Straddle::LinkedBankAccount::Status::TaggedSymbol)
+        INACTIVE =
+          T.let(:inactive, Straddle::LinkedBankAccount::Status::TaggedSymbol)
+        CANCELED =
+          T.let(:canceled, Straddle::LinkedBankAccount::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Straddle::LinkedBankAccount::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/linked_bank_account_cancel_params.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class LinkedBankAccountCancelParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::LinkedBankAccountCancelParams,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :linked_bank_account_id
+
+      # 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,
+          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:,
+        # 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,
+            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/linked_bank_account_create_params.rbi

@@ -0,0 +1,235 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class LinkedBankAccountCreateParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::LinkedBankAccountCreateParams,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Straddle::LinkedBankAccountCreateParams::BankAccount) }
+      attr_reader :bank_account
+
+      sig do
+        params(
+          bank_account:
+            Straddle::LinkedBankAccountCreateParams::BankAccount::OrHash
+        ).void
+      end
+      attr_writer :bank_account
+
+      # ID of the account that will own the linked bank account. Omit this field to
+      # assign ownership to the platform in the authenticated request context.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :account_id
+
+      # Your description for the linked bank account.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Up to 20 user-defined key-value pairs.
+      sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
+      attr_accessor :metadata
+
+      # ID of the platform to associate with the linked bank account.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :platform_id
+
+      # Payment purposes for the linked bank account. Defaults to `charges`, `payouts`,
+      # and `billing`.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[Straddle::LinkedBankAccountCreateParams::Purpose::OrSymbol]
+          )
+        )
+      end
+      attr_accessor :purposes
+
+      # 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(
+          bank_account:
+            Straddle::LinkedBankAccountCreateParams::BankAccount::OrHash,
+          account_id: T.nilable(String),
+          description: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          platform_id: T.nilable(String),
+          purposes:
+            T.nilable(
+              T::Array[
+                Straddle::LinkedBankAccountCreateParams::Purpose::OrSymbol
+              ]
+            ),
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        bank_account:,
+        # ID of the account that will own the linked bank account. Omit this field to
+        # assign ownership to the platform in the authenticated request context.
+        account_id: nil,
+        # Your description for the linked bank account.
+        description: nil,
+        # Up to 20 user-defined key-value pairs.
+        metadata: nil,
+        # ID of the platform to associate with the linked bank account.
+        platform_id: nil,
+        # Payment purposes for the linked bank account. Defaults to `charges`, `payouts`,
+        # and `billing`.
+        purposes: 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(
+          {
+            bank_account: Straddle::LinkedBankAccountCreateParams::BankAccount,
+            account_id: T.nilable(String),
+            description: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            platform_id: T.nilable(String),
+            purposes:
+              T.nilable(
+                T::Array[
+                  Straddle::LinkedBankAccountCreateParams::Purpose::OrSymbol
+                ]
+              ),
+            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::LinkedBankAccountCreateParams::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
+
+      module Purpose
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::LinkedBankAccountCreateParams::Purpose)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CHARGES =
+          T.let(
+            :charges,
+            Straddle::LinkedBankAccountCreateParams::Purpose::TaggedSymbol
+          )
+        PAYOUTS =
+          T.let(
+            :payouts,
+            Straddle::LinkedBankAccountCreateParams::Purpose::TaggedSymbol
+          )
+        BILLING =
+          T.let(
+            :billing,
+            Straddle::LinkedBankAccountCreateParams::Purpose::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Straddle::LinkedBankAccountCreateParams::Purpose::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/linked_bank_account_created_v1_webhook_event.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class LinkedBankAccountCreatedV1WebhookEvent < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::LinkedBankAccountCreatedV1WebhookEvent,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      # Unique identifier for the account associated with this event.
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      sig { returns(Straddle::LinkedBankAccount) }
+      attr_reader :data
+
+      sig { params(data: Straddle::LinkedBankAccount::OrHash).void }
+      attr_writer :data
+
+      # Unique identifier for this event.
+      sig { returns(String) }
+      attr_accessor :event_id
+
+      # Type of this event.
+      sig { returns(String) }
+      attr_accessor :event_type
+
+      sig do
+        params(
+          account_id: String,
+          data: Straddle::LinkedBankAccount::OrHash,
+          event_id: String,
+          event_type: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the account associated with this event.
+        account_id:,
+        data:,
+        # Unique identifier for this event.
+        event_id:,
+        # Type of this event.
+        event_type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            data: Straddle::LinkedBankAccount,
+            event_id: String,
+            event_type: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/linked_bank_account_event_v1_webhook_event.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class LinkedBankAccountEventV1WebhookEvent < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::LinkedBankAccountEventV1WebhookEvent,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      # Unique identifier for the account associated with this event.
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      sig { returns(Straddle::LinkedBankAccount) }
+      attr_reader :data
+
+      sig { params(data: Straddle::LinkedBankAccount::OrHash).void }
+      attr_writer :data
+
+      # Unique identifier for this event.
+      sig { returns(String) }
+      attr_accessor :event_id
+
+      # Type of this event.
+      sig { returns(String) }
+      attr_accessor :event_type
+
+      sig do
+        params(
+          account_id: String,
+          data: Straddle::LinkedBankAccount::OrHash,
+          event_id: String,
+          event_type: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the account associated with this event.
+        account_id:,
+        data:,
+        # Unique identifier for this event.
+        event_id:,
+        # Type of this event.
+        event_type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            data: Straddle::LinkedBankAccount,
+            event_id: String,
+            event_type: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end