straddle 0.1.1 → 0.2.0

data/lib/straddle/resources/customers.rb

@@ -13,7 +13,7 @@ module Straddle
       # risk assessment scores. This endpoint allows you to create a customer profile
       # and associate it with paykeys and payments.
       #
-      # @overload create(device:, email:, name:, phone:, type:, address: nil, compliance_profile: nil, config: nil, external_id: nil, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload create(device:, email:, name:, phone:, type:, address: nil, compliance_profile: nil, config: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param device [Straddle::Models::DeviceUnmaskedV1] Body param:
       #
@@ -38,6 +38,8 @@ module Straddle
       #
       # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
       #
+      # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+      #
       # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
       #
       # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -52,6 +54,7 @@ module Straddle
         header_params =
           {
             correlation_id: "correlation-id",
+            idempotency_key: "idempotency-key",
             request_id: "request-id",
             straddle_account_id: "straddle-account-id"
           }
@@ -71,7 +74,7 @@ module Straddle
       # Updates an existing customer's information. This endpoint allows you to modify
       # the customer's contact details, PII, and metadata.
       #
-      # @overload update(id, device:, email:, name:, phone:, status:, address: nil, compliance_profile: nil, external_id: nil, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload update(id, device:, email:, name:, phone:, status:, address: nil, compliance_profile: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param id [String] Path param:
       #
@@ -95,6 +98,8 @@ module Straddle
       #
       # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
       #
+      # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+      #
       # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
       #
       # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -109,6 +114,7 @@ module Straddle
         header_params =
           {
             correlation_id: "correlation-id",
+            idempotency_key: "idempotency-key",
             request_id: "request-id",
             straddle_account_id: "straddle-account-id"
           }
@@ -203,12 +209,14 @@ module Straddle
       # undone and should only be used to satisfy regulatory requirements or for privacy
       # compliance.
       #
-      # @overload delete(id, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload delete(id, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param id [String]
       #
       # @param correlation_id [String] Optional client generated identifier to trace and debug a series of requests.
       #
+      # @param idempotency_key [String] Optional client generated value to use for idempotent requests.
+      #
       # @param request_id [String] Optional client generated identifier to trace and debug a request.
       #
       # @param straddle_account_id [String] For use by platforms to specify an account id and set scope of a request.
@@ -225,6 +233,7 @@ module Straddle
           path: ["v1/customers/%1$s", id],
           headers: parsed.transform_keys(
             correlation_id: "correlation-id",
+            idempotency_key: "idempotency-key",
             request_id: "request-id",
             straddle_account_id: "straddle-account-id"
           ),
@@ -271,12 +280,14 @@ module Straddle
       # you to modify the outcome of a customer decision and is useful for correcting or
       # updating the status of a customer's verification.
       #
-      # @overload refresh_review(id, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload refresh_review(id, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param id [String]
       #
       # @param correlation_id [String] Optional client generated identifier to trace and debug a series of requests.
       #
+      # @param idempotency_key [String] Optional client generated value to use for idempotent requests.
+      #
       # @param request_id [String] Optional client generated identifier to trace and debug a request.
       #
       # @param straddle_account_id [String] For use by platforms to specify an account id and set scope of a request.
@@ -293,6 +304,7 @@ module Straddle
           path: ["v1/customers/%1$s/refresh_review", id],
           headers: parsed.transform_keys(
             correlation_id: "correlation-id",
+            idempotency_key: "idempotency-key",
             request_id: "request-id",
             straddle_account_id: "straddle-account-id"
           ),

data/lib/straddle/resources/embed/accounts/capability_requests.rb

@@ -12,7 +12,7 @@ module Straddle
           # Submits a request to enable a specific capability for an account. Use this
           # endpoint to request additional features or services for an account.
           #
-          # @overload create(account_id, businesses: nil, charges: nil, individuals: nil, internet: nil, payouts: nil, signed_agreement: nil, correlation_id: nil, request_id: nil, request_options: {})
+          # @overload create(account_id, businesses: nil, charges: nil, individuals: nil, internet: nil, payouts: nil, signed_agreement: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
           #
           # @param account_id [String] Path param:
           #
@@ -30,6 +30,8 @@ module Straddle
           #
           # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
           #
+          # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+          #
           # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
           #
           # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -39,7 +41,8 @@ module Straddle
           # @see Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams
           def create(account_id, params = {})
             parsed, options = Straddle::Embed::Accounts::CapabilityRequestCreateParams.dump_request(params)
-            header_params = {correlation_id: "correlation-id", request_id: "request-id"}
+            header_params =
+              {correlation_id: "correlation-id", idempotency_key: "idempotency-key", request_id: "request-id"}
             @client.request(
               method: :post,
               path: ["v1/accounts/%1$s/capability_requests", account_id],

data/lib/straddle/resources/embed/accounts.rb

@@ -14,7 +14,7 @@ module Straddle
         # endpoint allows you to set up an account with specified details, including
         # business information and access levels.
         #
-        # @overload create(access_level:, account_type:, business_profile:, organization_id:, external_id: nil, metadata: nil, correlation_id: nil, request_id: nil, request_options: {})
+        # @overload create(access_level:, account_type:, business_profile:, organization_id:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
         #
         # @param access_level [Symbol, Straddle::Models::Embed::AccountCreateParams::AccessLevel] Body param: The access level granted to the account. This is determined by your
         #
@@ -30,6 +30,8 @@ module Straddle
         #
         # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
         #
+        # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+        #
         # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
         #
         # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -39,7 +41,8 @@ module Straddle
         # @see Straddle::Models::Embed::AccountCreateParams
         def create(params)
           parsed, options = Straddle::Embed::AccountCreateParams.dump_request(params)
-          header_params = {correlation_id: "correlation-id", request_id: "request-id"}
+          header_params =
+            {correlation_id: "correlation-id", idempotency_key: "idempotency-key", request_id: "request-id"}
           @client.request(
             method: :post,
             path: "v1/accounts",
@@ -56,7 +59,7 @@ module Straddle
         # Updates an existing account's information. This endpoint allows you to update
         # various account details during onboarding or after the account has been created.
         #
-        # @overload update(account_id, business_profile:, external_id: nil, metadata: nil, correlation_id: nil, request_id: nil, request_options: {})
+        # @overload update(account_id, business_profile:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
         #
         # @param account_id [String] Path param:
         #
@@ -68,6 +71,8 @@ module Straddle
         #
         # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
         #
+        # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+        #
         # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
         #
         # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -77,7 +82,8 @@ module Straddle
         # @see Straddle::Models::Embed::AccountUpdateParams
         def update(account_id, params)
           parsed, options = Straddle::Embed::AccountUpdateParams.dump_request(params)
-          header_params = {correlation_id: "correlation-id", request_id: "request-id"}
+          header_params =
+            {correlation_id: "correlation-id", idempotency_key: "idempotency-key", request_id: "request-id"}
           @client.request(
             method: :put,
             path: ["v1/accounts/%1$s", account_id],
@@ -173,7 +179,7 @@ module Straddle
         # used for accounts where at least one representative and one bank account have
         # already been created.
         #
-        # @overload onboard(account_id, terms_of_service:, correlation_id: nil, request_id: nil, request_options: {})
+        # @overload onboard(account_id, terms_of_service:, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
         #
         # @param account_id [String] Path param:
         #
@@ -181,6 +187,8 @@ module Straddle
         #
         # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
         #
+        # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+        #
         # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
         #
         # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -190,7 +198,8 @@ module Straddle
         # @see Straddle::Models::Embed::AccountOnboardParams
         def onboard(account_id, params)
           parsed, options = Straddle::Embed::AccountOnboardParams.dump_request(params)
-          header_params = {correlation_id: "correlation-id", request_id: "request-id"}
+          header_params =
+            {correlation_id: "correlation-id", idempotency_key: "idempotency-key", request_id: "request-id"}
           @client.request(
             method: :post,
             path: ["v1/accounts/%1$s/onboard", account_id],
@@ -207,7 +216,7 @@ module Straddle
         # Simulate the status transitions for sandbox accounts. This endpoint can only be
         # used for sandbox accounts.
         #
-        # @overload simulate(account_id, final_status: nil, correlation_id: nil, request_id: nil, request_options: {})
+        # @overload simulate(account_id, final_status: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
         #
         # @param account_id [String] Path param:
         #
@@ -215,6 +224,8 @@ module Straddle
         #
         # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
         #
+        # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+        #
         # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
         #
         # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -231,6 +242,7 @@ module Straddle
             query: parsed.slice(*query_params),
             headers: parsed.except(*query_params).transform_keys(
               correlation_id: "correlation-id",
+              idempotency_key: "idempotency-key",
               request_id: "request-id"
             ),
             model: Straddle::Embed::AccountV1,

data/lib/straddle/resources/embed/linked_bank_accounts.rb

@@ -12,16 +12,24 @@ module Straddle
         # for various payment operations such as payment deposits, payout withdrawals, and
         # more.
         #
-        # @overload create(account_id:, bank_account:, metadata: nil, correlation_id: nil, request_id: nil, request_options: {})
+        # @overload create(account_id:, bank_account:, description: nil, metadata: nil, platform_id: nil, purposes: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
         #
-        # @param account_id [String] Body param: The unique identifier of the Straddle account to associate this bank
+        # @param account_id [String, nil] Body param: The unique identifier of the Straddle account to associate this bank
         #
         # @param bank_account [Straddle::Models::Embed::LinkedBankAccountCreateParams::BankAccount] Body param:
         #
+        # @param description [String, nil] Body param: Optional description for the bank account.
+        #
         # @param metadata [Hash{Symbol=>String, nil}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
         #
+        # @param platform_id [String, nil] Body param: The unique identifier of the Straddle Platform to associate this ban
+        #
+        # @param purposes [Array<Symbol, Straddle::Models::Embed::LinkedBankAccountCreateParams::Purpose>, nil] Body param: The purposes for the linked bank account.
+        #
         # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
         #
+        # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+        #
         # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
         #
         # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -31,7 +39,8 @@ module Straddle
         # @see Straddle::Models::Embed::LinkedBankAccountCreateParams
         def create(params)
           parsed, options = Straddle::Embed::LinkedBankAccountCreateParams.dump_request(params)
-          header_params = {correlation_id: "correlation-id", request_id: "request-id"}
+          header_params =
+            {correlation_id: "correlation-id", idempotency_key: "idempotency-key", request_id: "request-id"}
           @client.request(
             method: :post,
             path: "v1/linked_bank_accounts",
@@ -50,7 +59,7 @@ module Straddle
         # the linked account. The linked bank account must be in 'created' or 'onboarding'
         # status.
         #
-        # @overload update(linked_bank_account_id, bank_account:, metadata: nil, correlation_id: nil, request_id: nil, request_options: {})
+        # @overload update(linked_bank_account_id, bank_account:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
         #
         # @param linked_bank_account_id [String] Path param:
         #
@@ -60,6 +69,8 @@ module Straddle
         #
         # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
         #
+        # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+        #
         # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
         #
         # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -69,7 +80,8 @@ module Straddle
         # @see Straddle::Models::Embed::LinkedBankAccountUpdateParams
         def update(linked_bank_account_id, params)
           parsed, options = Straddle::Embed::LinkedBankAccountUpdateParams.dump_request(params)
-          header_params = {correlation_id: "correlation-id", request_id: "request-id"}
+          header_params =
+            {correlation_id: "correlation-id", idempotency_key: "idempotency-key", request_id: "request-id"}
           @client.request(
             method: :put,
             path: ["v1/linked_bank_accounts/%1$s", linked_bank_account_id],
@@ -128,6 +140,40 @@ module Straddle
           )
         end
 
+        # Cancels an existing linked bank account. This can be used to cancel a linked
+        # bank account before it has been reviewed. The linked bank account must be in
+        # 'created' status.
+        #
+        # @overload cancel(linked_bank_account_id, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+        #
+        # @param linked_bank_account_id [String]
+        #
+        # @param correlation_id [String] Optional client generated identifier to trace and debug a series of requests.
+        #
+        # @param idempotency_key [String] Optional client generated value to use for idempotent requests.
+        #
+        # @param request_id [String] Optional client generated identifier to trace and debug a request.
+        #
+        # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Straddle::Models::Embed::LinkedBankAccountV1]
+        #
+        # @see Straddle::Models::Embed::LinkedBankAccountCancelParams
+        def cancel(linked_bank_account_id, params = {})
+          parsed, options = Straddle::Embed::LinkedBankAccountCancelParams.dump_request(params)
+          @client.request(
+            method: :patch,
+            path: ["v1/linked_bank_accounts/%1$s/cancel", linked_bank_account_id],
+            headers: parsed.transform_keys(
+              correlation_id: "correlation-id",
+              idempotency_key: "idempotency-key",
+              request_id: "request-id"
+            ),
+            model: Straddle::Embed::LinkedBankAccountV1,
+            options: options
+          )
+        end
+
         # Retrieves the details of a linked bank account that has previously been created.
         # Supply the unique linked bank account `id`, and Straddle will return the
         # corresponding information. The response includes masked account details for

data/lib/straddle/resources/embed/organizations.rb

@@ -11,7 +11,7 @@ module Straddle
         # can be used to group related accounts and manage permissions across multiple
         # users.
         #
-        # @overload create(name:, external_id: nil, metadata: nil, correlation_id: nil, request_id: nil, request_options: {})
+        # @overload create(name:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
         #
         # @param name [String] Body param: The name of the organization.
         #
@@ -21,6 +21,8 @@ module Straddle
         #
         # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
         #
+        # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+        #
         # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
         #
         # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -30,7 +32,8 @@ module Straddle
         # @see Straddle::Models::Embed::OrganizationCreateParams
         def create(params)
           parsed, options = Straddle::Embed::OrganizationCreateParams.dump_request(params)
-          header_params = {correlation_id: "correlation-id", request_id: "request-id"}
+          header_params =
+            {correlation_id: "correlation-id", idempotency_key: "idempotency-key", request_id: "request-id"}
           @client.request(
             method: :post,
             path: "v1/organizations",

data/lib/straddle/resources/embed/representatives.rb

@@ -11,7 +11,7 @@ module Straddle
         # individuals who have legal authority or significant responsibility within the
         # business.
         #
-        # @overload create(account_id:, dob:, email:, first_name:, last_name:, mobile_number:, relationship:, ssn_last4:, external_id: nil, correlation_id: nil, request_id: nil, request_options: {})
+        # @overload create(account_id:, dob:, email:, first_name:, last_name:, mobile_number:, relationship:, ssn_last4:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
         #
         # @param account_id [String] Body param: The unique identifier of the account this representative is associat
         #
@@ -31,8 +31,12 @@ module Straddle
         #
         # @param external_id [String, nil] Body param: Unique identifier for the representative in your database, used for
         #
+        # @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
+        #
         # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
         #
+        # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+        #
         # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
         #
         # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -42,7 +46,8 @@ module Straddle
         # @see Straddle::Models::Embed::RepresentativeCreateParams
         def create(params)
           parsed, options = Straddle::Embed::RepresentativeCreateParams.dump_request(params)
-          header_params = {correlation_id: "correlation-id", request_id: "request-id"}
+          header_params =
+            {correlation_id: "correlation-id", idempotency_key: "idempotency-key", request_id: "request-id"}
           @client.request(
             method: :post,
             path: "v1/representatives",
@@ -60,7 +65,7 @@ module Straddle
         # personal details, contact information, or the relationship to the account or
         # organization.
         #
-        # @overload update(representative_id, dob:, email:, first_name:, last_name:, mobile_number:, relationship:, ssn_last4:, external_id: nil, correlation_id: nil, request_id: nil, request_options: {})
+        # @overload update(representative_id, dob:, email:, first_name:, last_name:, mobile_number:, relationship:, ssn_last4:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
         #
         # @param representative_id [String] Path param:
         #
@@ -80,8 +85,12 @@ module Straddle
         #
         # @param external_id [String, nil] Body param: Unique identifier for the representative in your database, used for
         #
+        # @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
+        #
         # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
         #
+        # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+        #
         # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
         #
         # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -91,7 +100,8 @@ module Straddle
         # @see Straddle::Models::Embed::RepresentativeUpdateParams
         def update(representative_id, params)
           parsed, options = Straddle::Embed::RepresentativeUpdateParams.dump_request(params)
-          header_params = {correlation_id: "correlation-id", request_id: "request-id"}
+          header_params =
+            {correlation_id: "correlation-id", idempotency_key: "idempotency-key", request_id: "request-id"}
           @client.request(
             method: :put,
             path: ["v1/representatives/%1$s", representative_id],

data/lib/straddle/resources/paykeys.rb

@@ -57,7 +57,7 @@ module Straddle
       # Some parameter documentations has been truncated, see
       # {Straddle::Models::PaykeyCancelParams} for more details.
       #
-      # @overload cancel(id, reason: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload cancel(id, reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param id [String] Path param:
       #
@@ -65,6 +65,8 @@ module Straddle
       #
       # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
       #
+      # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+      #
       # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
       #
       # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -79,6 +81,7 @@ module Straddle
         header_params =
           {
             correlation_id: "correlation-id",
+            idempotency_key: "idempotency-key",
             request_id: "request-id",
             straddle_account_id: "straddle-account-id"
           }
@@ -161,6 +164,49 @@ module Straddle
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Straddle::Models::PaykeyReviewParams} for more details.
+      #
+      # Update the status of a paykey when in review status
+      #
+      # @overload review(id, status:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #
+      # @param id [String] Path param:
+      #
+      # @param status [Symbol, Straddle::Models::PaykeyReviewParams::Status] Body param:
+      #
+      # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
+      #
+      # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+      #
+      # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
+      #
+      # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
+      #
+      # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Straddle::Models::PaykeyV1]
+      #
+      # @see Straddle::Models::PaykeyReviewParams
+      def review(id, params)
+        parsed, options = Straddle::PaykeyReviewParams.dump_request(params)
+        header_params =
+          {
+            correlation_id: "correlation-id",
+            idempotency_key: "idempotency-key",
+            request_id: "request-id",
+            straddle_account_id: "straddle-account-id"
+          }
+        @client.request(
+          method: :patch,
+          path: ["v1/paykeys/%1$s/review", id],
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Straddle::PaykeyV1,
+          options: options
+        )
+      end
+
       # Retrieves the unmasked details of an existing paykey. Supply the unique paykey
       # `id` and Straddle will return the corresponding paykey record, including the
       # unmasked bank account details. This endpoint needs to be enabled by Straddle for

data/lib/straddle/resources/payouts.rb

@@ -8,7 +8,7 @@ module Straddle
       #
       # Use payouts to send money to your customers.
       #
-      # @overload create(amount:, currency:, description:, device:, external_id:, paykey:, payment_date:, config: nil, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload create(amount:, currency:, description:, device:, external_id:, paykey:, payment_date:, config: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param amount [Integer] Body param: The amount of the payout in cents.
       #
@@ -30,6 +30,8 @@ module Straddle
       #
       # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
       #
+      # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+      #
       # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
       #
       # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -44,6 +46,7 @@ module Straddle
         header_params =
           {
             correlation_id: "correlation-id",
+            idempotency_key: "idempotency-key",
             request_id: "request-id",
             straddle_account_id: "straddle-account-id"
           }
@@ -63,7 +66,7 @@ module Straddle
       # Update the details of a payout prior to processing. The status of the payout
       # must be `created`, `scheduled`, or `on_hold`.
       #
-      # @overload update(id, amount:, description:, payment_date:, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload update(id, amount:, description:, payment_date:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param id [String] Path param:
       #
@@ -77,6 +80,8 @@ module Straddle
       #
       # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
       #
+      # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+      #
       # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
       #
       # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -91,6 +96,7 @@ module Straddle
         header_params =
           {
             correlation_id: "correlation-id",
+            idempotency_key: "idempotency-key",
             request_id: "request-id",
             straddle_account_id: "straddle-account-id"
           }
@@ -110,7 +116,7 @@ module Straddle
       # Cancel a payout to prevent it from being processed. The status of the payout
       # must be `created`, `scheduled`, or `on_hold`.
       #
-      # @overload cancel(id, reason:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload cancel(id, reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param id [String] Path param:
       #
@@ -118,6 +124,8 @@ module Straddle
       #
       # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
       #
+      # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+      #
       # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
       #
       # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -132,6 +140,7 @@ module Straddle
         header_params =
           {
             correlation_id: "correlation-id",
+            idempotency_key: "idempotency-key",
             request_id: "request-id",
             straddle_account_id: "straddle-account-id"
           }
@@ -184,7 +193,7 @@ module Straddle
       # Hold a payout to prevent it from being processed. The status of the payout must
       # be `created`, `scheduled`, or `on_hold`.
       #
-      # @overload hold(id, reason:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload hold(id, reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param id [String] Path param:
       #
@@ -192,6 +201,8 @@ module Straddle
       #
       # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
       #
+      # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+      #
       # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
       #
       # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -206,6 +217,7 @@ module Straddle
         header_params =
           {
             correlation_id: "correlation-id",
+            idempotency_key: "idempotency-key",
             request_id: "request-id",
             straddle_account_id: "straddle-account-id"
           }
@@ -225,7 +237,7 @@ module Straddle
       # Release a payout from a `hold` status to allow it to be rescheduled for
       # processing.
       #
-      # @overload release(id, reason:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload release(id, reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param id [String] Path param:
       #
@@ -233,6 +245,8 @@ module Straddle
       #
       # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
       #
+      # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+      #
       # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
       #
       # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -247,6 +261,7 @@ module Straddle
         header_params =
           {
             correlation_id: "correlation-id",
+            idempotency_key: "idempotency-key",
             request_id: "request-id",
             straddle_account_id: "straddle-account-id"
           }

data/lib/straddle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Straddle
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/straddle.rb

@@ -101,6 +101,7 @@ require_relative "straddle/models/embed/address_v1"
 require_relative "straddle/models/embed/business_profile_v1"
 require_relative "straddle/models/embed/capability_v1"
 require_relative "straddle/models/embed/industry_v1"
+require_relative "straddle/models/embed/linked_bank_account_cancel_params"
 require_relative "straddle/models/embed/linked_bank_account_create_params"
 require_relative "straddle/models/embed/linked_bank_account_get_params"
 require_relative "straddle/models/embed/linked_bank_account_list_params"
@@ -134,6 +135,7 @@ require_relative "straddle/models/paykey_get_params"
 require_relative "straddle/models/paykey_list_params"
 require_relative "straddle/models/paykey_reveal_params"
 require_relative "straddle/models/paykey_reveal_response"
+require_relative "straddle/models/paykey_review_params"
 require_relative "straddle/models/paykey_summary_paged_v1"
 require_relative "straddle/models/paykey_unmasked_params"
 require_relative "straddle/models/paykey_unmasked_v1"