straddle 0.4.0 → 0.5.0

data/rbi/straddle/models/charge_v1.rbi

@@ -119,6 +119,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
+
         # Value of the `paykey` used for the charge.
         sig { returns(String) }
         attr_accessor :paykey
@@ -160,6 +172,11 @@ module Straddle
         end
         attr_writer :customer_details
 
+        # Documents uploaded for this charge (e.g. proof of authorization), in the order
+        # they were uploaded.
+        sig { returns(T.nilable(T::Array[Straddle::ChargeV1::Data::Document])) }
+        attr_accessor :documents
+
         # Timestamp of when the charge was effective in the customer's bank account,
         # otherwise known as the date on which the customer is debited.
         sig { returns(T.nilable(Time)) }
@@ -199,14 +216,7 @@ module Straddle
 
         # Related payments.
         sig do
-          returns(
-            T.nilable(
-              T::Hash[
-                Symbol,
-                Straddle::ChargeV1::Data::RelatedPayment::TaggedSymbol
-              ]
-            )
-          )
+          returns(T.nilable(T::Array[Straddle::ChargeV1::Data::RelatedPayment]))
         end
         attr_accessor :related_payments
 
@@ -222,6 +232,9 @@ module Straddle
             device: Straddle::DeviceInfoV1::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: Straddle::ChargeV1::Data::Status::OrSymbol,
@@ -231,6 +244,8 @@ module Straddle
             trace_ids: T::Hash[Symbol, String],
             updated_at: T.nilable(Time),
             customer_details: Straddle::CustomerDetailsV1::OrHash,
+            documents:
+              T.nilable(T::Array[Straddle::ChargeV1::Data::Document::OrHash]),
             effective_at: T.nilable(Time),
             metadata: T.nilable(T::Hash[Symbol, String]),
             paykey_details: Straddle::PaykeyDetailsV1::OrHash,
@@ -238,10 +253,7 @@ module Straddle
             processed_at: T.nilable(Time),
             related_payments:
               T.nilable(
-                T::Hash[
-                  Symbol,
-                  Straddle::ChargeV1::Data::RelatedPayment::OrSymbol
-                ]
+                T::Array[Straddle::ChargeV1::Data::RelatedPayment::OrHash]
               )
           ).returns(T.attached_class)
         end
@@ -270,6 +282,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:,
           # Value of the `paykey` used for the charge.
           paykey:,
           # The desired date on which the payment should be occur. For charges, this means
@@ -287,6 +305,9 @@ module Straddle
           updated_at:,
           # Information about the customer associated with the charge.
           customer_details: nil,
+          # Documents uploaded for this charge (e.g. proof of authorization), in the order
+          # they were uploaded.
+          documents: nil,
           # Timestamp of when the charge was effective in the customer's bank account,
           # otherwise known as the date on which the customer is debited.
           effective_at: nil,
@@ -318,6 +339,9 @@ module Straddle
               device: Straddle::DeviceInfoV1,
               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: Straddle::ChargeV1::Data::Status::TaggedSymbol,
@@ -326,18 +350,15 @@ module Straddle
               trace_ids: T::Hash[Symbol, String],
               updated_at: T.nilable(Time),
               customer_details: Straddle::CustomerDetailsV1,
+              documents:
+                T.nilable(T::Array[Straddle::ChargeV1::Data::Document]),
               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),
               related_payments:
-                T.nilable(
-                  T::Hash[
-                    Symbol,
-                    Straddle::ChargeV1::Data::RelatedPayment::TaggedSymbol
-                  ]
-                )
+                T.nilable(T::Array[Straddle::ChargeV1::Data::RelatedPayment])
             }
           )
         end
@@ -527,6 +548,16 @@ module Straddle
                 :reversed_closed_bank_account,
                 Straddle::ChargeV1::Data::Config::SandboxOutcome::TaggedSymbol
               )
+            FAILED_NOT_AUTHORIZED =
+              T.let(
+                :failed_not_authorized,
+                Straddle::ChargeV1::Data::Config::SandboxOutcome::TaggedSymbol
+              )
+            REVERSED_NOT_AUTHORIZED =
+              T.let(
+                :reversed_not_authorized,
+                Straddle::ChargeV1::Data::Config::SandboxOutcome::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -973,6 +1004,103 @@ module Straddle
           end
         end
 
+        class Document < Straddle::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Straddle::ChargeV1::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::ChargeV1::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::ChargeV1::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::ChargeV1::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::ChargeV1::Data::Document::DocumentType)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PAYMENT_AUTHORIZATION =
+              T.let(
+                :payment_authorization,
+                Straddle::ChargeV1::Data::Document::DocumentType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::ChargeV1::Data::Document::DocumentType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         # The payment rail that the charge will be processed through.
         module PaymentRail
           extend Straddle::Internal::Type::Enum
@@ -994,37 +1122,138 @@ module Straddle
           end
         end
 
-        module RelatedPayment
-          extend Straddle::Internal::Type::Enum
-
-          TaggedSymbol =
+        class RelatedPayment < Straddle::Internal::Type::BaseModel
+          OrHash =
             T.type_alias do
-              T.all(Symbol, Straddle::ChargeV1::Data::RelatedPayment)
+              T.any(
+                Straddle::ChargeV1::Data::RelatedPayment,
+                Straddle::Internal::AnyHash
+              )
             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
+          # The ID of the related payment.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The type of payment.
+          sig do
+            returns(
+              Straddle::ChargeV1::Data::RelatedPayment::PaymentType::TaggedSymbol
             )
-          REFUND =
-            T.let(
-              :refund,
-              Straddle::ChargeV1::Data::RelatedPayment::TaggedSymbol
+          end
+          attr_accessor :payment_type
+
+          sig do
+            returns(
+              Straddle::ChargeV1::Data::RelatedPayment::Relationship::TaggedSymbol
             )
+          end
+          attr_accessor :relationship
+
+          sig do
+            params(
+              id: String,
+              payment_type:
+                Straddle::ChargeV1::Data::RelatedPayment::PaymentType::OrSymbol,
+              relationship:
+                Straddle::ChargeV1::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(
-              T::Array[Straddle::ChargeV1::Data::RelatedPayment::TaggedSymbol]
+              {
+                id: String,
+                payment_type:
+                  Straddle::ChargeV1::Data::RelatedPayment::PaymentType::TaggedSymbol,
+                relationship:
+                  Straddle::ChargeV1::Data::RelatedPayment::Relationship::TaggedSymbol
+              }
             )
           end
-          def self.values
+          def to_hash
+          end
+
+          # The type of payment.
+          module PaymentType
+            extend Straddle::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Straddle::ChargeV1::Data::RelatedPayment::PaymentType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CHARGE =
+              T.let(
+                :charge,
+                Straddle::ChargeV1::Data::RelatedPayment::PaymentType::TaggedSymbol
+              )
+            PAYOUT =
+              T.let(
+                :payout,
+                Straddle::ChargeV1::Data::RelatedPayment::PaymentType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::ChargeV1::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::ChargeV1::Data::RelatedPayment::Relationship
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ORIGINAL =
+              T.let(
+                :original,
+                Straddle::ChargeV1::Data::RelatedPayment::Relationship::TaggedSymbol
+              )
+            RESUBMIT =
+              T.let(
+                :resubmit,
+                Straddle::ChargeV1::Data::RelatedPayment::Relationship::TaggedSymbol
+              )
+            REFUND =
+              T.let(
+                :refund,
+                Straddle::ChargeV1::Data::RelatedPayment::Relationship::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::ChargeV1::Data::RelatedPayment::Relationship::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
           end
         end
       end

data/rbi/straddle/models/embed/account_list_params.rbi

@@ -15,6 +15,12 @@ module Straddle
             )
           end
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :external_id
+
+        sig { params(external_id: String).void }
+        attr_writer :external_id
+
         # Results page number. Starts at page 1. Default value: 1
         sig { returns(T.nilable(Integer)) }
         attr_reader :page_number
@@ -95,6 +101,7 @@ module Straddle
 
         sig do
           params(
+            external_id: String,
             page_number: Integer,
             page_size: Integer,
             search_text: String,
@@ -108,6 +115,7 @@ module Straddle
           ).returns(T.attached_class)
         end
         def self.new(
+          external_id: nil,
           # Results page number. Starts at page 1. Default value: 1
           page_number: nil,
           # Page size. Default value: 100. Max value: 1000
@@ -128,6 +136,7 @@ module Straddle
         sig do
           override.returns(
             {
+              external_id: String,
               page_number: Integer,
               page_size: Integer,
               search_text: String,

data/rbi/straddle/models/embed/representative.rbi

@@ -276,7 +276,7 @@ module Straddle
             sig { returns(T::Boolean) }
             attr_accessor :control
 
-            # Whether the representative owns any percentage of of the equity interests of the
+            # Whether the representative owns any percentage of the equity interests of the
             # legal entity.
             sig { returns(T::Boolean) }
             attr_accessor :owner
@@ -312,7 +312,7 @@ module Straddle
               # direct the organization. One representative must be identified under the control
               # prong for each legal entity.
               control:,
-              # Whether the representative owns any percentage of of the equity interests of the
+              # Whether the representative owns any percentage of the equity interests of the
               # legal entity.
               owner:,
               # Whether the person is authorized as the primary representative of the account.

data/rbi/straddle/models/embed/representative_create_params.rbi

@@ -171,7 +171,7 @@ module Straddle
           sig { returns(T::Boolean) }
           attr_accessor :control
 
-          # Whether the representative owns any percentage of of the equity interests of the
+          # Whether the representative owns any percentage of the equity interests of the
           # legal entity.
           sig { returns(T::Boolean) }
           attr_accessor :owner
@@ -207,7 +207,7 @@ module Straddle
             # direct the organization. One representative must be identified under the control
             # prong for each legal entity.
             control:,
-            # Whether the representative owns any percentage of of the equity interests of the
+            # Whether the representative owns any percentage of the equity interests of the
             # legal entity.
             owner:,
             # Whether the person is authorized as the primary representative of the account.

data/rbi/straddle/models/embed/representative_paged.rbi

@@ -287,7 +287,7 @@ module Straddle
             sig { returns(T::Boolean) }
             attr_accessor :control
 
-            # Whether the representative owns any percentage of of the equity interests of the
+            # Whether the representative owns any percentage of the equity interests of the
             # legal entity.
             sig { returns(T::Boolean) }
             attr_accessor :owner
@@ -323,7 +323,7 @@ module Straddle
               # direct the organization. One representative must be identified under the control
               # prong for each legal entity.
               control:,
-              # Whether the representative owns any percentage of of the equity interests of the
+              # Whether the representative owns any percentage of the equity interests of the
               # legal entity.
               owner:,
               # Whether the person is authorized as the primary representative of the account.

data/rbi/straddle/models/embed/representative_update_params.rbi

@@ -169,7 +169,7 @@ module Straddle
           sig { returns(T::Boolean) }
           attr_accessor :control
 
-          # Whether the representative owns any percentage of of the equity interests of the
+          # Whether the representative owns any percentage of the equity interests of the
           # legal entity.
           sig { returns(T::Boolean) }
           attr_accessor :owner
@@ -205,7 +205,7 @@ module Straddle
             # direct the organization. One representative must be identified under the control
             # prong for each legal entity.
             control:,
-            # Whether the representative owns any percentage of of the equity interests of the
+            # Whether the representative owns any percentage of the equity interests of the
             # legal entity.
             owner:,
             # Whether the person is authorized as the primary representative of the account.

data/rbi/straddle/models/paykey_list_params.rbi

@@ -11,6 +11,20 @@ module Straddle
           T.any(Straddle::PaykeyListParams, Straddle::Internal::AnyHash)
         end
 
+      # Start date for filtering by creation date.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_from
+
+      sig { params(created_from: Time).void }
+      attr_writer :created_from
+
+      # End date for filtering by creation date.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_to
+
+      sig { params(created_to: Time).void }
+      attr_writer :created_to
+
       # Filter paykeys by related customer ID.
       sig { returns(T.nilable(String)) }
       attr_reader :customer_id
@@ -115,6 +129,8 @@ module Straddle
 
       sig do
         params(
+          created_from: Time,
+          created_to: Time,
           customer_id: String,
           page_number: Integer,
           page_size: Integer,
@@ -131,6 +147,10 @@ module Straddle
         ).returns(T.attached_class)
       end
       def self.new(
+        # Start date for filtering by creation date.
+        created_from: nil,
+        # End date for filtering by creation date.
+        created_to: nil,
         # Filter paykeys by related customer ID.
         customer_id: nil,
         # Page number for paginated results. Starts at 1.
@@ -160,6 +180,8 @@ module Straddle
       sig do
         override.returns(
           {
+            created_from: Time,
+            created_to: Time,
             customer_id: String,
             page_number: Integer,
             page_size: Integer,