straddle 0.2.0 → 0.4.0

data/rbi/straddle/models/payout_unmask_response.rbi

@@ -108,7 +108,7 @@ module Straddle
         attr_accessor :currency
 
         # Description.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :description
 
         sig { returns(Straddle::Models::PayoutUnmaskResponse::Data::Device) }
@@ -161,6 +161,10 @@ module Straddle
         end
         attr_accessor :status_history
 
+        # Trace Ids.
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :trace_ids
+
         # Created at.
         sig { returns(T.nilable(Time)) }
         attr_accessor :created_at
@@ -210,6 +214,19 @@ module Straddle
         sig { returns(T.nilable(Time)) }
         attr_accessor :processed_at
 
+        # Related payments.
+        sig do
+          returns(
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::TaggedSymbol
+              ]
+            )
+          )
+        end
+        attr_accessor :related_payments
+
         # Updated at.
         sig { returns(T.nilable(Time)) }
         attr_accessor :updated_at
@@ -221,7 +238,7 @@ module Straddle
             config:
               Straddle::Models::PayoutUnmaskResponse::Data::Config::OrHash,
             currency: String,
-            description: String,
+            description: T.nilable(String),
             device:
               Straddle::Models::PayoutUnmaskResponse::Data::Device::OrHash,
             external_id: String,
@@ -235,6 +252,7 @@ module Straddle
               T::Array[
                 Straddle::Models::PayoutUnmaskResponse::Data::StatusHistory::OrHash
               ],
+            trace_ids: T::Hash[Symbol, String],
             created_at: T.nilable(Time),
             customer_details: Straddle::CustomerDetailsV1::OrHash,
             effective_at: T.nilable(Time),
@@ -243,6 +261,13 @@ module Straddle
             payment_rail:
               Straddle::Models::PayoutUnmaskResponse::Data::PaymentRail::OrSymbol,
             processed_at: T.nilable(Time),
+            related_payments:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::OrSymbol
+                ]
+              ),
             updated_at: T.nilable(Time)
           ).returns(T.attached_class)
         end
@@ -270,6 +295,8 @@ module Straddle
           status_details:,
           # Status history.
           status_history:,
+          # Trace Ids.
+          trace_ids:,
           # Created at.
           created_at: nil,
           # Information about the customer associated with the charge or payout.
@@ -283,6 +310,8 @@ module Straddle
           payment_rail: nil,
           # Processed at.
           processed_at: nil,
+          # Related payments.
+          related_payments: nil,
           # Updated at.
           updated_at: nil
         )
@@ -295,7 +324,7 @@ module Straddle
               amount: Integer,
               config: Straddle::Models::PayoutUnmaskResponse::Data::Config,
               currency: String,
-              description: String,
+              description: T.nilable(String),
               device: Straddle::Models::PayoutUnmaskResponse::Data::Device,
               external_id: String,
               funding_ids: T::Array[String],
@@ -308,6 +337,7 @@ module Straddle
                 T::Array[
                   Straddle::Models::PayoutUnmaskResponse::Data::StatusHistory
                 ],
+              trace_ids: T::Hash[Symbol, String],
               created_at: T.nilable(Time),
               customer_details: Straddle::CustomerDetailsV1,
               effective_at: T.nilable(Time),
@@ -316,6 +346,13 @@ module Straddle
               payment_rail:
                 Straddle::Models::PayoutUnmaskResponse::Data::PaymentRail::TaggedSymbol,
               processed_at: T.nilable(Time),
+              related_payments:
+                T.nilable(
+                  T::Hash[
+                    Symbol,
+                    Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::TaggedSymbol
+                  ]
+                ),
               updated_at: T.nilable(Time)
             }
           )
@@ -332,6 +369,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(
@@ -352,11 +397,17 @@ module Straddle
 
           sig do
             params(
+              auto_hold: T.nilable(T::Boolean),
+              auto_hold_message: T.nilable(String),
               sandbox_outcome:
                 Straddle::Models::PayoutUnmaskResponse::Data::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
           )
@@ -365,6 +416,8 @@ module Straddle
           sig do
             override.returns(
               {
+                auto_hold: T.nilable(T::Boolean),
+                auto_hold_message: T.nilable(String),
                 sandbox_outcome:
                   Straddle::Models::PayoutUnmaskResponse::Data::Config::SandboxOutcome::TaggedSymbol
               }
@@ -532,6 +585,11 @@ module Straddle
               :reversed,
               Straddle::Models::PayoutUnmaskResponse::Data::Status::TaggedSymbol
             )
+          VALIDATING =
+            T.let(
+              :validating,
+              Straddle::Models::PayoutUnmaskResponse::Data::Status::TaggedSymbol
+            )
 
           sig do
             override.returns(
@@ -754,6 +812,41 @@ module Straddle
                 :payout_refused,
                 Straddle::Models::PayoutUnmaskResponse::Data::StatusHistory::Reason::TaggedSymbol
               )
+            CANCEL_REQUEST =
+              T.let(
+                :cancel_request,
+                Straddle::Models::PayoutUnmaskResponse::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            FAILED_VERIFICATION =
+              T.let(
+                :failed_verification,
+                Straddle::Models::PayoutUnmaskResponse::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            REQUIRE_REVIEW =
+              T.let(
+                :require_review,
+                Straddle::Models::PayoutUnmaskResponse::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            BLOCKED_BY_SYSTEM =
+              T.let(
+                :blocked_by_system,
+                Straddle::Models::PayoutUnmaskResponse::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            WATCHTOWER_REVIEW =
+              T.let(
+                :watchtower_review,
+                Straddle::Models::PayoutUnmaskResponse::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            VALIDATING =
+              T.let(
+                :validating,
+                Straddle::Models::PayoutUnmaskResponse::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            AUTO_HOLD =
+              T.let(
+                :auto_hold,
+                Straddle::Models::PayoutUnmaskResponse::Data::StatusHistory::Reason::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -870,6 +963,11 @@ module Straddle
                 :reversed,
                 Straddle::Models::PayoutUnmaskResponse::Data::StatusHistory::Status::TaggedSymbol
               )
+            VALIDATING =
+              T.let(
+                :validating,
+                Straddle::Models::PayoutUnmaskResponse::Data::StatusHistory::Status::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -912,6 +1010,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::PayoutUnmaskResponse::Data::RelatedPayment
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ORIGINAL =
+            T.let(
+              :original,
+              Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::TaggedSymbol
+            )
+          RESUBMIT =
+            T.let(
+              :resubmit,
+              Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::TaggedSymbol
+            )
+          REFUND =
+            T.let(
+              :refund,
+              Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
 
       # Indicates the structure of the returned content.

data/rbi/straddle/models/payout_update_params.rbi

@@ -11,12 +11,15 @@ module Straddle
           T.any(Straddle::PayoutUpdateParams, Straddle::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :id
+
       # The amount of the payout in cents.
       sig { returns(Integer) }
       attr_accessor :amount
 
       # An arbitrary description for the payout.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :description
 
       # The desired date on which the payment should be occur. For payouts, 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 payout in cents.
         amount:,
         # An arbitrary description for the payout.
@@ -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/payout_v1.rbi

@@ -89,7 +89,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.
@@ -132,6 +132,10 @@ module Straddle
         sig { returns(T::Array[Straddle::PayoutV1::Data::StatusHistory]) }
         attr_accessor :status_history
 
+        # Trace Ids.
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :trace_ids
+
         # The time the payout was created.
         sig { returns(T.nilable(Time)) }
         attr_accessor :created_at
@@ -182,6 +186,19 @@ module Straddle
         sig { returns(T.nilable(Time)) }
         attr_accessor :processed_at
 
+        # Related payments.
+        sig do
+          returns(
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Straddle::PayoutV1::Data::RelatedPayment::TaggedSymbol
+              ]
+            )
+          )
+        end
+        attr_accessor :related_payments
+
         # The time the payout was last updated.
         sig { returns(T.nilable(Time)) }
         attr_accessor :updated_at
@@ -192,7 +209,7 @@ module Straddle
             amount: Integer,
             config: Straddle::PayoutV1::Data::Config::OrHash,
             currency: String,
-            description: String,
+            description: T.nilable(String),
             device: Straddle::DeviceInfoV1::OrHash,
             external_id: String,
             funding_ids: T::Array[String],
@@ -202,6 +219,7 @@ module Straddle
             status_details: Straddle::StatusDetailsV1::OrHash,
             status_history:
               T::Array[Straddle::PayoutV1::Data::StatusHistory::OrHash],
+            trace_ids: T::Hash[Symbol, String],
             created_at: T.nilable(Time),
             customer_details: Straddle::CustomerDetailsV1::OrHash,
             effective_at: T.nilable(Time),
@@ -209,6 +227,13 @@ module Straddle
             paykey_details: Straddle::PaykeyDetailsV1::OrHash,
             payment_rail: Straddle::PayoutV1::Data::PaymentRail::OrSymbol,
             processed_at: T.nilable(Time),
+            related_payments:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  Straddle::PayoutV1::Data::RelatedPayment::OrSymbol
+                ]
+              ),
             updated_at: T.nilable(Time)
           ).returns(T.attached_class)
         end
@@ -241,6 +266,8 @@ module Straddle
           status_details:,
           # History of the status changes for the payout.
           status_history:,
+          # Trace Ids.
+          trace_ids:,
           # The time the payout was created.
           created_at: nil,
           # Information about the customer associated with the payout.
@@ -258,6 +285,8 @@ module Straddle
           # The time the payout was processed by Straddle and originated to the payment
           # rail.
           processed_at: nil,
+          # Related payments.
+          related_payments: nil,
           # The time the payout was last updated.
           updated_at: nil
         )
@@ -270,7 +299,7 @@ module Straddle
               amount: Integer,
               config: Straddle::PayoutV1::Data::Config,
               currency: String,
-              description: String,
+              description: T.nilable(String),
               device: Straddle::DeviceInfoV1,
               external_id: String,
               funding_ids: T::Array[String],
@@ -279,6 +308,7 @@ module Straddle
               status: Straddle::PayoutV1::Data::Status::TaggedSymbol,
               status_details: Straddle::StatusDetailsV1,
               status_history: T::Array[Straddle::PayoutV1::Data::StatusHistory],
+              trace_ids: T::Hash[Symbol, String],
               created_at: T.nilable(Time),
               customer_details: Straddle::CustomerDetailsV1,
               effective_at: T.nilable(Time),
@@ -286,6 +316,13 @@ module Straddle
               paykey_details: Straddle::PaykeyDetailsV1,
               payment_rail: Straddle::PayoutV1::Data::PaymentRail::TaggedSymbol,
               processed_at: T.nilable(Time),
+              related_payments:
+                T.nilable(
+                  T::Hash[
+                    Symbol,
+                    Straddle::PayoutV1::Data::RelatedPayment::TaggedSymbol
+                  ]
+                ),
               updated_at: T.nilable(Time)
             }
           )
@@ -302,6 +339,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(
@@ -323,11 +368,17 @@ module Straddle
           # Configuration for the payout.
           sig do
             params(
+              auto_hold: T.nilable(T::Boolean),
+              auto_hold_message: T.nilable(String),
               sandbox_outcome:
                 Straddle::PayoutV1::Data::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
           )
@@ -336,6 +387,8 @@ module Straddle
           sig do
             override.returns(
               {
+                auto_hold: T.nilable(T::Boolean),
+                auto_hold_message: T.nilable(String),
                 sandbox_outcome:
                   Straddle::PayoutV1::Data::Config::SandboxOutcome::TaggedSymbol
               }
@@ -445,6 +498,8 @@ module Straddle
           PAID = T.let(:paid, Straddle::PayoutV1::Data::Status::TaggedSymbol)
           REVERSED =
             T.let(:reversed, Straddle::PayoutV1::Data::Status::TaggedSymbol)
+          VALIDATING =
+            T.let(:validating, Straddle::PayoutV1::Data::Status::TaggedSymbol)
 
           sig do
             override.returns(
@@ -659,6 +714,41 @@ module Straddle
                 :payout_refused,
                 Straddle::PayoutV1::Data::StatusHistory::Reason::TaggedSymbol
               )
+            CANCEL_REQUEST =
+              T.let(
+                :cancel_request,
+                Straddle::PayoutV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            FAILED_VERIFICATION =
+              T.let(
+                :failed_verification,
+                Straddle::PayoutV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            REQUIRE_REVIEW =
+              T.let(
+                :require_review,
+                Straddle::PayoutV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            BLOCKED_BY_SYSTEM =
+              T.let(
+                :blocked_by_system,
+                Straddle::PayoutV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            WATCHTOWER_REVIEW =
+              T.let(
+                :watchtower_review,
+                Straddle::PayoutV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            VALIDATING =
+              T.let(
+                :validating,
+                Straddle::PayoutV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            AUTO_HOLD =
+              T.let(
+                :auto_hold,
+                Straddle::PayoutV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -769,6 +859,11 @@ module Straddle
                 :reversed,
                 Straddle::PayoutV1::Data::StatusHistory::Status::TaggedSymbol
               )
+            VALIDATING =
+              T.let(
+                :validating,
+                Straddle::PayoutV1::Data::StatusHistory::Status::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -802,6 +897,40 @@ module Straddle
           def self.values
           end
         end
+
+        module RelatedPayment
+          extend Straddle::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Straddle::PayoutV1::Data::RelatedPayment)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ORIGINAL =
+            T.let(
+              :original,
+              Straddle::PayoutV1::Data::RelatedPayment::TaggedSymbol
+            )
+          RESUBMIT =
+            T.let(
+              :resubmit,
+              Straddle::PayoutV1::Data::RelatedPayment::TaggedSymbol
+            )
+          REFUND =
+            T.let(
+              :refund,
+              Straddle::PayoutV1::Data::RelatedPayment::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Straddle::PayoutV1::Data::RelatedPayment::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
       end
 
       # Indicates the structure of the returned content.

data/rbi/straddle/models/status_details_v1.rbi

@@ -162,6 +162,35 @@ module Straddle
             :payout_refused,
             Straddle::StatusDetailsV1::Reason::TaggedSymbol
           )
+        CANCEL_REQUEST =
+          T.let(
+            :cancel_request,
+            Straddle::StatusDetailsV1::Reason::TaggedSymbol
+          )
+        FAILED_VERIFICATION =
+          T.let(
+            :failed_verification,
+            Straddle::StatusDetailsV1::Reason::TaggedSymbol
+          )
+        REQUIRE_REVIEW =
+          T.let(
+            :require_review,
+            Straddle::StatusDetailsV1::Reason::TaggedSymbol
+          )
+        BLOCKED_BY_SYSTEM =
+          T.let(
+            :blocked_by_system,
+            Straddle::StatusDetailsV1::Reason::TaggedSymbol
+          )
+        WATCHTOWER_REVIEW =
+          T.let(
+            :watchtower_review,
+            Straddle::StatusDetailsV1::Reason::TaggedSymbol
+          )
+        VALIDATING =
+          T.let(:validating, Straddle::StatusDetailsV1::Reason::TaggedSymbol)
+        AUTO_HOLD =
+          T.let(:auto_hold, Straddle::StatusDetailsV1::Reason::TaggedSymbol)
 
         sig do
           override.returns(

data/rbi/straddle/models.rbi

@@ -35,8 +35,6 @@ module Straddle
 
   CustomerListParams = Straddle::Models::CustomerListParams
 
-  CustomerRefreshReviewParams = Straddle::Models::CustomerRefreshReviewParams
-
   Customers = Straddle::Models::Customers
 
   CustomerSummaryPagedV1 = Straddle::Models::CustomerSummaryPagedV1
@@ -75,7 +73,7 @@ module Straddle
 
   PaykeyRevealParams = Straddle::Models::PaykeyRevealParams
 
-  PaykeyReviewParams = Straddle::Models::PaykeyReviewParams
+  Paykeys = Straddle::Models::Paykeys
 
   PaykeySummaryPagedV1 = Straddle::Models::PaykeySummaryPagedV1
 
@@ -83,6 +81,8 @@ module Straddle
 
   PaykeyUnmaskedV1 = Straddle::Models::PaykeyUnmaskedV1
 
+  PaykeyUpdateBalanceParams = Straddle::Models::PaykeyUpdateBalanceParams
+
   PaykeyV1 = Straddle::Models::PaykeyV1
 
   PaymentListParams = Straddle::Models::PaymentListParams