modern_treasury 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18

data/lib/modern_treasury/resources/account_collection_flows.rb

@@ -5,17 +5,16 @@ module ModernTreasury
     class AccountCollectionFlows
       # create account_collection_flow
       #
-      # @param params [ModernTreasury::Models::AccountCollectionFlowCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(counterparty_id:, payment_types:, receiving_countries: nil, request_options: {})
       #
-      #   @option params [String] :counterparty_id Required.
-      #
-      #   @option params [Array<String>] :payment_types
-      #
-      #   @option params [Array<Symbol, ModernTreasury::Models::AccountCollectionFlowCreateParams::ReceivingCountry>] :receiving_countries
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param counterparty_id [String]
+      # @param payment_types [Array<String>]
+      # @param receiving_countries [Array<Symbol, ModernTreasury::Models::AccountCollectionFlowCreateParams::ReceivingCountry>]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::AccountCollectionFlow]
+      #
+      # @see ModernTreasury::Models::AccountCollectionFlowCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::AccountCollectionFlowCreateParams.dump_request(params)
         @client.request(
@@ -29,17 +28,18 @@ module ModernTreasury
 
       # get account_collection_flow
       #
-      # @param id [String] id
+      # @overload retrieve(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::AccountCollectionFlowRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::AccountCollectionFlow]
+      #
+      # @see ModernTreasury::Models::AccountCollectionFlowRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/account_collection_flows/%0s", id],
+          path: ["api/account_collection_flows/%1$s", id],
           model: ModernTreasury::Models::AccountCollectionFlow,
           options: params[:request_options]
         )
@@ -47,21 +47,20 @@ module ModernTreasury
 
       # update account_collection_flow
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::AccountCollectionFlowUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Symbol, ModernTreasury::Models::AccountCollectionFlowUpdateParams::Status] :status Required. The updated status of the account collection flow. Can only be used to
-      #     mark a flow as `cancelled`.
+      # @overload update(id, status:, request_options: {})
       #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param status [Symbol, ModernTreasury::Models::AccountCollectionFlowUpdateParams::Status]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::AccountCollectionFlow]
+      #
+      # @see ModernTreasury::Models::AccountCollectionFlowUpdateParams
       def update(id, params)
         parsed, options = ModernTreasury::Models::AccountCollectionFlowUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/account_collection_flows/%0s", id],
+          path: ["api/account_collection_flows/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::AccountCollectionFlow,
           options: options
@@ -70,35 +69,33 @@ module ModernTreasury
 
       # list account_collection_flows
       #
-      # @param params [ModernTreasury::Models::AccountCollectionFlowListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [String] :client_token
-      #
-      #   @option params [String] :counterparty_id
+      # @overload list(after_cursor: nil, client_token: nil, counterparty_id: nil, external_account_id: nil, per_page: nil, status: nil, request_options: {})
       #
-      #   @option params [String] :external_account_id
+      # @param after_cursor [String, nil]
+      # @param client_token [String]
+      # @param counterparty_id [String]
+      # @param external_account_id [String]
+      # @param per_page [Integer]
+      # @param status [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Integer] :per_page
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::AccountCollectionFlow>]
       #
-      #   @option params [String] :status
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::AccountCollectionFlow>]
+      # @see ModernTreasury::Models::AccountCollectionFlowListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::AccountCollectionFlowListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/account_collection_flows",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::AccountCollectionFlow,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/account_details.rb

@@ -5,20 +5,17 @@ module ModernTreasury
     class AccountDetails
       # Create an account detail for an external account.
       #
-      # @param account_id [String] Path param: The ID of the account.
+      # @overload create(account_id, accounts_type:, account_number:, account_number_type: nil, request_options: {})
       #
-      # @param params [ModernTreasury::Models::AccountDetailCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Symbol, ModernTreasury::Models::AccountDetailCreateParams::AccountsType] :accounts_type Path param:
-      #
-      #   @option params [String] :account_number Body param: The account number for the bank account.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::AccountDetailCreateParams::AccountNumberType] :account_number_type Body param: One of `iban`, `clabe`, `wallet_address`, or `other`. Use `other` if
-      #     the bank account number is in a generic format.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param account_id [String]
+      # @param accounts_type [Symbol, ModernTreasury::Models::AccountDetailCreateParams::AccountsType]
+      # @param account_number [String]
+      # @param account_number_type [Symbol, ModernTreasury::Models::AccountDetailCreateParams::AccountNumberType]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::AccountDetail]
+      #
+      # @see ModernTreasury::Models::AccountDetailCreateParams
       def create(account_id, params)
         parsed, options = ModernTreasury::Models::AccountDetailCreateParams.dump_request(params)
         accounts_type =
@@ -27,7 +24,7 @@ module ModernTreasury
           end
         @client.request(
           method: :post,
-          path: ["api/%0s/%1s/account_details", accounts_type, account_id],
+          path: ["api/%1$s/%2$s/account_details", accounts_type, account_id],
           body: parsed,
           model: ModernTreasury::Models::AccountDetail,
           options: options
@@ -36,17 +33,16 @@ module ModernTreasury
 
       # Get a single account detail for a single internal or external account.
       #
-      # @param id [String] The ID of the account detail.
+      # @overload retrieve(id, accounts_type:, account_id:, request_options: {})
       #
-      # @param params [ModernTreasury::Models::AccountDetailRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Symbol, ModernTreasury::Models::AccountsType] :accounts_type
-      #
-      #   @option params [String] :account_id The ID of the account.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param accounts_type [Symbol, ModernTreasury::Models::AccountsType]
+      # @param account_id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::AccountDetail]
+      #
+      # @see ModernTreasury::Models::AccountDetailRetrieveParams
       def retrieve(id, params)
         parsed, options = ModernTreasury::Models::AccountDetailRetrieveParams.dump_request(params)
         accounts_type =
@@ -59,7 +55,7 @@ module ModernTreasury
           end
         @client.request(
           method: :get,
-          path: ["api/%0s/%1s/account_details/%2s", accounts_type, account_id, id],
+          path: ["api/%1$s/%2$s/account_details/%3$s", accounts_type, account_id, id],
           model: ModernTreasury::Models::AccountDetail,
           options: options
         )
@@ -67,19 +63,17 @@ module ModernTreasury
 
       # Get a list of account details for a single internal or external account.
       #
-      # @param account_id [String] Path param: The ID of the account.
+      # @overload list(account_id, accounts_type:, after_cursor: nil, per_page: nil, request_options: {})
       #
-      # @param params [ModernTreasury::Models::AccountDetailListParams, Hash{Symbol=>Object}] .
+      # @param account_id [String]
+      # @param accounts_type [Symbol, ModernTreasury::Models::AccountsType]
+      # @param after_cursor [String, nil]
+      # @param per_page [Integer]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Symbol, ModernTreasury::Models::AccountsType] :accounts_type Path param:
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::AccountDetail>]
       #
-      #   @option params [String, nil] :after_cursor Query param:
-      #
-      #   @option params [Integer] :per_page Query param:
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::AccountDetail>]
+      # @see ModernTreasury::Models::AccountDetailListParams
       def list(account_id, params)
         parsed, options = ModernTreasury::Models::AccountDetailListParams.dump_request(params)
         accounts_type =
@@ -88,9 +82,9 @@ module ModernTreasury
           end
         @client.request(
           method: :get,
-          path: ["api/%0s/%1s/account_details", accounts_type, account_id],
+          path: ["api/%1$s/%2$s/account_details", accounts_type, account_id],
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::AccountDetail,
           options: options
         )
@@ -98,17 +92,16 @@ module ModernTreasury
 
       # Delete a single account detail for an external account.
       #
-      # @param id [String] The ID of the account detail.
-      #
-      # @param params [ModernTreasury::Models::AccountDetailDeleteParams, Hash{Symbol=>Object}] .
+      # @overload delete(id, accounts_type:, account_id:, request_options: {})
       #
-      #   @option params [Symbol, ModernTreasury::Models::AccountDetailDeleteParams::AccountsType] :accounts_type
-      #
-      #   @option params [String] :account_id The ID of the account.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param accounts_type [Symbol, ModernTreasury::Models::AccountDetailDeleteParams::AccountsType]
+      # @param account_id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
+      #
+      # @see ModernTreasury::Models::AccountDetailDeleteParams
       def delete(id, params)
         parsed, options = ModernTreasury::Models::AccountDetailDeleteParams.dump_request(params)
         accounts_type =
@@ -121,12 +114,14 @@ module ModernTreasury
           end
         @client.request(
           method: :delete,
-          path: ["api/%0s/%1s/account_details/%2s", accounts_type, account_id, id],
+          path: ["api/%1$s/%2$s/account_details/%3$s", accounts_type, account_id, id],
           model: NilClass,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/bulk_requests.rb

@@ -5,21 +5,17 @@ module ModernTreasury
     class BulkRequests
       # create bulk_request
       #
-      # @param params [ModernTreasury::Models::BulkRequestCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(action_type:, resource_type:, resources:, metadata: nil, request_options: {})
       #
-      #   @option params [Symbol, ModernTreasury::Models::BulkRequestCreateParams::ActionType] :action_type One of create, or update.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::BulkRequestCreateParams::ResourceType] :resource_type One of payment_order, expected_payment, or ledger_transaction.
-      #
-      #   @option params [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID>] :resources An array of objects where each object contains the input params for a single
-      #     `action_type` request on a `resource_type` resource
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param action_type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::ActionType]
+      # @param resource_type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::ResourceType]
+      # @param resources [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID>]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::BulkRequest]
+      #
+      # @see ModernTreasury::Models::BulkRequestCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::BulkRequestCreateParams.dump_request(params)
         @client.request(
@@ -33,17 +29,18 @@ module ModernTreasury
 
       # get bulk_request
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::BulkRequestRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(id, request_options: {})
       #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::BulkRequest]
+      #
+      # @see ModernTreasury::Models::BulkRequestRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/bulk_requests/%0s", id],
+          path: ["api/bulk_requests/%1$s", id],
           model: ModernTreasury::Models::BulkRequest,
           options: params[:request_options]
         )
@@ -51,37 +48,33 @@ module ModernTreasury
 
       # list bulk_requests
       #
-      # @param params [ModernTreasury::Models::BulkRequestListParams, Hash{Symbol=>Object}] .
+      # @overload list(action_type: nil, after_cursor: nil, metadata: nil, per_page: nil, resource_type: nil, status: nil, request_options: {})
       #
-      #   @option params [Symbol, ModernTreasury::Models::BulkRequestListParams::ActionType] :action_type One of create, or update.
+      # @param action_type [Symbol, ModernTreasury::Models::BulkRequestListParams::ActionType]
+      # @param after_cursor [String, nil]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param per_page [Integer]
+      # @param resource_type [Symbol, ModernTreasury::Models::BulkRequestListParams::ResourceType]
+      # @param status [Symbol, ModernTreasury::Models::BulkRequestListParams::Status]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [String, nil] :after_cursor
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::BulkRequest>]
       #
-      #   @option params [Hash{Symbol=>String}] :metadata For example, if you want to query for records with metadata key `Type` and value
-      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
-      #     parameters.
-      #
-      #   @option params [Integer] :per_page
-      #
-      #   @option params [Symbol, ModernTreasury::Models::BulkRequestListParams::ResourceType] :resource_type One of payment_order, expected_payment, or ledger_transaction.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::BulkRequestListParams::Status] :status One of pending, processing, or completed.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::BulkRequest>]
+      # @see ModernTreasury::Models::BulkRequestListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::BulkRequestListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/bulk_requests",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::BulkRequest,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/bulk_results.rb

@@ -5,17 +5,18 @@ module ModernTreasury
     class BulkResults
       # get bulk_result
       #
-      # @param id [String] id
+      # @overload retrieve(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::BulkResultRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::BulkResult]
+      #
+      # @see ModernTreasury::Models::BulkResultRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/bulk_results/%0s", id],
+          path: ["api/bulk_results/%1$s", id],
           model: ModernTreasury::Models::BulkResult,
           options: params[:request_options]
         )
@@ -23,40 +24,34 @@ module ModernTreasury
 
       # list bulk_results
       #
-      # @param params [ModernTreasury::Models::BulkResultListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [String] :entity_id Unique identifier for the result entity object.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::BulkResultListParams::EntityType] :entity_type The type of the request that created this result. bulk_request is the only
-      #     supported `request_type`
+      # @overload list(after_cursor: nil, entity_id: nil, entity_type: nil, per_page: nil, request_id: nil, request_type: nil, status: nil, request_options: {})
       #
-      #   @option params [Integer] :per_page
+      # @param after_cursor [String, nil]
+      # @param entity_id [String]
+      # @param entity_type [Symbol, ModernTreasury::Models::BulkResultListParams::EntityType]
+      # @param per_page [Integer]
+      # @param request_id [String]
+      # @param request_type [Symbol, ModernTreasury::Models::BulkResultListParams::RequestType]
+      # @param status [Symbol, ModernTreasury::Models::BulkResultListParams::Status]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [String] :request_id Unique identifier for the request that created this bulk result. This is the ID
-      #     of the bulk request when `request_type` is bulk_request
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::BulkResult>]
       #
-      #   @option params [Symbol, ModernTreasury::Models::BulkResultListParams::RequestType] :request_type The type of the request that created this result. bulk_request is the only
-      #     supported `request_type`
-      #
-      #   @option params [Symbol, ModernTreasury::Models::BulkResultListParams::Status] :status One of successful or failed.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::BulkResult>]
+      # @see ModernTreasury::Models::BulkResultListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::BulkResultListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/bulk_results",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::BulkResult,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/connection_legal_entities.rb

@@ -5,17 +5,16 @@ module ModernTreasury
     class ConnectionLegalEntities
       # Create a connection legal entity.
       #
-      # @param params [ModernTreasury::Models::ConnectionLegalEntityCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(connection_id:, legal_entity: nil, legal_entity_id: nil, request_options: {})
       #
-      #   @option params [String] :connection_id The ID of the connection.
-      #
-      #   @option params [ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity] :legal_entity The legal entity.
-      #
-      #   @option params [String] :legal_entity_id The ID of the legal entity.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param connection_id [String]
+      # @param legal_entity [ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity]
+      # @param legal_entity_id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ConnectionLegalEntity]
+      #
+      # @see ModernTreasury::Models::ConnectionLegalEntityCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::ConnectionLegalEntityCreateParams.dump_request(params)
         @client.request(
@@ -29,17 +28,18 @@ module ModernTreasury
 
       # Get details on a single connection legal entity.
       #
-      # @param id [String] The id of an existing connection legal entity.
+      # @overload retrieve(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::ConnectionLegalEntityRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ConnectionLegalEntity]
+      #
+      # @see ModernTreasury::Models::ConnectionLegalEntityRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/connection_legal_entities/%0s", id],
+          path: ["api/connection_legal_entities/%1$s", id],
           model: ModernTreasury::Models::ConnectionLegalEntity,
           options: params[:request_options]
         )
@@ -47,20 +47,20 @@ module ModernTreasury
 
       # Update a connection legal entity.
       #
-      # @param id [String] The id of an existing connection legal entity.
-      #
-      # @param params [ModernTreasury::Models::ConnectionLegalEntityUpdateParams, Hash{Symbol=>Object}] .
+      # @overload update(id, status: nil, request_options: {})
       #
-      #   @option params [Symbol, ModernTreasury::Models::ConnectionLegalEntityUpdateParams::Status] :status The status of the connection legal entity.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param status [Symbol, ModernTreasury::Models::ConnectionLegalEntityUpdateParams::Status]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ConnectionLegalEntity]
+      #
+      # @see ModernTreasury::Models::ConnectionLegalEntityUpdateParams
       def update(id, params = {})
         parsed, options = ModernTreasury::Models::ConnectionLegalEntityUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/connection_legal_entities/%0s", id],
+          path: ["api/connection_legal_entities/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::ConnectionLegalEntity,
           options: options
@@ -69,33 +69,32 @@ module ModernTreasury
 
       # Get a list of all connection legal entities.
       #
-      # @param params [ModernTreasury::Models::ConnectionLegalEntityListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [String] :connection_id
+      # @overload list(after_cursor: nil, connection_id: nil, legal_entity_id: nil, per_page: nil, status: nil, request_options: {})
       #
-      #   @option params [String] :legal_entity_id
+      # @param after_cursor [String, nil]
+      # @param connection_id [String]
+      # @param legal_entity_id [String]
+      # @param per_page [Integer]
+      # @param status [Symbol, ModernTreasury::Models::ConnectionLegalEntityListParams::Status]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Integer] :per_page
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::ConnectionLegalEntity>]
       #
-      #   @option params [Symbol, ModernTreasury::Models::ConnectionLegalEntityListParams::Status] :status
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::ConnectionLegalEntity>]
+      # @see ModernTreasury::Models::ConnectionLegalEntityListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::ConnectionLegalEntityListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/connection_legal_entities",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::ConnectionLegalEntity,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/connections.rb

@@ -5,31 +5,31 @@ module ModernTreasury
     class Connections
       # Get a list of all connections.
       #
-      # @param params [ModernTreasury::Models::ConnectionListParams, Hash{Symbol=>Object}] .
+      # @overload list(after_cursor: nil, entity: nil, per_page: nil, vendor_customer_id: nil, request_options: {})
       #
-      #   @option params [String, nil] :after_cursor
+      # @param after_cursor [String, nil]
+      # @param entity [String]
+      # @param per_page [Integer]
+      # @param vendor_customer_id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [String] :entity A string code representing the vendor (i.e. bank).
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::Connection>]
       #
-      #   @option params [Integer] :per_page
-      #
-      #   @option params [String] :vendor_customer_id An identifier assigned by the vendor to your organization.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::Connection>]
+      # @see ModernTreasury::Models::ConnectionListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::ConnectionListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/connections",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::Connection,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client