modern_treasury 0.1.0.pre.alpha.17 → 0.1.0.pre.alpha.19

data/lib/modern_treasury/resources/account_details.rb

@@ -3,21 +3,28 @@
 module ModernTreasury
   module Resources
     class AccountDetails
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::AccountDetailCreateParams} for more details.
+      #
       # Create an account detail for an external account.
       #
       # @overload create(account_id, accounts_type:, account_number:, account_number_type: 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 account_id [String] Path param: The ID of the account.
+      #
+      # @param accounts_type [Symbol, ModernTreasury::AccountDetailCreateParams::AccountsType] Path param:
+      #
+      # @param account_number [String] Body param: The account number for the bank account.
+      #
+      # @param account_number_type [Symbol, ModernTreasury::AccountDetailCreateParams::AccountNumberType] Body param: One of `iban`, `clabe`, `wallet_address`, or `other`. Use `other` if
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::AccountDetail]
+      # @return [ModernTreasury::AccountDetail]
       #
       # @see ModernTreasury::Models::AccountDetailCreateParams
       def create(account_id, params)
-        parsed, options = ModernTreasury::Models::AccountDetailCreateParams.dump_request(params)
+        parsed, options = ModernTreasury::AccountDetailCreateParams.dump_request(params)
         accounts_type =
           parsed.delete(:accounts_type) do
             raise ArgumentError.new("missing required path argument #{_1}")
@@ -26,7 +33,7 @@ module ModernTreasury
           method: :post,
           path: ["api/%1$s/%2$s/account_details", accounts_type, account_id],
           body: parsed,
-          model: ModernTreasury::Models::AccountDetail,
+          model: ModernTreasury::AccountDetail,
           options: options
         )
       end
@@ -35,16 +42,19 @@ module ModernTreasury
       #
       # @overload retrieve(id, accounts_type:, account_id:, request_options: {})
       #
-      # @param id [String]
-      # @param accounts_type [Symbol, ModernTreasury::Models::AccountsType]
-      # @param account_id [String]
+      # @param id [String] The ID of the account detail.
+      #
+      # @param accounts_type [Symbol, ModernTreasury::AccountsType]
+      #
+      # @param account_id [String] The ID of the account.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::AccountDetail]
+      # @return [ModernTreasury::AccountDetail]
       #
       # @see ModernTreasury::Models::AccountDetailRetrieveParams
       def retrieve(id, params)
-        parsed, options = ModernTreasury::Models::AccountDetailRetrieveParams.dump_request(params)
+        parsed, options = ModernTreasury::AccountDetailRetrieveParams.dump_request(params)
         accounts_type =
           parsed.delete(:accounts_type) do
             raise ArgumentError.new("missing required path argument #{_1}")
@@ -56,7 +66,7 @@ module ModernTreasury
         @client.request(
           method: :get,
           path: ["api/%1$s/%2$s/account_details/%3$s", accounts_type, account_id, id],
-          model: ModernTreasury::Models::AccountDetail,
+          model: ModernTreasury::AccountDetail,
           options: options
         )
       end
@@ -65,17 +75,21 @@ module ModernTreasury
       #
       # @overload list(account_id, accounts_type:, after_cursor: nil, per_page: nil, request_options: {})
       #
-      # @param account_id [String]
-      # @param accounts_type [Symbol, ModernTreasury::Models::AccountsType]
-      # @param after_cursor [String, nil]
-      # @param per_page [Integer]
+      # @param account_id [String] Path param: The ID of the account.
+      #
+      # @param accounts_type [Symbol, ModernTreasury::AccountsType] Path param:
+      #
+      # @param after_cursor [String, nil] Query param:
+      #
+      # @param per_page [Integer] Query param:
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::AccountDetail>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::AccountDetail>]
       #
       # @see ModernTreasury::Models::AccountDetailListParams
       def list(account_id, params)
-        parsed, options = ModernTreasury::Models::AccountDetailListParams.dump_request(params)
+        parsed, options = ModernTreasury::AccountDetailListParams.dump_request(params)
         accounts_type =
           parsed.delete(:accounts_type) do
             raise ArgumentError.new("missing required path argument #{_1}")
@@ -85,7 +99,7 @@ module ModernTreasury
           path: ["api/%1$s/%2$s/account_details", accounts_type, account_id],
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::AccountDetail,
+          model: ModernTreasury::AccountDetail,
           options: options
         )
       end
@@ -94,16 +108,19 @@ module ModernTreasury
       #
       # @overload delete(id, accounts_type:, account_id:, request_options: {})
       #
-      # @param id [String]
-      # @param accounts_type [Symbol, ModernTreasury::Models::AccountDetailDeleteParams::AccountsType]
-      # @param account_id [String]
+      # @param id [String] The ID of the account detail.
+      #
+      # @param accounts_type [Symbol, ModernTreasury::AccountDetailDeleteParams::AccountsType]
+      #
+      # @param account_id [String] The ID of the account.
+      #
       # @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)
+        parsed, options = ModernTreasury::AccountDetailDeleteParams.dump_request(params)
         accounts_type =
           parsed.delete(:accounts_type) do
             raise ArgumentError.new("missing required path argument #{_1}")

data/lib/modern_treasury/resources/bulk_requests.rb

@@ -3,26 +3,33 @@
 module ModernTreasury
   module Resources
     class BulkRequests
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::BulkRequestCreateParams} for more details.
+      #
       # create bulk_request
       #
       # @overload create(action_type:, resource_type:, resources:, metadata: 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 action_type [Symbol, ModernTreasury::BulkRequestCreateParams::ActionType] One of create, or update.
+      #
+      # @param resource_type [Symbol, ModernTreasury::BulkRequestCreateParams::ResourceType] One of payment_order, expected_payment, or ledger_transaction.
+      #
+      # @param resources [Array<ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest, ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::BulkRequestCreateParams::Resource::ID, ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID>] An array of objects where each object contains the input params for a single `ac
+      #
+      # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::BulkRequest]
+      # @return [ModernTreasury::BulkRequest]
       #
       # @see ModernTreasury::Models::BulkRequestCreateParams
       def create(params)
-        parsed, options = ModernTreasury::Models::BulkRequestCreateParams.dump_request(params)
+        parsed, options = ModernTreasury::BulkRequestCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/bulk_requests",
           body: parsed,
-          model: ModernTreasury::Models::BulkRequest,
+          model: ModernTreasury::BulkRequest,
           options: options
         )
       end
@@ -31,44 +38,54 @@ module ModernTreasury
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] id
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::BulkRequest]
+      # @return [ModernTreasury::BulkRequest]
       #
       # @see ModernTreasury::Models::BulkRequestRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
           path: ["api/bulk_requests/%1$s", id],
-          model: ModernTreasury::Models::BulkRequest,
+          model: ModernTreasury::BulkRequest,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::BulkRequestListParams} for more details.
+      #
       # list bulk_requests
       #
       # @overload list(action_type: nil, after_cursor: nil, metadata: nil, per_page: nil, resource_type: nil, status: nil, request_options: {})
       #
-      # @param action_type [Symbol, ModernTreasury::Models::BulkRequestListParams::ActionType]
+      # @param action_type [Symbol, ModernTreasury::BulkRequestListParams::ActionType] One of create, or update.
+      #
       # @param after_cursor [String, nil]
-      # @param metadata [Hash{Symbol=>String}]
+      #
+      # @param metadata [Hash{Symbol=>String}] For example, if you want to query for records with metadata key `Type` and value
+      #
       # @param per_page [Integer]
-      # @param resource_type [Symbol, ModernTreasury::Models::BulkRequestListParams::ResourceType]
-      # @param status [Symbol, ModernTreasury::Models::BulkRequestListParams::Status]
+      #
+      # @param resource_type [Symbol, ModernTreasury::BulkRequestListParams::ResourceType] One of payment_order, expected_payment, or ledger_transaction.
+      #
+      # @param status [Symbol, ModernTreasury::BulkRequestListParams::Status] One of pending, processing, or completed.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::BulkRequest>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::BulkRequest>]
       #
       # @see ModernTreasury::Models::BulkRequestListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::BulkRequestListParams.dump_request(params)
+        parsed, options = ModernTreasury::BulkRequestListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/bulk_requests",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::BulkRequest,
+          model: ModernTreasury::BulkRequest,
           options: options
         )
       end

data/lib/modern_treasury/resources/bulk_results.rb

@@ -7,45 +7,56 @@ module ModernTreasury
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] id
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::BulkResult]
+      # @return [ModernTreasury::BulkResult]
       #
       # @see ModernTreasury::Models::BulkResultRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
           path: ["api/bulk_results/%1$s", id],
-          model: ModernTreasury::Models::BulkResult,
+          model: ModernTreasury::BulkResult,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::BulkResultListParams} for more details.
+      #
       # list bulk_results
       #
       # @overload list(after_cursor: nil, entity_id: nil, entity_type: nil, per_page: nil, request_id: nil, request_type: nil, status: nil, request_options: {})
       #
       # @param after_cursor [String, nil]
-      # @param entity_id [String]
-      # @param entity_type [Symbol, ModernTreasury::Models::BulkResultListParams::EntityType]
+      #
+      # @param entity_id [String] Unique identifier for the result entity object.
+      #
+      # @param entity_type [Symbol, ModernTreasury::BulkResultListParams::EntityType] The type of the request that created this result. bulk_request is the only suppo
+      #
       # @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_id [String] Unique identifier for the request that created this bulk result. This is the ID
+      #
+      # @param request_type [Symbol, ModernTreasury::BulkResultListParams::RequestType] The type of the request that created this result. bulk_request is the only suppo
+      #
+      # @param status [Symbol, ModernTreasury::BulkResultListParams::Status] One of successful or failed.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::BulkResult>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::BulkResult>]
       #
       # @see ModernTreasury::Models::BulkResultListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::BulkResultListParams.dump_request(params)
+        parsed, options = ModernTreasury::BulkResultListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/bulk_results",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::BulkResult,
+          model: ModernTreasury::BulkResult,
           options: options
         )
       end

data/lib/modern_treasury/resources/connection_legal_entities.rb

@@ -7,21 +7,24 @@ module ModernTreasury
       #
       # @overload create(connection_id:, legal_entity: nil, legal_entity_id: nil, request_options: {})
       #
-      # @param connection_id [String]
-      # @param legal_entity [ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity]
-      # @param legal_entity_id [String]
+      # @param connection_id [String] The ID of the connection.
+      #
+      # @param legal_entity [ModernTreasury::ConnectionLegalEntityCreateParams::LegalEntity] The legal entity.
+      #
+      # @param legal_entity_id [String] The ID of the legal entity.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::ConnectionLegalEntity]
+      # @return [ModernTreasury::ConnectionLegalEntity]
       #
       # @see ModernTreasury::Models::ConnectionLegalEntityCreateParams
       def create(params)
-        parsed, options = ModernTreasury::Models::ConnectionLegalEntityCreateParams.dump_request(params)
+        parsed, options = ModernTreasury::ConnectionLegalEntityCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/connection_legal_entities",
           body: parsed,
-          model: ModernTreasury::Models::ConnectionLegalEntity,
+          model: ModernTreasury::ConnectionLegalEntity,
           options: options
         )
       end
@@ -30,17 +33,18 @@ module ModernTreasury
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The id of an existing connection legal entity.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::ConnectionLegalEntity]
+      # @return [ModernTreasury::ConnectionLegalEntity]
       #
       # @see ModernTreasury::Models::ConnectionLegalEntityRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
           path: ["api/connection_legal_entities/%1$s", id],
-          model: ModernTreasury::Models::ConnectionLegalEntity,
+          model: ModernTreasury::ConnectionLegalEntity,
           options: params[:request_options]
         )
       end
@@ -49,20 +53,22 @@ module ModernTreasury
       #
       # @overload update(id, status: nil, request_options: {})
       #
-      # @param id [String]
-      # @param status [Symbol, ModernTreasury::Models::ConnectionLegalEntityUpdateParams::Status]
+      # @param id [String] The id of an existing connection legal entity.
+      #
+      # @param status [Symbol, ModernTreasury::ConnectionLegalEntityUpdateParams::Status] The status of the connection legal entity.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::ConnectionLegalEntity]
+      # @return [ModernTreasury::ConnectionLegalEntity]
       #
       # @see ModernTreasury::Models::ConnectionLegalEntityUpdateParams
       def update(id, params = {})
-        parsed, options = ModernTreasury::Models::ConnectionLegalEntityUpdateParams.dump_request(params)
+        parsed, options = ModernTreasury::ConnectionLegalEntityUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["api/connection_legal_entities/%1$s", id],
           body: parsed,
-          model: ModernTreasury::Models::ConnectionLegalEntity,
+          model: ModernTreasury::ConnectionLegalEntity,
           options: options
         )
       end
@@ -75,20 +81,20 @@ module ModernTreasury
       # @param connection_id [String]
       # @param legal_entity_id [String]
       # @param per_page [Integer]
-      # @param status [Symbol, ModernTreasury::Models::ConnectionLegalEntityListParams::Status]
+      # @param status [Symbol, ModernTreasury::ConnectionLegalEntityListParams::Status]
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::ConnectionLegalEntity>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::ConnectionLegalEntity>]
       #
       # @see ModernTreasury::Models::ConnectionLegalEntityListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::ConnectionLegalEntityListParams.dump_request(params)
+        parsed, options = ModernTreasury::ConnectionLegalEntityListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/connection_legal_entities",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::ConnectionLegalEntity,
+          model: ModernTreasury::ConnectionLegalEntity,
           options: options
         )
       end

data/lib/modern_treasury/resources/connections.rb

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