straddle 0.5.0 → 1.0.0

data/rbi/straddle/resources/embed/accounts/capability_requests.rbi

@@ -1,123 +0,0 @@
-# typed: strong
-
-module Straddle
-  module Resources
-    class Embed
-      class Accounts
-        # Capabilities enable specific features and services for an Account. Use
-        # capability requests to unlock higher processing limits, new payment types, or
-        # additional platform features as your users' businesses grow. Track approval
-        # status and manage documentation requirements through a single interface.
-        class CapabilityRequests
-          # Submits a request to enable a specific capability for an account. Use this
-          # endpoint to request additional features or services for an account.
-          sig do
-            params(
-              account_id: String,
-              businesses:
-                Straddle::Embed::Accounts::CapabilityRequestCreateParams::Businesses::OrHash,
-              charges:
-                Straddle::Embed::Accounts::CapabilityRequestCreateParams::Charges::OrHash,
-              individuals:
-                Straddle::Embed::Accounts::CapabilityRequestCreateParams::Individuals::OrHash,
-              internet:
-                Straddle::Embed::Accounts::CapabilityRequestCreateParams::Internet::OrHash,
-              payouts:
-                Straddle::Embed::Accounts::CapabilityRequestCreateParams::Payouts::OrHash,
-              signed_agreement:
-                Straddle::Embed::Accounts::CapabilityRequestCreateParams::SignedAgreement::OrHash,
-              correlation_id: String,
-              idempotency_key: String,
-              request_id: String,
-              request_options: Straddle::RequestOptions::OrHash
-            ).returns(Straddle::Embed::Accounts::CapabilityRequestPagedV1)
-          end
-          def create(
-            # Path param
-            account_id,
-            # Body param: Allows the account to accept payments from businesses.
-            businesses: nil,
-            # Body param: The charges capability settings for the account.
-            charges: nil,
-            # Body param: Allows the account to accept payments from individuals.
-            individuals: nil,
-            # Body param: Allows the account to accept payments authorized via the internet or
-            # mobile applications.
-            internet: nil,
-            # Body param: The payouts capability settings for the account.
-            payouts: nil,
-            # Body param: Allows the account to accept payments authorized by signed
-            # agreements or contracts.
-            signed_agreement: nil,
-            # Header param: Optional client generated identifier to trace and debug a series
-            # of requests.
-            correlation_id: nil,
-            # Header param: Optional client generated value to use for idempotent requests.
-            idempotency_key: nil,
-            # Header param: Optional client generated identifier to trace and debug a request.
-            request_id: nil,
-            request_options: {}
-          )
-          end
-
-          # Retrieves a list of capability requests associated with an account. The requests
-          # are returned sorted by creation date, with the most recent requests appearing
-          # first. This endpoint supports advanced sorting and filtering options.
-          sig do
-            params(
-              account_id: String,
-              category:
-                Straddle::Embed::Accounts::CapabilityRequestListParams::Category::OrSymbol,
-              page_number: Integer,
-              page_size: Integer,
-              sort_by: String,
-              sort_order:
-                Straddle::Embed::Accounts::CapabilityRequestListParams::SortOrder::OrSymbol,
-              status:
-                Straddle::Embed::Accounts::CapabilityRequestListParams::Status::OrSymbol,
-              type:
-                Straddle::Embed::Accounts::CapabilityRequestListParams::Type::OrSymbol,
-              correlation_id: String,
-              request_id: String,
-              request_options: Straddle::RequestOptions::OrHash
-            ).returns(
-              Straddle::Internal::PageNumberSchema[
-                Straddle::Embed::Accounts::CapabilityRequestPagedV1::Data
-              ]
-            )
-          end
-          def list(
-            # Path param
-            account_id,
-            # Query param: Filter capability requests by category.
-            category: nil,
-            # Query param: Results page number. Starts at page 1.
-            page_number: nil,
-            # Query param: Page size.Max value: 1000
-            page_size: nil,
-            # Query param: Sort By.
-            sort_by: nil,
-            # Query param: Sort Order.
-            sort_order: nil,
-            # Query param: Filter capability requests by their current status.
-            status: nil,
-            # Query param: Filter capability requests by the specific type of capability.
-            type: nil,
-            # Header param: Optional client generated identifier to trace and debug a series
-            # of requests.
-            correlation_id: nil,
-            # Header param: Optional client generated identifier to trace and debug a request.
-            request_id: nil,
-            request_options: {}
-          )
-          end
-
-          # @api private
-          sig { params(client: Straddle::Client).returns(T.attached_class) }
-          def self.new(client:)
-          end
-        end
-      end
-    end
-  end
-end

data/rbi/straddle/resources/embed/accounts.rbi

@@ -1,240 +0,0 @@
-# typed: strong
-
-module Straddle
-  module Resources
-    class Embed
-      # Accounts represent businesses using Straddle through your platform. Each account
-      # must complete automated verification before processing payments. Use accounts to
-      # manage your users' payment capabilities, track verification status, and control
-      # access to features. Accounts can be instantly created in sandbox and require
-      # additional verification for production access.
-      class Accounts
-        # Capabilities enable specific features and services for an Account. Use
-        # capability requests to unlock higher processing limits, new payment types, or
-        # additional platform features as your users' businesses grow. Track approval
-        # status and manage documentation requirements through a single interface.
-        sig do
-          returns(Straddle::Resources::Embed::Accounts::CapabilityRequests)
-        end
-        attr_reader :capability_requests
-
-        # Creates a new account associated with your Straddle platform integration. This
-        # endpoint allows you to set up an account with specified details, including
-        # business information and access levels.
-        sig do
-          params(
-            access_level:
-              Straddle::Embed::AccountCreateParams::AccessLevel::OrSymbol,
-            account_type:
-              Straddle::Embed::AccountCreateParams::AccountType::OrSymbol,
-            business_profile: Straddle::Embed::BusinessProfileV1::OrHash,
-            organization_id: 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(Straddle::Embed::AccountV1)
-        end
-        def create(
-          # Body param: The access level granted to the account. This is determined by your
-          # platform configuration. Use `standard` unless instructed otherwise by Straddle.
-          access_level:,
-          # Body param: The type of account to be created. Currently, only `business` is
-          # supported.
-          account_type:,
-          # Body param
-          business_profile:,
-          # Body param: The unique identifier of the organization related to this account.
-          organization_id:,
-          # Body param: Unique identifier for the account in your database, used for
-          # cross-referencing between Straddle and your systems.
-          external_id: nil,
-          # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
-          # additional information about the account in a structured format.
-          metadata: nil,
-          # Header param: Optional client generated identifier to trace and debug a series
-          # of requests.
-          correlation_id: nil,
-          # Header param: Optional client generated value to use for idempotent requests.
-          idempotency_key: nil,
-          # Header param: Optional client generated identifier to trace and debug a request.
-          request_id: nil,
-          request_options: {}
-        )
-        end
-
-        # Updates an existing account's information. This endpoint allows you to update
-        # various account details during onboarding or after the account has been created.
-        sig do
-          params(
-            account_id: String,
-            business_profile: Straddle::Embed::BusinessProfileV1::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(Straddle::Embed::AccountV1)
-        end
-        def update(
-          # Path param
-          account_id,
-          # Body param
-          business_profile:,
-          # Body param: Unique identifier for the account in your database, used for
-          # cross-referencing between Straddle and your systems.
-          external_id: nil,
-          # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
-          # additional information about the account in a structured format.
-          metadata: nil,
-          # Header param: Optional client generated identifier to trace and debug a series
-          # of requests.
-          correlation_id: nil,
-          # Header param: Optional client generated value to use for idempotent requests.
-          idempotency_key: nil,
-          # Header param: Optional client generated identifier to trace and debug a request.
-          request_id: nil,
-          request_options: {}
-        )
-        end
-
-        # Returns a list of accounts associated with your Straddle platform integration.
-        # The accounts are returned sorted by creation date, with the most recently
-        # created accounts appearing first. This endpoint supports advanced sorting and
-        # filtering options.
-        sig do
-          params(
-            external_id: String,
-            page_number: Integer,
-            page_size: Integer,
-            search_text: String,
-            sort_by: String,
-            sort_order: Straddle::Embed::AccountListParams::SortOrder::OrSymbol,
-            status: Straddle::Embed::AccountListParams::Status::OrSymbol,
-            type: Straddle::Embed::AccountListParams::Type::OrSymbol,
-            correlation_id: String,
-            request_id: String,
-            request_options: Straddle::RequestOptions::OrHash
-          ).returns(
-            Straddle::Internal::PageNumberSchema[
-              Straddle::Embed::AccountPagedV1::Data
-            ]
-          )
-        end
-        def list(
-          # Query param
-          external_id: nil,
-          # Query param: Results page number. Starts at page 1. Default value: 1
-          page_number: nil,
-          # Query param: Page size. Default value: 100. Max value: 1000
-          page_size: nil,
-          # Query param
-          search_text: nil,
-          # Query param: Sort By. Default value: 'id'.
-          sort_by: nil,
-          # Query param: Sort Order. Default value: 'asc'.
-          sort_order: nil,
-          # Query param
-          status: nil,
-          # Query param
-          type: nil,
-          # Header param: Optional client generated identifier to trace and debug a series
-          # of requests.
-          correlation_id: nil,
-          # Header param: Optional client generated identifier to trace and debug a request.
-          request_id: nil,
-          request_options: {}
-        )
-        end
-
-        # Retrieves the details of an account that has previously been created. Supply the
-        # unique account ID that was returned from your previous request, and Straddle
-        # will return the corresponding account information.
-        sig do
-          params(
-            account_id: String,
-            correlation_id: String,
-            request_id: String,
-            request_options: Straddle::RequestOptions::OrHash
-          ).returns(Straddle::Embed::AccountV1)
-        end
-        def get(
-          # The unique identifier of the account to retrieve.
-          account_id,
-          # Optional client generated identifier to trace and debug a series of requests.
-          correlation_id: nil,
-          # Optional client generated identifier to trace and debug a request.
-          request_id: nil,
-          request_options: {}
-        )
-        end
-
-        # Initiates the onboarding process for a new account. This endpoint can only be
-        # used for accounts where at least one representative and one bank account have
-        # already been created.
-        sig do
-          params(
-            account_id: String,
-            terms_of_service: Straddle::Embed::TermsOfServiceV1::OrHash,
-            correlation_id: String,
-            idempotency_key: String,
-            request_id: String,
-            request_options: Straddle::RequestOptions::OrHash
-          ).returns(Straddle::Embed::AccountV1)
-        end
-        def onboard(
-          # Path param
-          account_id,
-          # Body param
-          terms_of_service:,
-          # Header param: Optional client generated identifier to trace and debug a series
-          # of requests.
-          correlation_id: nil,
-          # Header param: Optional client generated value to use for idempotent requests.
-          idempotency_key: nil,
-          # Header param: Optional client generated identifier to trace and debug a request.
-          request_id: nil,
-          request_options: {}
-        )
-        end
-
-        # Simulate the status transitions for sandbox accounts. This endpoint can only be
-        # used for sandbox accounts.
-        sig do
-          params(
-            account_id: String,
-            final_status:
-              Straddle::Embed::AccountSimulateParams::FinalStatus::OrSymbol,
-            correlation_id: String,
-            idempotency_key: String,
-            request_id: String,
-            request_options: Straddle::RequestOptions::OrHash
-          ).returns(Straddle::Embed::AccountV1)
-        end
-        def simulate(
-          # Path param
-          account_id,
-          # Query param
-          final_status: nil,
-          # Header param: Optional client generated identifier to trace and debug a series
-          # of requests.
-          correlation_id: nil,
-          # Header param: Optional client generated value to use for idempotent requests.
-          idempotency_key: nil,
-          # Header param: Optional client generated identifier to trace and debug a request.
-          request_id: nil,
-          request_options: {}
-        )
-        end
-
-        # @api private
-        sig { params(client: Straddle::Client).returns(T.attached_class) }
-        def self.new(client:)
-        end
-      end
-    end
-  end
-end

data/rbi/straddle/resources/embed/linked_bank_accounts.rbi

@@ -1,228 +0,0 @@
-# typed: strong
-
-module Straddle
-  module Resources
-    class Embed
-      # Linked bank accounts connect your platform users' external bank accounts to
-      # Straddle for settlements and payment funding. Each linked account undergoes
-      # automated verification and continuous monitoring. Use linked accounts to manage
-      # where clients receive deposits, fund payouts, and track settlement preferences.
-      class LinkedBankAccounts
-        # Creates a new linked bank account associated with a Straddle account. This
-        # endpoint allows you to associate external bank accounts with a Straddle account
-        # for various payment operations such as payment deposits, payout withdrawals, and
-        # more.
-        sig do
-          params(
-            account_id: T.nilable(String),
-            bank_account:
-              Straddle::Embed::LinkedBankAccountCreateParams::BankAccount::OrHash,
-            description: T.nilable(String),
-            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
-            platform_id: T.nilable(String),
-            purposes:
-              T.nilable(
-                T::Array[
-                  Straddle::Embed::LinkedBankAccountCreateParams::Purpose::OrSymbol
-                ]
-              ),
-            correlation_id: String,
-            idempotency_key: String,
-            request_id: String,
-            request_options: Straddle::RequestOptions::OrHash
-          ).returns(Straddle::Embed::LinkedBankAccountV1)
-        end
-        def create(
-          # Body param: The unique identifier of the Straddle account to associate this bank
-          # account with.
-          account_id:,
-          # Body param
-          bank_account:,
-          # Body param: Optional description for the bank account.
-          description: nil,
-          # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
-          # additional information about the linked bank account in a structured format.
-          metadata: nil,
-          # Body param: The unique identifier of the Straddle Platform to associate this
-          # bank account with.
-          platform_id: nil,
-          # Body param: The purposes for the linked bank account.
-          purposes: nil,
-          # Header param: Optional client generated identifier to trace and debug a series
-          # of requests.
-          correlation_id: nil,
-          # Header param: Optional client generated value to use for idempotent requests.
-          idempotency_key: nil,
-          # Header param: Optional client generated identifier to trace and debug a request.
-          request_id: nil,
-          request_options: {}
-        )
-        end
-
-        # Updates an existing linked bank account's information. This can be used to
-        # update account details during onboarding or to update metadata associated with
-        # the linked account. The linked bank account must be in 'created' or 'onboarding'
-        # status.
-        sig do
-          params(
-            linked_bank_account_id: String,
-            bank_account:
-              Straddle::Embed::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(Straddle::Embed::LinkedBankAccountV1)
-        end
-        def update(
-          # Path param
-          linked_bank_account_id,
-          # Body param
-          bank_account:,
-          # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
-          # additional information about the linked bank account in a structured format.
-          metadata: nil,
-          # Header param: Optional client generated identifier to trace and debug a series
-          # of requests.
-          correlation_id: nil,
-          # Header param: Optional client generated value to use for idempotent requests.
-          idempotency_key: nil,
-          # Header param: Optional client generated identifier to trace and debug a request.
-          request_id: nil,
-          request_options: {}
-        )
-        end
-
-        # Returns a list of bank accounts associated with a specific Straddle account. The
-        # linked bank accounts are returned sorted by creation date, with the most
-        # recently created appearing first. This endpoint supports pagination to handle
-        # accounts with multiple linked bank accounts.
-        sig do
-          params(
-            account_id: String,
-            level:
-              Straddle::Embed::LinkedBankAccountListParams::Level::OrSymbol,
-            page_number: Integer,
-            page_size: Integer,
-            purpose:
-              Straddle::Embed::LinkedBankAccountListParams::Purpose::OrSymbol,
-            sort_by: String,
-            sort_order:
-              Straddle::Embed::LinkedBankAccountListParams::SortOrder::OrSymbol,
-            status:
-              Straddle::Embed::LinkedBankAccountListParams::Status::OrSymbol,
-            correlation_id: String,
-            request_id: String,
-            request_options: Straddle::RequestOptions::OrHash
-          ).returns(
-            Straddle::Internal::PageNumberSchema[
-              Straddle::Embed::LinkedBankAccountPagedV1::Data
-            ]
-          )
-        end
-        def list(
-          # Query param: The unique identifier of the related account.
-          account_id: nil,
-          # Query param
-          level: nil,
-          # Query param: Results page number. Starts at page 1.
-          page_number: nil,
-          # Query param: Page size. Max value: 1000
-          page_size: nil,
-          # Query param: The purpose of the linked bank accounts to return. Possible values:
-          # 'charges', 'payouts', 'billing'.
-          purpose: nil,
-          # Query param: Sort By.
-          sort_by: nil,
-          # Query param: Sort Order.
-          sort_order: nil,
-          # Query param: The status of the linked bank accounts to return. Possible values:
-          # 'created', 'onboarding', 'active', 'inactive', 'rejected'.
-          status: nil,
-          # Header param: Optional client generated identifier to trace and debug a series
-          # of requests.
-          correlation_id: nil,
-          # Header param: Optional client generated identifier to trace and debug a request.
-          request_id: nil,
-          request_options: {}
-        )
-        end
-
-        # Cancels an existing linked bank account. This can be used to cancel a linked
-        # bank account before it has been reviewed. The linked bank account must be in
-        # 'created' status.
-        sig do
-          params(
-            linked_bank_account_id: String,
-            correlation_id: String,
-            idempotency_key: String,
-            request_id: String,
-            request_options: Straddle::RequestOptions::OrHash
-          ).returns(Straddle::Embed::LinkedBankAccountV1)
-        end
-        def cancel(
-          linked_bank_account_id,
-          # Optional client generated identifier to trace and debug a series of requests.
-          correlation_id: nil,
-          # Optional client generated value to use for idempotent requests.
-          idempotency_key: nil,
-          # Optional client generated identifier to trace and debug a request.
-          request_id: nil,
-          request_options: {}
-        )
-        end
-
-        # Retrieves the details of a linked bank account that has previously been created.
-        # Supply the unique linked bank account `id`, and Straddle will return the
-        # corresponding information. The response includes masked account details for
-        # security purposes.
-        sig do
-          params(
-            linked_bank_account_id: String,
-            correlation_id: String,
-            request_id: String,
-            request_options: Straddle::RequestOptions::OrHash
-          ).returns(Straddle::Embed::LinkedBankAccountV1)
-        end
-        def get(
-          linked_bank_account_id,
-          # Optional client generated identifier to trace and debug a series of requests.
-          correlation_id: nil,
-          # Optional client generated identifier to trace and debug a request.
-          request_id: nil,
-          request_options: {}
-        )
-        end
-
-        # Retrieves the unmasked details of a linked bank account that has previously been
-        # created. Supply the unique linked bank account `id`, and Straddle will return
-        # the corresponding information, including sensitive details. This endpoint needs
-        # to be enabled by Straddle for your account and should only be used when
-        # absolutely necessary.
-        sig do
-          params(
-            linked_bank_account_id: String,
-            correlation_id: String,
-            request_id: String,
-            request_options: Straddle::RequestOptions::OrHash
-          ).returns(Straddle::Embed::LinkedBankAccountUnmaskV1)
-        end
-        def unmask(
-          linked_bank_account_id,
-          # Optional client generated identifier to trace and debug a series of requests.
-          correlation_id: nil,
-          # Optional client generated identifier to trace and debug a request.
-          request_id: nil,
-          request_options: {}
-        )
-        end
-
-        # @api private
-        sig { params(client: Straddle::Client).returns(T.attached_class) }
-        def self.new(client:)
-        end
-      end
-    end
-  end
-end