modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

data/lib/modern_treasury/resources/counterparties.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    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
+      #
+      # @return [ModernTreasury::Models::Counterparty]
+      def create(params)
+        parsed, options = ModernTreasury::Models::CounterpartyCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/counterparties",
+          body: parsed,
+          model: ModernTreasury::Models::Counterparty,
+          options: options
+        )
+      end
+
+      # Get details on a single counterparty.
+      #
+      # @param id [String] The id of an existing counterparty.
+      #
+      # @param params [ModernTreasury::Models::CounterpartyRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::Counterparty]
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/counterparties/%0s", id],
+          model: ModernTreasury::Models::Counterparty,
+          options: params[:request_options]
+        )
+      end
+
+      # 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.
+      #
+      #   @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
+      #
+      # @return [ModernTreasury::Models::Counterparty]
+      def update(id, params = {})
+        parsed, options = ModernTreasury::Models::CounterpartyUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["api/counterparties/%0s", id],
+          body: parsed,
+          model: ModernTreasury::Models::Counterparty,
+          options: options
+        )
+      end
+
+      # 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.
+      #
+      #   @option params [Integer] :per_page
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Page<ModernTreasury::Models::Counterparty>]
+      def list(params = {})
+        parsed, options = ModernTreasury::Models::CounterpartyListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/counterparties",
+          query: parsed,
+          page: ModernTreasury::Page,
+          model: ModernTreasury::Models::Counterparty,
+          options: options
+        )
+      end
+
+      # Deletes a given counterparty.
+      #
+      # @param id [String] The id of an existing counterparty.
+      #
+      # @param params [ModernTreasury::Models::CounterpartyDeleteParams, 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/counterparties/%0s", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # 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.
+      #
+      #   @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
+      #
+      # @return [ModernTreasury::Models::CounterpartyCollectAccountResponse]
+      def collect_account(id, params)
+        parsed, options = ModernTreasury::Models::CounterpartyCollectAccountParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["api/counterparties/%0s/collect_account", id],
+          body: parsed,
+          model: ModernTreasury::Models::CounterpartyCollectAccountResponse,
+          options: options
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/modern_treasury/resources/documents.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class Documents
+      # Create a document.
+      #
+      # @param params [ModernTreasury::Models::DocumentCreateParams, Hash{Symbol=>Object}] .
+      #
+      #   @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
+      #
+      # @return [ModernTreasury::Models::Document]
+      def create(params)
+        parsed, options = ModernTreasury::Models::DocumentCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/documents",
+          headers: {"content-type" => "multipart/form-data"},
+          body: parsed,
+          model: ModernTreasury::Models::Document,
+          options: options
+        )
+      end
+
+      # Get an existing document.
+      #
+      # @param id [String] The ID of the document.
+      #
+      # @param params [ModernTreasury::Models::DocumentRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::Document]
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/documents/%0s", id],
+          model: ModernTreasury::Models::Document,
+          options: params[:request_options]
+        )
+      end
+
+      # 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.
+      #
+      #   @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`.
+      #
+      #   @option params [Integer] :per_page
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Page<ModernTreasury::Models::Document>]
+      def list(params = {})
+        parsed, options = ModernTreasury::Models::DocumentListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/documents",
+          query: parsed,
+          page: ModernTreasury::Page,
+          model: ModernTreasury::Models::Document,
+          options: options
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/modern_treasury/resources/events.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class Events
+      # get event
+      #
+      # @param id [String] event id
+      #
+      # @param params [ModernTreasury::Models::EventRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::Event]
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/events/%0s", id],
+          model: ModernTreasury::Models::Event,
+          options: params[:request_options]
+        )
+      end
+
+      # 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
+      #
+      #   @option params [Time] :event_time_end An inclusive upper bound for when the event occurred
+      #
+      #   @option params [Time] :event_time_start An inclusive lower bound for when the event occurred
+      #
+      #   @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>]
+      def list(params = {})
+        parsed, options = ModernTreasury::Models::EventListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/events",
+          query: parsed,
+          page: ModernTreasury::Page,
+          model: ModernTreasury::Models::Event,
+          options: options
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/modern_treasury/resources/expected_payments.rb

@@ -0,0 +1,227 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class ExpectedPayments
+      # create expected payment
+      #
+      # @param params [ModernTreasury::Models::ExpectedPaymentCreateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Integer, nil] :amount_lower_bound The lowest amount this expected payment may be equal to. Value in specified
+      #     currency's smallest unit. e.g. $10 would be represented as 1000.
+      #
+      #   @option params [Integer, nil] :amount_upper_bound The highest amount this expected payment may be equal to. Value in specified
+      #     currency's smallest unit. e.g. $10 would be represented as 1000.
+      #
+      #   @option params [String, nil] :counterparty_id The ID of the counterparty you expect for this payment.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::Currency, nil] :currency Must conform to ISO 4217. Defaults to the currency of the internal account.
+      #
+      #   @option params [Date, nil] :date_lower_bound The earliest date the payment may come in. Format: yyyy-mm-dd
+      #
+      #   @option params [Date, nil] :date_upper_bound The latest date the payment may come in. Format: yyyy-mm-dd
+      #
+      #   @option params [String, nil] :description An optional description for internal use.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::ExpectedPaymentCreateParams::Direction, nil] :direction One of credit or debit. When you are receiving money, use credit. When you are
+      #     being charged, use debit.
+      #
+      #   @option params [String, nil] :internal_account_id The ID of the Internal Account for the expected payment.
+      #
+      #   @option params [ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction] :ledger_transaction Specifies a ledger transaction object that will be created with the expected
+      #     payment. If the ledger transaction cannot be created, then the expected payment
+      #     creation will fail. The resulting ledger transaction will mirror the status of
+      #     the expected payment.
+      #
+      #   @option params [String] :ledger_transaction_id Either ledger_transaction or ledger_transaction_id can be provided. Only a
+      #     pending ledger transaction can be attached upon expected payment creation. Once
+      #     the expected payment is created, the status of the ledger transaction tracks the
+      #     expected payment automatically.
+      #
+      #   @option params [Array<ModernTreasury::Models::ExpectedPaymentCreateParams::LineItem>] :line_items
+      #
+      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @option params [Object, nil] :reconciliation_filters The reconciliation filters you have for this payment.
+      #
+      #   @option params [Object, nil] :reconciliation_groups The reconciliation groups you have for this payment.
+      #
+      #   @option params [Array<ModernTreasury::Models::ReconciliationRule>, nil] :reconciliation_rule_variables An array of reconciliation rule variables for this payment.
+      #
+      #   @option params [String, nil] :remittance_information For `ach`, this field will be passed through on an addenda record. For `wire`
+      #     payments the field will be passed through as the "Originator to Beneficiary
+      #     Information", also known as OBI or Fedwire tag 6000.
+      #
+      #   @option params [String, nil] :statement_descriptor The statement description you expect to see on the transaction. For ACH
+      #     payments, this will be the full line item passed from the bank. For wire
+      #     payments, this will be the OBI field on the wire. For check payments, this will
+      #     be the memo field.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil] :type One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
+      #     sepa, signet, wire.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::ExpectedPayment]
+      def create(params = {})
+        parsed, options = ModernTreasury::Models::ExpectedPaymentCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/expected_payments",
+          body: parsed,
+          model: ModernTreasury::Models::ExpectedPayment,
+          options: options
+        )
+      end
+
+      # get expected payment
+      #
+      # @param id [String] id
+      #
+      # @param params [ModernTreasury::Models::ExpectedPaymentRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::ExpectedPayment]
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/expected_payments/%0s", id],
+          model: ModernTreasury::Models::ExpectedPayment,
+          options: params[:request_options]
+        )
+      end
+
+      # update expected payment
+      #
+      # @param id [String] id
+      #
+      # @param params [ModernTreasury::Models::ExpectedPaymentUpdateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Integer, nil] :amount_lower_bound The lowest amount this expected payment may be equal to. Value in specified
+      #     currency's smallest unit. e.g. $10 would be represented as 1000.
+      #
+      #   @option params [Integer, nil] :amount_upper_bound The highest amount this expected payment may be equal to. Value in specified
+      #     currency's smallest unit. e.g. $10 would be represented as 1000.
+      #
+      #   @option params [String, nil] :counterparty_id The ID of the counterparty you expect for this payment.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::Currency, nil] :currency Must conform to ISO 4217. Defaults to the currency of the internal account.
+      #
+      #   @option params [Date, nil] :date_lower_bound The earliest date the payment may come in. Format: yyyy-mm-dd
+      #
+      #   @option params [Date, nil] :date_upper_bound The latest date the payment may come in. Format: yyyy-mm-dd
+      #
+      #   @option params [String, nil] :description An optional description for internal use.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::Direction, nil] :direction One of credit or debit. When you are receiving money, use credit. When you are
+      #     being charged, use debit.
+      #
+      #   @option params [String, nil] :internal_account_id The ID of the Internal Account for the expected payment.
+      #
+      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @option params [Object, nil] :reconciliation_filters The reconciliation filters you have for this payment.
+      #
+      #   @option params [Object, nil] :reconciliation_groups The reconciliation groups you have for this payment.
+      #
+      #   @option params [Array<ModernTreasury::Models::ReconciliationRule>, nil] :reconciliation_rule_variables An array of reconciliation rule variables for this payment.
+      #
+      #   @option params [String, nil] :remittance_information For `ach`, this field will be passed through on an addenda record. For `wire`
+      #     payments the field will be passed through as the "Originator to Beneficiary
+      #     Information", also known as OBI or Fedwire tag 6000.
+      #
+      #   @option params [String, nil] :statement_descriptor The statement description you expect to see on the transaction. For ACH
+      #     payments, this will be the full line item passed from the bank. For wire
+      #     payments, this will be the OBI field on the wire. For check payments, this will
+      #     be the memo field.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::Status, nil] :status The Expected Payment's status can be updated from partially_reconciled to
+      #     reconciled.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil] :type One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
+      #     sepa, signet, wire.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::ExpectedPayment]
+      def update(id, params = {})
+        parsed, options = ModernTreasury::Models::ExpectedPaymentUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["api/expected_payments/%0s", id],
+          body: parsed,
+          model: ModernTreasury::Models::ExpectedPayment,
+          options: options
+        )
+      end
+
+      # list expected_payments
+      #
+      # @param params [ModernTreasury::Models::ExpectedPaymentListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String, nil] :after_cursor
+      #
+      #   @option params [String] :counterparty_id Specify counterparty_id to see expected_payments for a specific account.
+      #
+      #   @option params [Time] :created_at_lower_bound Used to return expected payments created after some datetime
+      #
+      #   @option params [Time] :created_at_upper_bound Used to return expected payments created before some datetime
+      #
+      #   @option params [Symbol, ModernTreasury::Models::TransactionDirection] :direction One of credit, debit
+      #
+      #   @option params [String] :internal_account_id Specify internal_account_id to see expected_payments for 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 [Integer] :per_page
+      #
+      #   @option params [Symbol, ModernTreasury::Models::ExpectedPaymentListParams::Status] :status One of unreconciled, reconciled, or archived.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::ExpectedPaymentListParams::Type] :type One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp,sen,
+      #     sepa, signet, wire
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Page<ModernTreasury::Models::ExpectedPayment>]
+      def list(params = {})
+        parsed, options = ModernTreasury::Models::ExpectedPaymentListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/expected_payments",
+          query: parsed,
+          page: ModernTreasury::Page,
+          model: ModernTreasury::Models::ExpectedPayment,
+          options: options
+        )
+      end
+
+      # delete expected payment
+      #
+      # @param id [String] id
+      #
+      # @param params [ModernTreasury::Models::ExpectedPaymentDeleteParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::ExpectedPayment]
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["api/expected_payments/%0s", id],
+          model: ModernTreasury::Models::ExpectedPayment,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end