straddle 0.1.1 → 0.3.0

data/rbi/straddle/models/paykeys/review_refresh_review_params.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Paykeys
+      class ReviewRefreshReviewParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Paykeys::ReviewRefreshReviewParams,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        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(
+            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(
+          correlation_id: nil,
+          idempotency_key: nil,
+          request_id: nil,
+          straddle_account_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              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
+end

data/rbi/straddle/models/payment_summary_paged_v1.rbi

@@ -132,6 +132,10 @@ module Straddle
         sig { params(status_details: Straddle::StatusDetailsV1::OrHash).void }
         attr_writer :status_details
 
+        # Trace ids.
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :trace_ids
+
         # The time the `charge` or `payout` was last updated.
         sig { returns(Time) }
         attr_accessor :updated_at
@@ -178,6 +182,7 @@ module Straddle
               Straddle::PaymentSummaryPagedV1::Data::PaymentType::OrSymbol,
             status: Straddle::PaymentSummaryPagedV1::Data::Status::OrSymbol,
             status_details: Straddle::StatusDetailsV1::OrHash,
+            trace_ids: T::Hash[Symbol, String],
             updated_at: Time,
             customer_details: Straddle::CustomerDetailsV1::OrHash,
             effective_at: T.nilable(Time),
@@ -213,6 +218,8 @@ module Straddle
           status:,
           # Details about the current status of the `charge` or `payout`.
           status_details:,
+          # Trace ids.
+          trace_ids:,
           # The time the `charge` or `payout` was last updated.
           updated_at:,
           # Information about the customer associated with the charge or payout.
@@ -246,6 +253,7 @@ module Straddle
               status:
                 Straddle::PaymentSummaryPagedV1::Data::Status::TaggedSymbol,
               status_details: Straddle::StatusDetailsV1,
+              trace_ids: T::Hash[Symbol, String],
               updated_at: Time,
               customer_details: Straddle::CustomerDetailsV1,
               effective_at: T.nilable(Time),

data/rbi/straddle/models/payout_cancel_params.rbi

@@ -21,6 +21,12 @@ module Straddle
       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
 
@@ -37,6 +43,7 @@ module Straddle
         params(
           reason: String,
           correlation_id: String,
+          idempotency_key: String,
           request_id: String,
           straddle_account_id: String,
           request_options: Straddle::RequestOptions::OrHash
@@ -46,6 +53,7 @@ module Straddle
         # Details about why the payout status was updated.
         reason:,
         correlation_id: nil,
+        idempotency_key: nil,
         request_id: nil,
         straddle_account_id: nil,
         request_options: {}
@@ -57,6 +65,7 @@ module Straddle
           {
             reason: String,
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions

data/rbi/straddle/models/payout_create_params.rbi

@@ -61,6 +61,12 @@ module Straddle
       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
 
@@ -85,6 +91,7 @@ module Straddle
           config: Straddle::PayoutCreateParams::Config::OrHash,
           metadata: T.nilable(T::Hash[Symbol, String]),
           correlation_id: String,
+          idempotency_key: String,
           request_id: String,
           straddle_account_id: String,
           request_options: Straddle::RequestOptions::OrHash
@@ -112,6 +119,7 @@ module Straddle
         # information about the payout in a structured format.
         metadata: nil,
         correlation_id: nil,
+        idempotency_key: nil,
         request_id: nil,
         straddle_account_id: nil,
         request_options: {}
@@ -131,6 +139,7 @@ module Straddle
             config: Straddle::PayoutCreateParams::Config,
             metadata: T.nilable(T::Hash[Symbol, String]),
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions

data/rbi/straddle/models/payout_hold_params.rbi

@@ -21,6 +21,12 @@ module Straddle
       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
 
@@ -37,6 +43,7 @@ module Straddle
         params(
           reason: String,
           correlation_id: String,
+          idempotency_key: String,
           request_id: String,
           straddle_account_id: String,
           request_options: Straddle::RequestOptions::OrHash
@@ -46,6 +53,7 @@ module Straddle
         # Details about why the payout status was updated.
         reason:,
         correlation_id: nil,
+        idempotency_key: nil,
         request_id: nil,
         straddle_account_id: nil,
         request_options: {}
@@ -57,6 +65,7 @@ module Straddle
           {
             reason: String,
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions

data/rbi/straddle/models/payout_release_params.rbi

@@ -21,6 +21,12 @@ module Straddle
       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
 
@@ -37,6 +43,7 @@ module Straddle
         params(
           reason: String,
           correlation_id: String,
+          idempotency_key: String,
           request_id: String,
           straddle_account_id: String,
           request_options: Straddle::RequestOptions::OrHash
@@ -46,6 +53,7 @@ module Straddle
         # Details about why the payout status was updated.
         reason:,
         correlation_id: nil,
+        idempotency_key: nil,
         request_id: nil,
         straddle_account_id: nil,
         request_options: {}
@@ -57,6 +65,7 @@ module Straddle
           {
             reason: String,
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions

data/rbi/straddle/models/payout_update_params.rbi

@@ -35,6 +35,12 @@ module Straddle
       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
 
@@ -54,6 +60,7 @@ module Straddle
           payment_date: Date,
           metadata: T.nilable(T::Hash[Symbol, String]),
           correlation_id: String,
+          idempotency_key: String,
           request_id: String,
           straddle_account_id: String,
           request_options: Straddle::RequestOptions::OrHash
@@ -71,6 +78,7 @@ module Straddle
         # information about the payout in a structured format.
         metadata: nil,
         correlation_id: nil,
+        idempotency_key: nil,
         request_id: nil,
         straddle_account_id: nil,
         request_options: {}
@@ -85,6 +93,7 @@ module Straddle
             payment_date: Date,
             metadata: T.nilable(T::Hash[Symbol, String]),
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions

data/rbi/straddle/models.rbi

@@ -35,8 +35,6 @@ module Straddle
 
   CustomerListParams = Straddle::Models::CustomerListParams
 
-  CustomerRefreshReviewParams = Straddle::Models::CustomerRefreshReviewParams
-
   Customers = Straddle::Models::Customers
 
   CustomerSummaryPagedV1 = Straddle::Models::CustomerSummaryPagedV1
@@ -75,12 +73,16 @@ module Straddle
 
   PaykeyRevealParams = Straddle::Models::PaykeyRevealParams
 
+  Paykeys = Straddle::Models::Paykeys
+
   PaykeySummaryPagedV1 = Straddle::Models::PaykeySummaryPagedV1
 
   PaykeyUnmaskedParams = Straddle::Models::PaykeyUnmaskedParams
 
   PaykeyUnmaskedV1 = Straddle::Models::PaykeyUnmaskedV1
 
+  PaykeyUpdateBalanceParams = Straddle::Models::PaykeyUpdateBalanceParams
+
   PaykeyV1 = Straddle::Models::PaykeyV1
 
   PaymentListParams = Straddle::Models::PaymentListParams

data/rbi/straddle/resources/bridge/link.rbi

@@ -15,8 +15,10 @@ module Straddle
             customer_id: String,
             routing_number: String,
             config: Straddle::Bridge::LinkBankAccountParams::Config::OrHash,
+            external_id: T.nilable(String),
             metadata: T.nilable(T::Hash[Symbol, String]),
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions::OrHash
@@ -33,12 +35,17 @@ module Straddle
           routing_number:,
           # Body param:
           config: nil,
+          # Body param: Unique identifier for the paykey in your database, used for
+          # cross-referencing between Straddle and your systems.
+          external_id: nil,
           # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
           # additional information about the paykey in a structured format.
           metadata: nil,
           # 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
@@ -56,8 +63,10 @@ module Straddle
             customer_id: String,
             quiltt_token: String,
             config: Straddle::Bridge::LinkCreatePaykeyParams::Config::OrHash,
+            external_id: T.nilable(String),
             metadata: T.nilable(T::Hash[Symbol, String]),
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions::OrHash
@@ -71,12 +80,17 @@ module Straddle
           quiltt_token:,
           # Body param:
           config: nil,
+          # Body param: Unique identifier for the paykey in your database, used for
+          # cross-referencing between Straddle and your systems.
+          external_id: nil,
           # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
           # additional information about the paykey in a structured format.
           metadata: nil,
           # 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
@@ -94,8 +108,10 @@ module Straddle
             routing_number: String,
             tan: String,
             config: Straddle::Bridge::LinkCreateTanParams::Config::OrHash,
+            external_id: T.nilable(String),
             metadata: T.nilable(T::Hash[Symbol, String]),
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions::OrHash
@@ -112,12 +128,17 @@ module Straddle
           tan:,
           # Body param:
           config: nil,
+          # Body param: Unique identifier for the paykey in your database, used for
+          # cross-referencing between Straddle and your systems.
+          external_id: nil,
           # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
           # additional information about the paykey in a structured format.
           metadata: nil,
           # 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
@@ -135,8 +156,10 @@ module Straddle
             customer_id: String,
             plaid_token: String,
             config: Straddle::Bridge::LinkPlaidParams::Config::OrHash,
+            external_id: T.nilable(String),
             metadata: T.nilable(T::Hash[Symbol, String]),
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions::OrHash
@@ -150,12 +173,17 @@ module Straddle
           plaid_token:,
           # Body param:
           config: nil,
+          # Body param: Unique identifier for the paykey in your database, used for
+          # cross-referencing between Straddle and your systems.
+          external_id: nil,
           # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
           # additional information about the paykey in a structured format.
           metadata: nil,
           # 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

data/rbi/straddle/resources/bridge.rbi

@@ -11,7 +11,9 @@ module Straddle
         params(
           customer_id: String,
           config: Straddle::BridgeInitializeParams::Config::OrHash,
+          external_id: T.nilable(String),
           correlation_id: String,
+          idempotency_key: String,
           request_id: String,
           straddle_account_id: String,
           request_options: Straddle::RequestOptions::OrHash
@@ -23,9 +25,14 @@ module Straddle
         customer_id:,
         # Body param:
         config: nil,
+        # Body param: Unique identifier for the paykey in your database, used for
+        # cross-referencing between Straddle and your systems.
+        external_id: nil,
         # 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

data/rbi/straddle/resources/charges.rbi

@@ -17,6 +17,7 @@ module Straddle
           payment_date: Date,
           metadata: T.nilable(T::Hash[Symbol, String]),
           correlation_id: String,
+          idempotency_key: String,
           request_id: String,
           straddle_account_id: String,
           request_options: Straddle::RequestOptions::OrHash
@@ -52,6 +53,8 @@ module Straddle
         # 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
@@ -71,6 +74,7 @@ module Straddle
           payment_date: Date,
           metadata: T.nilable(T::Hash[Symbol, String]),
           correlation_id: String,
+          idempotency_key: String,
           request_id: String,
           straddle_account_id: String,
           request_options: Straddle::RequestOptions::OrHash
@@ -92,6 +96,8 @@ module Straddle
         # 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
@@ -108,6 +114,7 @@ module Straddle
           id: String,
           reason: T.nilable(String),
           correlation_id: String,
+          idempotency_key: String,
           request_id: String,
           straddle_account_id: String,
           request_options: Straddle::RequestOptions::OrHash
@@ -121,6 +128,8 @@ module Straddle
         # 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
@@ -160,6 +169,7 @@ module Straddle
           id: String,
           reason: T.nilable(String),
           correlation_id: String,
+          idempotency_key: String,
           request_id: String,
           straddle_account_id: String,
           request_options: Straddle::RequestOptions::OrHash
@@ -173,6 +183,8 @@ module Straddle
         # 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
@@ -189,6 +201,7 @@ module Straddle
           id: String,
           reason: T.nilable(String),
           correlation_id: String,
+          idempotency_key: String,
           request_id: String,
           straddle_account_id: String,
           request_options: Straddle::RequestOptions::OrHash
@@ -202,6 +215,8 @@ module Straddle
         # 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

data/rbi/straddle/resources/customers/review.rbi

@@ -13,6 +13,7 @@ module Straddle
             id: String,
             status: Straddle::Customers::ReviewDecisionParams::Status::OrSymbol,
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions::OrHash
@@ -26,6 +27,8 @@ module Straddle
           # 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
@@ -65,6 +68,33 @@ module Straddle
         )
         end
 
+        # Updates the decision of a customer's identity validation. This endpoint allows
+        # you to modify the outcome of a customer decision and is useful for correcting or
+        # updating the status of a customer's verification.
+        sig do
+          params(
+            id: String,
+            correlation_id: String,
+            idempotency_key: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(Straddle::CustomerV1)
+        end
+        def refresh_review(
+          id,
+          # Optional client generated identifier to trace and debug a series of requests.
+          correlation_id: nil,
+          # Optional client generated value to use for idempotent requests.
+          idempotency_key: nil,
+          # Optional client generated identifier to trace and debug a request.
+          request_id: nil,
+          # 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/rbi/straddle/resources/customers.rbi

@@ -28,6 +28,7 @@ module Straddle
           external_id: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, String]),
           correlation_id: String,
+          idempotency_key: String,
           request_id: String,
           straddle_account_id: String,
           request_options: Straddle::RequestOptions::OrHash
@@ -63,6 +64,8 @@ module Straddle
         # 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
@@ -93,6 +96,7 @@ module Straddle
           external_id: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, String]),
           correlation_id: String,
+          idempotency_key: String,
           request_id: String,
           straddle_account_id: String,
           request_options: Straddle::RequestOptions::OrHash
@@ -126,6 +130,8 @@ module Straddle
         # 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
@@ -207,6 +213,7 @@ module Straddle
         params(
           id: String,
           correlation_id: String,
+          idempotency_key: String,
           request_id: String,
           straddle_account_id: String,
           request_options: Straddle::RequestOptions::OrHash
@@ -216,6 +223,8 @@ module Straddle
         id,
         # Optional client generated identifier to trace and debug a series of requests.
         correlation_id: nil,
+        # Optional client generated value to use for idempotent requests.
+        idempotency_key: nil,
         # Optional client generated identifier to trace and debug a request.
         request_id: nil,
         # For use by platforms to specify an account id and set scope of a request.
@@ -248,30 +257,6 @@ module Straddle
       )
       end
 
-      # Updates the decision of a customer's identity validation. This endpoint allows
-      # you to modify the outcome of a customer decision and is useful for correcting or
-      # updating the status of a customer's verification.
-      sig do
-        params(
-          id: String,
-          correlation_id: String,
-          request_id: String,
-          straddle_account_id: String,
-          request_options: Straddle::RequestOptions::OrHash
-        ).returns(Straddle::CustomerV1)
-      end
-      def refresh_review(
-        id,
-        # Optional client generated identifier to trace and debug a series of requests.
-        correlation_id: nil,
-        # Optional client generated identifier to trace and debug a request.
-        request_id: nil,
-        # For use by platforms to specify an account id and set scope of a request.
-        straddle_account_id: nil,
-        request_options: {}
-      )
-      end
-
       # Retrieves the unmasked details, including PII, of an existing customer. Supply
       # the unique customer ID that was returned from your 'create customer' request,
       # and Straddle will return the corresponding customer information. This endpoint