straddle 0.4.0 → 1.0.0

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

@@ -1,274 +0,0 @@
-# frozen_string_literal: true
-
-module Straddle
-  module Resources
-    class Embed
-      # Accounts represent businesses using Straddle through your platform. Each account
-      # must complete automated verification before processing payments. Use accounts to
-      # manage your users' payment capabilities, track verification status, and control
-      # access to features. Accounts can be instantly created in sandbox and require
-      # additional verification for production access.
-      class Accounts
-        # Capabilities enable specific features and services for an Account. Use
-        # capability requests to unlock higher processing limits, new payment types, or
-        # additional platform features as your users' businesses grow. Track approval
-        # status and manage documentation requirements through a single interface.
-        # @return [Straddle::Resources::Embed::Accounts::CapabilityRequests]
-        attr_reader :capability_requests
-
-        # Some parameter documentations has been truncated, see
-        # {Straddle::Models::Embed::AccountCreateParams} for more details.
-        #
-        # Creates a new account associated with your Straddle platform integration. This
-        # 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, 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
-        #
-        # @param account_type [Symbol, Straddle::Models::Embed::AccountCreateParams::AccountType] Body param: The type of account to be created. Currently, only `business` is sup
-        #
-        # @param business_profile [Straddle::Models::Embed::BusinessProfileV1] Body param
-        #
-        # @param organization_id [String] Body param: The unique identifier of the organization related to this account.
-        #
-        # @param external_id [String, nil] Body param: Unique identifier for the account in your database, used for cross-r
-        #
-        # @param metadata [Hash{Symbol=>String, nil}, 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]
-        #
-        # @return [Straddle::Models::Embed::AccountV1]
-        #
-        # @see Straddle::Models::Embed::AccountCreateParams
-        def create(params)
-          parsed, options = Straddle::Embed::AccountCreateParams.dump_request(params)
-          header_params =
-            {correlation_id: "correlation-id", idempotency_key: "idempotency-key", request_id: "request-id"}
-          @client.request(
-            method: :post,
-            path: "v1/accounts",
-            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
-            body: parsed.except(*header_params.keys),
-            model: Straddle::Embed::AccountV1,
-            options: options
-          )
-        end
-
-        # Some parameter documentations has been truncated, see
-        # {Straddle::Models::Embed::AccountUpdateParams} for more details.
-        #
-        # 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, idempotency_key: nil, request_id: nil, request_options: {})
-        #
-        # @param account_id [String] Path param
-        #
-        # @param business_profile [Straddle::Models::Embed::BusinessProfileV1] Body param
-        #
-        # @param external_id [String, nil] Body param: Unique identifier for the account in your database, used for cross-r
-        #
-        # @param metadata [Hash{Symbol=>String, nil}, 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]
-        #
-        # @return [Straddle::Models::Embed::AccountV1]
-        #
-        # @see Straddle::Models::Embed::AccountUpdateParams
-        def update(account_id, params)
-          parsed, options = Straddle::Embed::AccountUpdateParams.dump_request(params)
-          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],
-            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
-            body: parsed.except(*header_params.keys),
-            model: Straddle::Embed::AccountV1,
-            options: options
-          )
-        end
-
-        # Some parameter documentations has been truncated, see
-        # {Straddle::Models::Embed::AccountListParams} for more details.
-        #
-        # Returns a list of accounts associated with your Straddle platform integration.
-        # The accounts are returned sorted by creation date, with the most recently
-        # created accounts appearing first. This endpoint supports advanced sorting and
-        # filtering options.
-        #
-        # @overload list(page_number: nil, page_size: nil, search_text: nil, sort_by: nil, sort_order: nil, status: nil, type: nil, correlation_id: nil, request_id: nil, request_options: {})
-        #
-        # @param page_number [Integer] Query param: Results page number. Starts at page 1. Default value: 1
-        #
-        # @param page_size [Integer] Query param: Page size. Default value: 100. Max value: 1000
-        #
-        # @param search_text [String] Query param
-        #
-        # @param sort_by [String] Query param: Sort By. Default value: 'id'.
-        #
-        # @param sort_order [Symbol, Straddle::Models::Embed::AccountListParams::SortOrder] Query param: Sort Order. Default value: 'asc'.
-        #
-        # @param status [Symbol, Straddle::Models::Embed::AccountListParams::Status] Query param
-        #
-        # @param type [Symbol, Straddle::Models::Embed::AccountListParams::Type] Query param
-        #
-        # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
-        #
-        # @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]
-        #
-        # @return [Straddle::Internal::PageNumberSchema<Straddle::Models::Embed::AccountPagedV1::Data>]
-        #
-        # @see Straddle::Models::Embed::AccountListParams
-        def list(params = {})
-          query_params = [:page_number, :page_size, :search_text, :sort_by, :sort_order, :status, :type]
-          parsed, options = Straddle::Embed::AccountListParams.dump_request(params)
-          query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
-          @client.request(
-            method: :get,
-            path: "v1/accounts",
-            query: query,
-            headers: parsed.except(*query_params).transform_keys(
-              correlation_id: "correlation-id",
-              request_id: "request-id"
-            ),
-            page: Straddle::Internal::PageNumberSchema,
-            model: Straddle::Embed::AccountPagedV1::Data,
-            options: options
-          )
-        end
-
-        # Retrieves the details of an account that has previously been created. Supply the
-        # unique account ID that was returned from your previous request, and Straddle
-        # will return the corresponding account information.
-        #
-        # @overload get(account_id, correlation_id: nil, request_id: nil, request_options: {})
-        #
-        # @param account_id [String] The unique identifier of the account to retrieve.
-        #
-        # @param correlation_id [String] Optional client generated identifier to trace and debug a series of 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::AccountV1]
-        #
-        # @see Straddle::Models::Embed::AccountGetParams
-        def get(account_id, params = {})
-          parsed, options = Straddle::Embed::AccountGetParams.dump_request(params)
-          @client.request(
-            method: :get,
-            path: ["v1/accounts/%1$s", account_id],
-            headers: parsed.transform_keys(correlation_id: "correlation-id", request_id: "request-id"),
-            model: Straddle::Embed::AccountV1,
-            options: options
-          )
-        end
-
-        # Some parameter documentations has been truncated, see
-        # {Straddle::Models::Embed::AccountOnboardParams} for more details.
-        #
-        # Initiates the onboarding process for a new account. This endpoint can only be
-        # 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, idempotency_key: nil, request_id: nil, request_options: {})
-        #
-        # @param account_id [String] Path param
-        #
-        # @param terms_of_service [Straddle::Models::Embed::TermsOfServiceV1] 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 request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Straddle::Models::Embed::AccountV1]
-        #
-        # @see Straddle::Models::Embed::AccountOnboardParams
-        def onboard(account_id, params)
-          parsed, options = Straddle::Embed::AccountOnboardParams.dump_request(params)
-          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],
-            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
-            body: parsed.except(*header_params.keys),
-            model: Straddle::Embed::AccountV1,
-            options: options
-          )
-        end
-
-        # Some parameter documentations has been truncated, see
-        # {Straddle::Models::Embed::AccountSimulateParams} for more details.
-        #
-        # 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, idempotency_key: nil, request_id: nil, request_options: {})
-        #
-        # @param account_id [String] Path param
-        #
-        # @param final_status [Symbol, Straddle::Models::Embed::AccountSimulateParams::FinalStatus] Query 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 request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Straddle::Models::Embed::AccountV1]
-        #
-        # @see Straddle::Models::Embed::AccountSimulateParams
-        def simulate(account_id, params = {})
-          query_params = [:final_status]
-          parsed, options = Straddle::Embed::AccountSimulateParams.dump_request(params)
-          query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
-          @client.request(
-            method: :post,
-            path: ["v1/accounts/%1$s/simulate", account_id],
-            query: query,
-            headers: parsed.except(*query_params).transform_keys(
-              correlation_id: "correlation-id",
-              idempotency_key: "idempotency-key",
-              request_id: "request-id"
-            ),
-            model: Straddle::Embed::AccountV1,
-            options: options
-          )
-        end
-
-        # @api private
-        #
-        # @param client [Straddle::Client]
-        def initialize(client:)
-          @client = client
-          @capability_requests = Straddle::Resources::Embed::Accounts::CapabilityRequests.new(client: client)
-        end
-      end
-    end
-  end
-end

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

@@ -1,263 +0,0 @@
-# frozen_string_literal: true
-
-module Straddle
-  module Resources
-    class Embed
-      # Linked bank accounts connect your platform users' external bank accounts to
-      # Straddle for settlements and payment funding. Each linked account undergoes
-      # automated verification and continuous monitoring. Use linked accounts to manage
-      # where clients receive deposits, fund payouts, and track settlement preferences.
-      class LinkedBankAccounts
-        # Some parameter documentations has been truncated, see
-        # {Straddle::Models::Embed::LinkedBankAccountCreateParams} for more details.
-        #
-        # Creates a new linked bank account associated with a Straddle account. This
-        # endpoint allows you to associate external bank accounts with a Straddle account
-        # for various payment operations such as payment deposits, payout withdrawals, and
-        # more.
-        #
-        # @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, 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]
-        #
-        # @return [Straddle::Models::Embed::LinkedBankAccountV1]
-        #
-        # @see Straddle::Models::Embed::LinkedBankAccountCreateParams
-        def create(params)
-          parsed, options = Straddle::Embed::LinkedBankAccountCreateParams.dump_request(params)
-          header_params =
-            {correlation_id: "correlation-id", idempotency_key: "idempotency-key", request_id: "request-id"}
-          @client.request(
-            method: :post,
-            path: "v1/linked_bank_accounts",
-            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
-            body: parsed.except(*header_params.keys),
-            model: Straddle::Embed::LinkedBankAccountV1,
-            options: options
-          )
-        end
-
-        # Some parameter documentations has been truncated, see
-        # {Straddle::Models::Embed::LinkedBankAccountUpdateParams} for more details.
-        #
-        # Updates an existing linked bank account's information. This can be used to
-        # update account details during onboarding or to update metadata associated with
-        # 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, idempotency_key: nil, request_id: nil, request_options: {})
-        #
-        # @param linked_bank_account_id [String] Path param
-        #
-        # @param bank_account [Straddle::Models::Embed::LinkedBankAccountUpdateParams::BankAccount] Body param
-        #
-        # @param metadata [Hash{Symbol=>String, nil}, 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]
-        #
-        # @return [Straddle::Models::Embed::LinkedBankAccountV1]
-        #
-        # @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", idempotency_key: "idempotency-key", request_id: "request-id"}
-          @client.request(
-            method: :put,
-            path: ["v1/linked_bank_accounts/%1$s", linked_bank_account_id],
-            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
-            body: parsed.except(*header_params.keys),
-            model: Straddle::Embed::LinkedBankAccountV1,
-            options: options
-          )
-        end
-
-        # Some parameter documentations has been truncated, see
-        # {Straddle::Models::Embed::LinkedBankAccountListParams} for more details.
-        #
-        # Returns a list of bank accounts associated with a specific Straddle account. The
-        # linked bank accounts are returned sorted by creation date, with the most
-        # recently created appearing first. This endpoint supports pagination to handle
-        # accounts with multiple linked bank accounts.
-        #
-        # @overload list(account_id: nil, level: nil, page_number: nil, page_size: nil, purpose: nil, sort_by: nil, sort_order: nil, status: nil, correlation_id: nil, request_id: nil, request_options: {})
-        #
-        # @param account_id [String] Query param: The unique identifier of the related account.
-        #
-        # @param level [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::Level] Query param
-        #
-        # @param page_number [Integer] Query param: Results page number. Starts at page 1.
-        #
-        # @param page_size [Integer] Query param: Page size. Max value: 1000
-        #
-        # @param purpose [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::Purpose] Query param: The purpose of the linked bank accounts to return. Possible values:
-        #
-        # @param sort_by [String] Query param: Sort By.
-        #
-        # @param sort_order [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::SortOrder] Query param: Sort Order.
-        #
-        # @param status [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::Status] Query param: The status of the linked bank accounts to return. Possible values:
-        #
-        # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
-        #
-        # @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]
-        #
-        # @return [Straddle::Internal::PageNumberSchema<Straddle::Models::Embed::LinkedBankAccountPagedV1::Data>]
-        #
-        # @see Straddle::Models::Embed::LinkedBankAccountListParams
-        def list(params = {})
-          query_params = [
-            :account_id,
-            :level,
-            :page_number,
-            :page_size,
-            :purpose,
-            :sort_by,
-            :sort_order,
-            :status
-          ]
-          parsed, options = Straddle::Embed::LinkedBankAccountListParams.dump_request(params)
-          query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
-          @client.request(
-            method: :get,
-            path: "v1/linked_bank_accounts",
-            query: query,
-            headers: parsed.except(*query_params).transform_keys(
-              correlation_id: "correlation-id",
-              request_id: "request-id"
-            ),
-            page: Straddle::Internal::PageNumberSchema,
-            model: Straddle::Embed::LinkedBankAccountPagedV1::Data,
-            options: options
-          )
-        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
-        # security purposes.
-        #
-        # @overload get(linked_bank_account_id, correlation_id: 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 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::LinkedBankAccountGetParams
-        def get(linked_bank_account_id, params = {})
-          parsed, options = Straddle::Embed::LinkedBankAccountGetParams.dump_request(params)
-          @client.request(
-            method: :get,
-            path: ["v1/linked_bank_accounts/%1$s", linked_bank_account_id],
-            headers: parsed.transform_keys(correlation_id: "correlation-id", request_id: "request-id"),
-            model: Straddle::Embed::LinkedBankAccountV1,
-            options: options
-          )
-        end
-
-        # Retrieves the unmasked 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, including sensitive details. This endpoint needs
-        # to be enabled by Straddle for your account and should only be used when
-        # absolutely necessary.
-        #
-        # @overload unmask(linked_bank_account_id, correlation_id: 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 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::LinkedBankAccountUnmaskV1]
-        #
-        # @see Straddle::Models::Embed::LinkedBankAccountUnmaskParams
-        def unmask(linked_bank_account_id, params = {})
-          parsed, options = Straddle::Embed::LinkedBankAccountUnmaskParams.dump_request(params)
-          @client.request(
-            method: :get,
-            path: ["v1/linked_bank_accounts/%1$s/unmask", linked_bank_account_id],
-            headers: parsed.transform_keys(correlation_id: "correlation-id", request_id: "request-id"),
-            model: Straddle::Embed::LinkedBankAccountUnmaskV1,
-            options: options
-          )
-        end
-
-        # @api private
-        #
-        # @param client [Straddle::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end

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

@@ -1,137 +0,0 @@
-# frozen_string_literal: true
-
-module Straddle
-  module Resources
-    class Embed
-      # Organizations are a powerful feature in Straddle that allow you to manage
-      # multiple accounts under a single umbrella. This hierarchical structure is
-      # particularly useful for businesses with complex operations, multiple
-      # departments, or legally related entities.
-      class Organizations
-        # Some parameter documentations has been truncated, see
-        # {Straddle::Models::Embed::OrganizationCreateParams} for more details.
-        #
-        # Creates a new organization related to your Straddle integration. Organizations
-        # can be used to group related accounts and manage permissions across multiple
-        # users.
-        #
-        # @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.
-        #
-        # @param external_id [String, nil] Body param: Unique identifier for the organization in your database, used for cr
-        #
-        # @param metadata [Hash{Symbol=>String, nil}, 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]
-        #
-        # @return [Straddle::Models::Embed::OrganizationV1]
-        #
-        # @see Straddle::Models::Embed::OrganizationCreateParams
-        def create(params)
-          parsed, options = Straddle::Embed::OrganizationCreateParams.dump_request(params)
-          header_params =
-            {correlation_id: "correlation-id", idempotency_key: "idempotency-key", request_id: "request-id"}
-          @client.request(
-            method: :post,
-            path: "v1/organizations",
-            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
-            body: parsed.except(*header_params.keys),
-            model: Straddle::Embed::OrganizationV1,
-            options: options
-          )
-        end
-
-        # Some parameter documentations has been truncated, see
-        # {Straddle::Models::Embed::OrganizationListParams} for more details.
-        #
-        # Retrieves a list of organizations associated with your Straddle integration. The
-        # organizations are returned sorted by creation date, with the most recently
-        # created organizations appearing first. This endpoint supports advanced sorting
-        # and filtering options to help you find specific organizations.
-        #
-        # @overload list(external_id: nil, name: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, correlation_id: nil, request_id: nil, request_options: {})
-        #
-        # @param external_id [String] Query param: List organizations by their external ID.
-        #
-        # @param name [String] Query param: List organizations by name (partial match supported).
-        #
-        # @param page_number [Integer] Query param: Results page number. Starts at page 1.
-        #
-        # @param page_size [Integer] Query param: Page size. Max value: 1000
-        #
-        # @param sort_by [String] Query param: Sort By.
-        #
-        # @param sort_order [Symbol, Straddle::Models::Embed::OrganizationListParams::SortOrder] Query param: Sort Order.
-        #
-        # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
-        #
-        # @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]
-        #
-        # @return [Straddle::Internal::PageNumberSchema<Straddle::Models::Embed::OrganizationPagedV1::Data>]
-        #
-        # @see Straddle::Models::Embed::OrganizationListParams
-        def list(params = {})
-          query_params = [:external_id, :name, :page_number, :page_size, :sort_by, :sort_order]
-          parsed, options = Straddle::Embed::OrganizationListParams.dump_request(params)
-          query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
-          @client.request(
-            method: :get,
-            path: "v1/organizations",
-            query: query,
-            headers: parsed.except(*query_params).transform_keys(
-              correlation_id: "correlation-id",
-              request_id: "request-id"
-            ),
-            page: Straddle::Internal::PageNumberSchema,
-            model: Straddle::Embed::OrganizationPagedV1::Data,
-            options: options
-          )
-        end
-
-        # Retrieves the details of an Organization that has previously been created.
-        # Supply the unique organization ID that was returned from your previous request,
-        # and Straddle will return the corresponding organization information.
-        #
-        # @overload get(organization_id, correlation_id: nil, request_id: nil, request_options: {})
-        #
-        # @param organization_id [String]
-        #
-        # @param correlation_id [String] Optional client generated identifier to trace and debug a series of 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::OrganizationV1]
-        #
-        # @see Straddle::Models::Embed::OrganizationGetParams
-        def get(organization_id, params = {})
-          parsed, options = Straddle::Embed::OrganizationGetParams.dump_request(params)
-          @client.request(
-            method: :get,
-            path: ["v1/organizations/%1$s", organization_id],
-            headers: parsed.transform_keys(correlation_id: "correlation-id", request_id: "request-id"),
-            model: Straddle::Embed::OrganizationV1,
-            options: options
-          )
-        end
-
-        # @api private
-        #
-        # @param client [Straddle::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end