straddle 0.5.0 → 1.0.0

data/rbi/straddle/models/payout.rbi

@@ -0,0 +1,269 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class Payout < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Straddle::Payout, Straddle::Internal::AnyHash) }
+
+      # Unique identifier for this payout.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Amount in cents.
+      sig { returns(Integer) }
+      attr_accessor :amount
+
+      # Configuration for the payout.
+      sig { returns(Straddle::PayoutConfiguration) }
+      attr_reader :config
+
+      sig { params(config: Straddle::PayoutConfiguration::OrHash).void }
+      attr_writer :config
+
+      # Currency code. Only `USD` is supported.
+      sig { returns(String) }
+      attr_accessor :currency
+
+      # A human-readable description of the payout.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Device used when the customer authorized the payout.
+      sig { returns(Straddle::MaskedPaymentDevice) }
+      attr_reader :device
+
+      sig { params(device: Straddle::MaskedPaymentDevice::OrHash).void }
+      attr_writer :device
+
+      # Your unique identifier for this payout, used to correlate with your internal
+      # records.
+      sig { returns(String) }
+      attr_accessor :external_id
+
+      # IDs of the funding events that included this payout.
+      sig { returns(T::Array[String]) }
+      attr_accessor :funding_ids
+
+      # Whether this payout has been resubmitted.
+      sig { returns(T::Boolean) }
+      attr_accessor :has_resubmit
+
+      # Whether this payout refunds an original charge.
+      sig { returns(T::Boolean) }
+      attr_accessor :is_refund
+
+      # Whether this payout resubmits an original payout.
+      sig { returns(T::Boolean) }
+      attr_accessor :is_resubmit
+
+      # The masked paykey token used for this payout.
+      sig { returns(String) }
+      attr_accessor :paykey
+
+      # Date when Straddle submits the payout for processing.
+      sig { returns(Date) }
+      attr_accessor :payment_date
+
+      # The current status of the payout.
+      sig { returns(Straddle::PaymentStatus::TaggedSymbol) }
+      attr_accessor :status
+
+      # Reason, source, and message for the most recent payout 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 payout.
+      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 payout was created.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :created_at
+
+      # Information about the customer associated with the payout.
+      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 payout, 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 payout.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :metadata
+
+      # Information about the paykey used for the payout.
+      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 payout.
+      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 payout 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 payout.
+      sig { returns(T.nilable(T::Array[Straddle::RelatedPayment])) }
+      attr_accessor :related_payments
+
+      # Timestamp when this payout was last updated.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :updated_at
+
+      sig do
+        params(
+          id: String,
+          amount: Integer,
+          config: Straddle::PayoutConfiguration::OrHash,
+          currency: String,
+          description: T.nilable(String),
+          device: Straddle::MaskedPaymentDevice::OrHash,
+          external_id: String,
+          funding_ids: T::Array[String],
+          has_resubmit: T::Boolean,
+          is_refund: 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],
+          created_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]),
+          updated_at: T.nilable(Time)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for this payout.
+        id:,
+        # Amount in cents.
+        amount:,
+        # Configuration for the payout.
+        config:,
+        # Currency code. Only `USD` is supported.
+        currency:,
+        # A human-readable description of the payout.
+        description:,
+        # Device used when the customer authorized the payout.
+        device:,
+        # Your unique identifier for this payout, used to correlate with your internal
+        # records.
+        external_id:,
+        # IDs of the funding events that included this payout.
+        funding_ids:,
+        # Whether this payout has been resubmitted.
+        has_resubmit:,
+        # Whether this payout refunds an original charge.
+        is_refund:,
+        # Whether this payout resubmits an original payout.
+        is_resubmit:,
+        # The masked paykey token used for this payout.
+        paykey:,
+        # Date when Straddle submits the payout for processing.
+        payment_date:,
+        # The current status of the payout.
+        status:,
+        # Reason, source, and message for the most recent payout status change.
+        status_details:,
+        # Complete ordered history of all status changes for this payout.
+        status_history:,
+        # Trace identifiers from the payment network. Keys depend on the payment rail.
+        trace_ids:,
+        # Timestamp when this payout was created.
+        created_at: nil,
+        # Information about the customer associated with the payout.
+        customer_details: nil,
+        # Authorization documents for this payout, 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 payout.
+        metadata: nil,
+        # Information about the paykey used for the payout.
+        paykey_details: nil,
+        # Payment rail used to process the payout.
+        payment_rail: nil,
+        # Timestamp when this payout was submitted to the payment network. Null until
+        # processed.
+        processed_at: nil,
+        # Related payments and their relationship to this payout.
+        related_payments: nil,
+        # Timestamp when this payout was last updated.
+        updated_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            amount: Integer,
+            config: Straddle::PayoutConfiguration,
+            currency: String,
+            description: T.nilable(String),
+            device: Straddle::MaskedPaymentDevice,
+            external_id: String,
+            funding_ids: T::Array[String],
+            has_resubmit: T::Boolean,
+            is_refund: 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],
+            created_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]),
+            updated_at: T.nilable(Time)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/payout_cancel_params.rbi

@@ -14,28 +14,32 @@ module Straddle
       sig { returns(String) }
       attr_accessor :id
 
-      # Details about why the payout status was updated.
-      sig { returns(String) }
+      # Message explaining the payout 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
 
@@ -45,7 +49,7 @@ module Straddle
       sig do
         params(
           id: String,
-          reason: String,
+          reason: T.nilable(String),
           correlation_id: String,
           idempotency_key: String,
           request_id: String,
@@ -55,11 +59,15 @@ module Straddle
       end
       def self.new(
         id:,
-        # Details about why the payout status was updated.
-        reason:,
+        # Message explaining the payout 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: {}
       )
@@ -69,7 +77,7 @@ module Straddle
         override.returns(
           {
             id: String,
-            reason: String,
+            reason: T.nilable(String),
             correlation_id: String,
             idempotency_key: String,
             request_id: String,

data/rbi/straddle/models/payout_configuration.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class PayoutConfiguration < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::PayoutConfiguration, Straddle::Internal::AnyHash)
+        end
+
+      # Whether to place the payout on hold automatically after creation.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :auto_hold
+
+      # Reason for placing the payout on hold automatically.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :auto_hold_message
+
+      # Payment will simulate processing if not Standard.
+      sig { returns(T.nilable(Straddle::SimulatedPaymentOutcome::OrSymbol)) }
+      attr_reader :sandbox_outcome
+
+      sig do
+        params(
+          sandbox_outcome: Straddle::SimulatedPaymentOutcome::OrSymbol
+        ).void
+      end
+      attr_writer :sandbox_outcome
+
+      sig do
+        params(
+          auto_hold: T.nilable(T::Boolean),
+          auto_hold_message: T.nilable(String),
+          sandbox_outcome: Straddle::SimulatedPaymentOutcome::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Whether to place the payout on hold automatically after creation.
+        auto_hold: nil,
+        # Reason for placing the payout on hold automatically.
+        auto_hold_message: nil,
+        # Payment will simulate processing if not Standard.
+        sandbox_outcome: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            auto_hold: T.nilable(T::Boolean),
+            auto_hold_message: T.nilable(String),
+            sandbox_outcome: Straddle::SimulatedPaymentOutcome::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end