straddle 0.5.0 → 1.0.0

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

@@ -1,117 +0,0 @@
-# typed: strong
-
-module Straddle
-  module Resources
-    class Embed
-      # Organizations are a powerful feature in Straddle that allow you to manage
-      # multiple accounts under a single umbrella. This hierarchical structure is
-      # particularly useful for businesses with complex operations, multiple
-      # departments, or legally related entities.
-      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,
-            idempotency_key: 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 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 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

@@ -1,228 +0,0 @@
-# typed: strong
-
-module Straddle
-  module Resources
-    class Embed
-      # Representatives are individuals who have legal authority or significant
-      # responsibility within a business entity associated with a Straddle account. Each
-      # representative undergoes automated verification as part of KYC/KYB compliance.
-      # Use representatives to collect and verify beneficial owners, control persons,
-      # and authorized signers required for account onboarding. Representatives also
-      # determine who can legally operate the account and make important changes.
-      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),
-            metadata: T.nilable(T::Hash[Symbol, String]),
-            correlation_id: String,
-            idempotency_key: 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,
-          # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
-          # additional information about the represetative 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 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),
-            metadata: T.nilable(T::Hash[Symbol, String]),
-            correlation_id: String,
-            idempotency_key: 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,
-          # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
-          # additional information about the represetative 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 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

@@ -1,43 +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.
-      sig { returns(Straddle::Resources::Embed::Accounts) }
-      attr_reader :accounts
-
-      # 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.
-      sig { returns(Straddle::Resources::Embed::LinkedBankAccounts) }
-      attr_reader :linked_bank_accounts
-
-      # Organizations are a powerful feature in Straddle that allow you to manage
-      # multiple accounts under a single umbrella. This hierarchical structure is
-      # particularly useful for businesses with complex operations, multiple
-      # departments, or legally related entities.
-      sig { returns(Straddle::Resources::Embed::Organizations) }
-      attr_reader :organizations
-
-      # Representatives are individuals who have legal authority or significant
-      # responsibility within a business entity associated with a Straddle account. Each
-      # representative undergoes automated verification as part of KYC/KYB compliance.
-      # Use representatives to collect and verify beneficial owners, control persons,
-      # and authorized signers required for account onboarding. Representatives also
-      # determine who can legally operate the account and make important changes.
-      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/reports.rbi

@@ -1,31 +0,0 @@
-# typed: strong
-
-module Straddle
-  module Resources
-    class Reports
-      sig do
-        params(
-          correlation_id: String,
-          request_id: String,
-          straddle_account_id: String,
-          request_options: Straddle::RequestOptions::OrHash
-        ).returns(Straddle::Models::ReportCreateTotalCustomersByStatusResponse)
-      end
-      def create_total_customers_by_status(
-        # 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

data/sig/straddle/internal/page_number_schema.rbs

@@ -1,52 +0,0 @@
-module Straddle
-  module Internal
-    class PageNumberSchema[Elem]
-      include Straddle::Internal::Type::BasePage[Elem]
-
-      attr_accessor data: ::Array[Elem]?
-
-      attr_accessor meta: Meta
-
-      def inspect: -> String
-
-      type meta =
-        {
-          max_page_size: Integer,
-          page_number: Integer,
-          page_size: Integer,
-          total_items: Integer
-        }
-      class Meta < Straddle::Internal::Type::BaseModel
-        attr_reader max_page_size: Integer?
-
-        def max_page_size=: (Integer) -> Integer
-
-        attr_reader page_number: Integer?
-
-        def page_number=: (Integer) -> Integer
-
-        attr_reader page_size: Integer?
-
-        def page_size=: (Integer) -> Integer
-
-        attr_reader total_items: Integer?
-
-        def total_items=: (Integer) -> Integer
-
-        def initialize: (
-          ?max_page_size: Integer,
-          ?page_number: Integer,
-          ?page_size: Integer,
-          ?total_items: Integer
-        ) -> void
-
-        def to_hash: -> {
-          max_page_size: Integer,
-          page_number: Integer,
-          page_size: Integer,
-          total_items: Integer
-        }
-      end
-    end
-  end
-end

data/sig/straddle/models/bridge/link_bank_account_params.rbs

@@ -1,156 +0,0 @@
-module Straddle
-  module Models
-    module Bridge
-      type link_bank_account_params =
-        {
-          account_number: String,
-          account_type: Straddle::Models::Bridge::LinkBankAccountParams::account_type,
-          customer_id: String,
-          routing_number: String,
-          config: Straddle::Bridge::LinkBankAccountParams::Config,
-          external_id: String?,
-          metadata: ::Hash[Symbol, String]?,
-          correlation_id: String,
-          idempotency_key: String,
-          request_id: String,
-          straddle_account_id: String
-        }
-        & Straddle::Internal::Type::request_parameters
-
-      class LinkBankAccountParams < Straddle::Internal::Type::BaseModel
-        extend Straddle::Internal::Type::RequestParameters::Converter
-        include Straddle::Internal::Type::RequestParameters
-
-        attr_accessor account_number: String
-
-        attr_accessor account_type: Straddle::Models::Bridge::LinkBankAccountParams::account_type
-
-        attr_accessor customer_id: String
-
-        attr_accessor routing_number: String
-
-        attr_reader config: Straddle::Bridge::LinkBankAccountParams::Config?
-
-        def config=: (
-          Straddle::Bridge::LinkBankAccountParams::Config
-        ) -> Straddle::Bridge::LinkBankAccountParams::Config
-
-        attr_accessor external_id: String?
-
-        attr_accessor metadata: ::Hash[Symbol, String]?
-
-        attr_reader correlation_id: String?
-
-        def correlation_id=: (String) -> String
-
-        attr_reader idempotency_key: String?
-
-        def idempotency_key=: (String) -> String
-
-        attr_reader request_id: String?
-
-        def request_id=: (String) -> String
-
-        attr_reader straddle_account_id: String?
-
-        def straddle_account_id=: (String) -> String
-
-        def initialize: (
-          account_number: String,
-          account_type: Straddle::Models::Bridge::LinkBankAccountParams::account_type,
-          customer_id: String,
-          routing_number: String,
-          ?config: Straddle::Bridge::LinkBankAccountParams::Config,
-          ?external_id: String?,
-          ?metadata: ::Hash[Symbol, String]?,
-          ?correlation_id: String,
-          ?idempotency_key: String,
-          ?request_id: String,
-          ?straddle_account_id: String,
-          ?request_options: Straddle::request_opts
-        ) -> void
-
-        def to_hash: -> {
-          account_number: String,
-          account_type: Straddle::Models::Bridge::LinkBankAccountParams::account_type,
-          customer_id: String,
-          routing_number: String,
-          config: Straddle::Bridge::LinkBankAccountParams::Config,
-          external_id: String?,
-          metadata: ::Hash[Symbol, String]?,
-          correlation_id: String,
-          idempotency_key: String,
-          request_id: String,
-          straddle_account_id: String,
-          request_options: Straddle::RequestOptions
-        }
-
-        type account_type = :checking | :savings
-
-        module AccountType
-          extend Straddle::Internal::Type::Enum
-
-          CHECKING: :checking
-          SAVINGS: :savings
-
-          def self?.values: -> ::Array[Straddle::Models::Bridge::LinkBankAccountParams::account_type]
-        end
-
-        type config =
-          {
-            processing_method: Straddle::Models::Bridge::LinkBankAccountParams::Config::processing_method,
-            sandbox_outcome: Straddle::Models::Bridge::LinkBankAccountParams::Config::sandbox_outcome
-          }
-
-        class Config < Straddle::Internal::Type::BaseModel
-          attr_reader processing_method: Straddle::Models::Bridge::LinkBankAccountParams::Config::processing_method?
-
-          def processing_method=: (
-            Straddle::Models::Bridge::LinkBankAccountParams::Config::processing_method
-          ) -> Straddle::Models::Bridge::LinkBankAccountParams::Config::processing_method
-
-          attr_reader sandbox_outcome: Straddle::Models::Bridge::LinkBankAccountParams::Config::sandbox_outcome?
-
-          def sandbox_outcome=: (
-            Straddle::Models::Bridge::LinkBankAccountParams::Config::sandbox_outcome
-          ) -> Straddle::Models::Bridge::LinkBankAccountParams::Config::sandbox_outcome
-
-          def initialize: (
-            ?processing_method: Straddle::Models::Bridge::LinkBankAccountParams::Config::processing_method,
-            ?sandbox_outcome: Straddle::Models::Bridge::LinkBankAccountParams::Config::sandbox_outcome
-          ) -> void
-
-          def to_hash: -> {
-            processing_method: Straddle::Models::Bridge::LinkBankAccountParams::Config::processing_method,
-            sandbox_outcome: Straddle::Models::Bridge::LinkBankAccountParams::Config::sandbox_outcome
-          }
-
-          type processing_method = :inline | :background | :skip
-
-          module ProcessingMethod
-            extend Straddle::Internal::Type::Enum
-
-            INLINE: :inline
-            BACKGROUND: :background
-            SKIP: :skip
-
-            def self?.values: -> ::Array[Straddle::Models::Bridge::LinkBankAccountParams::Config::processing_method]
-          end
-
-          type sandbox_outcome = :standard | :active | :rejected | :review
-
-          module SandboxOutcome
-            extend Straddle::Internal::Type::Enum
-
-            STANDARD: :standard
-            ACTIVE: :active
-            REJECTED: :rejected
-            REVIEW: :review
-
-            def self?.values: -> ::Array[Straddle::Models::Bridge::LinkBankAccountParams::Config::sandbox_outcome]
-          end
-        end
-      end
-    end
-  end
-end