straddle 0.3.0 → 0.5.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) }
@@ -144,6 +144,18 @@ module Straddle
         sig { returns(T::Array[String]) }
         attr_accessor :funding_ids
 
+        # Has the charge been refunded by an associated payout.
+        sig { returns(T::Boolean) }
+        attr_accessor :has_refund
+
+        # Has the charge been resubmitted.
+        sig { returns(T::Boolean) }
+        attr_accessor :has_resubmit
+
+        # Is the charge a resubmit of an original charge.
+        sig { returns(T::Boolean) }
+        attr_accessor :is_resubmit
+
         # Paykey.
         sig { returns(String) }
         attr_accessor :paykey
@@ -176,6 +188,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
@@ -189,6 +205,17 @@ module Straddle
         end
         attr_writer :customer_details
 
+        # Documents uploaded for this charge (e.g. proof of authorization), in the order
+        # they were uploaded.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Straddle::Models::ChargeUnmaskResponse::Data::Document]
+            )
+          )
+        end
+        attr_accessor :documents
+
         # Effective at.
         sig { returns(T.nilable(Time)) }
         attr_accessor :effective_at
@@ -225,6 +252,18 @@ module Straddle
         sig { returns(T.nilable(Time)) }
         attr_accessor :processed_at
 
+        # Related payments.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment
+              ]
+            )
+          )
+        end
+        attr_accessor :related_payments
+
         sig do
           params(
             id: String,
@@ -235,11 +274,14 @@ 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,
             funding_ids: T::Array[String],
+            has_refund: T::Boolean,
+            has_resubmit: T::Boolean,
+            is_resubmit: T::Boolean,
             paykey: String,
             payment_date: Date,
             status:
@@ -249,14 +291,27 @@ module Straddle
               T::Array[
                 Straddle::Models::ChargeUnmaskResponse::Data::StatusHistory::OrHash
               ],
+            trace_ids: T::Hash[Symbol, String],
             updated_at: Time,
             customer_details: Straddle::CustomerDetailsV1::OrHash,
+            documents:
+              T.nilable(
+                T::Array[
+                  Straddle::Models::ChargeUnmaskResponse::Data::Document::OrHash
+                ]
+              ),
             effective_at: T.nilable(Time),
             metadata: T.nilable(T::Hash[Symbol, String]),
             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::Array[
+                  Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::OrHash
+                ]
+              )
           ).returns(T.attached_class)
         end
         def self.new(
@@ -281,6 +336,12 @@ module Straddle
           external_id:,
           # Funding Ids
           funding_ids:,
+          # Has the charge been refunded by an associated payout.
+          has_refund:,
+          # Has the charge been resubmitted.
+          has_resubmit:,
+          # Is the charge a resubmit of an original charge.
+          is_resubmit:,
           # Paykey.
           paykey:,
           # Payment date.
@@ -290,10 +351,15 @@ 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.
           customer_details: nil,
+          # Documents uploaded for this charge (e.g. proof of authorization), in the order
+          # they were uploaded.
+          documents: nil,
           # Effective at.
           effective_at: nil,
           # Metadata.
@@ -302,7 +368,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,10 +384,13 @@ 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],
+              has_refund: T::Boolean,
+              has_resubmit: T::Boolean,
+              is_resubmit: T::Boolean,
               paykey: String,
               payment_date: Date,
               status:
@@ -329,14 +400,27 @@ module Straddle
                 T::Array[
                   Straddle::Models::ChargeUnmaskResponse::Data::StatusHistory
                 ],
+              trace_ids: T::Hash[Symbol, String],
               updated_at: Time,
               customer_details: Straddle::CustomerDetailsV1,
+              documents:
+                T.nilable(
+                  T::Array[
+                    Straddle::Models::ChargeUnmaskResponse::Data::Document
+                  ]
+                ),
               effective_at: T.nilable(Time),
               metadata: T.nilable(T::Hash[Symbol, String]),
               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::Array[
+                    Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment
+                  ]
+                )
             }
           )
         end
@@ -360,6 +444,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 +474,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 +483,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 +497,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
               }
@@ -515,6 +615,16 @@ module Straddle
                 :reversed_closed_bank_account,
                 Straddle::Models::ChargeUnmaskResponse::Data::Config::SandboxOutcome::TaggedSymbol
               )
+            FAILED_NOT_AUTHORIZED =
+              T.let(
+                :failed_not_authorized,
+                Straddle::Models::ChargeUnmaskResponse::Data::Config::SandboxOutcome::TaggedSymbol
+              )
+            REVERSED_NOT_AUTHORIZED =
+              T.let(
+                :reversed_not_authorized,
+                Straddle::Models::ChargeUnmaskResponse::Data::Config::SandboxOutcome::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -644,6 +754,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 +981,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 +1132,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(
@@ -995,6 +1150,106 @@ module Straddle
           end
         end
 
+        class Document < Straddle::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Straddle::Models::ChargeUnmaskResponse::Data::Document,
+                Straddle::Internal::AnyHash
+              )
+            end
+
+          # Unique identifier for this document.
+          sig { returns(String) }
+          attr_accessor :document_id
+
+          # The file name of this document as uploaded.
+          sig { returns(String) }
+          attr_accessor :document_name
+
+          # The size of this document in bytes.
+          sig { returns(Integer) }
+          attr_accessor :document_size
+
+          sig do
+            returns(
+              Straddle::Models::ChargeUnmaskResponse::Data::Document::DocumentType::TaggedSymbol
+            )
+          end
+          attr_accessor :document_type
+
+          # The UTC timestamp when this document was uploaded.
+          sig { returns(Time) }
+          attr_accessor :uploaded_at
+
+          sig do
+            params(
+              document_id: String,
+              document_name: String,
+              document_size: Integer,
+              document_type:
+                Straddle::Models::ChargeUnmaskResponse::Data::Document::DocumentType::OrSymbol,
+              uploaded_at: Time
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Unique identifier for this document.
+            document_id:,
+            # The file name of this document as uploaded.
+            document_name:,
+            # The size of this document in bytes.
+            document_size:,
+            document_type:,
+            # The UTC timestamp when this document was uploaded.
+            uploaded_at:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                document_id: String,
+                document_name: String,
+                document_size: Integer,
+                document_type:
+                  Straddle::Models::ChargeUnmaskResponse::Data::Document::DocumentType::TaggedSymbol,
+                uploaded_at: Time
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module DocumentType
+            extend Straddle::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Straddle::Models::ChargeUnmaskResponse::Data::Document::DocumentType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PAYMENT_AUTHORIZATION =
+              T.let(
+                :payment_authorization,
+                Straddle::Models::ChargeUnmaskResponse::Data::Document::DocumentType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::Models::ChargeUnmaskResponse::Data::Document::DocumentType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         # The payment rail used for the charge or payout.
         module PaymentRail
           extend Straddle::Internal::Type::Enum
@@ -1024,6 +1279,141 @@ module Straddle
           def self.values
           end
         end
+
+        class RelatedPayment < Straddle::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Straddle::Models::ChargeUnmaskResponse::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::Models::ChargeUnmaskResponse::Data::RelatedPayment::PaymentType::TaggedSymbol
+            )
+          end
+          attr_accessor :payment_type
+
+          sig do
+            returns(
+              Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::Relationship::TaggedSymbol
+            )
+          end
+          attr_accessor :relationship
+
+          sig do
+            params(
+              id: String,
+              payment_type:
+                Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::PaymentType::OrSymbol,
+              relationship:
+                Straddle::Models::ChargeUnmaskResponse::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::Models::ChargeUnmaskResponse::Data::RelatedPayment::PaymentType::TaggedSymbol,
+                relationship:
+                  Straddle::Models::ChargeUnmaskResponse::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::Models::ChargeUnmaskResponse::Data::RelatedPayment::PaymentType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CHARGE =
+              T.let(
+                :charge,
+                Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::PaymentType::TaggedSymbol
+              )
+            PAYOUT =
+              T.let(
+                :payout,
+                Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::PaymentType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::Models::ChargeUnmaskResponse::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::Models::ChargeUnmaskResponse::Data::RelatedPayment::Relationship
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ORIGINAL =
+              T.let(
+                :original,
+                Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::Relationship::TaggedSymbol
+              )
+            RESUBMIT =
+              T.let(
+                :resubmit,
+                Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::Relationship::TaggedSymbol
+              )
+            REFUND =
+              T.let(
+                :refund,
+                Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::Relationship::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::Relationship::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          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,