straddle 0.4.0 → 1.0.0

data/rbi/straddle/models/organization_list_params.rbi

@@ -0,0 +1,157 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class OrganizationListParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::OrganizationListParams, Straddle::Internal::AnyHash)
+        end
+
+      # Your external ID for the organization.
+      sig { returns(T.nilable(String)) }
+      attr_reader :external_id
+
+      sig { params(external_id: String).void }
+      attr_writer :external_id
+
+      # Organization name. Supports partial matches.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # Page number. Defaults to `1`.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_number
+
+      sig { params(page_number: Integer).void }
+      attr_writer :page_number
+
+      # Number of results per page. Defaults to `100`. Maximum `1000`.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      # Field used to sort results. Defaults to `id`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :sort_by
+
+      sig { params(sort_by: String).void }
+      attr_writer :sort_by
+
+      # Sort direction. Defaults to `asc`.
+      sig do
+        returns(
+          T.nilable(Straddle::OrganizationListParams::SortOrder::OrSymbol)
+        )
+      end
+      attr_reader :sort_order
+
+      sig do
+        params(
+          sort_order: Straddle::OrganizationListParams::SortOrder::OrSymbol
+        ).void
+      end
+      attr_writer :sort_order
+
+      # Optional client-generated identifier for tracing a series of related requests.
+      sig { returns(T.nilable(String)) }
+      attr_reader :correlation_id
+
+      sig { params(correlation_id: String).void }
+      attr_writer :correlation_id
+
+      # Optional client-generated identifier for tracing one request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :request_id
+
+      sig { params(request_id: String).void }
+      attr_writer :request_id
+
+      sig do
+        params(
+          external_id: String,
+          name: String,
+          page_number: Integer,
+          page_size: Integer,
+          sort_by: String,
+          sort_order: Straddle::OrganizationListParams::SortOrder::OrSymbol,
+          correlation_id: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Your external ID for the organization.
+        external_id: nil,
+        # Organization name. Supports partial matches.
+        name: nil,
+        # Page number. Defaults to `1`.
+        page_number: nil,
+        # Number of results per page. Defaults to `100`. Maximum `1000`.
+        page_size: nil,
+        # Field used to sort results. Defaults to `id`.
+        sort_by: nil,
+        # Sort direction. Defaults to `asc`.
+        sort_order: nil,
+        # Optional client-generated identifier for tracing a series of related requests.
+        correlation_id: nil,
+        # Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            external_id: String,
+            name: String,
+            page_number: Integer,
+            page_size: Integer,
+            sort_by: String,
+            sort_order: Straddle::OrganizationListParams::SortOrder::OrSymbol,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module SortOrder
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::OrganizationListParams::SortOrder)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ASC =
+          T.let(:asc, Straddle::OrganizationListParams::SortOrder::TaggedSymbol)
+        DESC =
+          T.let(
+            :desc,
+            Straddle::OrganizationListParams::SortOrder::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Straddle::OrganizationListParams::SortOrder::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/organization_response.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class OrganizationResponse < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::OrganizationResponse, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(Straddle::Organization) }
+      attr_reader :data
+
+      sig { params(data: Straddle::Organization::OrHash).void }
+      attr_writer :data
+
+      # Metadata for an API request.
+      sig { returns(Straddle::ResponseMetadata) }
+      attr_reader :meta
+
+      sig { params(meta: Straddle::ResponseMetadata::OrHash).void }
+      attr_writer :meta
+
+      # Indicates how the response content is structured.
+      #
+      # - `object` means `data` contains one JSON object.
+      # - `array` means `data` contains an array of objects.
+      # - `error` means `error` contains error details.
+      # - `none` means the response has no data.
+      sig do
+        returns(Straddle::OrganizationResponse::ResponseType::TaggedSymbol)
+      end
+      attr_accessor :response_type
+
+      sig do
+        params(
+          data: Straddle::Organization::OrHash,
+          meta: Straddle::ResponseMetadata::OrHash,
+          response_type: Straddle::OrganizationResponse::ResponseType::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        data:,
+        # Metadata for an API request.
+        meta:,
+        # Indicates how the response content is structured.
+        #
+        # - `object` means `data` contains one JSON object.
+        # - `array` means `data` contains an array of objects.
+        # - `error` means `error` contains error details.
+        # - `none` means the response has no data.
+        response_type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: Straddle::Organization,
+            meta: Straddle::ResponseMetadata,
+            response_type:
+              Straddle::OrganizationResponse::ResponseType::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Indicates how the response content is structured.
+      #
+      # - `object` means `data` contains one JSON object.
+      # - `array` means `data` contains an array of objects.
+      # - `error` means `error` contains error details.
+      # - `none` means the response has no data.
+      module ResponseType
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::OrganizationResponse::ResponseType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        OBJECT =
+          T.let(
+            :object,
+            Straddle::OrganizationResponse::ResponseType::TaggedSymbol
+          )
+        ARRAY =
+          T.let(
+            :array,
+            Straddle::OrganizationResponse::ResponseType::TaggedSymbol
+          )
+        ERROR =
+          T.let(
+            :error,
+            Straddle::OrganizationResponse::ResponseType::TaggedSymbol
+          )
+        NONE =
+          T.let(
+            :none,
+            Straddle::OrganizationResponse::ResponseType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Straddle::OrganizationResponse::ResponseType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/organization_retrieve_params.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class OrganizationRetrieveParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::OrganizationRetrieveParams,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :organization_id
+
+      # Optional client-generated identifier for tracing a series of related requests.
+      sig { returns(T.nilable(String)) }
+      attr_reader :correlation_id
+
+      sig { params(correlation_id: String).void }
+      attr_writer :correlation_id
+
+      # Optional client-generated identifier for tracing one request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :request_id
+
+      sig { params(request_id: String).void }
+      attr_writer :request_id
+
+      sig do
+        params(
+          organization_id: String,
+          correlation_id: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        organization_id:,
+        # Optional client-generated identifier for tracing a series of related requests.
+        correlation_id: nil,
+        # Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            organization_id: String,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/page_metadata.rbi

@@ -0,0 +1,102 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class PageMetadata < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::PageMetadata, Straddle::Internal::AnyHash)
+        end
+
+      # Unique identifier for the API request.
+      sig { returns(String) }
+      attr_accessor :api_request_id
+
+      # UTC timestamp for the API request.
+      sig { returns(Time) }
+      attr_accessor :api_request_timestamp
+
+      # Maximum page size allowed for this endpoint.
+      sig { returns(Integer) }
+      attr_accessor :max_page_size
+
+      # Current page number.
+      sig { returns(Integer) }
+      attr_accessor :page_number
+
+      # Number of items per page.
+      sig { returns(Integer) }
+      attr_accessor :page_size
+
+      # Field used to sort the results.
+      sig { returns(String) }
+      attr_accessor :sort_by
+
+      # Sort direction for the results.
+      sig { returns(Straddle::SortOrder::TaggedSymbol) }
+      attr_accessor :sort_order
+
+      # Total number of items available across all pages.
+      sig { returns(Integer) }
+      attr_accessor :total_items
+
+      # Total number of pages available.
+      sig { returns(Integer) }
+      attr_accessor :total_pages
+
+      # Metadata for an API request and a page of results.
+      sig do
+        params(
+          api_request_id: String,
+          api_request_timestamp: Time,
+          max_page_size: Integer,
+          page_number: Integer,
+          page_size: Integer,
+          sort_by: String,
+          sort_order: Straddle::SortOrder::OrSymbol,
+          total_items: Integer,
+          total_pages: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the API request.
+        api_request_id:,
+        # UTC timestamp for the API request.
+        api_request_timestamp:,
+        # Maximum page size allowed for this endpoint.
+        max_page_size:,
+        # Current page number.
+        page_number:,
+        # Number of items per page.
+        page_size:,
+        # Field used to sort the results.
+        sort_by:,
+        # Sort direction for the results.
+        sort_order:,
+        # Total number of items available across all pages.
+        total_items:,
+        # Total number of pages available.
+        total_pages:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            api_request_id: String,
+            api_request_timestamp: Time,
+            max_page_size: Integer,
+            page_number: Integer,
+            page_size: Integer,
+            sort_by: String,
+            sort_order: Straddle::SortOrder::TaggedSymbol,
+            total_items: Integer,
+            total_pages: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/paykey.rbi

@@ -0,0 +1,169 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class Paykey < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Straddle::Paykey, Straddle::Internal::AnyHash) }
+
+      # Unique identifier for the paykey.
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Straddle::PaykeyConfiguration) }
+      attr_reader :config
+
+      sig { params(config: Straddle::PaykeyConfiguration::OrHash).void }
+      attr_writer :config
+
+      # Timestamp of when the paykey was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Human-readable label for the paykey.
+      sig { returns(String) }
+      attr_accessor :label
+
+      # Masked paykey value.
+      sig { returns(String) }
+      attr_accessor :paykey
+
+      sig { returns(Straddle::PaykeySource::TaggedSymbol) }
+      attr_accessor :source
+
+      sig { returns(Straddle::PaykeyStatus::TaggedSymbol) }
+      attr_accessor :status
+
+      # Timestamp of the most recent update to the paykey.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      sig { returns(T.nilable(Straddle::PaykeyBalanceDetails)) }
+      attr_reader :balance
+
+      sig { params(balance: Straddle::PaykeyBalanceDetails::OrHash).void }
+      attr_writer :balance
+
+      sig { returns(T.nilable(Straddle::PaykeyBankDetails)) }
+      attr_reader :bank_data
+
+      sig { params(bank_data: Straddle::PaykeyBankDetails::OrHash).void }
+      attr_writer :bank_data
+
+      # Unique identifier for the customer associated with the paykey.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :customer_id
+
+      # Expiration date and time of the paykey, if applicable.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :expires_at
+
+      # Unique identifier for the paykey in your system.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :external_id
+
+      # Name of the financial institution.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :institution_name
+
+      # Up to 20 user-defined key-value pairs associated with the paykey.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :metadata
+
+      sig { returns(T.nilable(Straddle::PaymentStatusDetails)) }
+      attr_reader :status_details
+
+      sig do
+        params(status_details: Straddle::PaymentStatusDetails::OrHash).void
+      end
+      attr_writer :status_details
+
+      # Whether the paykey is eligible for client-initiated unblocking. `true` only when
+      # the paykey is blocked by an `R29` return and has not been unblocked before.
+      # `false` for other blocked paykeys. `null` when the paykey is not blocked.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :unblock_eligible
+
+      sig do
+        params(
+          id: String,
+          config: Straddle::PaykeyConfiguration::OrHash,
+          created_at: Time,
+          label: String,
+          paykey: String,
+          source: Straddle::PaykeySource::OrSymbol,
+          status: Straddle::PaykeyStatus::OrSymbol,
+          updated_at: Time,
+          balance: Straddle::PaykeyBalanceDetails::OrHash,
+          bank_data: Straddle::PaykeyBankDetails::OrHash,
+          customer_id: T.nilable(String),
+          expires_at: T.nilable(Time),
+          external_id: T.nilable(String),
+          institution_name: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          status_details: Straddle::PaymentStatusDetails::OrHash,
+          unblock_eligible: T.nilable(T::Boolean)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the paykey.
+        id:,
+        config:,
+        # Timestamp of when the paykey was created.
+        created_at:,
+        # Human-readable label for the paykey.
+        label:,
+        # Masked paykey value.
+        paykey:,
+        source:,
+        status:,
+        # Timestamp of the most recent update to the paykey.
+        updated_at:,
+        balance: nil,
+        bank_data: nil,
+        # Unique identifier for the customer associated with the paykey.
+        customer_id: nil,
+        # Expiration date and time of the paykey, if applicable.
+        expires_at: nil,
+        # Unique identifier for the paykey in your system.
+        external_id: nil,
+        # Name of the financial institution.
+        institution_name: nil,
+        # Up to 20 user-defined key-value pairs associated with the paykey.
+        metadata: nil,
+        status_details: nil,
+        # Whether the paykey is eligible for client-initiated unblocking. `true` only when
+        # the paykey is blocked by an `R29` return and has not been unblocked before.
+        # `false` for other blocked paykeys. `null` when the paykey is not blocked.
+        unblock_eligible: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            config: Straddle::PaykeyConfiguration,
+            created_at: Time,
+            label: String,
+            paykey: String,
+            source: Straddle::PaykeySource::TaggedSymbol,
+            status: Straddle::PaykeyStatus::TaggedSymbol,
+            updated_at: Time,
+            balance: Straddle::PaykeyBalanceDetails,
+            bank_data: Straddle::PaykeyBankDetails,
+            customer_id: T.nilable(String),
+            expires_at: T.nilable(Time),
+            external_id: T.nilable(String),
+            institution_name: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            status_details: Straddle::PaymentStatusDetails,
+            unblock_eligible: T.nilable(T::Boolean)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/paykey_balance_details.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class PaykeyBalanceDetails < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::PaykeyBalanceDetails, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(Straddle::PaykeyBalanceRefreshStatus::TaggedSymbol) }
+      attr_accessor :status
+
+      # Most recently retrieved account balance in cents.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :account_balance
+
+      # Timestamp of the most recent account balance update.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :updated_at
+
+      sig do
+        params(
+          status: Straddle::PaykeyBalanceRefreshStatus::OrSymbol,
+          account_balance: T.nilable(Integer),
+          updated_at: T.nilable(Time)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        status:,
+        # Most recently retrieved account balance in cents.
+        account_balance: nil,
+        # Timestamp of the most recent account balance update.
+        updated_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            status: Straddle::PaykeyBalanceRefreshStatus::TaggedSymbol,
+            account_balance: T.nilable(Integer),
+            updated_at: T.nilable(Time)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/paykey_balance_refresh_status.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module PaykeyBalanceRefreshStatus
+      extend Straddle::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, Straddle::PaykeyBalanceRefreshStatus) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      PENDING =
+        T.let(:pending, Straddle::PaykeyBalanceRefreshStatus::TaggedSymbol)
+      COMPLETED =
+        T.let(:completed, Straddle::PaykeyBalanceRefreshStatus::TaggedSymbol)
+      FAILED =
+        T.let(:failed, Straddle::PaykeyBalanceRefreshStatus::TaggedSymbol)
+
+      sig do
+        override.returns(
+          T::Array[Straddle::PaykeyBalanceRefreshStatus::TaggedSymbol]
+        )
+      end
+      def self.values
+      end
+    end
+  end
+end