straddle 0.3.0 → 0.5.0

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

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.
@@ -108,6 +108,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
+
         # Value of the `paykey` used for the payout.
         sig { returns(String) }
         attr_accessor :paykey
@@ -132,6 +144,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
@@ -145,6 +161,11 @@ module Straddle
         end
         attr_writer :customer_details
 
+        # Documents uploaded for this payout (e.g. proof of authorization), in the order
+        # they were uploaded.
+        sig { returns(T.nilable(T::Array[Straddle::PayoutV1::Data::Document])) }
+        attr_accessor :documents
+
         # The actual date on which the payment occurred. For payouts, this is the date the
         # funds were sent from your bank account.
         sig { returns(T.nilable(Time)) }
@@ -182,6 +203,12 @@ module Straddle
         sig { returns(T.nilable(Time)) }
         attr_accessor :processed_at
 
+        # Related payments.
+        sig do
+          returns(T.nilable(T::Array[Straddle::PayoutV1::Data::RelatedPayment]))
+        end
+        attr_accessor :related_payments
+
         # The time the payout was last updated.
         sig { returns(T.nilable(Time)) }
         attr_accessor :updated_at
@@ -192,23 +219,33 @@ 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],
+            has_resubmit: T::Boolean,
+            is_refund: T::Boolean,
+            is_resubmit: T::Boolean,
             paykey: String,
             payment_date: Date,
             status: Straddle::PayoutV1::Data::Status::OrSymbol,
             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,
+            documents:
+              T.nilable(T::Array[Straddle::PayoutV1::Data::Document::OrHash]),
             effective_at: T.nilable(Time),
             metadata: T.nilable(T::Hash[Symbol, String]),
             paykey_details: Straddle::PaykeyDetailsV1::OrHash,
             payment_rail: Straddle::PayoutV1::Data::PaymentRail::OrSymbol,
             processed_at: T.nilable(Time),
+            related_payments:
+              T.nilable(
+                T::Array[Straddle::PayoutV1::Data::RelatedPayment::OrHash]
+              ),
             updated_at: T.nilable(Time)
           ).returns(T.attached_class)
         end
@@ -230,6 +267,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:,
           # Value of the `paykey` used for the payout.
           paykey:,
           # The desired date on which the payment should be occur. For payouts, this means
@@ -241,10 +284,15 @@ 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.
           customer_details: nil,
+          # Documents uploaded for this payout (e.g. proof of authorization), in the order
+          # they were uploaded.
+          documents: nil,
           # The actual date on which the payment occurred. For payouts, this is the date the
           # funds were sent from your bank account.
           effective_at: nil,
@@ -258,6 +306,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,22 +320,30 @@ 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],
+              has_resubmit: T::Boolean,
+              is_refund: T::Boolean,
+              is_resubmit: T::Boolean,
               paykey: String,
               payment_date: Date,
               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,
+              documents:
+                T.nilable(T::Array[Straddle::PayoutV1::Data::Document]),
               effective_at: T.nilable(Time),
               metadata: T.nilable(T::Hash[Symbol, String]),
               paykey_details: Straddle::PaykeyDetailsV1,
               payment_rail: Straddle::PayoutV1::Data::PaymentRail::TaggedSymbol,
               processed_at: T.nilable(Time),
+              related_payments:
+                T.nilable(T::Array[Straddle::PayoutV1::Data::RelatedPayment]),
               updated_at: T.nilable(Time)
             }
           )
@@ -302,6 +360,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 +389,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 +408,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
               }
@@ -409,6 +483,16 @@ module Straddle
                 :reversed_closed_bank_account,
                 Straddle::PayoutV1::Data::Config::SandboxOutcome::TaggedSymbol
               )
+            FAILED_NOT_AUTHORIZED =
+              T.let(
+                :failed_not_authorized,
+                Straddle::PayoutV1::Data::Config::SandboxOutcome::TaggedSymbol
+              )
+            REVERSED_NOT_AUTHORIZED =
+              T.let(
+                :reversed_not_authorized,
+                Straddle::PayoutV1::Data::Config::SandboxOutcome::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -445,6 +529,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 +745,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 +890,11 @@ module Straddle
                 :reversed,
                 Straddle::PayoutV1::Data::StatusHistory::Status::TaggedSymbol
               )
+            VALIDATING =
+              T.let(
+                :validating,
+                Straddle::PayoutV1::Data::StatusHistory::Status::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -782,6 +908,103 @@ module Straddle
           end
         end
 
+        class Document < Straddle::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Straddle::PayoutV1::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::PayoutV1::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::PayoutV1::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::PayoutV1::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::PayoutV1::Data::Document::DocumentType)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PAYMENT_AUTHORIZATION =
+              T.let(
+                :payment_authorization,
+                Straddle::PayoutV1::Data::Document::DocumentType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::PayoutV1::Data::Document::DocumentType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         # The payment rail used for the payout.
         module PaymentRail
           extend Straddle::Internal::Type::Enum
@@ -802,6 +1025,141 @@ module Straddle
           def self.values
           end
         end
+
+        class RelatedPayment < Straddle::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Straddle::PayoutV1::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::PayoutV1::Data::RelatedPayment::PaymentType::TaggedSymbol
+            )
+          end
+          attr_accessor :payment_type
+
+          sig do
+            returns(
+              Straddle::PayoutV1::Data::RelatedPayment::Relationship::TaggedSymbol
+            )
+          end
+          attr_accessor :relationship
+
+          sig do
+            params(
+              id: String,
+              payment_type:
+                Straddle::PayoutV1::Data::RelatedPayment::PaymentType::OrSymbol,
+              relationship:
+                Straddle::PayoutV1::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::PayoutV1::Data::RelatedPayment::PaymentType::TaggedSymbol,
+                relationship:
+                  Straddle::PayoutV1::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::PayoutV1::Data::RelatedPayment::PaymentType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CHARGE =
+              T.let(
+                :charge,
+                Straddle::PayoutV1::Data::RelatedPayment::PaymentType::TaggedSymbol
+              )
+            PAYOUT =
+              T.let(
+                :payout,
+                Straddle::PayoutV1::Data::RelatedPayment::PaymentType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::PayoutV1::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::PayoutV1::Data::RelatedPayment::Relationship
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ORIGINAL =
+              T.let(
+                :original,
+                Straddle::PayoutV1::Data::RelatedPayment::Relationship::TaggedSymbol
+              )
+            RESUBMIT =
+              T.let(
+                :resubmit,
+                Straddle::PayoutV1::Data::RelatedPayment::Relationship::TaggedSymbol
+              )
+            REFUND =
+              T.let(
+                :refund,
+                Straddle::PayoutV1::Data::RelatedPayment::Relationship::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::PayoutV1::Data::RelatedPayment::Relationship::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          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

@@ -103,6 +103,9 @@ module Straddle
 
   PayoutUpdateParams = Straddle::Models::PayoutUpdateParams
 
+  PayoutUploadAuthorizationDocumentParams =
+    Straddle::Models::PayoutUploadAuthorizationDocumentParams
+
   PayoutV1 = Straddle::Models::PayoutV1
 
   ReportCreateTotalCustomersByStatusParams =