modern_treasury 0.0.0 → 0.1.0.pre.alpha.15

data/lib/modern_treasury/resources/returns.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class Returns
+      # Create a return.
+      #
+      # @param params [ModernTreasury::Models::ReturnCreateParams, Hash{Symbol=>Object}] .
+      #
+      #   @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
+      #
+      # @return [ModernTreasury::Models::ReturnObject]
+      #
+      def create(params)
+        parsed, options = ModernTreasury::Models::ReturnCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/returns",
+          body: parsed,
+          model: ModernTreasury::Models::ReturnObject,
+          options: options
+        )
+      end
+
+      # Get a single return.
+      #
+      # @param id [String] The ID of an existing return.
+      #
+      # @param params [ModernTreasury::Models::ReturnRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::ReturnObject]
+      #
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/returns/%0s", id],
+          model: ModernTreasury::Models::ReturnObject,
+          options: params[:request_options]
+        )
+      end
+
+      # 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.
+      #
+      #   @option params [Integer] :per_page
+      #
+      #   @option params [String] :returnable_id The ID of a valid returnable. Must be accompanied by `returnable_type`.
+      #
+      #   @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>]
+      #
+      def list(params = {})
+        parsed, options = ModernTreasury::Models::ReturnListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/returns",
+          query: parsed,
+          page: ModernTreasury::Page,
+          model: ModernTreasury::Models::ReturnObject,
+          options: options
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/modern_treasury/resources/routing_details.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class RoutingDetails
+      # Create a routing detail for a single external account.
+      #
+      # @param account_id [String] Path param: The ID of the account.
+      #
+      # @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
+      #
+      # @return [ModernTreasury::Models::RoutingDetail]
+      #
+      def create(account_id, params)
+        parsed, options = ModernTreasury::Models::RoutingDetailCreateParams.dump_request(params)
+        accounts_type = parsed.fetch(:accounts_type) do
+          raise ArgumentError.new("missing required path argument #{_1}")
+        end
+        @client.request(
+          method: :post,
+          path: ["api/%0s/%1s/routing_details", accounts_type, account_id],
+          body: parsed.except(:accounts_type),
+          model: ModernTreasury::Models::RoutingDetail,
+          options: options
+        )
+      end
+
+      # 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.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::RoutingDetail]
+      #
+      def retrieve(id, params)
+        parsed, options = ModernTreasury::Models::RoutingDetailRetrieveParams.dump_request(params)
+        accounts_type = parsed.fetch(:accounts_type) do
+          raise ArgumentError.new("missing required path argument #{_1}")
+        end
+        account_id = parsed.fetch(:account_id) do
+          raise ArgumentError.new("missing required path argument #{_1}")
+        end
+        @client.request(
+          method: :get,
+          path: ["api/%0s/%1s/routing_details/%2s", accounts_type, account_id, id],
+          model: ModernTreasury::Models::RoutingDetail,
+          options: options
+        )
+      end
+
+      # 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:
+      #
+      #   @option params [String, nil] :after_cursor Query param:
+      #
+      #   @option params [Integer] :per_page Query param:
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Page<ModernTreasury::Models::RoutingDetail>]
+      #
+      def list(account_id, params)
+        parsed, options = ModernTreasury::Models::RoutingDetailListParams.dump_request(params)
+        accounts_type = parsed.fetch(:accounts_type) do
+          raise ArgumentError.new("missing required path argument #{_1}")
+        end
+        @client.request(
+          method: :get,
+          path: ["api/%0s/%1s/routing_details", accounts_type, account_id],
+          query: parsed.except(:accounts_type),
+          page: ModernTreasury::Page,
+          model: ModernTreasury::Models::RoutingDetail,
+          options: options
+        )
+      end
+
+      # 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}] .
+      #
+      #   @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
+      #
+      # @return [nil]
+      #
+      def delete(id, params)
+        parsed, options = ModernTreasury::Models::RoutingDetailDeleteParams.dump_request(params)
+        accounts_type = parsed.fetch(:accounts_type) do
+          raise ArgumentError.new("missing required path argument #{_1}")
+        end
+        account_id = parsed.fetch(:account_id) do
+          raise ArgumentError.new("missing required path argument #{_1}")
+        end
+        @client.request(
+          method: :delete,
+          path: ["api/%0s/%1s/routing_details/%2s", accounts_type, account_id, id],
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class Transactions
+      class LineItems
+        # create transaction line items
+        #
+        # @param params [ModernTreasury::Models::Transactions::LineItemCreateParams, Hash{Symbol=>Object}] .
+        #
+        #   @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
+        #
+        # @return [ModernTreasury::Models::Transactions::TransactionLineItem]
+        #
+        def create(params)
+          parsed, options = ModernTreasury::Models::Transactions::LineItemCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "api/transaction_line_items",
+            body: parsed,
+            model: ModernTreasury::Models::Transactions::TransactionLineItem,
+            options: options
+          )
+        end
+
+        # get transaction line item
+        #
+        # @param id [String] id
+        #
+        # @param params [ModernTreasury::Models::Transactions::LineItemRetrieveParams, Hash{Symbol=>Object}] .
+        #
+        #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        #
+        # @return [ModernTreasury::Models::Transactions::TransactionLineItem]
+        #
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["api/transaction_line_items/%0s", id],
+            model: ModernTreasury::Models::Transactions::TransactionLineItem,
+            options: params[:request_options]
+          )
+        end
+
+        # list transaction_line_items
+        #
+        # @param params [ModernTreasury::Models::Transactions::LineItemListParams, Hash{Symbol=>Object}] .
+        #
+        #   @option params [Hash{Symbol=>String}] :id
+        #
+        #   @option params [String, nil] :after_cursor
+        #
+        #   @option params [Integer] :per_page
+        #
+        #   @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>]
+        #
+        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,
+            model: ModernTreasury::Models::Transactions::TransactionLineItem,
+            options: options
+          )
+        end
+
+        # delete transaction line item
+        #
+        # @param id [String] id
+        #
+        # @param params [ModernTreasury::Models::Transactions::LineItemDeleteParams, Hash{Symbol=>Object}] .
+        #
+        #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        #
+        # @return [nil]
+        #
+        def delete(id, params = {})
+          @client.request(
+            method: :delete,
+            path: ["api/transaction_line_items/%0s", id],
+            model: NilClass,
+            options: params[:request_options]
+          )
+        end
+
+        # @param client [ModernTreasury::Client]
+        #
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/modern_treasury/resources/transactions.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class Transactions
+      # @return [ModernTreasury::Resources::Transactions::LineItems]
+      attr_reader :line_items
+
+      # create transaction
+      #
+      # @param params [ModernTreasury::Models::TransactionCreateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Integer] :amount Value in specified currency's smallest unit. e.g. $10 would be represented
+      #     as 1000.
+      #
+      #   @option params [Date, nil] :as_of_date The date on which the transaction occurred.
+      #
+      #   @option params [String] :direction Either `credit` or `debit`.
+      #
+      #   @option params [String] :internal_account_id The ID of the relevant Internal Account.
+      #
+      #   @option params [String, nil] :vendor_code When applicable, the bank-given code that determines the transaction's category.
+      #     For most banks this is the BAI2/BTRS transaction code.
+      #
+      #   @option params [String, nil] :vendor_code_type The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
+      #     `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
+      #     `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
+      #     `swift`, `us_bank`, or others.
+      #
+      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @option params [Boolean] :posted This field will be `true` if the transaction has posted to the account.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::TransactionCreateParams::Type, nil] :type The type of the transaction. Examples could be
+      #     `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
+      #
+      #   @option params [String, nil] :vendor_description The transaction detail text that often appears in on your bank statement and in
+      #     your banking portal.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::Transaction]
+      #
+      def create(params)
+        parsed, options = ModernTreasury::Models::TransactionCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/transactions",
+          body: parsed,
+          model: ModernTreasury::Models::Transaction,
+          options: options
+        )
+      end
+
+      # Get details on a single transaction.
+      #
+      # @param id [String] Transaction ID
+      #
+      # @param params [ModernTreasury::Models::TransactionRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::Transaction]
+      #
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/transactions/%0s", id],
+          model: ModernTreasury::Models::Transaction,
+          options: params[:request_options]
+        )
+      end
+
+      # Update a single transaction.
+      #
+      # @param id [String] Transaction ID
+      #
+      # @param params [ModernTreasury::Models::TransactionUpdateParams, Hash{Symbol=>Object}] .
+      #
+      #   @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 [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::Transaction]
+      #
+      def update(id, params = {})
+        parsed, options = ModernTreasury::Models::TransactionUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["api/transactions/%0s", id],
+          body: parsed,
+          model: ModernTreasury::Models::Transaction,
+          options: options
+        )
+      end
+
+      # Get a list of all transactions.
+      #
+      # @param params [ModernTreasury::Models::TransactionListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String, nil] :after_cursor
+      #
+      #   @option params [Date] :as_of_date_end Filters transactions with an `as_of_date` starting on or before the specified
+      #     date (YYYY-MM-DD).
+      #
+      #   @option params [Date] :as_of_date_start Filters transactions with an `as_of_date` starting on or after the specified
+      #     date (YYYY-MM-DD).
+      #
+      #   @option params [String] :counterparty_id
+      #
+      #   @option params [String] :description Filters for transactions including the queried string in the description.
+      #
+      #   @option params [String] :direction
+      #
+      #   @option params [String] :internal_account_id Specify `internal_account_id` if you wish to see transactions to/from a specific
+      #     account.
+      #
+      #   @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] :payment_type
+      #
+      #   @option params [Integer] :per_page
+      #
+      #   @option params [Boolean] :posted Either `true` or `false`.
+      #
+      #   @option params [String] :transactable_type
+      #
+      #   @option params [String] :vendor_id Filters for transactions including the queried vendor id (an identifier given to
+      #     transactions by the bank).
+      #
+      #   @option params [String] :virtual_account_id
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Page<ModernTreasury::Models::Transaction>]
+      #
+      def list(params = {})
+        parsed, options = ModernTreasury::Models::TransactionListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/transactions",
+          query: parsed,
+          page: ModernTreasury::Page,
+          model: ModernTreasury::Models::Transaction,
+          options: options
+        )
+      end
+
+      # delete transaction
+      #
+      # @param id [String] Transaction ID
+      #
+      # @param params [ModernTreasury::Models::TransactionDeleteParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [nil]
+      #
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["api/transactions/%0s", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      #
+      def initialize(client:)
+        @client = client
+        @line_items = ModernTreasury::Resources::Transactions::LineItems.new(client: client)
+      end
+    end
+  end
+end

data/lib/modern_treasury/resources/validations.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class Validations
+      # Validates the routing number information supplied without creating a routing
+      #   detail
+      #
+      # @param params [ModernTreasury::Models::ValidationValidateRoutingNumberParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String] :routing_number The routing number that is being validated.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::ValidationValidateRoutingNumberParams::RoutingNumberType] :routing_number_type The type of routing number. See
+      #     https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+      #     more details. In sandbox mode we currently only support `aba` and `swift` with
+      #     routing numbers '123456789' and 'GRINUST0XXX' respectively.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::RoutingNumberLookupRequest]
+      #
+      def validate_routing_number(params)
+        parsed, options = ModernTreasury::Models::ValidationValidateRoutingNumberParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/validations/routing_numbers",
+          query: parsed,
+          model: ModernTreasury::Models::RoutingNumberLookupRequest,
+          options: options
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end