straddle 0.5.0 → 1.0.0

data/rbi/straddle/models/customers/review_list_params.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Customers
+      class ReviewListParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Customers::ReviewListParams,
+              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
+end

data/rbi/straddle/models/customers/review_set_verification_decision_params.rbi

@@ -0,0 +1,139 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Customers
+      class ReviewSetVerificationDecisionParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Customers::ReviewSetVerificationDecisionParams,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The final status of the customer review.
+        sig do
+          returns(
+            Straddle::Customers::ReviewSetVerificationDecisionParams::Status::OrSymbol
+          )
+        end
+        attr_accessor :status
+
+        # 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
+
+        sig { params(straddle_account_id: String).void }
+        attr_writer :straddle_account_id
+
+        sig do
+          params(
+            id: String,
+            status:
+              Straddle::Customers::ReviewSetVerificationDecisionParams::Status::OrSymbol,
+            correlation_id: String,
+            idempotency_key: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # The final status of the customer review.
+          status:,
+          # 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: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              status:
+                Straddle::Customers::ReviewSetVerificationDecisionParams::Status::OrSymbol,
+              correlation_id: String,
+              idempotency_key: String,
+              request_id: String,
+              straddle_account_id: String,
+              request_options: Straddle::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The final status of the customer review.
+        module Status
+          extend Straddle::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Straddle::Customers::ReviewSetVerificationDecisionParams::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          VERIFIED =
+            T.let(
+              :verified,
+              Straddle::Customers::ReviewSetVerificationDecisionParams::Status::TaggedSymbol
+            )
+          REJECTED =
+            T.let(
+              :rejected,
+              Straddle::Customers::ReviewSetVerificationDecisionParams::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Straddle::Customers::ReviewSetVerificationDecisionParams::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/customers/verification_decision.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Customers
+      module VerificationDecision
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::Customers::VerificationDecision)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACCEPT =
+          T.let(
+            :accept,
+            Straddle::Customers::VerificationDecision::TaggedSymbol
+          )
+        REJECT =
+          T.let(
+            :reject,
+            Straddle::Customers::VerificationDecision::TaggedSymbol
+          )
+        REVIEW =
+          T.let(
+            :review,
+            Straddle::Customers::VerificationDecision::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Straddle::Customers::VerificationDecision::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/funding_event.rbi

@@ -0,0 +1,182 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class FundingEvent < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::FundingEvent, Straddle::Internal::AnyHash)
+        end
+
+      # Unique identifier for this funding event.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Total funding event amount in the smallest currency unit. For example, `1000` is
+      # $10.00 USD.
+      sig { returns(Integer) }
+      attr_accessor :amount
+
+      # Timestamp when this funding event was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Transfer direction relative to the linked bank account. `deposit` moves funds
+      # into the account, and `withdrawal` moves funds out.
+      sig { returns(Straddle::FundingEventTransferDirection::TaggedSymbol) }
+      attr_accessor :direction
+
+      # Reason for the funding event. `charge_deposit` settles collected charges to the
+      # linked bank account. `charge_reversal` withdraws funds for reversed charges.
+      # `payout_withdrawal` withdraws funds for payouts. `payout_return` deposits
+      # returned payout funds.
+      sig { returns(Straddle::FundingEventType::TaggedSymbol) }
+      attr_accessor :event_type
+
+      # Number of payments included in this funding event.
+      sig { returns(Integer) }
+      attr_accessor :payment_count
+
+      # Complete ordered history of all status changes for this funding event.
+      sig { returns(T::Array[Straddle::PaymentStatusHistory]) }
+      attr_accessor :status_history
+
+      # Network-level trace identifiers assigned during processing. Keys vary by payment
+      # rail.
+      sig { returns(T::Hash[Symbol, String]) }
+      attr_accessor :trace_ids
+
+      # Network trace numbers associated with payments in this funding event.
+      sig { returns(T::Array[String]) }
+      attr_accessor :trace_numbers
+
+      # The date the funds transfer was initiated.
+      sig { returns(Date) }
+      attr_accessor :transfer_date
+
+      # Timestamp when this funding event was last updated.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # Configuration used to process this funding event.
+      sig { returns(T.nilable(Straddle::FundingEventConfiguration)) }
+      attr_reader :config
+
+      sig { params(config: Straddle::FundingEventConfiguration::OrHash).void }
+      attr_writer :config
+
+      # Details of the linked bank account used for this funding event.
+      sig { returns(T.nilable(Straddle::UnmaskedLinkedBankAccountDetails)) }
+      attr_reader :linked_bank_account_details
+
+      sig do
+        params(
+          linked_bank_account_details:
+            Straddle::UnmaskedLinkedBankAccountDetails::OrHash
+        ).void
+      end
+      attr_writer :linked_bank_account_details
+
+      # Current status of this funding event.
+      sig { returns(T.nilable(Straddle::PaymentStatus::TaggedSymbol)) }
+      attr_reader :status
+
+      sig { params(status: Straddle::PaymentStatus::OrSymbol).void }
+      attr_writer :status
+
+      # Reason, source, and message for the most recent status change.
+      sig { returns(T.nilable(Straddle::PaymentStatusDetails)) }
+      attr_reader :status_details
+
+      sig do
+        params(status_details: Straddle::PaymentStatusDetails::OrHash).void
+      end
+      attr_writer :status_details
+
+      sig do
+        params(
+          id: String,
+          amount: Integer,
+          created_at: Time,
+          direction: Straddle::FundingEventTransferDirection::OrSymbol,
+          event_type: Straddle::FundingEventType::OrSymbol,
+          payment_count: Integer,
+          status_history: T::Array[Straddle::PaymentStatusHistory::OrHash],
+          trace_ids: T::Hash[Symbol, String],
+          trace_numbers: T::Array[String],
+          transfer_date: Date,
+          updated_at: Time,
+          config: Straddle::FundingEventConfiguration::OrHash,
+          linked_bank_account_details:
+            Straddle::UnmaskedLinkedBankAccountDetails::OrHash,
+          status: Straddle::PaymentStatus::OrSymbol,
+          status_details: Straddle::PaymentStatusDetails::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for this funding event.
+        id:,
+        # Total funding event amount in the smallest currency unit. For example, `1000` is
+        # $10.00 USD.
+        amount:,
+        # Timestamp when this funding event was created.
+        created_at:,
+        # Transfer direction relative to the linked bank account. `deposit` moves funds
+        # into the account, and `withdrawal` moves funds out.
+        direction:,
+        # Reason for the funding event. `charge_deposit` settles collected charges to the
+        # linked bank account. `charge_reversal` withdraws funds for reversed charges.
+        # `payout_withdrawal` withdraws funds for payouts. `payout_return` deposits
+        # returned payout funds.
+        event_type:,
+        # Number of payments included in this funding event.
+        payment_count:,
+        # Complete ordered history of all status changes for this funding event.
+        status_history:,
+        # Network-level trace identifiers assigned during processing. Keys vary by payment
+        # rail.
+        trace_ids:,
+        # Network trace numbers associated with payments in this funding event.
+        trace_numbers:,
+        # The date the funds transfer was initiated.
+        transfer_date:,
+        # Timestamp when this funding event was last updated.
+        updated_at:,
+        # Configuration used to process this funding event.
+        config: nil,
+        # Details of the linked bank account used for this funding event.
+        linked_bank_account_details: nil,
+        # Current status of this funding event.
+        status: nil,
+        # Reason, source, and message for the most recent status change.
+        status_details: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            amount: Integer,
+            created_at: Time,
+            direction: Straddle::FundingEventTransferDirection::TaggedSymbol,
+            event_type: Straddle::FundingEventType::TaggedSymbol,
+            payment_count: Integer,
+            status_history: T::Array[Straddle::PaymentStatusHistory],
+            trace_ids: T::Hash[Symbol, String],
+            trace_numbers: T::Array[String],
+            transfer_date: Date,
+            updated_at: Time,
+            config: Straddle::FundingEventConfiguration,
+            linked_bank_account_details:
+              Straddle::UnmaskedLinkedBankAccountDetails,
+            status: Straddle::PaymentStatus::TaggedSymbol,
+            status_details: Straddle::PaymentStatusDetails
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/funding_event_configuration.rbi

@@ -0,0 +1,47 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class FundingEventConfiguration < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::FundingEventConfiguration,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      # Processing outcome configured for this simulated funding event.
+      sig do
+        returns(T.nilable(Straddle::SimulatedPaymentOutcome::TaggedSymbol))
+      end
+      attr_reader :sandbox_outcome
+
+      sig do
+        params(
+          sandbox_outcome: Straddle::SimulatedPaymentOutcome::OrSymbol
+        ).void
+      end
+      attr_writer :sandbox_outcome
+
+      sig do
+        params(
+          sandbox_outcome: Straddle::SimulatedPaymentOutcome::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Processing outcome configured for this simulated funding event.
+        sandbox_outcome: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          { sandbox_outcome: Straddle::SimulatedPaymentOutcome::TaggedSymbol }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end