straddle 0.5.0 → 1.0.0

data/rbi/straddle/models/report_create_total_customers_by_status_params.rbi

@@ -1,65 +0,0 @@
-# typed: strong
-
-module Straddle
-  module Models
-    class ReportCreateTotalCustomersByStatusParams < Straddle::Internal::Type::BaseModel
-      extend Straddle::Internal::Type::RequestParameters::Converter
-      include Straddle::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(
-            Straddle::ReportCreateTotalCustomersByStatusParams,
-            Straddle::Internal::AnyHash
-          )
-        end
-
-      sig { returns(T.nilable(String)) }
-      attr_reader :correlation_id
-
-      sig { params(correlation_id: String).void }
-      attr_writer :correlation_id
-
-      sig { returns(T.nilable(String)) }
-      attr_reader :request_id
-
-      sig { params(request_id: String).void }
-      attr_writer :request_id
-
-      sig { returns(T.nilable(String)) }
-      attr_reader :straddle_account_id
-
-      sig { params(straddle_account_id: String).void }
-      attr_writer :straddle_account_id
-
-      sig do
-        params(
-          correlation_id: String,
-          request_id: String,
-          straddle_account_id: String,
-          request_options: Straddle::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        correlation_id: nil,
-        request_id: nil,
-        straddle_account_id: nil,
-        request_options: {}
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            correlation_id: String,
-            request_id: String,
-            straddle_account_id: String,
-            request_options: Straddle::RequestOptions
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/straddle/models/report_create_total_customers_by_status_response.rbi

@@ -1,191 +0,0 @@
-# typed: strong
-
-module Straddle
-  module Models
-    class ReportCreateTotalCustomersByStatusResponse < Straddle::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            Straddle::Models::ReportCreateTotalCustomersByStatusResponse,
-            Straddle::Internal::AnyHash
-          )
-        end
-
-      sig do
-        returns(
-          Straddle::Models::ReportCreateTotalCustomersByStatusResponse::Data
-        )
-      end
-      attr_reader :data
-
-      sig do
-        params(
-          data:
-            Straddle::Models::ReportCreateTotalCustomersByStatusResponse::Data::OrHash
-        ).void
-      end
-      attr_writer :data
-
-      # Metadata about the API request, including an identifier and timestamp.
-      sig { returns(Straddle::ResponseMetadata) }
-      attr_reader :meta
-
-      sig { params(meta: Straddle::ResponseMetadata::OrHash).void }
-      attr_writer :meta
-
-      # Indicates the structure of the returned content.
-      #
-      # - "object" means the `data` field contains a single JSON object.
-      # - "array" means the `data` field contains an array of objects.
-      # - "error" means the `data` field contains an error object with details of the
-      #   issue.
-      # - "none" means no data is returned.
-      sig do
-        returns(
-          Straddle::Models::ReportCreateTotalCustomersByStatusResponse::ResponseType::TaggedSymbol
-        )
-      end
-      attr_accessor :response_type
-
-      sig do
-        params(
-          data:
-            Straddle::Models::ReportCreateTotalCustomersByStatusResponse::Data::OrHash,
-          meta: Straddle::ResponseMetadata::OrHash,
-          response_type:
-            Straddle::Models::ReportCreateTotalCustomersByStatusResponse::ResponseType::OrSymbol
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        data:,
-        # Metadata about the API request, including an identifier and timestamp.
-        meta:,
-        # Indicates the structure of the returned content.
-        #
-        # - "object" means the `data` field contains a single JSON object.
-        # - "array" means the `data` field contains an array of objects.
-        # - "error" means the `data` field contains an error object with details of the
-        #   issue.
-        # - "none" means no data is returned.
-        response_type:
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            data:
-              Straddle::Models::ReportCreateTotalCustomersByStatusResponse::Data,
-            meta: Straddle::ResponseMetadata,
-            response_type:
-              Straddle::Models::ReportCreateTotalCustomersByStatusResponse::ResponseType::TaggedSymbol
-          }
-        )
-      end
-      def to_hash
-      end
-
-      class Data < Straddle::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Straddle::Models::ReportCreateTotalCustomersByStatusResponse::Data,
-              Straddle::Internal::AnyHash
-            )
-          end
-
-        sig { returns(Integer) }
-        attr_accessor :inactive
-
-        sig { returns(Integer) }
-        attr_accessor :pending
-
-        sig { returns(Integer) }
-        attr_accessor :rejected
-
-        sig { returns(Integer) }
-        attr_accessor :review
-
-        sig { returns(Integer) }
-        attr_accessor :verified
-
-        sig do
-          params(
-            inactive: Integer,
-            pending: Integer,
-            rejected: Integer,
-            review: Integer,
-            verified: Integer
-          ).returns(T.attached_class)
-        end
-        def self.new(inactive:, pending:, rejected:, review:, verified:)
-        end
-
-        sig do
-          override.returns(
-            {
-              inactive: Integer,
-              pending: Integer,
-              rejected: Integer,
-              review: Integer,
-              verified: Integer
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-
-      # Indicates the structure of the returned content.
-      #
-      # - "object" means the `data` field contains a single JSON object.
-      # - "array" means the `data` field contains an array of objects.
-      # - "error" means the `data` field contains an error object with details of the
-      #   issue.
-      # - "none" means no data is returned.
-      module ResponseType
-        extend Straddle::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              Straddle::Models::ReportCreateTotalCustomersByStatusResponse::ResponseType
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        OBJECT =
-          T.let(
-            :object,
-            Straddle::Models::ReportCreateTotalCustomersByStatusResponse::ResponseType::TaggedSymbol
-          )
-        ARRAY =
-          T.let(
-            :array,
-            Straddle::Models::ReportCreateTotalCustomersByStatusResponse::ResponseType::TaggedSymbol
-          )
-        ERROR =
-          T.let(
-            :error,
-            Straddle::Models::ReportCreateTotalCustomersByStatusResponse::ResponseType::TaggedSymbol
-          )
-        NONE =
-          T.let(
-            :none,
-            Straddle::Models::ReportCreateTotalCustomersByStatusResponse::ResponseType::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Straddle::Models::ReportCreateTotalCustomersByStatusResponse::ResponseType::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-    end
-  end
-end

data/rbi/straddle/models/status_details_v1.rbi

@@ -1,236 +0,0 @@
-# typed: strong
-
-module Straddle
-  module Models
-    class StatusDetailsV1 < Straddle::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(Straddle::StatusDetailsV1, Straddle::Internal::AnyHash)
-        end
-
-      # The time the status change occurred.
-      sig { returns(Time) }
-      attr_accessor :changed_at
-
-      # A human-readable description of the current status.
-      sig { returns(String) }
-      attr_accessor :message
-
-      # A machine-readable identifier for the specific status, useful for programmatic
-      # handling.
-      sig { returns(Straddle::StatusDetailsV1::Reason::TaggedSymbol) }
-      attr_accessor :reason
-
-      # Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`).
-      # This helps in tracking the cause of status updates.
-      sig { returns(Straddle::StatusDetailsV1::Source::TaggedSymbol) }
-      attr_accessor :source
-
-      # The status code if applicable.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :code
-
-      sig do
-        params(
-          changed_at: Time,
-          message: String,
-          reason: Straddle::StatusDetailsV1::Reason::OrSymbol,
-          source: Straddle::StatusDetailsV1::Source::OrSymbol,
-          code: T.nilable(String)
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # The time the status change occurred.
-        changed_at:,
-        # A human-readable description of the current status.
-        message:,
-        # A machine-readable identifier for the specific status, useful for programmatic
-        # handling.
-        reason:,
-        # Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`).
-        # This helps in tracking the cause of status updates.
-        source:,
-        # The status code if applicable.
-        code: nil
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            changed_at: Time,
-            message: String,
-            reason: Straddle::StatusDetailsV1::Reason::TaggedSymbol,
-            source: Straddle::StatusDetailsV1::Source::TaggedSymbol,
-            code: T.nilable(String)
-          }
-        )
-      end
-      def to_hash
-      end
-
-      # A machine-readable identifier for the specific status, useful for programmatic
-      # handling.
-      module Reason
-        extend Straddle::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, Straddle::StatusDetailsV1::Reason) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        INSUFFICIENT_FUNDS =
-          T.let(
-            :insufficient_funds,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        CLOSED_BANK_ACCOUNT =
-          T.let(
-            :closed_bank_account,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        INVALID_BANK_ACCOUNT =
-          T.let(
-            :invalid_bank_account,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        INVALID_ROUTING =
-          T.let(
-            :invalid_routing,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        DISPUTED =
-          T.let(:disputed, Straddle::StatusDetailsV1::Reason::TaggedSymbol)
-        PAYMENT_STOPPED =
-          T.let(
-            :payment_stopped,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        OWNER_DECEASED =
-          T.let(
-            :owner_deceased,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        FROZEN_BANK_ACCOUNT =
-          T.let(
-            :frozen_bank_account,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        RISK_REVIEW =
-          T.let(:risk_review, Straddle::StatusDetailsV1::Reason::TaggedSymbol)
-        FRAUDULENT =
-          T.let(:fraudulent, Straddle::StatusDetailsV1::Reason::TaggedSymbol)
-        DUPLICATE_ENTRY =
-          T.let(
-            :duplicate_entry,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        INVALID_PAYKEY =
-          T.let(
-            :invalid_paykey,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        PAYMENT_BLOCKED =
-          T.let(
-            :payment_blocked,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        AMOUNT_TOO_LARGE =
-          T.let(
-            :amount_too_large,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        TOO_MANY_ATTEMPTS =
-          T.let(
-            :too_many_attempts,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        INTERNAL_SYSTEM_ERROR =
-          T.let(
-            :internal_system_error,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        USER_REQUEST =
-          T.let(:user_request, Straddle::StatusDetailsV1::Reason::TaggedSymbol)
-        OK = T.let(:ok, Straddle::StatusDetailsV1::Reason::TaggedSymbol)
-        OTHER_NETWORK_RETURN =
-          T.let(
-            :other_network_return,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        PAYOUT_REFUSED =
-          T.let(
-            :payout_refused,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        CANCEL_REQUEST =
-          T.let(
-            :cancel_request,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        FAILED_VERIFICATION =
-          T.let(
-            :failed_verification,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        REQUIRE_REVIEW =
-          T.let(
-            :require_review,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        BLOCKED_BY_SYSTEM =
-          T.let(
-            :blocked_by_system,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        WATCHTOWER_REVIEW =
-          T.let(
-            :watchtower_review,
-            Straddle::StatusDetailsV1::Reason::TaggedSymbol
-          )
-        VALIDATING =
-          T.let(:validating, Straddle::StatusDetailsV1::Reason::TaggedSymbol)
-        AUTO_HOLD =
-          T.let(:auto_hold, Straddle::StatusDetailsV1::Reason::TaggedSymbol)
-
-        sig do
-          override.returns(
-            T::Array[Straddle::StatusDetailsV1::Reason::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-
-      # Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`).
-      # This helps in tracking the cause of status updates.
-      module Source
-        extend Straddle::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, Straddle::StatusDetailsV1::Source) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        WATCHTOWER =
-          T.let(:watchtower, Straddle::StatusDetailsV1::Source::TaggedSymbol)
-        BANK_DECLINE =
-          T.let(:bank_decline, Straddle::StatusDetailsV1::Source::TaggedSymbol)
-        CUSTOMER_DISPUTE =
-          T.let(
-            :customer_dispute,
-            Straddle::StatusDetailsV1::Source::TaggedSymbol
-          )
-        USER_ACTION =
-          T.let(:user_action, Straddle::StatusDetailsV1::Source::TaggedSymbol)
-        SYSTEM = T.let(:system, Straddle::StatusDetailsV1::Source::TaggedSymbol)
-
-        sig do
-          override.returns(
-            T::Array[Straddle::StatusDetailsV1::Source::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-    end
-  end
-end

data/rbi/straddle/resources/bridge/link.rbi

@@ -1,209 +0,0 @@
-# typed: strong
-
-module Straddle
-  module Resources
-    class Bridge
-      # Bridge provides a comprehensive suite of tools for connecting customer bank
-      # accounts. Use it to generate secure widget sessions for instant account
-      # verification, accept tokens from major providers like Plaid and Finicity, or
-      # verify accounts directly via our API. Bridge handles all sensitive banking
-      # credentials and ensures secure, compliant connections with support for 90% of US
-      # bank accounts.
-      class Link
-        # Use Bridge to create a new paykey using a bank routing and account number as the
-        # source. This endpoint allows you to create a secure payment token linked to a
-        # specific bank account.
-        sig do
-          params(
-            account_number: String,
-            account_type:
-              Straddle::Bridge::LinkBankAccountParams::AccountType::OrSymbol,
-            customer_id: String,
-            routing_number: String,
-            config: Straddle::Bridge::LinkBankAccountParams::Config::OrHash,
-            external_id: T.nilable(String),
-            metadata: T.nilable(T::Hash[Symbol, String]),
-            correlation_id: String,
-            idempotency_key: String,
-            request_id: String,
-            straddle_account_id: String,
-            request_options: Straddle::RequestOptions::OrHash
-          ).returns(Straddle::PaykeyV1)
-        end
-        def bank_account(
-          # Body param: The bank account number.
-          account_number:,
-          # Body param
-          account_type:,
-          # Body param: Unique identifier of the related customer object.
-          customer_id:,
-          # Body param: The routing number of the bank account.
-          routing_number:,
-          # Body param
-          config: nil,
-          # Body param: Unique identifier for the paykey 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 paykey 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,
-          # Header param: For use by platforms to specify an account id and set scope of a
-          # request.
-          straddle_account_id: nil,
-          request_options: {}
-        )
-        end
-
-        # Creates a new paykey using a Quiltt token as the source. This endpoint allows
-        # you to create a secure payment token linked to a bank account authenticated
-        # through Quiltt.
-        sig do
-          params(
-            customer_id: String,
-            quiltt_token: String,
-            config: Straddle::Bridge::LinkCreatePaykeyParams::Config::OrHash,
-            external_id: T.nilable(String),
-            metadata: T.nilable(T::Hash[Symbol, String]),
-            correlation_id: String,
-            idempotency_key: String,
-            request_id: String,
-            straddle_account_id: String,
-            request_options: Straddle::RequestOptions::OrHash
-          ).returns(Straddle::Models::Bridge::LinkCreatePaykeyResponse)
-        end
-        def create_paykey(
-          # Body param: Unique identifier of the related customer object.
-          customer_id:,
-          # Body param: Quiltt processor token generated by your application for use with
-          # the Straddle API.
-          quiltt_token:,
-          # Body param
-          config: nil,
-          # Body param: Unique identifier for the paykey 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 paykey 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,
-          # Header param: For use by platforms to specify an account id and set scope of a
-          # request.
-          straddle_account_id: nil,
-          request_options: {}
-        )
-        end
-
-        sig do
-          params(
-            account_type:
-              Straddle::Bridge::LinkCreateTanParams::AccountType::OrSymbol,
-            customer_id: String,
-            routing_number: String,
-            tan: String,
-            config: Straddle::Bridge::LinkCreateTanParams::Config::OrHash,
-            external_id: T.nilable(String),
-            metadata: T.nilable(T::Hash[Symbol, String]),
-            correlation_id: String,
-            idempotency_key: String,
-            request_id: String,
-            straddle_account_id: String,
-            request_options: Straddle::RequestOptions::OrHash
-          ).returns(Straddle::Models::Bridge::LinkCreateTanResponse)
-        end
-        def create_tan(
-          # Body param
-          account_type:,
-          # Body param: Unique identifier of the related customer object.
-          customer_id:,
-          # Body param: Bank routing number.
-          routing_number:,
-          # Body param: Tokenized account number.
-          tan:,
-          # Body param
-          config: nil,
-          # Body param: Unique identifier for the paykey 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 paykey 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,
-          # Header param: For use by platforms to specify an account id and set scope of a
-          # request.
-          straddle_account_id: nil,
-          request_options: {}
-        )
-        end
-
-        # Use Bridge to create a new paykey using a Plaid token as the source. This
-        # endpoint allows you to create a secure payment token linked to a bank account
-        # authenticated through Plaid.
-        sig do
-          params(
-            customer_id: String,
-            plaid_token: String,
-            config: Straddle::Bridge::LinkPlaidParams::Config::OrHash,
-            external_id: T.nilable(String),
-            metadata: T.nilable(T::Hash[Symbol, String]),
-            correlation_id: String,
-            idempotency_key: String,
-            request_id: String,
-            straddle_account_id: String,
-            request_options: Straddle::RequestOptions::OrHash
-          ).returns(Straddle::PaykeyV1)
-        end
-        def plaid(
-          # Body param: Unique identifier of the related customer object.
-          customer_id:,
-          # Body param: Plaid processor token generated by your application for use with the
-          # Straddle API.
-          plaid_token:,
-          # Body param
-          config: nil,
-          # Body param: Unique identifier for the paykey 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 paykey 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,
-          # Header param: 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
-end