straddle 0.4.0 → 0.5.0

data/rbi/straddle/models/payout_unmask_response.rbi

@@ -129,6 +129,18 @@ module Straddle
         sig { returns(T::Array[String]) }
         attr_accessor :funding_ids
 
+        # Has the payout been resubmitted.
+        sig { returns(T::Boolean) }
+        attr_accessor :has_resubmit
+
+        # Is the payout a refund of an original charge.
+        sig { returns(T::Boolean) }
+        attr_accessor :is_refund
+
+        # Is the payout a resubmit of an original payout.
+        sig { returns(T::Boolean) }
+        attr_accessor :is_resubmit
+
         # Paykey.
         sig { returns(String) }
         attr_accessor :paykey
@@ -178,6 +190,17 @@ module Straddle
         end
         attr_writer :customer_details
 
+        # Documents uploaded for this payout (e.g. proof of authorization), in the order
+        # they were uploaded.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Straddle::Models::PayoutUnmaskResponse::Data::Document]
+            )
+          )
+        end
+        attr_accessor :documents
+
         # Effective at.
         sig { returns(T.nilable(Time)) }
         attr_accessor :effective_at
@@ -218,9 +241,8 @@ module Straddle
         sig do
           returns(
             T.nilable(
-              T::Hash[
-                Symbol,
-                Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::TaggedSymbol
+              T::Array[
+                Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment
               ]
             )
           )
@@ -243,6 +265,9 @@ module Straddle
               Straddle::Models::PayoutUnmaskResponse::Data::Device::OrHash,
             external_id: String,
             funding_ids: T::Array[String],
+            has_resubmit: T::Boolean,
+            is_refund: T::Boolean,
+            is_resubmit: T::Boolean,
             paykey: String,
             payment_date: Date,
             status:
@@ -255,6 +280,12 @@ module Straddle
             trace_ids: T::Hash[Symbol, String],
             created_at: T.nilable(Time),
             customer_details: Straddle::CustomerDetailsV1::OrHash,
+            documents:
+              T.nilable(
+                T::Array[
+                  Straddle::Models::PayoutUnmaskResponse::Data::Document::OrHash
+                ]
+              ),
             effective_at: T.nilable(Time),
             metadata: T.nilable(T::Hash[Symbol, String]),
             paykey_details: Straddle::PaykeyDetailsV1::OrHash,
@@ -263,9 +294,8 @@ module Straddle
             processed_at: T.nilable(Time),
             related_payments:
               T.nilable(
-                T::Hash[
-                  Symbol,
-                  Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::OrSymbol
+                T::Array[
+                  Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::OrHash
                 ]
               ),
             updated_at: T.nilable(Time)
@@ -286,6 +316,12 @@ module Straddle
           external_id:,
           # Funding Ids
           funding_ids:,
+          # Has the payout been resubmitted.
+          has_resubmit:,
+          # Is the payout a refund of an original charge.
+          is_refund:,
+          # Is the payout a resubmit of an original payout.
+          is_resubmit:,
           # Paykey.
           paykey:,
           # Payment date.
@@ -301,6 +337,9 @@ module Straddle
           created_at: nil,
           # Information about the customer associated with the charge or payout.
           customer_details: nil,
+          # Documents uploaded for this payout (e.g. proof of authorization), in the order
+          # they were uploaded.
+          documents: nil,
           # Effective at.
           effective_at: nil,
           # Metadata.
@@ -328,6 +367,9 @@ module Straddle
               device: Straddle::Models::PayoutUnmaskResponse::Data::Device,
               external_id: String,
               funding_ids: T::Array[String],
+              has_resubmit: T::Boolean,
+              is_refund: T::Boolean,
+              is_resubmit: T::Boolean,
               paykey: String,
               payment_date: Date,
               status:
@@ -340,6 +382,12 @@ module Straddle
               trace_ids: T::Hash[Symbol, String],
               created_at: T.nilable(Time),
               customer_details: Straddle::CustomerDetailsV1,
+              documents:
+                T.nilable(
+                  T::Array[
+                    Straddle::Models::PayoutUnmaskResponse::Data::Document
+                  ]
+                ),
               effective_at: T.nilable(Time),
               metadata: T.nilable(T::Hash[Symbol, String]),
               paykey_details: Straddle::PaykeyDetailsV1,
@@ -348,9 +396,8 @@ module Straddle
               processed_at: T.nilable(Time),
               related_payments:
                 T.nilable(
-                  T::Hash[
-                    Symbol,
-                    Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::TaggedSymbol
+                  T::Array[
+                    Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment
                   ]
                 ),
               updated_at: T.nilable(Time)
@@ -494,6 +541,16 @@ module Straddle
                 :reversed_closed_bank_account,
                 Straddle::Models::PayoutUnmaskResponse::Data::Config::SandboxOutcome::TaggedSymbol
               )
+            FAILED_NOT_AUTHORIZED =
+              T.let(
+                :failed_not_authorized,
+                Straddle::Models::PayoutUnmaskResponse::Data::Config::SandboxOutcome::TaggedSymbol
+              )
+            REVERSED_NOT_AUTHORIZED =
+              T.let(
+                :reversed_not_authorized,
+                Straddle::Models::PayoutUnmaskResponse::Data::Config::SandboxOutcome::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -981,6 +1038,106 @@ module Straddle
           end
         end
 
+        class Document < Straddle::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Straddle::Models::PayoutUnmaskResponse::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::PayoutUnmaskResponse::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::PayoutUnmaskResponse::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::PayoutUnmaskResponse::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::PayoutUnmaskResponse::Data::Document::DocumentType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PAYMENT_AUTHORIZATION =
+              T.let(
+                :payment_authorization,
+                Straddle::Models::PayoutUnmaskResponse::Data::Document::DocumentType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::Models::PayoutUnmaskResponse::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
@@ -1011,42 +1168,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::Models::PayoutUnmaskResponse::Data::RelatedPayment
+              T.any(
+                Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment,
+                Straddle::Internal::AnyHash
               )
             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
+          # The ID of the related payment.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The type of payment.
+          sig do
+            returns(
+              Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::PaymentType::TaggedSymbol
             )
-          REFUND =
-            T.let(
-              :refund,
-              Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::TaggedSymbol
+          end
+          attr_accessor :payment_type
+
+          sig do
+            returns(
+              Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::Relationship::TaggedSymbol
             )
+          end
+          attr_accessor :relationship
+
+          sig do
+            params(
+              id: String,
+              payment_type:
+                Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::PaymentType::OrSymbol,
+              relationship:
+                Straddle::Models::PayoutUnmaskResponse::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::Models::PayoutUnmaskResponse::Data::RelatedPayment::TaggedSymbol
-              ]
+              {
+                id: String,
+                payment_type:
+                  Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::PaymentType::TaggedSymbol,
+                relationship:
+                  Straddle::Models::PayoutUnmaskResponse::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::Models::PayoutUnmaskResponse::Data::RelatedPayment::PaymentType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CHARGE =
+              T.let(
+                :charge,
+                Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::PaymentType::TaggedSymbol
+              )
+            PAYOUT =
+              T.let(
+                :payout,
+                Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::PaymentType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::Models::PayoutUnmaskResponse::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::PayoutUnmaskResponse::Data::RelatedPayment::Relationship
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ORIGINAL =
+              T.let(
+                :original,
+                Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::Relationship::TaggedSymbol
+              )
+            RESUBMIT =
+              T.let(
+                :resubmit,
+                Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::Relationship::TaggedSymbol
+              )
+            REFUND =
+              T.let(
+                :refund,
+                Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::Relationship::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::Relationship::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
           end
         end
       end

data/rbi/straddle/models/payout_upload_authorization_document_params.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class PayoutUploadAuthorizationDocumentParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::PayoutUploadAuthorizationDocumentParams,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The document file to upload as proof of authorization for this payout.
+      sig { returns(Straddle::Internal::FileInput) }
+      attr_accessor :file
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :correlation_id
+
+      sig { params(correlation_id: String).void }
+      attr_writer :correlation_id
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :request_id
+
+      sig { params(request_id: String).void }
+      attr_writer :request_id
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :straddle_account_id
+
+      sig { params(straddle_account_id: String).void }
+      attr_writer :straddle_account_id
+
+      sig do
+        params(
+          id: String,
+          file: Straddle::Internal::FileInput,
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # The document file to upload as proof of authorization for this payout.
+        file:,
+        correlation_id: nil,
+        idempotency_key: nil,
+        request_id: nil,
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            file: Straddle::Internal::FileInput,
+            correlation_id: String,
+            idempotency_key: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end