modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.19

data/lib/modern_treasury/resources/legal_entities.rb

@@ -3,48 +3,77 @@
 module ModernTreasury
   module Resources
     class LegalEntities
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::LegalEntityCreateParams} for more details.
+      #
       # create legal_entity
       #
       # @overload create(legal_entity_type:, addresses: nil, bank_settings: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, first_name: nil, identifications: nil, industry_classifications: nil, last_name: nil, legal_entity_associations: nil, legal_structure: nil, metadata: nil, middle_name: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, risk_rating: nil, suffix: nil, wealth_and_employment_details: nil, website: nil, request_options: {})
       #
-      # @param legal_entity_type [Symbol, ModernTreasury::Models::LegalEntityCreateParams::LegalEntityType]
-      # @param addresses [Array<ModernTreasury::Models::LegalEntityCreateParams::Address>]
-      # @param bank_settings [ModernTreasury::Models::BankSettings, nil]
-      # @param business_name [String, nil]
-      # @param citizenship_country [String, nil]
-      # @param compliance_details [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
-      # @param date_formed [Date, nil]
-      # @param date_of_birth [Date, nil]
+      # @param legal_entity_type [Symbol, ModernTreasury::LegalEntityCreateParams::LegalEntityType] The type of legal entity.
+      #
+      # @param addresses [Array<ModernTreasury::LegalEntityCreateParams::Address>] A list of addresses for the entity.
+      #
+      # @param bank_settings [ModernTreasury::BankSettings, nil]
+      #
+      # @param business_name [String, nil] The business's legal business name.
+      #
+      # @param citizenship_country [String, nil] The country of citizenship for an individual.
+      #
+      # @param compliance_details [ModernTreasury::LegalEntityComplianceDetail, nil]
+      #
+      # @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
+      #
+      # @param date_of_birth [Date, nil] An individual's date of birth (YYYY-MM-DD).
+      #
       # @param doing_business_as_names [Array<String>]
-      # @param email [String, nil]
-      # @param first_name [String, nil]
-      # @param identifications [Array<ModernTreasury::Models::LegalEntityCreateParams::Identification>]
-      # @param industry_classifications [Array<ModernTreasury::Models::LegalEntityIndustryClassification>]
-      # @param last_name [String, nil]
-      # @param legal_entity_associations [Array<ModernTreasury::Models::LegalEntityCreateParams::LegalEntityAssociation>, nil]
-      # @param legal_structure [Symbol, ModernTreasury::Models::LegalEntityCreateParams::LegalStructure, nil]
-      # @param metadata [Hash{Symbol=>String}]
-      # @param middle_name [String, nil]
-      # @param phone_numbers [Array<ModernTreasury::Models::LegalEntityCreateParams::PhoneNumber>]
-      # @param politically_exposed_person [Boolean, nil]
-      # @param preferred_name [String, nil]
-      # @param prefix [String, nil]
-      # @param risk_rating [Symbol, ModernTreasury::Models::LegalEntityCreateParams::RiskRating, nil]
-      # @param suffix [String, nil]
-      # @param wealth_and_employment_details [ModernTreasury::Models::WealthAndEmploymentDetails, nil]
-      # @param website [String, nil]
+      #
+      # @param email [String, nil] The entity's primary email.
+      #
+      # @param first_name [String, nil] An individual's first name.
+      #
+      # @param identifications [Array<ModernTreasury::LegalEntityCreateParams::Identification>] A list of identifications for the legal entity.
+      #
+      # @param industry_classifications [Array<ModernTreasury::LegalEntityIndustryClassification>] A list of industry classifications for the legal entity.
+      #
+      # @param last_name [String, nil] An individual's last name.
+      #
+      # @param legal_entity_associations [Array<ModernTreasury::LegalEntityCreateParams::LegalEntityAssociation>, nil] The legal entity associations and its child legal entities.
+      #
+      # @param legal_structure [Symbol, ModernTreasury::LegalEntityCreateParams::LegalStructure, nil] The business's legal structure.
+      #
+      # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      # @param middle_name [String, nil] An individual's middle name.
+      #
+      # @param phone_numbers [Array<ModernTreasury::LegalEntityCreateParams::PhoneNumber>]
+      #
+      # @param politically_exposed_person [Boolean, nil] Whether the individual is a politically exposed person.
+      #
+      # @param preferred_name [String, nil] An individual's preferred name.
+      #
+      # @param prefix [String, nil] An individual's prefix.
+      #
+      # @param risk_rating [Symbol, ModernTreasury::LegalEntityCreateParams::RiskRating, nil] The risk rating of the legal entity. One of low, medium, high.
+      #
+      # @param suffix [String, nil] An individual's suffix.
+      #
+      # @param wealth_and_employment_details [ModernTreasury::WealthAndEmploymentDetails, nil]
+      #
+      # @param website [String, nil] The entity's primary website URL.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::LegalEntity]
+      # @return [ModernTreasury::LegalEntity]
       #
       # @see ModernTreasury::Models::LegalEntityCreateParams
       def create(params)
-        parsed, options = ModernTreasury::Models::LegalEntityCreateParams.dump_request(params)
+        parsed, options = ModernTreasury::LegalEntityCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/legal_entities",
           body: parsed,
-          model: ModernTreasury::Models::LegalEntity,
+          model: ModernTreasury::LegalEntity,
           options: options
         )
       end
@@ -53,88 +82,125 @@ 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::LegalEntity]
+      # @return [ModernTreasury::LegalEntity]
       #
       # @see ModernTreasury::Models::LegalEntityRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
           path: ["api/legal_entities/%1$s", id],
-          model: ModernTreasury::Models::LegalEntity,
+          model: ModernTreasury::LegalEntity,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::LegalEntityUpdateParams} for more details.
+      #
       # Update a legal entity.
       #
       # @overload update(id, addresses: nil, bank_settings: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, first_name: nil, identifications: nil, industry_classifications: nil, last_name: nil, legal_structure: nil, metadata: nil, middle_name: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, risk_rating: nil, suffix: nil, wealth_and_employment_details: nil, website: nil, request_options: {})
       #
-      # @param id [String]
-      # @param addresses [Array<ModernTreasury::Models::LegalEntityUpdateParams::Address>]
-      # @param bank_settings [ModernTreasury::Models::BankSettings, nil]
-      # @param business_name [String, nil]
-      # @param citizenship_country [String, nil]
-      # @param compliance_details [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
-      # @param date_formed [Date, nil]
-      # @param date_of_birth [Date, nil]
+      # @param id [String] id
+      #
+      # @param addresses [Array<ModernTreasury::LegalEntityUpdateParams::Address>] A list of addresses for the entity.
+      #
+      # @param bank_settings [ModernTreasury::BankSettings, nil]
+      #
+      # @param business_name [String, nil] The business's legal business name.
+      #
+      # @param citizenship_country [String, nil] The country of citizenship for an individual.
+      #
+      # @param compliance_details [ModernTreasury::LegalEntityComplianceDetail, nil]
+      #
+      # @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
+      #
+      # @param date_of_birth [Date, nil] An individual's date of birth (YYYY-MM-DD).
+      #
       # @param doing_business_as_names [Array<String>]
-      # @param email [String, nil]
-      # @param first_name [String, nil]
-      # @param identifications [Array<ModernTreasury::Models::LegalEntityUpdateParams::Identification>]
-      # @param industry_classifications [Array<ModernTreasury::Models::LegalEntityIndustryClassification>]
-      # @param last_name [String, nil]
-      # @param legal_structure [Symbol, ModernTreasury::Models::LegalEntityUpdateParams::LegalStructure, nil]
-      # @param metadata [Hash{Symbol=>String}]
-      # @param middle_name [String, nil]
-      # @param phone_numbers [Array<ModernTreasury::Models::LegalEntityUpdateParams::PhoneNumber>]
-      # @param politically_exposed_person [Boolean, nil]
-      # @param preferred_name [String, nil]
-      # @param prefix [String, nil]
-      # @param risk_rating [Symbol, ModernTreasury::Models::LegalEntityUpdateParams::RiskRating, nil]
-      # @param suffix [String, nil]
-      # @param wealth_and_employment_details [ModernTreasury::Models::WealthAndEmploymentDetails, nil]
-      # @param website [String, nil]
+      #
+      # @param email [String, nil] The entity's primary email.
+      #
+      # @param first_name [String, nil] An individual's first name.
+      #
+      # @param identifications [Array<ModernTreasury::LegalEntityUpdateParams::Identification>] A list of identifications for the legal entity.
+      #
+      # @param industry_classifications [Array<ModernTreasury::LegalEntityIndustryClassification>] A list of industry classifications for the legal entity.
+      #
+      # @param last_name [String, nil] An individual's last name.
+      #
+      # @param legal_structure [Symbol, ModernTreasury::LegalEntityUpdateParams::LegalStructure, nil] The business's legal structure.
+      #
+      # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      # @param middle_name [String, nil] An individual's middle name.
+      #
+      # @param phone_numbers [Array<ModernTreasury::LegalEntityUpdateParams::PhoneNumber>]
+      #
+      # @param politically_exposed_person [Boolean, nil] Whether the individual is a politically exposed person.
+      #
+      # @param preferred_name [String, nil] An individual's preferred name.
+      #
+      # @param prefix [String, nil] An individual's prefix.
+      #
+      # @param risk_rating [Symbol, ModernTreasury::LegalEntityUpdateParams::RiskRating, nil] The risk rating of the legal entity. One of low, medium, high.
+      #
+      # @param suffix [String, nil] An individual's suffix.
+      #
+      # @param wealth_and_employment_details [ModernTreasury::WealthAndEmploymentDetails, nil]
+      #
+      # @param website [String, nil] The entity's primary website URL.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::LegalEntity]
+      # @return [ModernTreasury::LegalEntity]
       #
       # @see ModernTreasury::Models::LegalEntityUpdateParams
       def update(id, params = {})
-        parsed, options = ModernTreasury::Models::LegalEntityUpdateParams.dump_request(params)
+        parsed, options = ModernTreasury::LegalEntityUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["api/legal_entities/%1$s", id],
           body: parsed,
-          model: ModernTreasury::Models::LegalEntity,
+          model: ModernTreasury::LegalEntity,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::LegalEntityListParams} for more details.
+      #
       # Get a list of all legal entities.
       #
       # @overload list(after_cursor: nil, legal_entity_type: nil, metadata: nil, per_page: nil, show_deleted: nil, request_options: {})
       #
       # @param after_cursor [String, nil]
-      # @param legal_entity_type [Symbol, ModernTreasury::Models::LegalEntityListParams::LegalEntityType]
-      # @param metadata [Hash{Symbol=>String}]
+      #
+      # @param legal_entity_type [Symbol, ModernTreasury::LegalEntityListParams::LegalEntityType]
+      #
+      # @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 show_deleted [String]
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::LegalEntity>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::LegalEntity>]
       #
       # @see ModernTreasury::Models::LegalEntityListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::LegalEntityListParams.dump_request(params)
+        parsed, options = ModernTreasury::LegalEntityListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/legal_entities",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::LegalEntity,
+          model: ModernTreasury::LegalEntity,
           options: options
         )
       end

data/lib/modern_treasury/resources/legal_entity_associations.rb

@@ -3,28 +3,37 @@
 module ModernTreasury
   module Resources
     class LegalEntityAssociations
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::LegalEntityAssociationCreateParams} for more details.
+      #
       # create legal_entity_association
       #
       # @overload create(parent_legal_entity_id:, relationship_types:, child_legal_entity: nil, child_legal_entity_id: nil, ownership_percentage: nil, title: nil, request_options: {})
       #
-      # @param parent_legal_entity_id [String]
-      # @param relationship_types [Array<Symbol, ModernTreasury::Models::LegalEntityAssociationCreateParams::RelationshipType>]
-      # @param child_legal_entity [ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity]
-      # @param child_legal_entity_id [String]
-      # @param ownership_percentage [Integer, nil]
-      # @param title [String, nil]
+      # @param parent_legal_entity_id [String] The ID of the parent legal entity. This must be a business or joint legal entity
+      #
+      # @param relationship_types [Array<Symbol, ModernTreasury::LegalEntityAssociationCreateParams::RelationshipType>]
+      #
+      # @param child_legal_entity [ModernTreasury::LegalEntityAssociationCreateParams::ChildLegalEntity] The child legal entity.
+      #
+      # @param child_legal_entity_id [String] The ID of the child legal entity.
+      #
+      # @param ownership_percentage [Integer, nil] The child entity's ownership percentage iff they are a beneficial owner.
+      #
+      # @param title [String, nil] The job title of the child entity at the parent entity.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::LegalEntityAssociation]
+      # @return [ModernTreasury::LegalEntityAssociation]
       #
       # @see ModernTreasury::Models::LegalEntityAssociationCreateParams
       def create(params)
-        parsed, options = ModernTreasury::Models::LegalEntityAssociationCreateParams.dump_request(params)
+        parsed, options = ModernTreasury::LegalEntityAssociationCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/legal_entity_associations",
           body: parsed,
-          model: ModernTreasury::Models::LegalEntityAssociation,
+          model: ModernTreasury::LegalEntityAssociation,
           options: options
         )
       end

data/lib/modern_treasury/resources/line_items.rb

@@ -7,16 +7,19 @@ module ModernTreasury
       #
       # @overload retrieve(id, itemizable_type:, itemizable_id:, request_options: {})
       #
-      # @param id [String]
-      # @param itemizable_type [Symbol, ModernTreasury::Models::LineItemRetrieveParams::ItemizableType]
-      # @param itemizable_id [String]
+      # @param id [String] The ID of the line item.
+      #
+      # @param itemizable_type [Symbol, ModernTreasury::LineItemRetrieveParams::ItemizableType] One of `payment_orders` or `expected_payments`.
+      #
+      # @param itemizable_id [String] The ID of the payment order or expected payment.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::LineItem]
+      # @return [ModernTreasury::LineItem]
       #
       # @see ModernTreasury::Models::LineItemRetrieveParams
       def retrieve(id, params)
-        parsed, options = ModernTreasury::Models::LineItemRetrieveParams.dump_request(params)
+        parsed, options = ModernTreasury::LineItemRetrieveParams.dump_request(params)
         itemizable_type =
           parsed.delete(:itemizable_type) do
             raise ArgumentError.new("missing required path argument #{_1}")
@@ -28,26 +31,33 @@ module ModernTreasury
         @client.request(
           method: :get,
           path: ["api/%1$s/%2$s/line_items/%3$s", itemizable_type, itemizable_id, id],
-          model: ModernTreasury::Models::LineItem,
+          model: ModernTreasury::LineItem,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::LineItemUpdateParams} for more details.
+      #
       # update line item
       #
       # @overload update(id, itemizable_type:, itemizable_id:, metadata: nil, request_options: {})
       #
-      # @param id [String]
-      # @param itemizable_type [Symbol, ModernTreasury::Models::LineItemUpdateParams::ItemizableType]
-      # @param itemizable_id [String]
-      # @param metadata [Hash{Symbol=>String}]
+      # @param id [String] Path param: The ID of the line item.
+      #
+      # @param itemizable_type [Symbol, ModernTreasury::LineItemUpdateParams::ItemizableType] Path param: One of `payment_orders` or `expected_payments`.
+      #
+      # @param itemizable_id [String] Path param: The ID of the payment order or expected payment.
+      #
+      # @param metadata [Hash{Symbol=>String}] Body param: Additional data represented as key-value pairs. Both the key and val
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::LineItem]
+      # @return [ModernTreasury::LineItem]
       #
       # @see ModernTreasury::Models::LineItemUpdateParams
       def update(id, params)
-        parsed, options = ModernTreasury::Models::LineItemUpdateParams.dump_request(params)
+        parsed, options = ModernTreasury::LineItemUpdateParams.dump_request(params)
         itemizable_type =
           parsed.delete(:itemizable_type) do
             raise ArgumentError.new("missing required path argument #{_1}")
@@ -60,7 +70,7 @@ module ModernTreasury
           method: :patch,
           path: ["api/%1$s/%2$s/line_items/%3$s", itemizable_type, itemizable_id, id],
           body: parsed,
-          model: ModernTreasury::Models::LineItem,
+          model: ModernTreasury::LineItem,
           options: options
         )
       end
@@ -69,17 +79,21 @@ module ModernTreasury
       #
       # @overload list(itemizable_id, itemizable_type:, after_cursor: nil, per_page: nil, request_options: {})
       #
-      # @param itemizable_id [String]
-      # @param itemizable_type [Symbol, ModernTreasury::Models::LineItemListParams::ItemizableType]
-      # @param after_cursor [String, nil]
-      # @param per_page [Integer]
+      # @param itemizable_id [String] Path param: The ID of the payment order or expected payment.
+      #
+      # @param itemizable_type [Symbol, ModernTreasury::LineItemListParams::ItemizableType] Path param: One of `payment_orders` or `expected_payments`.
+      #
+      # @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::LineItem>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::LineItem>]
       #
       # @see ModernTreasury::Models::LineItemListParams
       def list(itemizable_id, params)
-        parsed, options = ModernTreasury::Models::LineItemListParams.dump_request(params)
+        parsed, options = ModernTreasury::LineItemListParams.dump_request(params)
         itemizable_type =
           parsed.delete(:itemizable_type) do
             raise ArgumentError.new("missing required path argument #{_1}")
@@ -89,7 +103,7 @@ module ModernTreasury
           path: ["api/%1$s/%2$s/line_items", itemizable_type, itemizable_id],
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::LineItem,
+          model: ModernTreasury::LineItem,
           options: options
         )
       end

data/lib/modern_treasury/resources/paper_items.rb

@@ -7,43 +7,52 @@ 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::PaperItem]
+      # @return [ModernTreasury::PaperItem]
       #
       # @see ModernTreasury::Models::PaperItemRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
           path: ["api/paper_items/%1$s", id],
-          model: ModernTreasury::Models::PaperItem,
+          model: ModernTreasury::PaperItem,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::PaperItemListParams} for more details.
+      #
       # Get a list of all paper items.
       #
       # @overload list(after_cursor: nil, deposit_date_end: nil, deposit_date_start: nil, lockbox_number: nil, per_page: nil, request_options: {})
       #
       # @param after_cursor [String, nil]
-      # @param deposit_date_end [Date]
-      # @param deposit_date_start [Date]
-      # @param lockbox_number [String]
+      #
+      # @param deposit_date_end [Date] Specify an inclusive end date (YYYY-MM-DD) when filtering by deposit_date
+      #
+      # @param deposit_date_start [Date] Specify an inclusive start date (YYYY-MM-DD) when filtering by deposit_date
+      #
+      # @param lockbox_number [String] Specify `lockbox_number` if you wish to see paper items that are associated with
+      #
       # @param per_page [Integer]
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::PaperItem>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::PaperItem>]
       #
       # @see ModernTreasury::Models::PaperItemListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::PaperItemListParams.dump_request(params)
+        parsed, options = ModernTreasury::PaperItemListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/paper_items",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::PaperItem,
+          model: ModernTreasury::PaperItem,
           options: options
         )
       end

data/lib/modern_treasury/resources/payment_flows.rb

@@ -3,28 +3,37 @@
 module ModernTreasury
   module Resources
     class PaymentFlows
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::PaymentFlowCreateParams} for more details.
+      #
       # create payment_flow
       #
       # @overload create(amount:, counterparty_id:, currency:, direction:, originating_account_id:, due_date: nil, request_options: {})
       #
-      # @param amount [Integer]
-      # @param counterparty_id [String]
-      # @param currency [String]
-      # @param direction [Symbol, ModernTreasury::Models::PaymentFlowCreateParams::Direction]
-      # @param originating_account_id [String]
-      # @param due_date [Date]
+      # @param amount [Integer] Required. Value in specified currency's smallest unit. e.g. $10 would be represe
+      #
+      # @param counterparty_id [String] Required. The ID of a counterparty associated with the payment. As part of the p
+      #
+      # @param currency [String] Required. The currency of the payment.
+      #
+      # @param direction [Symbol, ModernTreasury::PaymentFlowCreateParams::Direction] Required. Describes the direction money is flowing in the transaction. Can only
+      #
+      # @param originating_account_id [String] Required. The ID of one of your organization's internal accounts.
+      #
+      # @param due_date [Date] Optional. Can only be passed in when `effective_date_selection_enabled` is `true
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::PaymentFlow]
+      # @return [ModernTreasury::PaymentFlow]
       #
       # @see ModernTreasury::Models::PaymentFlowCreateParams
       def create(params)
-        parsed, options = ModernTreasury::Models::PaymentFlowCreateParams.dump_request(params)
+        parsed, options = ModernTreasury::PaymentFlowCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/payment_flows",
           body: parsed,
-          model: ModernTreasury::Models::PaymentFlow,
+          model: ModernTreasury::PaymentFlow,
           options: options
         )
       end
@@ -33,39 +42,45 @@ 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::PaymentFlow]
+      # @return [ModernTreasury::PaymentFlow]
       #
       # @see ModernTreasury::Models::PaymentFlowRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
           path: ["api/payment_flows/%1$s", id],
-          model: ModernTreasury::Models::PaymentFlow,
+          model: ModernTreasury::PaymentFlow,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::PaymentFlowUpdateParams} for more details.
+      #
       # update payment_flow
       #
       # @overload update(id, status:, request_options: {})
       #
-      # @param id [String]
-      # @param status [Symbol, ModernTreasury::Models::PaymentFlowUpdateParams::Status]
+      # @param id [String] id
+      #
+      # @param status [Symbol, ModernTreasury::PaymentFlowUpdateParams::Status] Required. The updated status of the payment flow. Can only be used to mark a flo
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::PaymentFlow]
+      # @return [ModernTreasury::PaymentFlow]
       #
       # @see ModernTreasury::Models::PaymentFlowUpdateParams
       def update(id, params)
-        parsed, options = ModernTreasury::Models::PaymentFlowUpdateParams.dump_request(params)
+        parsed, options = ModernTreasury::PaymentFlowUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["api/payment_flows/%1$s", id],
           body: parsed,
-          model: ModernTreasury::Models::PaymentFlow,
+          model: ModernTreasury::PaymentFlow,
           options: options
         )
       end
@@ -84,17 +99,17 @@ module ModernTreasury
       # @param status [String]
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::PaymentFlow>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::PaymentFlow>]
       #
       # @see ModernTreasury::Models::PaymentFlowListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::PaymentFlowListParams.dump_request(params)
+        parsed, options = ModernTreasury::PaymentFlowListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/payment_flows",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::PaymentFlow,
+          model: ModernTreasury::PaymentFlow,
           options: options
         )
       end