straddle 0.3.0 → 0.4.0

data/rbi/straddle/models/charge_unmask_response.rbi

@@ -123,7 +123,7 @@ module Straddle
         attr_accessor :currency
 
         # Description.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :description
 
         sig { returns(Straddle::Models::ChargeUnmaskResponse::Data::Device) }
@@ -176,6 +176,10 @@ module Straddle
         end
         attr_accessor :status_history
 
+        # Trace Ids.
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :trace_ids
+
         # Updated at.
         sig { returns(Time) }
         attr_accessor :updated_at
@@ -225,6 +229,19 @@ module Straddle
         sig { returns(T.nilable(Time)) }
         attr_accessor :processed_at
 
+        # Related payments.
+        sig do
+          returns(
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::TaggedSymbol
+              ]
+            )
+          )
+        end
+        attr_accessor :related_payments
+
         sig do
           params(
             id: String,
@@ -235,7 +252,7 @@ module Straddle
               Straddle::Models::ChargeUnmaskResponse::Data::ConsentType::OrSymbol,
             created_at: Time,
             currency: String,
-            description: String,
+            description: T.nilable(String),
             device:
               Straddle::Models::ChargeUnmaskResponse::Data::Device::OrHash,
             external_id: String,
@@ -249,6 +266,7 @@ module Straddle
               T::Array[
                 Straddle::Models::ChargeUnmaskResponse::Data::StatusHistory::OrHash
               ],
+            trace_ids: T::Hash[Symbol, String],
             updated_at: Time,
             customer_details: Straddle::CustomerDetailsV1::OrHash,
             effective_at: T.nilable(Time),
@@ -256,7 +274,14 @@ module Straddle
             paykey_details: Straddle::PaykeyDetailsV1::OrHash,
             payment_rail:
               Straddle::Models::ChargeUnmaskResponse::Data::PaymentRail::OrSymbol,
-            processed_at: T.nilable(Time)
+            processed_at: T.nilable(Time),
+            related_payments:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::OrSymbol
+                ]
+              )
           ).returns(T.attached_class)
         end
         def self.new(
@@ -290,6 +315,8 @@ module Straddle
           status_details:,
           # Status history.
           status_history:,
+          # Trace Ids.
+          trace_ids:,
           # Updated at.
           updated_at:,
           # Information about the customer associated with the charge or payout.
@@ -302,7 +329,9 @@ module Straddle
           # The payment rail used for the charge or payout.
           payment_rail: nil,
           # Processed at.
-          processed_at: nil
+          processed_at: nil,
+          # Related payments.
+          related_payments: nil
         )
         end
 
@@ -316,7 +345,7 @@ module Straddle
                 Straddle::Models::ChargeUnmaskResponse::Data::ConsentType::TaggedSymbol,
               created_at: Time,
               currency: String,
-              description: String,
+              description: T.nilable(String),
               device: Straddle::Models::ChargeUnmaskResponse::Data::Device,
               external_id: String,
               funding_ids: T::Array[String],
@@ -329,6 +358,7 @@ module Straddle
                 T::Array[
                   Straddle::Models::ChargeUnmaskResponse::Data::StatusHistory
                 ],
+              trace_ids: T::Hash[Symbol, String],
               updated_at: Time,
               customer_details: Straddle::CustomerDetailsV1,
               effective_at: T.nilable(Time),
@@ -336,7 +366,14 @@ module Straddle
               paykey_details: Straddle::PaykeyDetailsV1,
               payment_rail:
                 Straddle::Models::ChargeUnmaskResponse::Data::PaymentRail::TaggedSymbol,
-              processed_at: T.nilable(Time)
+              processed_at: T.nilable(Time),
+              related_payments:
+                T.nilable(
+                  T::Hash[
+                    Symbol,
+                    Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::TaggedSymbol
+                  ]
+                )
             }
           )
         end
@@ -360,6 +397,14 @@ module Straddle
           end
           attr_accessor :balance_check
 
+          # 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 charge 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(
@@ -382,6 +427,8 @@ module Straddle
             params(
               balance_check:
                 Straddle::Models::ChargeUnmaskResponse::Data::Config::BalanceCheck::OrSymbol,
+              auto_hold: T.nilable(T::Boolean),
+              auto_hold_message: T.nilable(String),
               sandbox_outcome:
                 Straddle::Models::ChargeUnmaskResponse::Data::Config::SandboxOutcome::OrSymbol
             ).returns(T.attached_class)
@@ -389,6 +436,10 @@ module Straddle
           def self.new(
             # Defines whether to check the customer's balance before processing the charge.
             balance_check:,
+            # Defines whether to automatically place this charge on hold after being created.
+            auto_hold: nil,
+            # The reason the charge is being automatically held on creation.
+            auto_hold_message: nil,
             # Payment will simulate processing if not Standard.
             sandbox_outcome: nil
           )
@@ -399,6 +450,8 @@ module Straddle
               {
                 balance_check:
                   Straddle::Models::ChargeUnmaskResponse::Data::Config::BalanceCheck::TaggedSymbol,
+                auto_hold: T.nilable(T::Boolean),
+                auto_hold_message: T.nilable(String),
                 sandbox_outcome:
                   Straddle::Models::ChargeUnmaskResponse::Data::Config::SandboxOutcome::TaggedSymbol
               }
@@ -644,6 +697,11 @@ module Straddle
               :reversed,
               Straddle::Models::ChargeUnmaskResponse::Data::Status::TaggedSymbol
             )
+          VALIDATING =
+            T.let(
+              :validating,
+              Straddle::Models::ChargeUnmaskResponse::Data::Status::TaggedSymbol
+            )
 
           sig do
             override.returns(
@@ -866,6 +924,41 @@ module Straddle
                 :payout_refused,
                 Straddle::Models::ChargeUnmaskResponse::Data::StatusHistory::Reason::TaggedSymbol
               )
+            CANCEL_REQUEST =
+              T.let(
+                :cancel_request,
+                Straddle::Models::ChargeUnmaskResponse::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            FAILED_VERIFICATION =
+              T.let(
+                :failed_verification,
+                Straddle::Models::ChargeUnmaskResponse::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            REQUIRE_REVIEW =
+              T.let(
+                :require_review,
+                Straddle::Models::ChargeUnmaskResponse::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            BLOCKED_BY_SYSTEM =
+              T.let(
+                :blocked_by_system,
+                Straddle::Models::ChargeUnmaskResponse::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            WATCHTOWER_REVIEW =
+              T.let(
+                :watchtower_review,
+                Straddle::Models::ChargeUnmaskResponse::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            VALIDATING =
+              T.let(
+                :validating,
+                Straddle::Models::ChargeUnmaskResponse::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            AUTO_HOLD =
+              T.let(
+                :auto_hold,
+                Straddle::Models::ChargeUnmaskResponse::Data::StatusHistory::Reason::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -982,6 +1075,11 @@ module Straddle
                 :reversed,
                 Straddle::Models::ChargeUnmaskResponse::Data::StatusHistory::Status::TaggedSymbol
               )
+            VALIDATING =
+              T.let(
+                :validating,
+                Straddle::Models::ChargeUnmaskResponse::Data::StatusHistory::Status::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -1024,6 +1122,45 @@ module Straddle
           def self.values
           end
         end
+
+        module RelatedPayment
+          extend Straddle::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ORIGINAL =
+            T.let(
+              :original,
+              Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::TaggedSymbol
+            )
+          RESUBMIT =
+            T.let(
+              :resubmit,
+              Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::TaggedSymbol
+            )
+          REFUND =
+            T.let(
+              :refund,
+              Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
 
       # Indicates the structure of the returned content.

data/rbi/straddle/models/charge_update_params.rbi

@@ -11,12 +11,15 @@ module Straddle
           T.any(Straddle::ChargeUpdateParams, Straddle::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :id
+
       # The amount of the charge in cents.
       sig { returns(Integer) }
       attr_accessor :amount
 
       # An arbitrary description for the charge.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :description
 
       # The desired date on which the payment should be occur. For charges, this means
@@ -55,8 +58,9 @@ module Straddle
 
       sig do
         params(
+          id: String,
           amount: Integer,
-          description: String,
+          description: T.nilable(String),
           payment_date: Date,
           metadata: T.nilable(T::Hash[Symbol, String]),
           correlation_id: String,
@@ -67,6 +71,7 @@ module Straddle
         ).returns(T.attached_class)
       end
       def self.new(
+        id:,
         # The amount of the charge in cents.
         amount:,
         # An arbitrary description for the charge.
@@ -88,8 +93,9 @@ module Straddle
       sig do
         override.returns(
           {
+            id: String,
             amount: Integer,
-            description: String,
+            description: T.nilable(String),
             payment_date: Date,
             metadata: T.nilable(T::Hash[Symbol, String]),
             correlation_id: String,

data/rbi/straddle/models/charge_v1.rbi

@@ -100,7 +100,7 @@ module Straddle
         attr_accessor :currency
 
         # An arbitrary description for the charge.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :description
 
         # Information about the device used when the customer authorized the payment.
@@ -143,6 +143,10 @@ module Straddle
         sig { returns(T::Array[Straddle::ChargeV1::Data::StatusHistory]) }
         attr_accessor :status_history
 
+        # Trace Ids.
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :trace_ids
+
         # Timestamp of when the charge was last updated.
         sig { returns(T.nilable(Time)) }
         attr_accessor :updated_at
@@ -193,6 +197,19 @@ module Straddle
         sig { returns(T.nilable(Time)) }
         attr_accessor :processed_at
 
+        # Related payments.
+        sig do
+          returns(
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Straddle::ChargeV1::Data::RelatedPayment::TaggedSymbol
+              ]
+            )
+          )
+        end
+        attr_accessor :related_payments
+
         sig do
           params(
             id: String,
@@ -201,7 +218,7 @@ module Straddle
             consent_type: Straddle::ChargeV1::Data::ConsentType::OrSymbol,
             created_at: T.nilable(Time),
             currency: String,
-            description: String,
+            description: T.nilable(String),
             device: Straddle::DeviceInfoV1::OrHash,
             external_id: String,
             funding_ids: T::Array[String],
@@ -211,13 +228,21 @@ module Straddle
             status_details: Straddle::StatusDetailsV1::OrHash,
             status_history:
               T::Array[Straddle::ChargeV1::Data::StatusHistory::OrHash],
+            trace_ids: T::Hash[Symbol, String],
             updated_at: T.nilable(Time),
             customer_details: Straddle::CustomerDetailsV1::OrHash,
             effective_at: T.nilable(Time),
             metadata: T.nilable(T::Hash[Symbol, String]),
             paykey_details: Straddle::PaykeyDetailsV1::OrHash,
             payment_rail: Straddle::ChargeV1::Data::PaymentRail::OrSymbol,
-            processed_at: T.nilable(Time)
+            processed_at: T.nilable(Time),
+            related_payments:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  Straddle::ChargeV1::Data::RelatedPayment::OrSymbol
+                ]
+              )
           ).returns(T.attached_class)
         end
         def self.new(
@@ -256,6 +281,8 @@ module Straddle
           status_details:,
           # Status history.
           status_history:,
+          # Trace Ids.
+          trace_ids:,
           # Timestamp of when the charge was last updated.
           updated_at:,
           # Information about the customer associated with the charge.
@@ -272,7 +299,9 @@ module Straddle
           payment_rail: nil,
           # Timestamp of when the charge was processed by Straddle and originated to the
           # payment rail.
-          processed_at: nil
+          processed_at: nil,
+          # Related payments.
+          related_payments: nil
         )
         end
 
@@ -285,7 +314,7 @@ module Straddle
               consent_type: Straddle::ChargeV1::Data::ConsentType::TaggedSymbol,
               created_at: T.nilable(Time),
               currency: String,
-              description: String,
+              description: T.nilable(String),
               device: Straddle::DeviceInfoV1,
               external_id: String,
               funding_ids: T::Array[String],
@@ -294,13 +323,21 @@ module Straddle
               status: Straddle::ChargeV1::Data::Status::TaggedSymbol,
               status_details: Straddle::StatusDetailsV1,
               status_history: T::Array[Straddle::ChargeV1::Data::StatusHistory],
+              trace_ids: T::Hash[Symbol, String],
               updated_at: T.nilable(Time),
               customer_details: Straddle::CustomerDetailsV1,
               effective_at: T.nilable(Time),
               metadata: T.nilable(T::Hash[Symbol, String]),
               paykey_details: Straddle::PaykeyDetailsV1,
               payment_rail: Straddle::ChargeV1::Data::PaymentRail::TaggedSymbol,
-              processed_at: T.nilable(Time)
+              processed_at: T.nilable(Time),
+              related_payments:
+                T.nilable(
+                  T::Hash[
+                    Symbol,
+                    Straddle::ChargeV1::Data::RelatedPayment::TaggedSymbol
+                  ]
+                )
             }
           )
         end
@@ -324,6 +361,14 @@ module Straddle
           end
           attr_accessor :balance_check
 
+          # 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 charge 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(
@@ -347,6 +392,8 @@ module Straddle
             params(
               balance_check:
                 Straddle::ChargeV1::Data::Config::BalanceCheck::OrSymbol,
+              auto_hold: T.nilable(T::Boolean),
+              auto_hold_message: T.nilable(String),
               sandbox_outcome:
                 Straddle::ChargeV1::Data::Config::SandboxOutcome::OrSymbol
             ).returns(T.attached_class)
@@ -354,6 +401,10 @@ module Straddle
           def self.new(
             # Defines whether to check the customer's balance before processing the charge.
             balance_check:,
+            # Defines whether to automatically place this charge on hold after being created.
+            auto_hold: nil,
+            # The reason the charge is being automatically held on creation.
+            auto_hold_message: nil,
             # Payment will simulate processing if not Standard.
             sandbox_outcome: nil
           )
@@ -364,6 +415,8 @@ module Straddle
               {
                 balance_check:
                   Straddle::ChargeV1::Data::Config::BalanceCheck::TaggedSymbol,
+                auto_hold: T.nilable(T::Boolean),
+                auto_hold_message: T.nilable(String),
                 sandbox_outcome:
                   Straddle::ChargeV1::Data::Config::SandboxOutcome::TaggedSymbol
               }
@@ -540,6 +593,8 @@ module Straddle
           PAID = T.let(:paid, Straddle::ChargeV1::Data::Status::TaggedSymbol)
           REVERSED =
             T.let(:reversed, Straddle::ChargeV1::Data::Status::TaggedSymbol)
+          VALIDATING =
+            T.let(:validating, Straddle::ChargeV1::Data::Status::TaggedSymbol)
 
           sig do
             override.returns(
@@ -755,6 +810,41 @@ module Straddle
                 :payout_refused,
                 Straddle::ChargeV1::Data::StatusHistory::Reason::TaggedSymbol
               )
+            CANCEL_REQUEST =
+              T.let(
+                :cancel_request,
+                Straddle::ChargeV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            FAILED_VERIFICATION =
+              T.let(
+                :failed_verification,
+                Straddle::ChargeV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            REQUIRE_REVIEW =
+              T.let(
+                :require_review,
+                Straddle::ChargeV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            BLOCKED_BY_SYSTEM =
+              T.let(
+                :blocked_by_system,
+                Straddle::ChargeV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            WATCHTOWER_REVIEW =
+              T.let(
+                :watchtower_review,
+                Straddle::ChargeV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            VALIDATING =
+              T.let(
+                :validating,
+                Straddle::ChargeV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            AUTO_HOLD =
+              T.let(
+                :auto_hold,
+                Straddle::ChargeV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -865,6 +955,11 @@ module Straddle
                 :reversed,
                 Straddle::ChargeV1::Data::StatusHistory::Status::TaggedSymbol
               )
+            VALIDATING =
+              T.let(
+                :validating,
+                Straddle::ChargeV1::Data::StatusHistory::Status::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -898,6 +993,40 @@ module Straddle
           def self.values
           end
         end
+
+        module RelatedPayment
+          extend Straddle::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Straddle::ChargeV1::Data::RelatedPayment)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ORIGINAL =
+            T.let(
+              :original,
+              Straddle::ChargeV1::Data::RelatedPayment::TaggedSymbol
+            )
+          RESUBMIT =
+            T.let(
+              :resubmit,
+              Straddle::ChargeV1::Data::RelatedPayment::TaggedSymbol
+            )
+          REFUND =
+            T.let(
+              :refund,
+              Straddle::ChargeV1::Data::RelatedPayment::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Straddle::ChargeV1::Data::RelatedPayment::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
       end
 
       # Indicates the structure of the returned content.

data/rbi/straddle/models/customer_delete_params.rbi

@@ -11,6 +11,9 @@ module Straddle
           T.any(Straddle::CustomerDeleteParams, Straddle::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :id
+
       sig { returns(T.nilable(String)) }
       attr_reader :correlation_id
 
@@ -37,6 +40,7 @@ module Straddle
 
       sig do
         params(
+          id: String,
           correlation_id: String,
           idempotency_key: String,
           request_id: String,
@@ -45,6 +49,7 @@ module Straddle
         ).returns(T.attached_class)
       end
       def self.new(
+        id:,
         correlation_id: nil,
         idempotency_key: nil,
         request_id: nil,
@@ -56,6 +61,7 @@ module Straddle
       sig do
         override.returns(
           {
+            id: String,
             correlation_id: String,
             idempotency_key: String,
             request_id: String,

data/rbi/straddle/models/customer_get_params.rbi

@@ -11,6 +11,9 @@ module Straddle
           T.any(Straddle::CustomerGetParams, 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/customer_unmasked_params.rbi

@@ -11,6 +11,9 @@ module Straddle
           T.any(Straddle::CustomerUnmaskedParams, 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,