straddle 0.4.0 → 1.0.0

data/rbi/straddle/models/account_list.rbi

@@ -0,0 +1,94 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class AccountList < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::AccountList, Straddle::Internal::AnyHash)
+        end
+
+      # Accounts returned for this page.
+      sig { returns(T::Array[Straddle::Account]) }
+      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::AccountList::ResponseType::TaggedSymbol) }
+      attr_accessor :response_type
+
+      sig do
+        params(
+          data: T::Array[Straddle::Account::OrHash],
+          meta: Straddle::PageMetadata::OrHash,
+          response_type: Straddle::AccountList::ResponseType::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Accounts 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::Account],
+            meta: Straddle::PageMetadata,
+            response_type: Straddle::AccountList::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 { T.all(Symbol, Straddle::AccountList::ResponseType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        OBJECT =
+          T.let(:object, Straddle::AccountList::ResponseType::TaggedSymbol)
+        ARRAY = T.let(:array, Straddle::AccountList::ResponseType::TaggedSymbol)
+        ERROR = T.let(:error, Straddle::AccountList::ResponseType::TaggedSymbol)
+        NONE = T.let(:none, Straddle::AccountList::ResponseType::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Straddle::AccountList::ResponseType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/account_list_params.rbi

@@ -0,0 +1,217 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class AccountListParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::AccountListParams, Straddle::Internal::AnyHash)
+        end
+
+      # Your external ID for the account.
+      sig { returns(T.nilable(String)) }
+      attr_reader :external_id
+
+      sig { params(external_id: String).void }
+      attr_writer :external_id
+
+      # Page number. Defaults to `1`.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_number
+
+      sig { params(page_number: Integer).void }
+      attr_writer :page_number
+
+      # Number of results per page. Defaults to `100`. Maximum `1000`.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      # Text to search for across account fields.
+      sig { returns(T.nilable(String)) }
+      attr_reader :search_text
+
+      sig { params(search_text: String).void }
+      attr_writer :search_text
+
+      # Field used to sort results. Defaults to `id`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :sort_by
+
+      sig { params(sort_by: String).void }
+      attr_writer :sort_by
+
+      # Sort direction. Defaults to `asc`.
+      sig do
+        returns(T.nilable(Straddle::AccountListParams::SortOrder::OrSymbol))
+      end
+      attr_reader :sort_order
+
+      sig do
+        params(
+          sort_order: Straddle::AccountListParams::SortOrder::OrSymbol
+        ).void
+      end
+      attr_writer :sort_order
+
+      # Account status to return.
+      sig { returns(T.nilable(Straddle::AccountListParams::Status::OrSymbol)) }
+      attr_reader :status
+
+      sig { params(status: Straddle::AccountListParams::Status::OrSymbol).void }
+      attr_writer :status
+
+      # Account type to return.
+      sig { returns(T.nilable(Straddle::AccountListParams::Type::OrSymbol)) }
+      attr_reader :type
+
+      sig { params(type: Straddle::AccountListParams::Type::OrSymbol).void }
+      attr_writer :type
+
+      # 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 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(
+          external_id: String,
+          page_number: Integer,
+          page_size: Integer,
+          search_text: String,
+          sort_by: String,
+          sort_order: Straddle::AccountListParams::SortOrder::OrSymbol,
+          status: Straddle::AccountListParams::Status::OrSymbol,
+          type: Straddle::AccountListParams::Type::OrSymbol,
+          correlation_id: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Your external ID for the account.
+        external_id: nil,
+        # Page number. Defaults to `1`.
+        page_number: nil,
+        # Number of results per page. Defaults to `100`. Maximum `1000`.
+        page_size: nil,
+        # Text to search for across account fields.
+        search_text: nil,
+        # Field used to sort results. Defaults to `id`.
+        sort_by: nil,
+        # Sort direction. Defaults to `asc`.
+        sort_order: nil,
+        # Account status to return.
+        status: nil,
+        # Account type to return.
+        type: nil,
+        # Optional client-generated identifier for tracing a series of related requests.
+        correlation_id: nil,
+        # Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            external_id: String,
+            page_number: Integer,
+            page_size: Integer,
+            search_text: String,
+            sort_by: String,
+            sort_order: Straddle::AccountListParams::SortOrder::OrSymbol,
+            status: Straddle::AccountListParams::Status::OrSymbol,
+            type: Straddle::AccountListParams::Type::OrSymbol,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module SortOrder
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Straddle::AccountListParams::SortOrder) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ASC = T.let(:asc, Straddle::AccountListParams::SortOrder::TaggedSymbol)
+        DESC =
+          T.let(:desc, Straddle::AccountListParams::SortOrder::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Straddle::AccountListParams::SortOrder::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Status
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Straddle::AccountListParams::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CREATED =
+          T.let(:created, Straddle::AccountListParams::Status::TaggedSymbol)
+        ONBOARDING =
+          T.let(:onboarding, Straddle::AccountListParams::Status::TaggedSymbol)
+        ACTIVE =
+          T.let(:active, Straddle::AccountListParams::Status::TaggedSymbol)
+        REJECTED =
+          T.let(:rejected, Straddle::AccountListParams::Status::TaggedSymbol)
+        INACTIVE =
+          T.let(:inactive, Straddle::AccountListParams::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Straddle::AccountListParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Type
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Straddle::AccountListParams::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        BUSINESS =
+          T.let(:business, Straddle::AccountListParams::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Straddle::AccountListParams::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/account_onboard_params.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class AccountOnboardParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::AccountOnboardParams, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      sig { returns(Straddle::TermsOfService) }
+      attr_reader :terms_of_service
+
+      sig { params(terms_of_service: Straddle::TermsOfService::OrHash).void }
+      attr_writer :terms_of_service
+
+      # 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,
+          terms_of_service: Straddle::TermsOfService::OrHash,
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        account_id:,
+        terms_of_service:,
+        # 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,
+            terms_of_service: Straddle::TermsOfService,
+            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/account_payment_capabilities.rbi

@@ -0,0 +1,47 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class AccountPaymentCapabilities < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::AccountPaymentCapabilities,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Straddle::AccountCapability) }
+      attr_reader :charges
+
+      sig { params(charges: Straddle::AccountCapability::OrHash).void }
+      attr_writer :charges
+
+      sig { returns(Straddle::AccountCapability) }
+      attr_reader :payouts
+
+      sig { params(payouts: Straddle::AccountCapability::OrHash).void }
+      attr_writer :payouts
+
+      sig do
+        params(
+          charges: Straddle::AccountCapability::OrHash,
+          payouts: Straddle::AccountCapability::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(charges:, payouts:)
+      end
+
+      sig do
+        override.returns(
+          {
+            charges: Straddle::AccountCapability,
+            payouts: Straddle::AccountCapability
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/account_payment_settings.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class AccountPaymentSettings < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::AccountPaymentSettings, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(Straddle::AccountChargeSettings) }
+      attr_reader :charges
+
+      sig { params(charges: Straddle::AccountChargeSettings::OrHash).void }
+      attr_writer :charges
+
+      sig { returns(Straddle::AccountPayoutSettings) }
+      attr_reader :payouts
+
+      sig { params(payouts: Straddle::AccountPayoutSettings::OrHash).void }
+      attr_writer :payouts
+
+      sig do
+        params(
+          charges: Straddle::AccountChargeSettings::OrHash,
+          payouts: Straddle::AccountPayoutSettings::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(charges:, payouts:)
+      end
+
+      sig do
+        override.returns(
+          {
+            charges: Straddle::AccountChargeSettings,
+            payouts: Straddle::AccountPayoutSettings
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/account_payment_type_settings.rbi

@@ -0,0 +1,117 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class AccountPaymentTypeSettings < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::AccountPaymentTypeSettings,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      # Status of charge support for the account.
+      sig do
+        returns(Straddle::AccountPaymentTypeSettings::Charges::TaggedSymbol)
+      end
+      attr_accessor :charges
+
+      # Status of payout support for the account.
+      sig do
+        returns(Straddle::AccountPaymentTypeSettings::Payouts::TaggedSymbol)
+      end
+      attr_accessor :payouts
+
+      sig do
+        params(
+          charges: Straddle::AccountPaymentTypeSettings::Charges::OrSymbol,
+          payouts: Straddle::AccountPaymentTypeSettings::Payouts::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Status of charge support for the account.
+        charges:,
+        # Status of payout support for the account.
+        payouts:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            charges:
+              Straddle::AccountPaymentTypeSettings::Charges::TaggedSymbol,
+            payouts: Straddle::AccountPaymentTypeSettings::Payouts::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Status of charge support for the account.
+      module Charges
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::AccountPaymentTypeSettings::Charges)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(
+            :active,
+            Straddle::AccountPaymentTypeSettings::Charges::TaggedSymbol
+          )
+        INACTIVE =
+          T.let(
+            :inactive,
+            Straddle::AccountPaymentTypeSettings::Charges::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Straddle::AccountPaymentTypeSettings::Charges::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Status of payout support for the account.
+      module Payouts
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::AccountPaymentTypeSettings::Payouts)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(
+            :active,
+            Straddle::AccountPaymentTypeSettings::Payouts::TaggedSymbol
+          )
+        INACTIVE =
+          T.let(
+            :inactive,
+            Straddle::AccountPaymentTypeSettings::Payouts::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Straddle::AccountPaymentTypeSettings::Payouts::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end