straddle 0.4.0 → 1.0.0

data/rbi/straddle/models/capability_request_list_params.rbi

@@ -0,0 +1,332 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class CapabilityRequestListParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::CapabilityRequestListParams,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      # Capability category to return.
+      sig do
+        returns(
+          T.nilable(Straddle::CapabilityRequestListParams::Category::OrSymbol)
+        )
+      end
+      attr_reader :category
+
+      sig do
+        params(
+          category: Straddle::CapabilityRequestListParams::Category::OrSymbol
+        ).void
+      end
+      attr_writer :category
+
+      # 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::CapabilityRequestListParams::SortOrder::OrSymbol)
+        )
+      end
+      attr_reader :sort_order
+
+      sig do
+        params(
+          sort_order: Straddle::CapabilityRequestListParams::SortOrder::OrSymbol
+        ).void
+      end
+      attr_writer :sort_order
+
+      # Capability request status to return.
+      sig do
+        returns(
+          T.nilable(Straddle::CapabilityRequestListParams::Status::OrSymbol)
+        )
+      end
+      attr_reader :status
+
+      sig do
+        params(
+          status: Straddle::CapabilityRequestListParams::Status::OrSymbol
+        ).void
+      end
+      attr_writer :status
+
+      # Capability type to return.
+      sig do
+        returns(
+          T.nilable(Straddle::CapabilityRequestListParams::Type::OrSymbol)
+        )
+      end
+      attr_reader :type
+
+      sig do
+        params(type: Straddle::CapabilityRequestListParams::Type::OrSymbol).void
+      end
+      attr_writer :type
+
+      # 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(
+          account_id: String,
+          category: Straddle::CapabilityRequestListParams::Category::OrSymbol,
+          page_number: Integer,
+          page_size: Integer,
+          sort_by: String,
+          sort_order:
+            Straddle::CapabilityRequestListParams::SortOrder::OrSymbol,
+          status: Straddle::CapabilityRequestListParams::Status::OrSymbol,
+          type: Straddle::CapabilityRequestListParams::Type::OrSymbol,
+          correlation_id: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        account_id:,
+        # Capability category to return.
+        category: 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,
+        # Capability request status to return.
+        status: nil,
+        # Capability type to return.
+        type: 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(
+          {
+            account_id: String,
+            category: Straddle::CapabilityRequestListParams::Category::OrSymbol,
+            page_number: Integer,
+            page_size: Integer,
+            sort_by: String,
+            sort_order:
+              Straddle::CapabilityRequestListParams::SortOrder::OrSymbol,
+            status: Straddle::CapabilityRequestListParams::Status::OrSymbol,
+            type: Straddle::CapabilityRequestListParams::Type::OrSymbol,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Category
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::CapabilityRequestListParams::Category)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PAYMENT_TYPE =
+          T.let(
+            :payment_type,
+            Straddle::CapabilityRequestListParams::Category::TaggedSymbol
+          )
+        CUSTOMER_TYPE =
+          T.let(
+            :customer_type,
+            Straddle::CapabilityRequestListParams::Category::TaggedSymbol
+          )
+        CONSENT_TYPE =
+          T.let(
+            :consent_type,
+            Straddle::CapabilityRequestListParams::Category::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Straddle::CapabilityRequestListParams::Category::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module SortOrder
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::CapabilityRequestListParams::SortOrder)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ASC =
+          T.let(
+            :asc,
+            Straddle::CapabilityRequestListParams::SortOrder::TaggedSymbol
+          )
+        DESC =
+          T.let(
+            :desc,
+            Straddle::CapabilityRequestListParams::SortOrder::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Straddle::CapabilityRequestListParams::SortOrder::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Status
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::CapabilityRequestListParams::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(
+            :active,
+            Straddle::CapabilityRequestListParams::Status::TaggedSymbol
+          )
+        INACTIVE =
+          T.let(
+            :inactive,
+            Straddle::CapabilityRequestListParams::Status::TaggedSymbol
+          )
+        IN_REVIEW =
+          T.let(
+            :in_review,
+            Straddle::CapabilityRequestListParams::Status::TaggedSymbol
+          )
+        REJECTED =
+          T.let(
+            :rejected,
+            Straddle::CapabilityRequestListParams::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Straddle::CapabilityRequestListParams::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Type
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::CapabilityRequestListParams::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CHARGES =
+          T.let(
+            :charges,
+            Straddle::CapabilityRequestListParams::Type::TaggedSymbol
+          )
+        PAYOUTS =
+          T.let(
+            :payouts,
+            Straddle::CapabilityRequestListParams::Type::TaggedSymbol
+          )
+        INDIVIDUALS =
+          T.let(
+            :individuals,
+            Straddle::CapabilityRequestListParams::Type::TaggedSymbol
+          )
+        BUSINESSES =
+          T.let(
+            :businesses,
+            Straddle::CapabilityRequestListParams::Type::TaggedSymbol
+          )
+        SIGNED_AGREEMENT =
+          T.let(
+            :signed_agreement,
+            Straddle::CapabilityRequestListParams::Type::TaggedSymbol
+          )
+        INTERNET =
+          T.let(
+            :internet,
+            Straddle::CapabilityRequestListParams::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Straddle::CapabilityRequestListParams::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/charge.rbi

@@ -0,0 +1,279 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class Charge < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Straddle::Charge, Straddle::Internal::AnyHash) }
+
+      # Unique identifier for this charge.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Amount in cents.
+      sig { returns(Integer) }
+      attr_accessor :amount
+
+      # Configuration options for the charge.
+      sig { returns(Straddle::ChargeConfiguration) }
+      attr_reader :config
+
+      sig { params(config: Straddle::ChargeConfiguration::OrHash).void }
+      attr_writer :config
+
+      # How the customer authorized the charge. `internet` covers online and mobile
+      # authorization. `signed` covers written or PDF-signed agreements.
+      sig { returns(Straddle::ConsentType::TaggedSymbol) }
+      attr_accessor :consent_type
+
+      # Timestamp when this charge was created.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :created_at
+
+      # Currency code. Only `USD` is supported.
+      sig { returns(String) }
+      attr_accessor :currency
+
+      # A human-readable description of the charge.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Device used when the customer authorized the charge.
+      sig { returns(Straddle::MaskedPaymentDevice) }
+      attr_reader :device
+
+      sig { params(device: Straddle::MaskedPaymentDevice::OrHash).void }
+      attr_writer :device
+
+      # Your unique identifier for this charge, used to correlate with your internal
+      # records.
+      sig { returns(String) }
+      attr_accessor :external_id
+
+      # IDs of the funding events that included this charge.
+      sig { returns(T::Array[String]) }
+      attr_accessor :funding_ids
+
+      # Whether an associated payout has refunded this charge.
+      sig { returns(T::Boolean) }
+      attr_accessor :has_refund
+
+      # Whether this charge has been resubmitted.
+      sig { returns(T::Boolean) }
+      attr_accessor :has_resubmit
+
+      # Whether this charge resubmits an original charge.
+      sig { returns(T::Boolean) }
+      attr_accessor :is_resubmit
+
+      # The masked paykey token used for this charge.
+      sig { returns(String) }
+      attr_accessor :paykey
+
+      # Date when Straddle submits the charge for processing.
+      sig { returns(Date) }
+      attr_accessor :payment_date
+
+      # The current status of the charge.
+      sig { returns(Straddle::PaymentStatus::TaggedSymbol) }
+      attr_accessor :status
+
+      # Reason, source, and message for the most recent charge status change.
+      sig { returns(Straddle::PaymentStatusDetails) }
+      attr_reader :status_details
+
+      sig do
+        params(status_details: Straddle::PaymentStatusDetails::OrHash).void
+      end
+      attr_writer :status_details
+
+      # Complete ordered history of all status changes for this charge.
+      sig { returns(T::Array[Straddle::PaymentStatusHistory]) }
+      attr_accessor :status_history
+
+      # Trace identifiers from the payment network. Keys depend on the payment rail.
+      sig { returns(T::Hash[Symbol, String]) }
+      attr_accessor :trace_ids
+
+      # Timestamp when this charge was last updated.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :updated_at
+
+      # Information about the customer associated with the charge.
+      sig { returns(T.nilable(Straddle::CustomerDetails)) }
+      attr_reader :customer_details
+
+      sig { params(customer_details: Straddle::CustomerDetails::OrHash).void }
+      attr_writer :customer_details
+
+      # Authorization documents for this charge, ordered by upload time.
+      sig { returns(T.nilable(T::Array[Straddle::PaymentAuthorizationProof])) }
+      attr_accessor :documents
+
+      # Timestamp when funds were settled. Null until settlement is confirmed.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :effective_at
+
+      # Key-value metadata stored with this charge.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :metadata
+
+      # Information about the paykey used for the charge.
+      sig { returns(T.nilable(Straddle::PaykeyDetails)) }
+      attr_reader :paykey_details
+
+      sig { params(paykey_details: Straddle::PaykeyDetails::OrHash).void }
+      attr_writer :paykey_details
+
+      # Payment rail used to process the charge.
+      sig { returns(T.nilable(Straddle::PaymentRail::TaggedSymbol)) }
+      attr_reader :payment_rail
+
+      sig { params(payment_rail: Straddle::PaymentRail::OrSymbol).void }
+      attr_writer :payment_rail
+
+      # Timestamp when this charge was submitted to the payment network. Null until
+      # processed.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :processed_at
+
+      # Related payments and their relationship to this charge.
+      sig { returns(T.nilable(T::Array[Straddle::RelatedPayment])) }
+      attr_accessor :related_payments
+
+      sig do
+        params(
+          id: String,
+          amount: Integer,
+          config: Straddle::ChargeConfiguration::OrHash,
+          consent_type: Straddle::ConsentType::OrSymbol,
+          created_at: T.nilable(Time),
+          currency: String,
+          description: T.nilable(String),
+          device: Straddle::MaskedPaymentDevice::OrHash,
+          external_id: String,
+          funding_ids: T::Array[String],
+          has_refund: T::Boolean,
+          has_resubmit: T::Boolean,
+          is_resubmit: T::Boolean,
+          paykey: String,
+          payment_date: Date,
+          status: Straddle::PaymentStatus::OrSymbol,
+          status_details: Straddle::PaymentStatusDetails::OrHash,
+          status_history: T::Array[Straddle::PaymentStatusHistory::OrHash],
+          trace_ids: T::Hash[Symbol, String],
+          updated_at: T.nilable(Time),
+          customer_details: Straddle::CustomerDetails::OrHash,
+          documents:
+            T.nilable(T::Array[Straddle::PaymentAuthorizationProof::OrHash]),
+          effective_at: T.nilable(Time),
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          paykey_details: Straddle::PaykeyDetails::OrHash,
+          payment_rail: Straddle::PaymentRail::OrSymbol,
+          processed_at: T.nilable(Time),
+          related_payments:
+            T.nilable(T::Array[Straddle::RelatedPayment::OrHash])
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for this charge.
+        id:,
+        # Amount in cents.
+        amount:,
+        # Configuration options for the charge.
+        config:,
+        # How the customer authorized the charge. `internet` covers online and mobile
+        # authorization. `signed` covers written or PDF-signed agreements.
+        consent_type:,
+        # Timestamp when this charge was created.
+        created_at:,
+        # Currency code. Only `USD` is supported.
+        currency:,
+        # A human-readable description of the charge.
+        description:,
+        # Device used when the customer authorized the charge.
+        device:,
+        # Your unique identifier for this charge, used to correlate with your internal
+        # records.
+        external_id:,
+        # IDs of the funding events that included this charge.
+        funding_ids:,
+        # Whether an associated payout has refunded this charge.
+        has_refund:,
+        # Whether this charge has been resubmitted.
+        has_resubmit:,
+        # Whether this charge resubmits an original charge.
+        is_resubmit:,
+        # The masked paykey token used for this charge.
+        paykey:,
+        # Date when Straddle submits the charge for processing.
+        payment_date:,
+        # The current status of the charge.
+        status:,
+        # Reason, source, and message for the most recent charge status change.
+        status_details:,
+        # Complete ordered history of all status changes for this charge.
+        status_history:,
+        # Trace identifiers from the payment network. Keys depend on the payment rail.
+        trace_ids:,
+        # Timestamp when this charge was last updated.
+        updated_at:,
+        # Information about the customer associated with the charge.
+        customer_details: nil,
+        # Authorization documents for this charge, ordered by upload time.
+        documents: nil,
+        # Timestamp when funds were settled. Null until settlement is confirmed.
+        effective_at: nil,
+        # Key-value metadata stored with this charge.
+        metadata: nil,
+        # Information about the paykey used for the charge.
+        paykey_details: nil,
+        # Payment rail used to process the charge.
+        payment_rail: nil,
+        # Timestamp when this charge was submitted to the payment network. Null until
+        # processed.
+        processed_at: nil,
+        # Related payments and their relationship to this charge.
+        related_payments: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            amount: Integer,
+            config: Straddle::ChargeConfiguration,
+            consent_type: Straddle::ConsentType::TaggedSymbol,
+            created_at: T.nilable(Time),
+            currency: String,
+            description: T.nilable(String),
+            device: Straddle::MaskedPaymentDevice,
+            external_id: String,
+            funding_ids: T::Array[String],
+            has_refund: T::Boolean,
+            has_resubmit: T::Boolean,
+            is_resubmit: T::Boolean,
+            paykey: String,
+            payment_date: Date,
+            status: Straddle::PaymentStatus::TaggedSymbol,
+            status_details: Straddle::PaymentStatusDetails,
+            status_history: T::Array[Straddle::PaymentStatusHistory],
+            trace_ids: T::Hash[Symbol, String],
+            updated_at: T.nilable(Time),
+            customer_details: Straddle::CustomerDetails,
+            documents: T.nilable(T::Array[Straddle::PaymentAuthorizationProof]),
+            effective_at: T.nilable(Time),
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            paykey_details: Straddle::PaykeyDetails,
+            payment_rail: Straddle::PaymentRail::TaggedSymbol,
+            processed_at: T.nilable(Time),
+            related_payments: T.nilable(T::Array[Straddle::RelatedPayment])
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/charge_cancel_params.rbi

@@ -14,28 +14,32 @@ module Straddle
       sig { returns(String) }
       attr_accessor :id
 
-      # Details about why the charge status was updated.
+      # Message explaining the charge status change.
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
 
+      # 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 key for an idempotent request.
       sig { returns(T.nilable(String)) }
       attr_reader :idempotency_key
 
       sig { params(idempotency_key: String).void }
       attr_writer :idempotency_key
 
+      # 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
 
@@ -55,11 +59,15 @@ module Straddle
       end
       def self.new(
         id:,
-        # Details about why the charge status was updated.
+        # Message explaining the charge status change.
         reason: nil,
+        # Optional client-generated identifier for tracing a series of related requests.
         correlation_id: nil,
+        # Optional client-generated key for an idempotent request.
         idempotency_key: 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: {}
       )