straddle 0.1.0.pre.alpha.1 → 0.2.0

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

@@ -155,6 +155,11 @@ module Straddle
           sig { returns(T.nilable(String)) }
           attr_accessor :external_id
 
+          # Up to 20 additional user-defined key-value pairs. Useful for storing additional
+          # information about the represetative in a structured format.
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_accessor :metadata
+
           sig { returns(T.nilable(String)) }
           attr_accessor :phone
 
@@ -182,6 +187,7 @@ module Straddle
                 Straddle::Embed::Representative::Data::StatusDetail::OrHash,
               updated_at: Time,
               external_id: T.nilable(String),
+              metadata: T.nilable(T::Hash[Symbol, String]),
               phone: T.nilable(String),
               user_id: T.nilable(String)
             ).returns(T.attached_class)
@@ -215,6 +221,9 @@ module Straddle
             # Unique identifier for the representative in your database, used for
             # cross-referencing between Straddle and your systems.
             external_id: nil,
+            # Up to 20 additional user-defined key-value pairs. Useful for storing additional
+            # information about the represetative in a structured format.
+            metadata: nil,
             phone: nil,
             # The unique identifier of the user account associated with this representative,
             # if applicable.
@@ -243,6 +252,7 @@ module Straddle
                   Straddle::Embed::Representative::Data::StatusDetail,
                 updated_at: Time,
                 external_id: T.nilable(String),
+                metadata: T.nilable(T::Hash[Symbol, String]),
                 phone: T.nilable(String),
                 user_id: T.nilable(String)
               }

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

@@ -61,12 +61,23 @@ module Straddle
         sig { returns(T.nilable(String)) }
         attr_accessor :external_id
 
+        # Up to 20 additional user-defined key-value pairs. Useful for storing additional
+        # information about the represetative in a structured format.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_accessor :metadata
+
         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
 
@@ -85,7 +96,9 @@ module Straddle
               Straddle::Embed::RepresentativeCreateParams::Relationship::OrHash,
             ssn_last4: String,
             external_id: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, String]),
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             request_options: Straddle::RequestOptions::OrHash
           ).returns(T.attached_class)
@@ -109,7 +122,11 @@ module Straddle
           # Unique identifier for the representative in your database, used for
           # cross-referencing between Straddle and your systems.
           external_id: nil,
+          # Up to 20 additional user-defined key-value pairs. Useful for storing additional
+          # information about the represetative in a structured format.
+          metadata: nil,
           correlation_id: nil,
+          idempotency_key: nil,
           request_id: nil,
           request_options: {}
         )
@@ -128,7 +145,9 @@ module Straddle
                 Straddle::Embed::RepresentativeCreateParams::Relationship,
               ssn_last4: String,
               external_id: T.nilable(String),
+              metadata: T.nilable(T::Hash[Symbol, String]),
               correlation_id: String,
+              idempotency_key: String,
               request_id: String,
               request_options: Straddle::RequestOptions
             }

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

@@ -165,6 +165,11 @@ module Straddle
           sig { returns(T.nilable(String)) }
           attr_accessor :external_id
 
+          # Up to 20 additional user-defined key-value pairs. Useful for storing additional
+          # information about the represetative in a structured format.
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_accessor :metadata
+
           sig { returns(T.nilable(String)) }
           attr_accessor :phone
 
@@ -193,6 +198,7 @@ module Straddle
                 Straddle::Embed::RepresentativePaged::Data::StatusDetail::OrHash,
               updated_at: Time,
               external_id: T.nilable(String),
+              metadata: T.nilable(T::Hash[Symbol, String]),
               phone: T.nilable(String),
               user_id: T.nilable(String)
             ).returns(T.attached_class)
@@ -226,6 +232,9 @@ module Straddle
             # Unique identifier for the representative in your database, used for
             # cross-referencing between Straddle and your systems.
             external_id: nil,
+            # Up to 20 additional user-defined key-value pairs. Useful for storing additional
+            # information about the represetative in a structured format.
+            metadata: nil,
             phone: nil,
             # The unique identifier of the user account associated with this representative,
             # if applicable.
@@ -254,6 +263,7 @@ module Straddle
                   Straddle::Embed::RepresentativePaged::Data::StatusDetail,
                 updated_at: Time,
                 external_id: T.nilable(String),
+                metadata: T.nilable(T::Hash[Symbol, String]),
                 phone: T.nilable(String),
                 user_id: T.nilable(String)
               }

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

@@ -57,12 +57,23 @@ module Straddle
         sig { returns(T.nilable(String)) }
         attr_accessor :external_id
 
+        # Up to 20 additional user-defined key-value pairs. Useful for storing additional
+        # information about the represetative in a structured format.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_accessor :metadata
+
         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
 
@@ -80,7 +91,9 @@ module Straddle
               Straddle::Embed::RepresentativeUpdateParams::Relationship::OrHash,
             ssn_last4: String,
             external_id: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, String]),
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             request_options: Straddle::RequestOptions::OrHash
           ).returns(T.attached_class)
@@ -102,7 +115,11 @@ module Straddle
           # Unique identifier for the representative in your database, used for
           # cross-referencing between Straddle and your systems.
           external_id: nil,
+          # Up to 20 additional user-defined key-value pairs. Useful for storing additional
+          # information about the represetative in a structured format.
+          metadata: nil,
           correlation_id: nil,
+          idempotency_key: nil,
           request_id: nil,
           request_options: {}
         )
@@ -120,7 +137,9 @@ module Straddle
                 Straddle::Embed::RepresentativeUpdateParams::Relationship,
               ssn_last4: String,
               external_id: T.nilable(String),
+              metadata: T.nilable(T::Hash[Symbol, String]),
               correlation_id: String,
+              idempotency_key: String,
               request_id: String,
               request_options: Straddle::RequestOptions
             }

data/rbi/straddle/models/paykey_cancel_params.rbi

@@ -20,6 +20,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
 
@@ -36,6 +42,7 @@ module Straddle
         params(
           reason: T.nilable(String),
           correlation_id: String,
+          idempotency_key: String,
           request_id: String,
           straddle_account_id: String,
           request_options: Straddle::RequestOptions::OrHash
@@ -44,6 +51,7 @@ module Straddle
       def self.new(
         reason: nil,
         correlation_id: nil,
+        idempotency_key: nil,
         request_id: nil,
         straddle_account_id: nil,
         request_options: {}
@@ -55,6 +63,7 @@ module Straddle
           {
             reason: T.nilable(String),
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions

data/rbi/straddle/models/paykey_review_params.rbi

@@ -0,0 +1,98 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class PaykeyReviewParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::PaykeyReviewParams, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(Straddle::PaykeyReviewParams::Status::OrSymbol) }
+      attr_accessor :status
+
+      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(
+          status: Straddle::PaykeyReviewParams::Status::OrSymbol,
+          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(
+        status:,
+        correlation_id: nil,
+        idempotency_key: nil,
+        request_id: nil,
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            status: Straddle::PaykeyReviewParams::Status::OrSymbol,
+            correlation_id: String,
+            idempotency_key: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Status
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Straddle::PaykeyReviewParams::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(:active, Straddle::PaykeyReviewParams::Status::TaggedSymbol)
+        REJECTED =
+          T.let(:rejected, Straddle::PaykeyReviewParams::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Straddle::PaykeyReviewParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

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

@@ -75,6 +75,8 @@ module Straddle
 
   PaykeyRevealParams = Straddle::Models::PaykeyRevealParams
 
+  PaykeyReviewParams = Straddle::Models::PaykeyReviewParams
+
   PaykeySummaryPagedV1 = Straddle::Models::PaykeySummaryPagedV1
 
   PaykeyUnmaskedParams = Straddle::Models::PaykeyUnmaskedParams

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

@@ -17,6 +17,7 @@ module Straddle
             config: Straddle::Bridge::LinkBankAccountParams::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
@@ -39,6 +40,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
@@ -58,6 +61,7 @@ module Straddle
             config: Straddle::Bridge::LinkCreatePaykeyParams::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
@@ -77,6 +81,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
@@ -96,6 +102,7 @@ module Straddle
             config: Straddle::Bridge::LinkCreateTanParams::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
@@ -118,6 +125,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
@@ -137,6 +146,7 @@ module Straddle
             config: Straddle::Bridge::LinkPlaidParams::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
@@ -156,6 +166,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/bridge.rbi

@@ -12,6 +12,7 @@ module Straddle
           customer_id: String,
           config: Straddle::BridgeInitializeParams::Config::OrHash,
           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

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