straddle 0.1.0.pre.alpha.1

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

@@ -0,0 +1,169 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    class Embed
+      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: String,
+            bank_account:
+              Straddle::Embed::LinkedBankAccountCreateParams::BankAccount::OrHash,
+            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            correlation_id: 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: 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 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,
+            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 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,
+            sort_by: String,
+            sort_order:
+              Straddle::Embed::LinkedBankAccountListParams::SortOrder::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: Sort By.
+          sort_by: nil,
+          # Query param: Sort Order.
+          sort_order: 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 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

data/rbi/straddle/resources/embed/organizations.rbi

@@ -0,0 +1,110 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    class Embed
+      class Organizations
+        # Creates a new organization related to your Straddle integration. Organizations
+        # can be used to group related accounts and manage permissions across multiple
+        # users.
+        sig do
+          params(
+            name: String,
+            external_id: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(Straddle::Embed::OrganizationV1)
+        end
+        def create(
+          # Body param: The name of the organization.
+          name:,
+          # Body param: Unique identifier for the organization 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 organization 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 identifier to trace and debug a request.
+          request_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Retrieves a list of organizations associated with your Straddle integration. The
+        # organizations are returned sorted by creation date, with the most recently
+        # created organizations appearing first. This endpoint supports advanced sorting
+        # and filtering options to help you find specific organizations.
+        sig do
+          params(
+            external_id: String,
+            name: String,
+            page_number: Integer,
+            page_size: Integer,
+            sort_by: String,
+            sort_order:
+              Straddle::Embed::OrganizationListParams::SortOrder::OrSymbol,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(
+            Straddle::Internal::PageNumberSchema[
+              Straddle::Embed::OrganizationPagedV1::Data
+            ]
+          )
+        end
+        def list(
+          # Query param: List organizations by their external ID.
+          external_id: nil,
+          # Query param: List organizations by name (partial match supported).
+          name: 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,
+          # 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 Organization that has previously been created.
+        # Supply the unique organization ID that was returned from your previous request,
+        # and Straddle will return the corresponding organization information.
+        sig do
+          params(
+            organization_id: String,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(Straddle::Embed::OrganizationV1)
+        end
+        def get(
+          organization_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

data/rbi/straddle/resources/embed/representatives.rbi

@@ -0,0 +1,208 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    class Embed
+      class Representatives
+        # Creates a new representative associated with an account. Representatives are
+        # individuals who have legal authority or significant responsibility within the
+        # business.
+        sig do
+          params(
+            account_id: String,
+            dob: Date,
+            email: String,
+            first_name: String,
+            last_name: String,
+            mobile_number: String,
+            relationship:
+              Straddle::Embed::RepresentativeCreateParams::Relationship::OrHash,
+            ssn_last4: String,
+            external_id: T.nilable(String),
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(Straddle::Embed::Representative)
+        end
+        def create(
+          # Body param: The unique identifier of the account this representative is
+          # associated with.
+          account_id:,
+          # Body param: Date of birth for the representative in ISO 8601 format
+          # (YYYY-MM-DD).
+          dob:,
+          # Body param: The company email address of the representative.
+          email:,
+          # Body param: The first name of the representative.
+          first_name:,
+          # Body param: The last name of the representative.
+          last_name:,
+          # Body param: The mobile phone number of the representative.
+          mobile_number:,
+          # Body param:
+          relationship:,
+          # Body param: The last 4 digits of the representative's Social Security Number.
+          ssn_last4:,
+          # Body param: Unique identifier for the representative in your database, used for
+          # cross-referencing between Straddle and your systems.
+          external_id: 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
+
+        # Updates an existing representative's information. This can be used to update
+        # personal details, contact information, or the relationship to the account or
+        # organization.
+        sig do
+          params(
+            representative_id: String,
+            dob: Date,
+            email: String,
+            first_name: String,
+            last_name: String,
+            mobile_number: String,
+            relationship:
+              Straddle::Embed::RepresentativeUpdateParams::Relationship::OrHash,
+            ssn_last4: String,
+            external_id: T.nilable(String),
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(Straddle::Embed::Representative)
+        end
+        def update(
+          # Path param:
+          representative_id,
+          # Body param: The date of birth of the representative, in ISO 8601 format
+          # (YYYY-MM-DD).
+          dob:,
+          # Body param: The email address of the representative.
+          email:,
+          # Body param: The first name of the representative.
+          first_name:,
+          # Body param: The last name of the representative.
+          last_name:,
+          # Body param: The mobile phone number of the representative.
+          mobile_number:,
+          # Body param:
+          relationship:,
+          # Body param: The last 4 digits of the representative's Social Security Number.
+          ssn_last4:,
+          # Body param: Unique identifier for the representative in your database, used for
+          # cross-referencing between Straddle and your systems.
+          external_id: 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
+
+        # Returns a list of representatives associated with a specific account or
+        # organization. The representatives are returned sorted by creation date, with the
+        # most recently created representatives appearing first. This endpoint supports
+        # advanced sorting and filtering options.
+        sig do
+          params(
+            account_id: String,
+            level: Straddle::Embed::RepresentativeListParams::Level::OrSymbol,
+            organization_id: String,
+            page_number: Integer,
+            page_size: Integer,
+            platform_id: String,
+            sort_by: String,
+            sort_order:
+              Straddle::Embed::RepresentativeListParams::SortOrder::OrSymbol,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(
+            Straddle::Internal::PageNumberSchema[
+              Straddle::Embed::RepresentativePaged::Data
+            ]
+          )
+        end
+        def list(
+          # Query param: The unique identifier of the account to list representatives for.
+          account_id: nil,
+          # Query param:
+          level: nil,
+          # Query param:
+          organization_id: 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:
+          platform_id: nil,
+          # Query param: Sort By.
+          sort_by: nil,
+          # Query param: Sort Order.
+          sort_order: 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 existing representative. Supply the unique
+        # representative ID, and Straddle will return the corresponding representative
+        # information.
+        sig do
+          params(
+            representative_id: String,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(Straddle::Embed::Representative)
+        end
+        def get(
+          representative_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 representative that has previously been
+        # created. Supply the unique representative ID, and Straddle will return the
+        # corresponding representative information, including sensitive details. This
+        # endpoint requires additional authentication and should be used with caution.
+        sig do
+          params(
+            representative_id: String,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(Straddle::Embed::Representative)
+        end
+        def unmask(
+          representative_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

data/rbi/straddle/resources/embed.rbi

@@ -0,0 +1,24 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    class Embed
+      sig { returns(Straddle::Resources::Embed::Accounts) }
+      attr_reader :accounts
+
+      sig { returns(Straddle::Resources::Embed::LinkedBankAccounts) }
+      attr_reader :linked_bank_accounts
+
+      sig { returns(Straddle::Resources::Embed::Organizations) }
+      attr_reader :organizations
+
+      sig { returns(Straddle::Resources::Embed::Representatives) }
+      attr_reader :representatives
+
+      # @api private
+      sig { params(client: Straddle::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/straddle/resources/funding_events.rbi

@@ -0,0 +1,94 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    class FundingEvents
+      # Retrieves a list of funding events for your account. This endpoint supports
+      # advanced sorting and filtering options.
+      sig do
+        params(
+          created_from: T.nilable(Date),
+          created_to: T.nilable(Date),
+          direction: Straddle::FundingEventListParams::Direction::OrSymbol,
+          event_type: Straddle::FundingEventListParams::EventType::OrSymbol,
+          page_number: Integer,
+          page_size: Integer,
+          sort_by: Straddle::FundingEventListParams::SortBy::OrSymbol,
+          sort_order: Straddle::FundingEventListParams::SortOrder::OrSymbol,
+          trace_number: T.nilable(String),
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(
+          Straddle::Internal::PageNumberSchema[
+            Straddle::FundingEventSummaryPagedV1::Data
+          ]
+        )
+      end
+      def list(
+        # Query param: The start date of the range to filter by using the `YYYY-MM-DD`
+        # format.
+        created_from: nil,
+        # Query param: The end date of the range to filter by using the `YYYY-MM-DD`
+        # format.
+        created_to: nil,
+        # Query param: Describes the direction of the funding event from the perspective
+        # of the `linked_bank_account`.
+        direction: nil,
+        # Query param: The funding event types describes the direction and reason for the
+        # funding event.
+        event_type: nil,
+        # Query param: Results page number. Starts at page 1.
+        page_number: nil,
+        # Query param: Results page size. Max value: 1000
+        page_size: nil,
+        # Query param: The field to sort the results by.
+        sort_by: nil,
+        # Query param: The order in which to sort the results.
+        sort_order: nil,
+        # Query param: Trace number.
+        trace_number: 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,
+        # Header param: For use by platforms to specify an account id and set scope of a
+        # request.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves the details of an existing funding event. Supply the unique funding
+      # event `id`, and Straddle will return the individual transaction items that make
+      # up the funding event.
+      sig do
+        params(
+          id: String,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::FundingEventSummaryItemV1)
+      end
+      def get(
+        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,
+        # For use by platforms to specify an account id and set scope of a request.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Straddle::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end