modern_treasury 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.17

data/lib/modern_treasury/resources/legal_entities.rb

@@ -5,60 +5,39 @@ module ModernTreasury
     class LegalEntities
       # create legal_entity
       #
-      # @param params [ModernTreasury::Models::LegalEntityCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LegalEntityCreateParams::LegalEntityType] :legal_entity_type The type of legal entity.
-      #
-      #   @option params [Array<ModernTreasury::Models::LegalEntityCreateParams::Address>] :addresses A list of addresses for the entity.
-      #
-      #   @option params [ModernTreasury::Models::BankSettings, nil] :bank_settings
-      #
-      #   @option params [String, nil] :business_name The business's legal business name.
-      #
-      #   @option params [String, nil] :citizenship_country The country of citizenship for an individual.
-      #
-      #   @option params [Date, nil] :date_formed A business's formation date (YYYY-MM-DD).
-      #
-      #   @option params [Date, nil] :date_of_birth An individual's date of birth (YYYY-MM-DD).
-      #
-      #   @option params [Array<String>] :doing_business_as_names
-      #
-      #   @option params [String, nil] :email The entity's primary email.
-      #
-      #   @option params [String, nil] :first_name An individual's first name.
-      #
-      #   @option params [Array<ModernTreasury::Models::LegalEntityCreateParams::Identification>] :identifications A list of identifications for the legal entity.
-      #
-      #   @option params [String, nil] :last_name An individual's last name.
-      #
-      #   @option params [Array<ModernTreasury::Models::LegalEntityCreateParams::LegalEntityAssociation>, nil] :legal_entity_associations The legal entity associations and its child legal entities.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LegalEntityCreateParams::LegalStructure, nil] :legal_structure The business's legal structure.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
-      #
-      #   @option params [String, nil] :middle_name An individual's middle name.
-      #
-      #   @option params [Array<ModernTreasury::Models::LegalEntityCreateParams::PhoneNumber>] :phone_numbers
-      #
-      #   @option params [Boolean, nil] :politically_exposed_person Whether the individual is a politically exposed person.
-      #
-      #   @option params [String, nil] :preferred_name An individual's preferred name.
-      #
-      #   @option params [String, nil] :prefix An individual's prefix.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LegalEntityCreateParams::RiskRating, nil] :risk_rating The risk rating of the legal entity. One of low, medium, high.
-      #
-      #   @option params [String, nil] :suffix An individual's suffix.
-      #
-      #   @option params [ModernTreasury::Models::WealthAndEmploymentDetails, nil] :wealth_and_employment_details
-      #
-      #   @option params [String, nil] :website The entity's primary website URL.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @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 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 request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LegalEntity]
+      #
+      # @see ModernTreasury::Models::LegalEntityCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::LegalEntityCreateParams.dump_request(params)
         @client.request(
@@ -72,17 +51,18 @@ module ModernTreasury
 
       # Get details on a single legal entity.
       #
-      # @param id [String] id
+      # @overload retrieve(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::LegalEntityRetrieveParams, 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::LegalEntity]
+      #
+      # @see ModernTreasury::Models::LegalEntityRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/legal_entities/%0s", id],
+          path: ["api/legal_entities/%1$s", id],
           model: ModernTreasury::Models::LegalEntity,
           options: params[:request_options]
         )
@@ -90,63 +70,43 @@ module ModernTreasury
 
       # Update a legal entity.
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::LegalEntityUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Array<ModernTreasury::Models::LegalEntityUpdateParams::Address>] :addresses A list of addresses for the entity.
-      #
-      #   @option params [ModernTreasury::Models::BankSettings, nil] :bank_settings
-      #
-      #   @option params [String, nil] :business_name The business's legal business name.
-      #
-      #   @option params [String, nil] :citizenship_country The country of citizenship for an individual.
-      #
-      #   @option params [Date, nil] :date_formed A business's formation date (YYYY-MM-DD).
-      #
-      #   @option params [Date, nil] :date_of_birth An individual's date of birth (YYYY-MM-DD).
-      #
-      #   @option params [Array<String>] :doing_business_as_names
-      #
-      #   @option params [String, nil] :email The entity's primary email.
-      #
-      #   @option params [String, nil] :first_name An individual's first name.
-      #
-      #   @option params [Array<ModernTreasury::Models::LegalEntityUpdateParams::Identification>] :identifications A list of identifications for the legal entity.
-      #
-      #   @option params [String, nil] :last_name An individual's last name.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LegalEntityUpdateParams::LegalStructure, nil] :legal_structure The business's legal structure.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
-      #
-      #   @option params [String, nil] :middle_name An individual's middle name.
-      #
-      #   @option params [Array<ModernTreasury::Models::LegalEntityUpdateParams::PhoneNumber>] :phone_numbers
-      #
-      #   @option params [Boolean, nil] :politically_exposed_person Whether the individual is a politically exposed person.
-      #
-      #   @option params [String, nil] :preferred_name An individual's preferred name.
-      #
-      #   @option params [String, nil] :prefix An individual's prefix.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LegalEntityUpdateParams::RiskRating, nil] :risk_rating The risk rating of the legal entity. One of low, medium, high.
-      #
-      #   @option params [String, nil] :suffix An individual's suffix.
-      #
-      #   @option params [ModernTreasury::Models::WealthAndEmploymentDetails, nil] :wealth_and_employment_details
-      #
-      #   @option params [String, nil] :website The entity's primary website URL.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @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 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 request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LegalEntity]
+      #
+      # @see ModernTreasury::Models::LegalEntityUpdateParams
       def update(id, params = {})
         parsed, options = ModernTreasury::Models::LegalEntityUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/legal_entities/%0s", id],
+          path: ["api/legal_entities/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::LegalEntity,
           options: options
@@ -155,35 +115,32 @@ module ModernTreasury
 
       # Get a list of all legal entities.
       #
-      # @param params [ModernTreasury::Models::LegalEntityListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LegalEntityListParams::LegalEntityType] :legal_entity_type
+      # @overload list(after_cursor: nil, legal_entity_type: nil, metadata: nil, per_page: nil, show_deleted: nil, request_options: {})
       #
-      #   @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.
+      # @param after_cursor [String, nil]
+      # @param legal_entity_type [Symbol, ModernTreasury::Models::LegalEntityListParams::LegalEntityType]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param per_page [Integer]
+      # @param show_deleted [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Integer] :per_page
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::LegalEntity>]
       #
-      #   @option params [String] :show_deleted
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::LegalEntity>]
+      # @see ModernTreasury::Models::LegalEntityListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::LegalEntityListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/legal_entities",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::LegalEntity,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/legal_entity_associations.rb

@@ -5,24 +5,19 @@ module ModernTreasury
     class LegalEntityAssociations
       # create legal_entity_association
       #
-      # @param params [ModernTreasury::Models::LegalEntityAssociationCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(parent_legal_entity_id:, relationship_types:, child_legal_entity: nil, child_legal_entity_id: nil, ownership_percentage: nil, title: nil, request_options: {})
       #
-      #   @option params [String] :parent_legal_entity_id The ID of the parent legal entity. This must be a business or joint legal
-      #     entity.
-      #
-      #   @option params [Array<Symbol, ModernTreasury::Models::LegalEntityAssociationCreateParams::RelationshipType>] :relationship_types
-      #
-      #   @option params [ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity] :child_legal_entity The child legal entity.
-      #
-      #   @option params [String] :child_legal_entity_id The ID of the child legal entity.
-      #
-      #   @option params [Integer, nil] :ownership_percentage The child entity's ownership percentage iff they are a beneficial owner.
-      #
-      #   @option params [String, nil] :title The job title of the child entity at the parent entity.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, 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 request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LegalEntityAssociation]
+      #
+      # @see ModernTreasury::Models::LegalEntityAssociationCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::LegalEntityAssociationCreateParams.dump_request(params)
         @client.request(
@@ -34,6 +29,8 @@ module ModernTreasury
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/line_items.rb

@@ -5,17 +5,16 @@ module ModernTreasury
     class LineItems
       # Get a single line item
       #
-      # @param id [String] The ID of the line item.
+      # @overload retrieve(id, itemizable_type:, itemizable_id:, request_options: {})
       #
-      # @param params [ModernTreasury::Models::LineItemRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LineItemRetrieveParams::ItemizableType] :itemizable_type One of `payment_orders` or `expected_payments`.
-      #
-      #   @option params [String] :itemizable_id The ID of the payment order or expected payment.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param itemizable_type [Symbol, ModernTreasury::Models::LineItemRetrieveParams::ItemizableType]
+      # @param itemizable_id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LineItem]
+      #
+      # @see ModernTreasury::Models::LineItemRetrieveParams
       def retrieve(id, params)
         parsed, options = ModernTreasury::Models::LineItemRetrieveParams.dump_request(params)
         itemizable_type =
@@ -28,7 +27,7 @@ module ModernTreasury
           end
         @client.request(
           method: :get,
-          path: ["api/%0s/%1s/line_items/%2s", itemizable_type, itemizable_id, id],
+          path: ["api/%1$s/%2$s/line_items/%3$s", itemizable_type, itemizable_id, id],
           model: ModernTreasury::Models::LineItem,
           options: options
         )
@@ -36,20 +35,17 @@ module ModernTreasury
 
       # update line item
       #
-      # @param id [String] Path param: The ID of the line item.
-      #
-      # @param params [ModernTreasury::Models::LineItemUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LineItemUpdateParams::ItemizableType] :itemizable_type Path param: One of `payment_orders` or `expected_payments`.
-      #
-      #   @option params [String] :itemizable_id Path param: The ID of the payment order or expected payment.
+      # @overload update(id, itemizable_type:, itemizable_id:, metadata: nil, request_options: {})
       #
-      #   @option params [Hash{Symbol=>String}] :metadata Body param: 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 id [String]
+      # @param itemizable_type [Symbol, ModernTreasury::Models::LineItemUpdateParams::ItemizableType]
+      # @param itemizable_id [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LineItem]
+      #
+      # @see ModernTreasury::Models::LineItemUpdateParams
       def update(id, params)
         parsed, options = ModernTreasury::Models::LineItemUpdateParams.dump_request(params)
         itemizable_type =
@@ -62,7 +58,7 @@ module ModernTreasury
           end
         @client.request(
           method: :patch,
-          path: ["api/%0s/%1s/line_items/%2s", itemizable_type, itemizable_id, id],
+          path: ["api/%1$s/%2$s/line_items/%3$s", itemizable_type, itemizable_id, id],
           body: parsed,
           model: ModernTreasury::Models::LineItem,
           options: options
@@ -71,19 +67,17 @@ module ModernTreasury
 
       # Get a list of line items
       #
-      # @param itemizable_id [String] Path param: The ID of the payment order or expected payment.
-      #
-      # @param params [ModernTreasury::Models::LineItemListParams, Hash{Symbol=>Object}] .
+      # @overload list(itemizable_id, itemizable_type:, after_cursor: nil, per_page: nil, request_options: {})
       #
-      #   @option params [Symbol, ModernTreasury::Models::LineItemListParams::ItemizableType] :itemizable_type Path param: One of `payment_orders` or `expected_payments`.
+      # @param itemizable_id [String]
+      # @param itemizable_type [Symbol, ModernTreasury::Models::LineItemListParams::ItemizableType]
+      # @param after_cursor [String, nil]
+      # @param per_page [Integer]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [String, nil] :after_cursor Query param:
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::LineItem>]
       #
-      #   @option params [Integer] :per_page Query param:
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::LineItem>]
+      # @see ModernTreasury::Models::LineItemListParams
       def list(itemizable_id, params)
         parsed, options = ModernTreasury::Models::LineItemListParams.dump_request(params)
         itemizable_type =
@@ -92,14 +86,16 @@ module ModernTreasury
           end
         @client.request(
           method: :get,
-          path: ["api/%0s/%1s/line_items", itemizable_type, itemizable_id],
+          path: ["api/%1$s/%2$s/line_items", itemizable_type, itemizable_id],
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::LineItem,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/paper_items.rb

@@ -5,17 +5,18 @@ module ModernTreasury
     class PaperItems
       # Get details on a single paper item.
       #
-      # @param id [String] id
+      # @overload retrieve(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::PaperItemRetrieveParams, 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::PaperItem]
+      #
+      # @see ModernTreasury::Models::PaperItemRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/paper_items/%0s", id],
+          path: ["api/paper_items/%1$s", id],
           model: ModernTreasury::Models::PaperItem,
           options: params[:request_options]
         )
@@ -23,34 +24,32 @@ module ModernTreasury
 
       # Get a list of all paper items.
       #
-      # @param params [ModernTreasury::Models::PaperItemListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [Date] :deposit_date_end Specify an inclusive end date (YYYY-MM-DD) when filtering by deposit_date
+      # @overload list(after_cursor: nil, deposit_date_end: nil, deposit_date_start: nil, lockbox_number: nil, per_page: nil, request_options: {})
       #
-      #   @option params [Date] :deposit_date_start Specify an inclusive start date (YYYY-MM-DD) when filtering by deposit_date
+      # @param after_cursor [String, nil]
+      # @param deposit_date_end [Date]
+      # @param deposit_date_start [Date]
+      # @param lockbox_number [String]
+      # @param per_page [Integer]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [String] :lockbox_number Specify `lockbox_number` if you wish to see paper items that are associated with
-      #     a specific lockbox number.
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::PaperItem>]
       #
-      #   @option params [Integer] :per_page
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::PaperItem>]
+      # @see ModernTreasury::Models::PaperItemListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::PaperItemListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/paper_items",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::PaperItem,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/payment_flows.rb

@@ -5,28 +5,19 @@ module ModernTreasury
     class PaymentFlows
       # create payment_flow
       #
-      # @param params [ModernTreasury::Models::PaymentFlowCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(amount:, counterparty_id:, currency:, direction:, originating_account_id:, due_date: nil, request_options: {})
       #
-      #   @option params [Integer] :amount Required. Value in specified currency's smallest unit. e.g. $10 would be
-      #     represented as 1000. Can be any integer up to 36 digits.
-      #
-      #   @option params [String] :counterparty_id Required. The ID of a counterparty associated with the payment. As part of the
-      #     payment workflow an external account will be associated with this model.
-      #
-      #   @option params [String] :currency Required. The currency of the payment.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::PaymentFlowCreateParams::Direction] :direction Required. Describes the direction money is flowing in the transaction. Can only
-      #     be `debit`. A `debit` pulls money from someone else's account to your own.
-      #
-      #   @option params [String] :originating_account_id Required. The ID of one of your organization's internal accounts.
-      #
-      #   @option params [Date] :due_date Optional. Can only be passed in when `effective_date_selection_enabled` is
-      #     `true`. When set, the due date is shown to your end-user in the pre-built UI as
-      #     they are selecting a payment `effective_date`.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, 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 request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::PaymentFlow]
+      #
+      # @see ModernTreasury::Models::PaymentFlowCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::PaymentFlowCreateParams.dump_request(params)
         @client.request(
@@ -40,17 +31,18 @@ module ModernTreasury
 
       # get payment_flow
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::PaymentFlowRetrieveParams, 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::PaymentFlow]
+      #
+      # @see ModernTreasury::Models::PaymentFlowRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/payment_flows/%0s", id],
+          path: ["api/payment_flows/%1$s", id],
           model: ModernTreasury::Models::PaymentFlow,
           options: params[:request_options]
         )
@@ -58,21 +50,20 @@ module ModernTreasury
 
       # update payment_flow
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::PaymentFlowUpdateParams, Hash{Symbol=>Object}] .
+      # @overload update(id, status:, request_options: {})
       #
-      #   @option params [Symbol, ModernTreasury::Models::PaymentFlowUpdateParams::Status] :status Required. The updated status of the payment flow. Can only be used to mark a
-      #     flow as `cancelled`.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param status [Symbol, ModernTreasury::Models::PaymentFlowUpdateParams::Status]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::PaymentFlow]
+      #
+      # @see ModernTreasury::Models::PaymentFlowUpdateParams
       def update(id, params)
         parsed, options = ModernTreasury::Models::PaymentFlowUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/payment_flows/%0s", id],
+          path: ["api/payment_flows/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::PaymentFlow,
           options: options
@@ -81,39 +72,35 @@ module ModernTreasury
 
       # list payment_flows
       #
-      # @param params [ModernTreasury::Models::PaymentFlowListParams, 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, originating_account_id: nil, payment_order_id: nil, per_page: nil, receiving_account_id: nil, status: nil, request_options: {})
       #
-      #   @option params [String] :originating_account_id
+      # @param after_cursor [String, nil]
+      # @param client_token [String]
+      # @param counterparty_id [String]
+      # @param originating_account_id [String]
+      # @param payment_order_id [String]
+      # @param per_page [Integer]
+      # @param receiving_account_id [String]
+      # @param status [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [String] :payment_order_id
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::PaymentFlow>]
       #
-      #   @option params [Integer] :per_page
-      #
-      #   @option params [String] :receiving_account_id
-      #
-      #   @option params [String] :status
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::PaymentFlow>]
+      # @see ModernTreasury::Models::PaymentFlowListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::PaymentFlowListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/payment_flows",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::PaymentFlow,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client