straddle 0.4.0 → 0.5.0

data/rbi/straddle/models/payout_v1.rbi

@@ -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
@@ -149,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)) }
@@ -188,14 +205,7 @@ module Straddle
 
         # Related payments.
         sig do
-          returns(
-            T.nilable(
-              T::Hash[
-                Symbol,
-                Straddle::PayoutV1::Data::RelatedPayment::TaggedSymbol
-              ]
-            )
-          )
+          returns(T.nilable(T::Array[Straddle::PayoutV1::Data::RelatedPayment]))
         end
         attr_accessor :related_payments
 
@@ -213,6 +223,9 @@ module Straddle
             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,
@@ -222,6 +235,8 @@ module Straddle
             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,
@@ -229,10 +244,7 @@ module Straddle
             processed_at: T.nilable(Time),
             related_payments:
               T.nilable(
-                T::Hash[
-                  Symbol,
-                  Straddle::PayoutV1::Data::RelatedPayment::OrSymbol
-                ]
+                T::Array[Straddle::PayoutV1::Data::RelatedPayment::OrHash]
               ),
             updated_at: T.nilable(Time)
           ).returns(T.attached_class)
@@ -255,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
@@ -272,6 +290,9 @@ module Straddle
           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,
@@ -303,6 +324,9 @@ module Straddle
               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,
@@ -311,18 +335,15 @@ module Straddle
               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::Hash[
-                    Symbol,
-                    Straddle::PayoutV1::Data::RelatedPayment::TaggedSymbol
-                  ]
-                ),
+                T.nilable(T::Array[Straddle::PayoutV1::Data::RelatedPayment]),
               updated_at: T.nilable(Time)
             }
           )
@@ -462,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(
@@ -877,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
@@ -898,37 +1026,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::PayoutV1::Data::RelatedPayment)
+              T.any(
+                Straddle::PayoutV1::Data::RelatedPayment,
+                Straddle::Internal::AnyHash
+              )
             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
+          # 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
             )
-          REFUND =
-            T.let(
-              :refund,
-              Straddle::PayoutV1::Data::RelatedPayment::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(
-              T::Array[Straddle::PayoutV1::Data::RelatedPayment::TaggedSymbol]
+              {
+                id: String,
+                payment_type:
+                  Straddle::PayoutV1::Data::RelatedPayment::PaymentType::TaggedSymbol,
+                relationship:
+                  Straddle::PayoutV1::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::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

data/rbi/straddle/models.rbi

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

data/rbi/straddle/resources/embed/accounts.rbi

@@ -107,6 +107,7 @@ module Straddle
         # filtering options.
         sig do
           params(
+            external_id: String,
             page_number: Integer,
             page_size: Integer,
             search_text: String,
@@ -124,6 +125,8 @@ module Straddle
           )
         end
         def list(
+          # Query param
+          external_id: nil,
           # Query param: Results page number. Starts at page 1. Default value: 1
           page_number: nil,
           # Query param: Page size. Default value: 100. Max value: 1000

data/rbi/straddle/resources/paykeys.rbi

@@ -20,6 +20,8 @@ module Straddle
       # supports advanced sorting and filtering options.
       sig do
         params(
+          created_from: Time,
+          created_to: Time,
           customer_id: String,
           page_number: Integer,
           page_size: Integer,
@@ -40,6 +42,10 @@ module Straddle
         )
       end
       def list(
+        # Query param: Start date for filtering by creation date.
+        created_from: nil,
+        # Query param: End date for filtering by creation date.
+        created_to: nil,
         # Query param: Filter paykeys by related customer ID.
         customer_id: nil,
         # Query param: Page number for paginated results. Starts at 1.

data/rbi/straddle/resources/payments.rbi

@@ -16,15 +16,21 @@ module Straddle
             Straddle::PaymentListParams::DefaultSortOrder::OrSymbol,
           external_id: String,
           funding_id: String,
+          has_refund: T::Boolean,
+          has_resubmit: T::Boolean,
           include_metadata: T::Boolean,
+          is_refund: T::Boolean,
+          is_resubmit: T::Boolean,
           max_amount: Integer,
           max_created_at: Time,
           max_effective_at: Time,
           max_payment_date: Date,
+          max_updated_at: Time,
           min_amount: Integer,
           min_created_at: Time,
           min_effective_at: Time,
           min_payment_date: Date,
+          min_updated_at: Time,
           page_number: Integer,
           page_size: Integer,
           paykey: String,
@@ -64,8 +70,18 @@ module Straddle
         external_id: nil,
         # Query param: Search using the `funding_id` of a `charge` or `payout`.
         funding_id: nil,
+        # Query param: Has the payment been refunded by an associated payout (only
+        # applicable to charges).
+        has_refund: nil,
+        # Query param: Has the payment been resubmitted.
+        has_resubmit: nil,
         # Query param: Include the metadata for payments in the returned data.
         include_metadata: nil,
+        # Query param: Is the payment a refund of an original charge (only applicable to
+        # payouts).
+        is_refund: nil,
+        # Query param: Is the payment a resubmit of an original payment.
+        is_resubmit: nil,
         # Query param: Search using a maximum `amount` of a `charge` or `payout`.
         max_amount: nil,
         # Query param: Search using the latest `created_at` date of a `charge` or
@@ -75,6 +91,8 @@ module Straddle
         max_effective_at: nil,
         # Query param: Search using the latest `payment_date` of a `charge` or `payout`.
         max_payment_date: nil,
+        # Query param: Filter to payments last updated on or before this timestamp.
+        max_updated_at: nil,
         # Query param: Search using the minimum `amount of a `charge`or`payout`.
         min_amount: nil,
         # Query param: Search using the earliest `created_at` date of a `charge` or
@@ -85,6 +103,8 @@ module Straddle
         min_effective_at: nil,
         # Query param: Search using the earliest ` `of a `charge` or `payout`.
         min_payment_date: nil,
+        # Query param: Filter to payments last updated on or after this timestamp.
+        min_updated_at: nil,
         # Query param: Results page number. Starts at page 1.
         page_number: nil,
         # Query param: Results page size. Max value: 1000

data/rbi/straddle/resources/payouts.rbi

@@ -247,6 +247,39 @@ module Straddle
       )
       end
 
+      # Uploads a document as proof of authorization for a payout. Uploading again adds
+      # another entry to documents rather than replacing the previous one.
+      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(Straddle::PayoutV1)
+      end
+      def upload_authorization_document(
+        # Path param
+        id,
+        # Body param: The document file to upload as proof of authorization for this
+        # payout.
+        file:,
+        # Header param: Optional client generated identifier to trace and debug a series
+        # of requests.
+        correlation_id: nil,
+        # Header param: Optional client generated value to use for idempotent requests.
+        idempotency_key: nil,
+        # Header param: Optional client generated identifier to trace and debug a request.
+        request_id: nil,
+        # Header param: For use by platforms to specify an account id and set scope of a
+        # request.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Straddle::Client).returns(T.attached_class) }
       def self.new(client:)

data/sig/straddle/internal/util.rbs

@@ -45,8 +45,12 @@ module Straddle
         -> top?
       } -> top?
 
+      RFC_3986_NOT_PCHARS: Regexp
+
       def self?.uri_origin: (URI::Generic uri) -> String
 
+      def self?.encode_path: (String | Integer path) -> String
+
       def self?.interpolate_path: (String | ::Array[String] path) -> String
 
       def self?.decode_query: (String? query) -> ::Hash[String, ::Array[String]]

data/sig/straddle/models/charge_create_params.rbs

@@ -154,6 +154,8 @@ module Straddle
           | :reversed_customer_dispute
           | :failed_closed_bank_account
           | :reversed_closed_bank_account
+          | :failed_not_authorized
+          | :reversed_not_authorized
 
         module SandboxOutcome
           extend Straddle::Internal::Type::Enum
@@ -169,6 +171,8 @@ module Straddle
           REVERSED_CUSTOMER_DISPUTE: :reversed_customer_dispute
           FAILED_CLOSED_BANK_ACCOUNT: :failed_closed_bank_account
           REVERSED_CLOSED_BANK_ACCOUNT: :reversed_closed_bank_account
+          FAILED_NOT_AUTHORIZED: :failed_not_authorized
+          REVERSED_NOT_AUTHORIZED: :reversed_not_authorized
 
           def self?.values: -> ::Array[Straddle::Models::ChargeCreateParams::Config::sandbox_outcome]
         end