straddle 0.4.0 → 1.0.0

data/rbi/straddle/models/funding_event_list_payments_params.rbi

@@ -0,0 +1,268 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class FundingEventListPaymentsParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::FundingEventListPaymentsParams,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Default number of results returned per page.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :default_page_size
+
+      sig { params(default_page_size: Integer).void }
+      attr_writer :default_page_size
+
+      # Default field used to sort the results.
+      sig do
+        returns(
+          T.nilable(
+            Straddle::FundingEventListPaymentsParams::DefaultSort::OrSymbol
+          )
+        )
+      end
+      attr_reader :default_sort
+
+      sig do
+        params(
+          default_sort:
+            Straddle::FundingEventListPaymentsParams::DefaultSort::OrSymbol
+        ).void
+      end
+      attr_writer :default_sort
+
+      # Default order in which to sort the results.
+      sig { returns(T.nilable(Straddle::SortOrder::OrSymbol)) }
+      attr_reader :default_sort_order
+
+      sig { params(default_sort_order: Straddle::SortOrder::OrSymbol).void }
+      attr_writer :default_sort_order
+
+      # When `true`, includes each payment's metadata. Defaults to `false`.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :include_metadata
+
+      sig { params(include_metadata: T::Boolean).void }
+      attr_writer :include_metadata
+
+      # Results page number. Starts at 1. 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. Maximum 1,000. Defaults to 100.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      # Field used to sort the results.
+      sig do
+        returns(
+          T.nilable(Straddle::FundingEventListPaymentsParams::SortBy::OrSymbol)
+        )
+      end
+      attr_reader :sort_by
+
+      sig do
+        params(
+          sort_by: Straddle::FundingEventListPaymentsParams::SortBy::OrSymbol
+        ).void
+      end
+      attr_writer :sort_by
+
+      # Order in which to sort the results.
+      sig { returns(T.nilable(Straddle::SortOrder::OrSymbol)) }
+      attr_reader :sort_order
+
+      sig { params(sort_order: Straddle::SortOrder::OrSymbol).void }
+      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
+
+      # For platform requests, the embedded account UUID that sets the request scope.
+      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(
+          id: String,
+          default_page_size: Integer,
+          default_sort:
+            Straddle::FundingEventListPaymentsParams::DefaultSort::OrSymbol,
+          default_sort_order: Straddle::SortOrder::OrSymbol,
+          include_metadata: T::Boolean,
+          page_number: Integer,
+          page_size: Integer,
+          sort_by: Straddle::FundingEventListPaymentsParams::SortBy::OrSymbol,
+          sort_order: Straddle::SortOrder::OrSymbol,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Default number of results returned per page.
+        default_page_size: nil,
+        # Default field used to sort the results.
+        default_sort: nil,
+        # Default order in which to sort the results.
+        default_sort_order: nil,
+        # When `true`, includes each payment's metadata. Defaults to `false`.
+        include_metadata: nil,
+        # Results page number. Starts at 1. Defaults to 1.
+        page_number: nil,
+        # Number of results per page. Maximum 1,000. Defaults to 100.
+        page_size: nil,
+        # Field used to sort the results.
+        sort_by: nil,
+        # Order in which to sort the results.
+        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,
+        # For platform requests, the embedded account UUID that sets the request scope.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            default_page_size: Integer,
+            default_sort:
+              Straddle::FundingEventListPaymentsParams::DefaultSort::OrSymbol,
+            default_sort_order: Straddle::SortOrder::OrSymbol,
+            include_metadata: T::Boolean,
+            page_number: Integer,
+            page_size: Integer,
+            sort_by: Straddle::FundingEventListPaymentsParams::SortBy::OrSymbol,
+            sort_order: Straddle::SortOrder::OrSymbol,
+            correlation_id: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module DefaultSort
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::FundingEventListPaymentsParams::DefaultSort)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CREATED_AT =
+          T.let(
+            :created_at,
+            Straddle::FundingEventListPaymentsParams::DefaultSort::TaggedSymbol
+          )
+        PAYMENT_DATE =
+          T.let(
+            :payment_date,
+            Straddle::FundingEventListPaymentsParams::DefaultSort::TaggedSymbol
+          )
+        EFFECTIVE_AT =
+          T.let(
+            :effective_at,
+            Straddle::FundingEventListPaymentsParams::DefaultSort::TaggedSymbol
+          )
+        ID =
+          T.let(
+            :id,
+            Straddle::FundingEventListPaymentsParams::DefaultSort::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Straddle::FundingEventListPaymentsParams::DefaultSort::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module SortBy
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::FundingEventListPaymentsParams::SortBy)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CREATED_AT =
+          T.let(
+            :created_at,
+            Straddle::FundingEventListPaymentsParams::SortBy::TaggedSymbol
+          )
+        PAYMENT_DATE =
+          T.let(
+            :payment_date,
+            Straddle::FundingEventListPaymentsParams::SortBy::TaggedSymbol
+          )
+        EFFECTIVE_AT =
+          T.let(
+            :effective_at,
+            Straddle::FundingEventListPaymentsParams::SortBy::TaggedSymbol
+          )
+        ID =
+          T.let(
+            :id,
+            Straddle::FundingEventListPaymentsParams::SortBy::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Straddle::FundingEventListPaymentsParams::SortBy::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/funding_event_payment.rbi

@@ -0,0 +1,147 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class FundingEventPayment < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::FundingEventPayment, Straddle::Internal::AnyHash)
+        end
+
+      # Unique identifier for this payment.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Three-letter ISO 4217 currency code.
+      sig { returns(String) }
+      attr_accessor :currency
+
+      # Your unique identifier for this payment, used to correlate with your internal
+      # records.
+      sig { returns(String) }
+      attr_accessor :external_id
+
+      # Portion of the payment amount included in this funding event, in the smallest
+      # currency unit.
+      sig { returns(Integer) }
+      attr_accessor :funding_amount
+
+      # Total payment amount in the smallest currency unit (e.g. 1000 = $10.00 USD).
+      sig { returns(Integer) }
+      attr_accessor :payment_amount
+
+      # The date on which this payment was submitted for processing.
+      sig { returns(Date) }
+      attr_accessor :payment_date
+
+      # Whether this payment is a charge or payout.
+      sig { returns(Straddle::PaymentType::TaggedSymbol) }
+      attr_accessor :payment_type
+
+      # Reason this payment was included in the funding event.
+      sig { returns(Straddle::FundingEventPaymentReason::TaggedSymbol) }
+      attr_accessor :reason
+
+      # Current status of this payment.
+      sig { returns(Straddle::PaymentStatus::TaggedSymbol) }
+      attr_accessor :status
+
+      # Network-level trace identifiers assigned during processing. Keys vary by payment
+      # rail.
+      sig { returns(T::Hash[Symbol, String]) }
+      attr_accessor :trace_ids
+
+      # Details of the customer associated with this payment.
+      sig { returns(T.nilable(Straddle::CustomerDetails)) }
+      attr_reader :customer_details
+
+      sig { params(customer_details: Straddle::CustomerDetails::OrHash).void }
+      attr_writer :customer_details
+
+      # Key-value metadata for this payment. Included only when `include_metadata` is
+      # `true`.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :metadata
+
+      # Details of the paykey used for this payment.
+      sig { returns(T.nilable(Straddle::PaykeyDetails)) }
+      attr_reader :paykey_details
+
+      sig { params(paykey_details: Straddle::PaykeyDetails::OrHash).void }
+      attr_writer :paykey_details
+
+      sig do
+        params(
+          id: String,
+          currency: String,
+          external_id: String,
+          funding_amount: Integer,
+          payment_amount: Integer,
+          payment_date: Date,
+          payment_type: Straddle::PaymentType::OrSymbol,
+          reason: Straddle::FundingEventPaymentReason::OrSymbol,
+          status: Straddle::PaymentStatus::OrSymbol,
+          trace_ids: T::Hash[Symbol, String],
+          customer_details: Straddle::CustomerDetails::OrHash,
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          paykey_details: Straddle::PaykeyDetails::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for this payment.
+        id:,
+        # Three-letter ISO 4217 currency code.
+        currency:,
+        # Your unique identifier for this payment, used to correlate with your internal
+        # records.
+        external_id:,
+        # Portion of the payment amount included in this funding event, in the smallest
+        # currency unit.
+        funding_amount:,
+        # Total payment amount in the smallest currency unit (e.g. 1000 = $10.00 USD).
+        payment_amount:,
+        # The date on which this payment was submitted for processing.
+        payment_date:,
+        # Whether this payment is a charge or payout.
+        payment_type:,
+        # Reason this payment was included in the funding event.
+        reason:,
+        # Current status of this payment.
+        status:,
+        # Network-level trace identifiers assigned during processing. Keys vary by payment
+        # rail.
+        trace_ids:,
+        # Details of the customer associated with this payment.
+        customer_details: nil,
+        # Key-value metadata for this payment. Included only when `include_metadata` is
+        # `true`.
+        metadata: nil,
+        # Details of the paykey used for this payment.
+        paykey_details: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            currency: String,
+            external_id: String,
+            funding_amount: Integer,
+            payment_amount: Integer,
+            payment_date: Date,
+            payment_type: Straddle::PaymentType::TaggedSymbol,
+            reason: Straddle::FundingEventPaymentReason::TaggedSymbol,
+            status: Straddle::PaymentStatus::TaggedSymbol,
+            trace_ids: T::Hash[Symbol, String],
+            customer_details: Straddle::CustomerDetails,
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            paykey_details: Straddle::PaykeyDetails
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/funding_event_payment_list.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class FundingEventPaymentList < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::FundingEventPaymentList, Straddle::Internal::AnyHash)
+        end
+
+      # Funding-event payments returned for this page.
+      sig { returns(T::Array[Straddle::FundingEventPayment]) }
+      attr_accessor :data
+
+      # Metadata for an API request and a page of results.
+      sig { returns(Straddle::PageMetadata) }
+      attr_reader :meta
+
+      sig { params(meta: Straddle::PageMetadata::OrHash).void }
+      attr_writer :meta
+
+      # Shape of the response envelope.
+      #
+      # - `object` means `data` contains one JSON object.
+      # - `array` means `data` contains an array of JSON objects.
+      # - `error` means `error` contains the error details.
+      # - `none` means the response contains no data.
+      sig { returns(Straddle::ResponseType::TaggedSymbol) }
+      attr_accessor :response_type
+
+      sig do
+        params(
+          data: T::Array[Straddle::FundingEventPayment::OrHash],
+          meta: Straddle::PageMetadata::OrHash,
+          response_type: Straddle::ResponseType::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Funding-event payments returned for this page.
+        data:,
+        # Metadata for an API request and a page of results.
+        meta:,
+        # Shape of the response envelope.
+        #
+        # - `object` means `data` contains one JSON object.
+        # - `array` means `data` contains an array of JSON objects.
+        # - `error` means `error` contains the error details.
+        # - `none` means the response contains no data.
+        response_type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T::Array[Straddle::FundingEventPayment],
+            meta: Straddle::PageMetadata,
+            response_type: Straddle::ResponseType::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/funding_event_payment_reason.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Straddle
+  module Models
+    # Reason the payment was included in the funding event.
+    module FundingEventPaymentReason
+      extend Straddle::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, Straddle::FundingEventPaymentReason) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      CREDIT = T.let(:credit, Straddle::FundingEventPaymentReason::TaggedSymbol)
+      DEBIT = T.let(:debit, Straddle::FundingEventPaymentReason::TaggedSymbol)
+      REVERSAL =
+        T.let(:reversal, Straddle::FundingEventPaymentReason::TaggedSymbol)
+      FAILED = T.let(:failed, Straddle::FundingEventPaymentReason::TaggedSymbol)
+
+      sig do
+        override.returns(
+          T::Array[Straddle::FundingEventPaymentReason::TaggedSymbol]
+        )
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/straddle/models/funding_event_response.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class FundingEventResponse < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::FundingEventResponse, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(Straddle::FundingEvent) }
+      attr_reader :data
+
+      sig { params(data: Straddle::FundingEvent::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
+
+      # Shape of the response envelope.
+      #
+      # - `object` means `data` contains one JSON object.
+      # - `array` means `data` contains an array of JSON objects.
+      # - `error` means `error` contains the error details.
+      # - `none` means the response contains no data.
+      sig { returns(Straddle::ResponseType::TaggedSymbol) }
+      attr_accessor :response_type
+
+      sig do
+        params(
+          data: Straddle::FundingEvent::OrHash,
+          meta: Straddle::ResponseMetadata::OrHash,
+          response_type: Straddle::ResponseType::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        data:,
+        # Metadata for an API request.
+        meta:,
+        # Shape of the response envelope.
+        #
+        # - `object` means `data` contains one JSON object.
+        # - `array` means `data` contains an array of JSON objects.
+        # - `error` means `error` contains the error details.
+        # - `none` means the response contains no data.
+        response_type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: Straddle::FundingEvent,
+            meta: Straddle::ResponseMetadata,
+            response_type: Straddle::ResponseType::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/funding_event_retrieve_params.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class FundingEventRetrieveParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::FundingEventRetrieveParams,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :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
+
+      # For platform requests, the embedded account UUID that sets the request scope.
+      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(
+          id: String,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        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,
+        # For platform requests, the embedded account UUID that sets the request scope.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            correlation_id: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end