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

data/lib/modern_treasury/resources/counterparties.rb

@@ -5,36 +5,24 @@ module ModernTreasury
     class Counterparties
       # Create a new counterparty.
       #
-      # @param params [ModernTreasury::Models::CounterpartyCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :name A human friendly name for this counterparty.
-      #
-      #   @option params [ModernTreasury::Models::CounterpartyCreateParams::Accounting] :accounting
-      #
-      #   @option params [Array<ModernTreasury::Models::CounterpartyCreateParams::Account>] :accounts The accounts for this counterparty.
-      #
-      #   @option params [String, nil] :email The counterparty's email.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LedgerType] :ledger_type An optional type to auto-sync the counterparty to your ledger. Either `customer`
-      #     or `vendor`.
-      #
-      #   @option params [ModernTreasury::Models::CounterpartyCreateParams::LegalEntity] :legal_entity
-      #
-      #   @option params [String, nil] :legal_entity_id The id of the legal entity.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
-      #
-      #   @option params [Boolean] :send_remittance_advice Send an email to the counterparty whenever an associated payment order is sent
-      #     to the bank.
-      #
-      #   @option params [String] :taxpayer_identifier Either a valid SSN or EIN.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::CounterpartyCreateParams::VerificationStatus] :verification_status The verification status of the counterparty.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @overload create(name:, accounting: nil, accounts: nil, email: nil, ledger_type: nil, legal_entity: nil, legal_entity_id: nil, metadata: nil, send_remittance_advice: nil, taxpayer_identifier: nil, verification_status: nil, request_options: {})
+      #
+      # @param name [String, nil]
+      # @param accounting [ModernTreasury::Models::CounterpartyCreateParams::Accounting]
+      # @param accounts [Array<ModernTreasury::Models::CounterpartyCreateParams::Account>]
+      # @param email [String, nil]
+      # @param ledger_type [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LedgerType]
+      # @param legal_entity [ModernTreasury::Models::CounterpartyCreateParams::LegalEntity]
+      # @param legal_entity_id [String, nil]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param send_remittance_advice [Boolean]
+      # @param taxpayer_identifier [String]
+      # @param verification_status [Symbol, ModernTreasury::Models::CounterpartyCreateParams::VerificationStatus]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::Counterparty]
+      #
+      # @see ModernTreasury::Models::CounterpartyCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::CounterpartyCreateParams.dump_request(params)
         @client.request(
@@ -48,17 +36,18 @@ module ModernTreasury
 
       # Get details on a single counterparty.
       #
-      # @param id [String] The id of an existing counterparty.
+      # @overload retrieve(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::CounterpartyRetrieveParams, 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::Counterparty]
+      #
+      # @see ModernTreasury::Models::CounterpartyRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/counterparties/%0s", id],
+          path: ["api/counterparties/%1$s", id],
           model: ModernTreasury::Models::Counterparty,
           options: params[:request_options]
         )
@@ -66,32 +55,25 @@ module ModernTreasury
 
       # Updates a given counterparty with new information.
       #
-      # @param id [String] The id of an existing counterparty.
-      #
-      # @param params [ModernTreasury::Models::CounterpartyUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :email A new email for the counterparty.
-      #
-      #   @option params [String, nil] :legal_entity_id The id of the legal entity.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data in the form of key-value pairs. Pairs can be removed by passing
-      #     an empty string or `null` as the value.
-      #
-      #   @option params [String] :name A new name for the counterparty. Will only update if passed.
+      # @overload update(id, email: nil, legal_entity_id: nil, metadata: nil, name: nil, send_remittance_advice: nil, taxpayer_identifier: nil, request_options: {})
       #
-      #   @option params [Boolean] :send_remittance_advice If this is `true`, Modern Treasury will send an email to the counterparty
-      #     whenever an associated payment order is sent to the bank.
-      #
-      #   @option params [String] :taxpayer_identifier Either a valid SSN or EIN.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param email [String]
+      # @param legal_entity_id [String, nil]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param name [String]
+      # @param send_remittance_advice [Boolean]
+      # @param taxpayer_identifier [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::Counterparty]
+      #
+      # @see ModernTreasury::Models::CounterpartyUpdateParams
       def update(id, params = {})
         parsed, options = ModernTreasury::Models::CounterpartyUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/counterparties/%0s", id],
+          path: ["api/counterparties/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::Counterparty,
           options: options
@@ -100,38 +82,28 @@ module ModernTreasury
 
       # Get a paginated list of all counterparties.
       #
-      # @param params [ModernTreasury::Models::CounterpartyListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [Time] :created_at_lower_bound Used to return counterparties created after some datetime.
-      #
-      #   @option params [Time] :created_at_upper_bound Used to return counterparties created before some datetime.
-      #
-      #   @option params [String] :email Performs a partial string match of the email field. This is also case
-      #     insensitive.
-      #
-      #   @option params [String] :legal_entity_id Filters for counterparties with the given legal entity ID.
-      #
-      #   @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 [String] :name Performs a partial string match of the name field. This is also case
-      #     insensitive.
+      # @overload list(after_cursor: nil, created_at_lower_bound: nil, created_at_upper_bound: nil, email: nil, legal_entity_id: nil, metadata: nil, name: nil, per_page: nil, request_options: {})
       #
-      #   @option params [Integer] :per_page
+      # @param after_cursor [String, nil]
+      # @param created_at_lower_bound [Time]
+      # @param created_at_upper_bound [Time]
+      # @param email [String]
+      # @param legal_entity_id [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param name [String]
+      # @param per_page [Integer]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::Counterparty>]
       #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::Counterparty>]
+      # @see ModernTreasury::Models::CounterpartyListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::CounterpartyListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/counterparties",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::Counterparty,
           options: options
         )
@@ -139,17 +111,18 @@ module ModernTreasury
 
       # Deletes a given counterparty.
       #
-      # @param id [String] The id of an existing counterparty.
+      # @overload delete(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::CounterpartyDeleteParams, 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 [nil]
+      #
+      # @see ModernTreasury::Models::CounterpartyDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
-          path: ["api/counterparties/%0s", id],
+          path: ["api/counterparties/%1$s", id],
           model: NilClass,
           options: params[:request_options]
         )
@@ -157,43 +130,31 @@ module ModernTreasury
 
       # Send an email requesting account details.
       #
-      # @param id [String] counterparty id
-      #
-      # @param params [ModernTreasury::Models::CounterpartyCollectAccountParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Symbol, ModernTreasury::Models::TransactionDirection] :direction One of `credit` or `debit`. Use `credit` when you want to pay a counterparty.
-      #     Use `debit` when you need to charge a counterparty. This field helps us send a
-      #     more tailored email to your counterparties."
-      #
-      #   @option params [String] :custom_redirect The URL you want your customer to visit upon filling out the form. By default,
-      #     they will be sent to a Modern Treasury landing page. This must be a valid HTTPS
-      #     URL if set.
+      # @overload collect_account(id, direction:, custom_redirect: nil, fields: nil, send_email: nil, request_options: {})
       #
-      #   @option params [Array<Symbol, ModernTreasury::Models::CounterpartyCollectAccountParams::Field>] :fields The list of fields you want on the form. This field is optional and if it is not
-      #     set, will default to [\"nameOnAccount\", \"accountType\", \"accountNumber\",
-      #     \"routingNumber\", \"address\"]. The full list of options is [\"name\",
-      #     \"nameOnAccount\", \"taxpayerIdentifier\", \"accountType\", \"accountNumber\",
-      #     \"routingNumber\", \"address\", \"ibanNumber\", \"swiftCode\"].
-      #
-      #   @option params [Boolean] :send_email By default, Modern Treasury will send an email to your counterparty that
-      #     includes a link to the form they must fill out. However, if you would like to
-      #     send the counterparty the link, you can set this parameter to `false`. The JSON
-      #     body will include the link to the secure Modern Treasury form.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param direction [Symbol, ModernTreasury::Models::TransactionDirection]
+      # @param custom_redirect [String]
+      # @param fields [Array<Symbol, ModernTreasury::Models::CounterpartyCollectAccountParams::Field>]
+      # @param send_email [Boolean]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::CounterpartyCollectAccountResponse]
+      #
+      # @see ModernTreasury::Models::CounterpartyCollectAccountParams
       def collect_account(id, params)
         parsed, options = ModernTreasury::Models::CounterpartyCollectAccountParams.dump_request(params)
         @client.request(
           method: :post,
-          path: ["api/counterparties/%0s/collect_account", id],
+          path: ["api/counterparties/%1$s/collect_account", id],
           body: parsed,
           model: ModernTreasury::Models::CounterpartyCollectAccountResponse,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/documents.rb

@@ -5,19 +5,17 @@ module ModernTreasury
     class Documents
       # Create a document.
       #
-      # @param params [ModernTreasury::Models::DocumentCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(documentable_id:, documentable_type:, file:, document_type: nil, request_options: {})
       #
-      #   @option params [String] :documentable_id The unique identifier for the associated object.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::DocumentCreateParams::DocumentableType] :documentable_type
-      #
-      #   @option params [IO, StringIO] :file
-      #
-      #   @option params [String] :document_type A category given to the document, can be `null`.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param documentable_id [String]
+      # @param documentable_type [Symbol, ModernTreasury::Models::DocumentCreateParams::DocumentableType]
+      # @param file [Pathname, StringIO]
+      # @param document_type [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::Document]
+      #
+      # @see ModernTreasury::Models::DocumentCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::DocumentCreateParams.dump_request(params)
         @client.request(
@@ -32,17 +30,18 @@ module ModernTreasury
 
       # Get an existing document.
       #
-      # @param id [String] The ID of the document.
-      #
-      # @param params [ModernTreasury::Models::DocumentRetrieveParams, 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::Document]
+      #
+      # @see ModernTreasury::Models::DocumentRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/documents/%0s", id],
+          path: ["api/documents/%1$s", id],
           model: ModernTreasury::Models::Document,
           options: params[:request_options]
         )
@@ -50,33 +49,31 @@ module ModernTreasury
 
       # Get a list of documents.
       #
-      # @param params [ModernTreasury::Models::DocumentListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [String] :documentable_id The unique identifier for the associated object.
+      # @overload list(after_cursor: nil, documentable_id: nil, documentable_type: nil, per_page: nil, request_options: {})
       #
-      #   @option params [Symbol, ModernTreasury::Models::DocumentListParams::DocumentableType] :documentable_type The type of the associated object. Currently can be one of `payment_order`,
-      #     `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
-      #     `case`, `internal_account`, `decision`, or `external_account`.
+      # @param after_cursor [String, nil]
+      # @param documentable_id [String]
+      # @param documentable_type [Symbol, ModernTreasury::Models::DocumentListParams::DocumentableType]
+      # @param per_page [Integer]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Integer] :per_page
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::Document>]
       #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::Document>]
+      # @see ModernTreasury::Models::DocumentListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::DocumentListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/documents",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::Document,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/events.rb

@@ -5,17 +5,18 @@ module ModernTreasury
     class Events
       # get event
       #
-      # @param id [String] event id
+      # @overload retrieve(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::EventRetrieveParams, 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::Event]
+      #
+      # @see ModernTreasury::Models::EventRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/events/%0s", id],
+          path: ["api/events/%1$s", id],
           model: ModernTreasury::Models::Event,
           options: params[:request_options]
         )
@@ -23,37 +24,34 @@ module ModernTreasury
 
       # list events
       #
-      # @param params [ModernTreasury::Models::EventListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [String] :entity_id
-      #
-      #   @option params [String] :event_name
+      # @overload list(after_cursor: nil, entity_id: nil, event_name: nil, event_time_end: nil, event_time_start: nil, per_page: nil, resource: nil, request_options: {})
       #
-      #   @option params [Time] :event_time_end An inclusive upper bound for when the event occurred
+      # @param after_cursor [String, nil]
+      # @param entity_id [String]
+      # @param event_name [String]
+      # @param event_time_end [Time]
+      # @param event_time_start [Time]
+      # @param per_page [Integer]
+      # @param resource [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Time] :event_time_start An inclusive lower bound for when the event occurred
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::Event>]
       #
-      #   @option params [Integer] :per_page
-      #
-      #   @option params [String] :resource
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::Event>]
+      # @see ModernTreasury::Models::EventListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::EventListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/events",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::Event,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client