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

data/lib/modern_treasury/resources/payment_references.rb

@@ -5,17 +5,18 @@ module ModernTreasury
     class PaymentReferences
       # get payment_reference
       #
-      # @param id [String] id
+      # @overload retrieve(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::PaymentReferenceRetrieveParams, 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::PaymentReference]
+      #
+      # @see ModernTreasury::Models::PaymentReferenceRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/payment_references/%0s", id],
+          path: ["api/payment_references/%1$s", id],
           model: ModernTreasury::Models::PaymentReference,
           options: params[:request_options]
         )
@@ -23,30 +24,25 @@ module ModernTreasury
 
       # list payment_references
       #
-      # @param params [ModernTreasury::Models::PaymentReferenceListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [Integer] :per_page
+      # @overload list(after_cursor: nil, per_page: nil, reference_number: nil, referenceable_id: nil, referenceable_type: nil, request_options: {})
       #
-      #   @option params [String] :reference_number The actual reference number assigned by the bank.
+      # @param after_cursor [String, nil]
+      # @param per_page [Integer]
+      # @param reference_number [String]
+      # @param referenceable_id [String]
+      # @param referenceable_type [Symbol, ModernTreasury::Models::PaymentReferenceListParams::ReferenceableType]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [String] :referenceable_id The id of the referenceable to search for. Must be accompanied by the
-      #     referenceable_type or will return an error.
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::PaymentReference>]
       #
-      #   @option params [Symbol, ModernTreasury::Models::PaymentReferenceListParams::ReferenceableType] :referenceable_type One of the referenceable types. This must be accompanied by the id of the
-      #     referenceable or will return an error.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::PaymentReference>]
+      # @see ModernTreasury::Models::PaymentReferenceListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::PaymentReferenceListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/payment_references",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::PaymentReference,
           options: options
         )
@@ -57,6 +53,8 @@ module ModernTreasury
       # get payment_reference
       alias_method :retireve, :retrieve
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/returns.rb

@@ -5,27 +5,20 @@ module ModernTreasury
     class Returns
       # Create a return.
       #
-      # @param params [ModernTreasury::Models::ReturnCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(returnable_id:, returnable_type:, additional_information: nil, code: nil, data: nil, date_of_death: nil, reason: nil, request_options: {})
       #
-      #   @option params [String, nil] :returnable_id The ID of the object being returned or `null`.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::ReturnCreateParams::ReturnableType] :returnable_type The type of object being returned. Currently, this may only be
-      #     incoming_payment_detail.
-      #
-      #   @option params [String, nil] :additional_information Some returns may include additional information from the bank. In these cases,
-      #     this string will be present.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::ReturnCreateParams::Code, nil] :code The return code. For ACH returns, this is the required ACH return code.
-      #
-      #   @option params [Date, nil] :date_of_death If the return code is `R14` or `R15` this is the date the deceased counterparty
-      #     passed away.
-      #
-      #   @option params [String, nil] :reason An optional description of the reason for the return. This is for internal usage
-      #     and will not be transmitted to the bank.”
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param returnable_id [String, nil]
+      # @param returnable_type [Symbol, ModernTreasury::Models::ReturnCreateParams::ReturnableType]
+      # @param additional_information [String, nil]
+      # @param code [Symbol, ModernTreasury::Models::ReturnCreateParams::Code, nil]
+      # @param data [Object, nil]
+      # @param date_of_death [Date, nil]
+      # @param reason [String, nil]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ReturnObject]
+      #
+      # @see ModernTreasury::Models::ReturnCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::ReturnCreateParams.dump_request(params)
         @client.request(
@@ -39,17 +32,18 @@ module ModernTreasury
 
       # Get a single return.
       #
-      # @param id [String] The ID of an existing return.
-      #
-      # @param params [ModernTreasury::Models::ReturnRetrieveParams, 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::ReturnObject]
+      #
+      # @see ModernTreasury::Models::ReturnRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/returns/%0s", id],
+          path: ["api/returns/%1$s", id],
           model: ModernTreasury::Models::ReturnObject,
           options: params[:request_options]
         )
@@ -57,38 +51,33 @@ module ModernTreasury
 
       # Get a list of returns.
       #
-      # @param params [ModernTreasury::Models::ReturnListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [String] :counterparty_id Specify `counterparty_id` if you wish to see returns that occurred with a
-      #     specific counterparty.
-      #
-      #   @option params [String] :internal_account_id Specify `internal_account_id` if you wish to see returns to/from a specific
-      #     account.
+      # @overload list(after_cursor: nil, counterparty_id: nil, internal_account_id: nil, per_page: nil, returnable_id: nil, returnable_type: nil, request_options: {})
       #
-      #   @option params [Integer] :per_page
+      # @param after_cursor [String, nil]
+      # @param counterparty_id [String]
+      # @param internal_account_id [String]
+      # @param per_page [Integer]
+      # @param returnable_id [String]
+      # @param returnable_type [Symbol, ModernTreasury::Models::ReturnListParams::ReturnableType]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [String] :returnable_id The ID of a valid returnable. Must be accompanied by `returnable_type`.
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::ReturnObject>]
       #
-      #   @option params [Symbol, ModernTreasury::Models::ReturnListParams::ReturnableType] :returnable_type One of `payment_order`, `paper_item`, `reversal`, or `incoming_payment_detail`.
-      #     Must be accompanied by `returnable_id`.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::ReturnObject>]
+      # @see ModernTreasury::Models::ReturnListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::ReturnListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/returns",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::ReturnObject,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/routing_details.rb

@@ -5,24 +5,18 @@ module ModernTreasury
     class RoutingDetails
       # Create a routing detail for a single external account.
       #
-      # @param account_id [String] Path param: The ID of the account.
+      # @overload create(account_id, accounts_type:, routing_number:, routing_number_type:, payment_type: nil, request_options: {})
       #
-      # @param params [ModernTreasury::Models::RoutingDetailCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Symbol, ModernTreasury::Models::RoutingDetailCreateParams::AccountsType] :accounts_type Path param:
-      #
-      #   @option params [String] :routing_number Body param: The routing number of the bank.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::RoutingDetailCreateParams::RoutingNumberType] :routing_number_type Body param: The type of routing number. See
-      #     https://docs.moderntreasury.com/platform/reference/routing-detail-object for
-      #     more details.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::RoutingDetailCreateParams::PaymentType, nil] :payment_type Body param: If the routing detail is to be used for a specific payment type this
-      #     field will be populated, otherwise null.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param account_id [String]
+      # @param accounts_type [Symbol, ModernTreasury::Models::RoutingDetailCreateParams::AccountsType]
+      # @param routing_number [String]
+      # @param routing_number_type [Symbol, ModernTreasury::Models::RoutingDetailCreateParams::RoutingNumberType]
+      # @param payment_type [Symbol, ModernTreasury::Models::RoutingDetailCreateParams::PaymentType, nil]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::RoutingDetail]
+      #
+      # @see ModernTreasury::Models::RoutingDetailCreateParams
       def create(account_id, params)
         parsed, options = ModernTreasury::Models::RoutingDetailCreateParams.dump_request(params)
         accounts_type =
@@ -31,7 +25,7 @@ module ModernTreasury
           end
         @client.request(
           method: :post,
-          path: ["api/%0s/%1s/routing_details", accounts_type, account_id],
+          path: ["api/%1$s/%2$s/routing_details", accounts_type, account_id],
           body: parsed,
           model: ModernTreasury::Models::RoutingDetail,
           options: options
@@ -40,17 +34,16 @@ module ModernTreasury
 
       # Get a single routing detail for a single internal or external account.
       #
-      # @param id [String] The ID of the routing detail.
-      #
-      # @param params [ModernTreasury::Models::RoutingDetailRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Symbol, ModernTreasury::Models::AccountsType] :accounts_type
-      #
-      #   @option params [String] :account_id The ID of the account.
+      # @overload retrieve(id, accounts_type:, account_id:, request_options: {})
       #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param accounts_type [Symbol, ModernTreasury::Models::AccountsType]
+      # @param account_id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::RoutingDetail]
+      #
+      # @see ModernTreasury::Models::RoutingDetailRetrieveParams
       def retrieve(id, params)
         parsed, options = ModernTreasury::Models::RoutingDetailRetrieveParams.dump_request(params)
         accounts_type =
@@ -63,7 +56,7 @@ module ModernTreasury
           end
         @client.request(
           method: :get,
-          path: ["api/%0s/%1s/routing_details/%2s", accounts_type, account_id, id],
+          path: ["api/%1$s/%2$s/routing_details/%3$s", accounts_type, account_id, id],
           model: ModernTreasury::Models::RoutingDetail,
           options: options
         )
@@ -71,19 +64,17 @@ module ModernTreasury
 
       # Get a list of routing details for a single internal or external account.
       #
-      # @param account_id [String] Path param: The ID of the account.
-      #
-      # @param params [ModernTreasury::Models::RoutingDetailListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Symbol, ModernTreasury::Models::AccountsType] :accounts_type Path param:
+      # @overload list(account_id, accounts_type:, after_cursor: nil, per_page: nil, request_options: {})
       #
-      #   @option params [String, nil] :after_cursor Query param:
+      # @param account_id [String]
+      # @param accounts_type [Symbol, ModernTreasury::Models::AccountsType]
+      # @param after_cursor [String, nil]
+      # @param per_page [Integer]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Integer] :per_page Query param:
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::RoutingDetail>]
       #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::RoutingDetail>]
+      # @see ModernTreasury::Models::RoutingDetailListParams
       def list(account_id, params)
         parsed, options = ModernTreasury::Models::RoutingDetailListParams.dump_request(params)
         accounts_type =
@@ -92,9 +83,9 @@ module ModernTreasury
           end
         @client.request(
           method: :get,
-          path: ["api/%0s/%1s/routing_details", accounts_type, account_id],
+          path: ["api/%1$s/%2$s/routing_details", accounts_type, account_id],
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::RoutingDetail,
           options: options
         )
@@ -102,17 +93,16 @@ module ModernTreasury
 
       # Delete a routing detail for a single external account.
       #
-      # @param id [String] The ID of the routing detail.
-      #
-      # @param params [ModernTreasury::Models::RoutingDetailDeleteParams, Hash{Symbol=>Object}] .
+      # @overload delete(id, accounts_type:, account_id:, request_options: {})
       #
-      #   @option params [Symbol, ModernTreasury::Models::RoutingDetailDeleteParams::AccountsType] :accounts_type
-      #
-      #   @option params [String] :account_id The ID of the account.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param accounts_type [Symbol, ModernTreasury::Models::RoutingDetailDeleteParams::AccountsType]
+      # @param account_id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
+      #
+      # @see ModernTreasury::Models::RoutingDetailDeleteParams
       def delete(id, params)
         parsed, options = ModernTreasury::Models::RoutingDetailDeleteParams.dump_request(params)
         accounts_type =
@@ -125,12 +115,14 @@ module ModernTreasury
           end
         @client.request(
           method: :delete,
-          path: ["api/%0s/%1s/routing_details/%2s", accounts_type, account_id, id],
+          path: ["api/%1$s/%2$s/routing_details/%3$s", accounts_type, account_id, id],
           model: NilClass,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/transactions/line_items.rb

@@ -6,18 +6,16 @@ module ModernTreasury
       class LineItems
         # create transaction line items
         #
-        # @param params [ModernTreasury::Models::Transactions::LineItemCreateParams, Hash{Symbol=>Object}] .
+        # @overload create(amount:, expected_payment_id:, transaction_id:, request_options: {})
         #
-        #   @option params [Integer] :amount If a matching object exists in Modern Treasury, `amount` will be populated.
-        #     Value in specified currency's smallest unit (taken from parent Transaction).
-        #
-        #   @option params [String] :expected_payment_id The ID of the reconciled Expected Payment, otherwise `null`.
-        #
-        #   @option params [String] :transaction_id The ID of the parent transaction.
-        #
-        #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param amount [Integer]
+        # @param expected_payment_id [String]
+        # @param transaction_id [String]
+        # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [ModernTreasury::Models::Transactions::TransactionLineItem]
+        #
+        # @see ModernTreasury::Models::Transactions::LineItemCreateParams
         def create(params)
           parsed, options = ModernTreasury::Models::Transactions::LineItemCreateParams.dump_request(params)
           @client.request(
@@ -31,17 +29,18 @@ module ModernTreasury
 
         # get transaction line item
         #
-        # @param id [String] id
+        # @overload retrieve(id, request_options: {})
         #
-        # @param params [ModernTreasury::Models::Transactions::LineItemRetrieveParams, 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::Transactions::TransactionLineItem]
+        #
+        # @see ModernTreasury::Models::Transactions::LineItemRetrieveParams
         def retrieve(id, params = {})
           @client.request(
             method: :get,
-            path: ["api/transaction_line_items/%0s", id],
+            path: ["api/transaction_line_items/%1$s", id],
             model: ModernTreasury::Models::Transactions::TransactionLineItem,
             options: params[:request_options]
           )
@@ -49,28 +48,25 @@ module ModernTreasury
 
         # list transaction_line_items
         #
-        # @param params [ModernTreasury::Models::Transactions::LineItemListParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Hash{Symbol=>String}] :id
+        # @overload list(id: nil, after_cursor: nil, per_page: nil, transaction_id: nil, type: nil, request_options: {})
         #
-        #   @option params [String, nil] :after_cursor
+        # @param id [Hash{Symbol=>String}]
+        # @param after_cursor [String, nil]
+        # @param per_page [Integer]
+        # @param transaction_id [String]
+        # @param type [Symbol, ModernTreasury::Models::Transactions::LineItemListParams::Type, nil]
+        # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        #   @option params [Integer] :per_page
+        # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::Transactions::TransactionLineItem>]
         #
-        #   @option params [String] :transaction_id
-        #
-        #   @option params [Symbol, ModernTreasury::Models::Transactions::LineItemListParams::Type, nil] :type
-        #
-        #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [ModernTreasury::Page<ModernTreasury::Models::Transactions::TransactionLineItem>]
+        # @see ModernTreasury::Models::Transactions::LineItemListParams
         def list(params = {})
           parsed, options = ModernTreasury::Models::Transactions::LineItemListParams.dump_request(params)
           @client.request(
             method: :get,
             path: "api/transaction_line_items",
             query: parsed,
-            page: ModernTreasury::Page,
+            page: ModernTreasury::Internal::Page,
             model: ModernTreasury::Models::Transactions::TransactionLineItem,
             options: options
           )
@@ -78,22 +74,25 @@ module ModernTreasury
 
         # delete transaction line item
         #
-        # @param id [String] id
+        # @overload delete(id, request_options: {})
         #
-        # @param params [ModernTreasury::Models::Transactions::LineItemDeleteParams, 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::Transactions::LineItemDeleteParams
         def delete(id, params = {})
           @client.request(
             method: :delete,
-            path: ["api/transaction_line_items/%0s", id],
+            path: ["api/transaction_line_items/%1$s", id],
             model: NilClass,
             options: params[:request_options]
           )
         end
 
+        # @api private
+        #
         # @param client [ModernTreasury::Client]
         def initialize(client:)
           @client = client