straddle 0.3.0 → 0.5.0

data/rbi/straddle/models/payment_list_params.rbi

@@ -66,6 +66,42 @@ module Straddle
       sig { params(funding_id: String).void }
       attr_writer :funding_id
 
+      # Has the payment been refunded by an associated payout (only applicable to
+      # charges).
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :has_refund
+
+      sig { params(has_refund: T::Boolean).void }
+      attr_writer :has_refund
+
+      # Has the payment been resubmitted.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :has_resubmit
+
+      sig { params(has_resubmit: T::Boolean).void }
+      attr_writer :has_resubmit
+
+      # Include the metadata for payments in the returned data.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :include_metadata
+
+      sig { params(include_metadata: T::Boolean).void }
+      attr_writer :include_metadata
+
+      # Is the payment a refund of an original charge (only applicable to payouts).
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :is_refund
+
+      sig { params(is_refund: T::Boolean).void }
+      attr_writer :is_refund
+
+      # Is the payment a resubmit of an original payment.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :is_resubmit
+
+      sig { params(is_resubmit: T::Boolean).void }
+      attr_writer :is_resubmit
+
       # Search using a maximum `amount` of a `charge` or `payout`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :max_amount
@@ -94,6 +130,13 @@ module Straddle
       sig { params(max_payment_date: Date).void }
       attr_writer :max_payment_date
 
+      # Filter to payments last updated on or before this timestamp.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :max_updated_at
+
+      sig { params(max_updated_at: Time).void }
+      attr_writer :max_updated_at
+
       # Search using the minimum `amount of a `charge`or`payout`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :min_amount
@@ -122,6 +165,13 @@ module Straddle
       sig { params(min_payment_date: Date).void }
       attr_writer :min_payment_date
 
+      # Filter to payments last updated on or after this timestamp.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :min_updated_at
+
+      sig { params(min_updated_at: Time).void }
+      attr_writer :min_updated_at
+
       # Results page number. Starts at page 1.
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_number
@@ -284,14 +334,21 @@ module Straddle
             Straddle::PaymentListParams::DefaultSortOrder::OrSymbol,
           external_id: String,
           funding_id: String,
+          has_refund: T::Boolean,
+          has_resubmit: T::Boolean,
+          include_metadata: T::Boolean,
+          is_refund: T::Boolean,
+          is_resubmit: T::Boolean,
           max_amount: Integer,
           max_created_at: Time,
           max_effective_at: Time,
           max_payment_date: Date,
+          max_updated_at: Time,
           min_amount: Integer,
           min_created_at: Time,
           min_effective_at: Time,
           min_payment_date: Date,
+          min_updated_at: Time,
           page_number: Integer,
           page_size: Integer,
           paykey: String,
@@ -325,6 +382,17 @@ module Straddle
         external_id: nil,
         # Search using the `funding_id` of a `charge` or `payout`.
         funding_id: nil,
+        # Has the payment been refunded by an associated payout (only applicable to
+        # charges).
+        has_refund: nil,
+        # Has the payment been resubmitted.
+        has_resubmit: nil,
+        # Include the metadata for payments in the returned data.
+        include_metadata: nil,
+        # Is the payment a refund of an original charge (only applicable to payouts).
+        is_refund: nil,
+        # Is the payment a resubmit of an original payment.
+        is_resubmit: nil,
         # Search using a maximum `amount` of a `charge` or `payout`.
         max_amount: nil,
         # Search using the latest `created_at` date of a `charge` or `payout`.
@@ -333,6 +401,8 @@ module Straddle
         max_effective_at: nil,
         # Search using the latest `payment_date` of a `charge` or `payout`.
         max_payment_date: nil,
+        # Filter to payments last updated on or before this timestamp.
+        max_updated_at: nil,
         # Search using the minimum `amount of a `charge`or`payout`.
         min_amount: nil,
         # Search using the earliest `created_at` date of a `charge` or `payout`.
@@ -341,6 +411,8 @@ module Straddle
         min_effective_at: nil,
         # Search using the earliest ` `of a `charge` or `payout`.
         min_payment_date: nil,
+        # Filter to payments last updated on or after this timestamp.
+        min_updated_at: nil,
         # Results page number. Starts at page 1.
         page_number: nil,
         # Results page size. Max value: 1000
@@ -381,14 +453,21 @@ module Straddle
               Straddle::PaymentListParams::DefaultSortOrder::OrSymbol,
             external_id: String,
             funding_id: String,
+            has_refund: T::Boolean,
+            has_resubmit: T::Boolean,
+            include_metadata: T::Boolean,
+            is_refund: T::Boolean,
+            is_resubmit: T::Boolean,
             max_amount: Integer,
             max_created_at: Time,
             max_effective_at: Time,
             max_payment_date: Date,
+            max_updated_at: Time,
             min_amount: Integer,
             min_created_at: Time,
             min_effective_at: Time,
             min_payment_date: Date,
+            min_updated_at: Time,
             page_number: Integer,
             page_size: Integer,
             paykey: String,
@@ -443,6 +522,11 @@ module Straddle
         ID = T.let(:id, Straddle::PaymentListParams::DefaultSort::TaggedSymbol)
         AMOUNT =
           T.let(:amount, Straddle::PaymentListParams::DefaultSort::TaggedSymbol)
+        UPDATED_AT =
+          T.let(
+            :updated_at,
+            Straddle::PaymentListParams::DefaultSort::TaggedSymbol
+          )
 
         sig do
           override.returns(
@@ -531,6 +615,11 @@ module Straddle
             :reversed,
             Straddle::PaymentListParams::PaymentStatus::TaggedSymbol
           )
+        VALIDATING =
+          T.let(
+            :validating,
+            Straddle::PaymentListParams::PaymentStatus::TaggedSymbol
+          )
 
         sig do
           override.returns(
@@ -588,6 +677,8 @@ module Straddle
         ID = T.let(:id, Straddle::PaymentListParams::SortBy::TaggedSymbol)
         AMOUNT =
           T.let(:amount, Straddle::PaymentListParams::SortBy::TaggedSymbol)
+        UPDATED_AT =
+          T.let(:updated_at, Straddle::PaymentListParams::SortBy::TaggedSymbol)
 
         sig do
           override.returns(
@@ -723,6 +814,41 @@ module Straddle
             :payout_refused,
             Straddle::PaymentListParams::StatusReason::TaggedSymbol
           )
+        CANCEL_REQUEST =
+          T.let(
+            :cancel_request,
+            Straddle::PaymentListParams::StatusReason::TaggedSymbol
+          )
+        FAILED_VERIFICATION =
+          T.let(
+            :failed_verification,
+            Straddle::PaymentListParams::StatusReason::TaggedSymbol
+          )
+        REQUIRE_REVIEW =
+          T.let(
+            :require_review,
+            Straddle::PaymentListParams::StatusReason::TaggedSymbol
+          )
+        BLOCKED_BY_SYSTEM =
+          T.let(
+            :blocked_by_system,
+            Straddle::PaymentListParams::StatusReason::TaggedSymbol
+          )
+        WATCHTOWER_REVIEW =
+          T.let(
+            :watchtower_review,
+            Straddle::PaymentListParams::StatusReason::TaggedSymbol
+          )
+        VALIDATING =
+          T.let(
+            :validating,
+            Straddle::PaymentListParams::StatusReason::TaggedSymbol
+          )
+        AUTO_HOLD =
+          T.let(
+            :auto_hold,
+            Straddle::PaymentListParams::StatusReason::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/straddle/models/payment_summary_paged_v1.rbi

@@ -89,7 +89,7 @@ module Straddle
         attr_accessor :currency
 
         # An arbitrary description for the `charge` or `payout`.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :description
 
         # Unique identifier for the `charge` or `payout` in your database. This value must
@@ -101,6 +101,23 @@ module Straddle
         sig { returns(T::Array[String]) }
         attr_accessor :funding_ids
 
+        # Has the payment been refunded by an associated payout (only applicable to
+        # charges).
+        sig { returns(T::Boolean) }
+        attr_accessor :has_refund
+
+        # Has the payment been resubmitted.
+        sig { returns(T::Boolean) }
+        attr_accessor :has_resubmit
+
+        # Is the payment a refund of an original charge (only applicable to payouts).
+        sig { returns(T::Boolean) }
+        attr_accessor :is_refund
+
+        # Is the payment a resubmit of an original payment.
+        sig { returns(T::Boolean) }
+        attr_accessor :is_resubmit
+
         # Value of the `paykey` used for the `charge` or `payout`.
         sig { returns(String) }
         attr_accessor :paykey
@@ -160,6 +177,10 @@ module Straddle
         sig { returns(T.nilable(String)) }
         attr_accessor :funding_id
 
+        # Metadata for payment - only included if requested.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_accessor :metadata
+
         # Information about the paykey used for the `charge` or `payout`.
         sig { returns(T.nilable(Straddle::PaykeyDetailsV1)) }
         attr_reader :paykey_details
@@ -167,15 +188,30 @@ module Straddle
         sig { params(paykey_details: Straddle::PaykeyDetailsV1::OrHash).void }
         attr_writer :paykey_details
 
+        # Payments related to this one (e.g. refunds, resubmissions), mapped by payment ID
+        # to relationship type.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Straddle::PaymentSummaryPagedV1::Data::RelatedPayment]
+            )
+          )
+        end
+        attr_accessor :related_payments
+
         sig do
           params(
             id: String,
             amount: Integer,
             created_at: Time,
             currency: String,
-            description: String,
+            description: T.nilable(String),
             external_id: String,
             funding_ids: T::Array[String],
+            has_refund: T::Boolean,
+            has_resubmit: T::Boolean,
+            is_refund: T::Boolean,
+            is_resubmit: T::Boolean,
             paykey: String,
             payment_date: Date,
             payment_type:
@@ -187,7 +223,14 @@ module Straddle
             customer_details: Straddle::CustomerDetailsV1::OrHash,
             effective_at: T.nilable(Time),
             funding_id: T.nilable(String),
-            paykey_details: Straddle::PaykeyDetailsV1::OrHash
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            paykey_details: Straddle::PaykeyDetailsV1::OrHash,
+            related_payments:
+              T.nilable(
+                T::Array[
+                  Straddle::PaymentSummaryPagedV1::Data::RelatedPayment::OrHash
+                ]
+              )
           ).returns(T.attached_class)
         end
         def self.new(
@@ -206,6 +249,15 @@ module Straddle
           external_id:,
           # Funding ids.
           funding_ids:,
+          # Has the payment been refunded by an associated payout (only applicable to
+          # charges).
+          has_refund:,
+          # Has the payment been resubmitted.
+          has_resubmit:,
+          # Is the payment a refund of an original charge (only applicable to payouts).
+          is_refund:,
+          # Is the payment a resubmit of an original payment.
+          is_resubmit:,
           # Value of the `paykey` used for the `charge` or `payout`.
           paykey:,
           # The desired date on which the payment should be occur. For charges, this means
@@ -231,8 +283,13 @@ module Straddle
           # Unique identifier for the funding event associated with the `charge` or
           # `payout`.
           funding_id: nil,
+          # Metadata for payment - only included if requested.
+          metadata: nil,
           # Information about the paykey used for the `charge` or `payout`.
-          paykey_details: nil
+          paykey_details: nil,
+          # Payments related to this one (e.g. refunds, resubmissions), mapped by payment ID
+          # to relationship type.
+          related_payments: nil
         )
         end
 
@@ -243,9 +300,13 @@ module Straddle
               amount: Integer,
               created_at: Time,
               currency: String,
-              description: String,
+              description: T.nilable(String),
               external_id: String,
               funding_ids: T::Array[String],
+              has_refund: T::Boolean,
+              has_resubmit: T::Boolean,
+              is_refund: T::Boolean,
+              is_resubmit: T::Boolean,
               paykey: String,
               payment_date: Date,
               payment_type:
@@ -258,7 +319,14 @@ module Straddle
               customer_details: Straddle::CustomerDetailsV1,
               effective_at: T.nilable(Time),
               funding_id: T.nilable(String),
-              paykey_details: Straddle::PaykeyDetailsV1
+              metadata: T.nilable(T::Hash[Symbol, String]),
+              paykey_details: Straddle::PaykeyDetailsV1,
+              related_payments:
+                T.nilable(
+                  T::Array[
+                    Straddle::PaymentSummaryPagedV1::Data::RelatedPayment
+                  ]
+                )
             }
           )
         end
@@ -347,6 +415,11 @@ module Straddle
               :reversed,
               Straddle::PaymentSummaryPagedV1::Data::Status::TaggedSymbol
             )
+          VALIDATING =
+            T.let(
+              :validating,
+              Straddle::PaymentSummaryPagedV1::Data::Status::TaggedSymbol
+            )
 
           sig do
             override.returns(
@@ -358,6 +431,141 @@ module Straddle
           def self.values
           end
         end
+
+        class RelatedPayment < Straddle::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Straddle::PaymentSummaryPagedV1::Data::RelatedPayment,
+                Straddle::Internal::AnyHash
+              )
+            end
+
+          # The ID of the related payment.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The type of payment.
+          sig do
+            returns(
+              Straddle::PaymentSummaryPagedV1::Data::RelatedPayment::PaymentType::TaggedSymbol
+            )
+          end
+          attr_accessor :payment_type
+
+          sig do
+            returns(
+              Straddle::PaymentSummaryPagedV1::Data::RelatedPayment::Relationship::TaggedSymbol
+            )
+          end
+          attr_accessor :relationship
+
+          sig do
+            params(
+              id: String,
+              payment_type:
+                Straddle::PaymentSummaryPagedV1::Data::RelatedPayment::PaymentType::OrSymbol,
+              relationship:
+                Straddle::PaymentSummaryPagedV1::Data::RelatedPayment::Relationship::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The ID of the related payment.
+            id:,
+            # The type of payment.
+            payment_type:,
+            relationship:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                payment_type:
+                  Straddle::PaymentSummaryPagedV1::Data::RelatedPayment::PaymentType::TaggedSymbol,
+                relationship:
+                  Straddle::PaymentSummaryPagedV1::Data::RelatedPayment::Relationship::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The type of payment.
+          module PaymentType
+            extend Straddle::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Straddle::PaymentSummaryPagedV1::Data::RelatedPayment::PaymentType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CHARGE =
+              T.let(
+                :charge,
+                Straddle::PaymentSummaryPagedV1::Data::RelatedPayment::PaymentType::TaggedSymbol
+              )
+            PAYOUT =
+              T.let(
+                :payout,
+                Straddle::PaymentSummaryPagedV1::Data::RelatedPayment::PaymentType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::PaymentSummaryPagedV1::Data::RelatedPayment::PaymentType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module Relationship
+            extend Straddle::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Straddle::PaymentSummaryPagedV1::Data::RelatedPayment::Relationship
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ORIGINAL =
+              T.let(
+                :original,
+                Straddle::PaymentSummaryPagedV1::Data::RelatedPayment::Relationship::TaggedSymbol
+              )
+            RESUBMIT =
+              T.let(
+                :resubmit,
+                Straddle::PaymentSummaryPagedV1::Data::RelatedPayment::Relationship::TaggedSymbol
+              )
+            REFUND =
+              T.let(
+                :refund,
+                Straddle::PaymentSummaryPagedV1::Data::RelatedPayment::Relationship::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::PaymentSummaryPagedV1::Data::RelatedPayment::Relationship::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
       end
 
       class Meta < Straddle::Internal::Type::BaseModel

data/rbi/straddle/models/payout_cancel_params.rbi

@@ -11,6 +11,9 @@ module Straddle
           T.any(Straddle::PayoutCancelParams, Straddle::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :id
+
       # Details about why the payout status was updated.
       sig { returns(String) }
       attr_accessor :reason
@@ -41,6 +44,7 @@ module Straddle
 
       sig do
         params(
+          id: String,
           reason: String,
           correlation_id: String,
           idempotency_key: String,
@@ -50,6 +54,7 @@ module Straddle
         ).returns(T.attached_class)
       end
       def self.new(
+        id:,
         # Details about why the payout status was updated.
         reason:,
         correlation_id: nil,
@@ -63,6 +68,7 @@ module Straddle
       sig do
         override.returns(
           {
+            id: String,
             reason: String,
             correlation_id: String,
             idempotency_key: String,

data/rbi/straddle/models/payout_create_params.rbi

@@ -20,7 +20,7 @@ module Straddle
       attr_accessor :currency
 
       # An arbitrary description for the payout.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :description
 
       # Information about the device used when the customer authorized the payout.
@@ -83,7 +83,7 @@ module Straddle
         params(
           amount: Integer,
           currency: String,
-          description: String,
+          description: T.nilable(String),
           device: Straddle::DeviceInfoV1::OrHash,
           external_id: String,
           paykey: String,
@@ -131,7 +131,7 @@ module Straddle
           {
             amount: Integer,
             currency: String,
-            description: String,
+            description: T.nilable(String),
             device: Straddle::DeviceInfoV1,
             external_id: String,
             paykey: String,
@@ -158,6 +158,14 @@ module Straddle
             )
           end
 
+        # Defines whether to automatically place this charge on hold after being created.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :auto_hold
+
+        # The reason the payout is being automatically held on creation.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :auto_hold_message
+
         # Payment will simulate processing if not Standard.
         sig do
           returns(
@@ -178,11 +186,17 @@ module Straddle
 
         sig do
           params(
+            auto_hold: T.nilable(T::Boolean),
+            auto_hold_message: T.nilable(String),
             sandbox_outcome:
               Straddle::PayoutCreateParams::Config::SandboxOutcome::OrSymbol
           ).returns(T.attached_class)
         end
         def self.new(
+          # Defines whether to automatically place this charge on hold after being created.
+          auto_hold: nil,
+          # The reason the payout is being automatically held on creation.
+          auto_hold_message: nil,
           # Payment will simulate processing if not Standard.
           sandbox_outcome: nil
         )
@@ -191,6 +205,8 @@ module Straddle
         sig do
           override.returns(
             {
+              auto_hold: T.nilable(T::Boolean),
+              auto_hold_message: T.nilable(String),
               sandbox_outcome:
                 Straddle::PayoutCreateParams::Config::SandboxOutcome::OrSymbol
             }
@@ -267,6 +283,16 @@ module Straddle
               :reversed_closed_bank_account,
               Straddle::PayoutCreateParams::Config::SandboxOutcome::TaggedSymbol
             )
+          FAILED_NOT_AUTHORIZED =
+            T.let(
+              :failed_not_authorized,
+              Straddle::PayoutCreateParams::Config::SandboxOutcome::TaggedSymbol
+            )
+          REVERSED_NOT_AUTHORIZED =
+            T.let(
+              :reversed_not_authorized,
+              Straddle::PayoutCreateParams::Config::SandboxOutcome::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/straddle/models/payout_get_params.rbi

@@ -11,6 +11,9 @@ module Straddle
           T.any(Straddle::PayoutGetParams, Straddle::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :id
+
       sig { returns(T.nilable(String)) }
       attr_reader :correlation_id
 
@@ -31,6 +34,7 @@ module Straddle
 
       sig do
         params(
+          id: String,
           correlation_id: String,
           request_id: String,
           straddle_account_id: String,
@@ -38,6 +42,7 @@ module Straddle
         ).returns(T.attached_class)
       end
       def self.new(
+        id:,
         correlation_id: nil,
         request_id: nil,
         straddle_account_id: nil,
@@ -48,6 +53,7 @@ module Straddle
       sig do
         override.returns(
           {
+            id: String,
             correlation_id: String,
             request_id: String,
             straddle_account_id: String,

data/rbi/straddle/models/payout_hold_params.rbi

@@ -11,6 +11,9 @@ module Straddle
           T.any(Straddle::PayoutHoldParams, Straddle::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :id
+
       # Details about why the payout status was updated.
       sig { returns(String) }
       attr_accessor :reason
@@ -41,6 +44,7 @@ module Straddle
 
       sig do
         params(
+          id: String,
           reason: String,
           correlation_id: String,
           idempotency_key: String,
@@ -50,6 +54,7 @@ module Straddle
         ).returns(T.attached_class)
       end
       def self.new(
+        id:,
         # Details about why the payout status was updated.
         reason:,
         correlation_id: nil,
@@ -63,6 +68,7 @@ module Straddle
       sig do
         override.returns(
           {
+            id: String,
             reason: String,
             correlation_id: String,
             idempotency_key: String,