modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.19

data/lib/modern_treasury/resources/invoices.rb

@@ -6,47 +6,75 @@ module ModernTreasury
       # @return [ModernTreasury::Resources::Invoices::LineItems]
       attr_reader :line_items
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::InvoiceCreateParams} for more details.
+      #
       # create invoice
       #
       # @overload create(counterparty_id:, due_date:, originating_account_id:, auto_advance: nil, contact_details: nil, counterparty_billing_address: nil, counterparty_shipping_address: nil, currency: nil, description: nil, fallback_payment_method: nil, ingest_ledger_entries: nil, invoice_line_items: nil, invoicer_address: nil, ledger_account_settlement_id: nil, metadata: nil, notification_email_addresses: nil, notifications_enabled: nil, payment_effective_date: nil, payment_method: nil, payment_type: nil, receiving_account_id: nil, recipient_email: nil, recipient_name: nil, remind_after_overdue_days: nil, virtual_account_id: nil, request_options: {})
       #
-      # @param counterparty_id [String]
-      # @param due_date [Time]
-      # @param originating_account_id [String]
-      # @param auto_advance [Boolean, nil]
-      # @param contact_details [Array<ModernTreasury::Models::InvoiceCreateParams::ContactDetail>]
-      # @param counterparty_billing_address [ModernTreasury::Models::InvoiceCreateParams::CounterpartyBillingAddress, nil]
-      # @param counterparty_shipping_address [ModernTreasury::Models::InvoiceCreateParams::CounterpartyShippingAddress, nil]
-      # @param currency [Symbol, ModernTreasury::Models::Currency]
-      # @param description [String]
-      # @param fallback_payment_method [String, nil]
-      # @param ingest_ledger_entries [Boolean, nil]
-      # @param invoice_line_items [Array<ModernTreasury::Models::InvoiceCreateParams::InvoiceLineItem>, nil]
-      # @param invoicer_address [ModernTreasury::Models::InvoiceCreateParams::InvoicerAddress, nil]
-      # @param ledger_account_settlement_id [String, nil]
-      # @param metadata [Hash{Symbol=>String}, nil]
-      # @param notification_email_addresses [Array<String>, nil]
-      # @param notifications_enabled [Boolean]
-      # @param payment_effective_date [Date]
-      # @param payment_method [Symbol, ModernTreasury::Models::InvoiceCreateParams::PaymentMethod]
-      # @param payment_type [Symbol, ModernTreasury::Models::PaymentOrderType]
-      # @param receiving_account_id [String]
-      # @param recipient_email [String, nil]
-      # @param recipient_name [String, nil]
-      # @param remind_after_overdue_days [Array<Integer>, nil]
-      # @param virtual_account_id [String, nil]
+      # @param counterparty_id [String] The ID of the counterparty receiving the invoice.
+      #
+      # @param due_date [Time] A future date by when the invoice needs to be paid.
+      #
+      # @param originating_account_id [String] The ID of the internal account the invoice should be paid to.
+      #
+      # @param auto_advance [Boolean, nil] When true, the invoice will progress to unpaid automatically and cannot be edite
+      #
+      # @param contact_details [Array<ModernTreasury::InvoiceCreateParams::ContactDetail>] The invoicer's contact details displayed at the top of the invoice.
+      #
+      # @param counterparty_billing_address [ModernTreasury::InvoiceCreateParams::CounterpartyBillingAddress, nil] The counterparty's billing address.
+      #
+      # @param counterparty_shipping_address [ModernTreasury::InvoiceCreateParams::CounterpartyShippingAddress, nil] The counterparty's shipping address where physical goods should be delivered.
+      #
+      # @param currency [Symbol, ModernTreasury::Currency] Currency that the invoice is denominated in. Defaults to `USD` if not provided.
+      #
+      # @param description [String] A free-form description of the invoice.
+      #
+      # @param fallback_payment_method [String, nil] When payment_method is automatic, the fallback payment method to use when an aut
+      #
+      # @param ingest_ledger_entries [Boolean, nil] Whether to ingest the ledger_entries to populate the invoice line items. If this
+      #
+      # @param invoice_line_items [Array<ModernTreasury::InvoiceCreateParams::InvoiceLineItem>, nil] An array of invoice line items. The API supports a maximum of 50 invoice line it
+      #
+      # @param invoicer_address [ModernTreasury::InvoiceCreateParams::InvoicerAddress, nil] The invoice issuer's business address.
+      #
+      # @param ledger_account_settlement_id [String, nil] The ID of the virtual account the invoice should be paid to.
+      #
+      # @param metadata [Hash{Symbol=>String}, nil] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      # @param notification_email_addresses [Array<String>, nil] Emails in addition to the counterparty email to send invoice status notification
+      #
+      # @param notifications_enabled [Boolean] If true, the invoice will send email notifications to the invoice recipients abo
+      #
+      # @param payment_effective_date [Date] Date transactions are to be posted to the participants' account. Defaults to the
+      #
+      # @param payment_method [Symbol, ModernTreasury::InvoiceCreateParams::PaymentMethod] The method by which the invoice can be paid. `ui` will show the embedded payment
+      #
+      # @param payment_type [Symbol, ModernTreasury::PaymentOrderType] One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sep
+      #
+      # @param receiving_account_id [String] The receiving account ID. Can be an `external_account`.
+      #
+      # @param recipient_email [String, nil] The email of the recipient of the invoice. Leaving this value as null will fallb
+      #
+      # @param recipient_name [String, nil] The name of the recipient of the invoice. Leaving this value as null will fallba
+      #
+      # @param remind_after_overdue_days [Array<Integer>, nil] Number of days after due date when overdue reminder emails will be sent out to i
+      #
+      # @param virtual_account_id [String, nil] The ID of the virtual account the invoice should be paid to.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::Invoice]
+      # @return [ModernTreasury::Invoice]
       #
       # @see ModernTreasury::Models::InvoiceCreateParams
       def create(params)
-        parsed, options = ModernTreasury::Models::InvoiceCreateParams.dump_request(params)
+        parsed, options = ModernTreasury::InvoiceCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/invoices",
           body: parsed,
-          model: ModernTreasury::Models::Invoice,
+          model: ModernTreasury::Invoice,
           options: options
         )
       end
@@ -55,95 +83,139 @@ module ModernTreasury
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] id
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::Invoice]
+      # @return [ModernTreasury::Invoice]
       #
       # @see ModernTreasury::Models::InvoiceRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
           path: ["api/invoices/%1$s", id],
-          model: ModernTreasury::Models::Invoice,
+          model: ModernTreasury::Invoice,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::InvoiceUpdateParams} for more details.
+      #
       # update invoice
       #
       # @overload update(id, contact_details: nil, counterparty_billing_address: nil, counterparty_id: nil, counterparty_shipping_address: nil, currency: nil, description: nil, due_date: nil, fallback_payment_method: nil, ingest_ledger_entries: nil, invoice_line_items: nil, invoicer_address: nil, ledger_account_settlement_id: nil, metadata: nil, notification_email_addresses: nil, notifications_enabled: nil, originating_account_id: nil, payment_effective_date: nil, payment_method: nil, payment_type: nil, receiving_account_id: nil, recipient_email: nil, recipient_name: nil, remind_after_overdue_days: nil, status: nil, virtual_account_id: nil, request_options: {})
       #
-      # @param id [String]
-      # @param contact_details [Array<ModernTreasury::Models::InvoiceUpdateParams::ContactDetail>]
-      # @param counterparty_billing_address [ModernTreasury::Models::InvoiceUpdateParams::CounterpartyBillingAddress, nil]
-      # @param counterparty_id [String]
-      # @param counterparty_shipping_address [ModernTreasury::Models::InvoiceUpdateParams::CounterpartyShippingAddress, nil]
-      # @param currency [Symbol, ModernTreasury::Models::Currency]
-      # @param description [String]
-      # @param due_date [Time]
-      # @param fallback_payment_method [String, nil]
-      # @param ingest_ledger_entries [Boolean, nil]
-      # @param invoice_line_items [Array<ModernTreasury::Models::InvoiceUpdateParams::InvoiceLineItem>, nil]
-      # @param invoicer_address [ModernTreasury::Models::InvoiceUpdateParams::InvoicerAddress, nil]
-      # @param ledger_account_settlement_id [String, nil]
-      # @param metadata [Hash{Symbol=>String}, nil]
-      # @param notification_email_addresses [Array<String>, nil]
-      # @param notifications_enabled [Boolean]
-      # @param originating_account_id [String]
-      # @param payment_effective_date [Date]
-      # @param payment_method [Symbol, ModernTreasury::Models::InvoiceUpdateParams::PaymentMethod]
-      # @param payment_type [Symbol, ModernTreasury::Models::PaymentOrderType]
-      # @param receiving_account_id [String]
-      # @param recipient_email [String, nil]
-      # @param recipient_name [String, nil]
-      # @param remind_after_overdue_days [Array<Integer>, nil]
-      # @param status [String]
-      # @param virtual_account_id [String, nil]
+      # @param id [String] id
+      #
+      # @param contact_details [Array<ModernTreasury::InvoiceUpdateParams::ContactDetail>] The invoicer's contact details displayed at the top of the invoice.
+      #
+      # @param counterparty_billing_address [ModernTreasury::InvoiceUpdateParams::CounterpartyBillingAddress, nil] The counterparty's billing address.
+      #
+      # @param counterparty_id [String] The ID of the counterparty receiving the invoice.
+      #
+      # @param counterparty_shipping_address [ModernTreasury::InvoiceUpdateParams::CounterpartyShippingAddress, nil] The counterparty's shipping address where physical goods should be delivered.
+      #
+      # @param currency [Symbol, ModernTreasury::Currency] Currency that the invoice is denominated in. Defaults to `USD` if not provided.
+      #
+      # @param description [String] A free-form description of the invoice.
+      #
+      # @param due_date [Time] A future date by when the invoice needs to be paid.
+      #
+      # @param fallback_payment_method [String, nil] When payment_method is automatic, the fallback payment method to use when an aut
+      #
+      # @param ingest_ledger_entries [Boolean, nil] Whether to ingest the ledger_entries to populate the invoice line items. If this
+      #
+      # @param invoice_line_items [Array<ModernTreasury::InvoiceUpdateParams::InvoiceLineItem>, nil] An array of invoice line items. The API supports a maximum of 50 invoice line it
+      #
+      # @param invoicer_address [ModernTreasury::InvoiceUpdateParams::InvoicerAddress, nil] The invoice issuer's business address.
+      #
+      # @param ledger_account_settlement_id [String, nil] The ID of the virtual account the invoice should be paid to.
+      #
+      # @param metadata [Hash{Symbol=>String}, nil] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      # @param notification_email_addresses [Array<String>, nil] Emails in addition to the counterparty email to send invoice status notification
+      #
+      # @param notifications_enabled [Boolean] If true, the invoice will send email notifications to the invoice recipients abo
+      #
+      # @param originating_account_id [String] The ID of the internal account the invoice should be paid to.
+      #
+      # @param payment_effective_date [Date] Date transactions are to be posted to the participants' account. Defaults to the
+      #
+      # @param payment_method [Symbol, ModernTreasury::InvoiceUpdateParams::PaymentMethod] The method by which the invoice can be paid. `ui` will show the embedded payment
+      #
+      # @param payment_type [Symbol, ModernTreasury::PaymentOrderType] One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sep
+      #
+      # @param receiving_account_id [String] The receiving account ID. Can be an `external_account`.
+      #
+      # @param recipient_email [String, nil] The email of the recipient of the invoice. Leaving this value as null will fallb
+      #
+      # @param recipient_name [String, nil] The name of the recipient of the invoice. Leaving this value as null will fallba
+      #
+      # @param remind_after_overdue_days [Array<Integer>, nil] Number of days after due date when overdue reminder emails will be sent out to i
+      #
+      # @param status [String] Invoice status must be updated in a `PATCH` request that does not modify any oth
+      #
+      # @param virtual_account_id [String, nil] The ID of the virtual account the invoice should be paid to.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::Invoice]
+      # @return [ModernTreasury::Invoice]
       #
       # @see ModernTreasury::Models::InvoiceUpdateParams
       def update(id, params = {})
-        parsed, options = ModernTreasury::Models::InvoiceUpdateParams.dump_request(params)
+        parsed, options = ModernTreasury::InvoiceUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["api/invoices/%1$s", id],
           body: parsed,
-          model: ModernTreasury::Models::Invoice,
+          model: ModernTreasury::Invoice,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::InvoiceListParams} for more details.
+      #
       # list invoices
       #
       # @overload list(after_cursor: nil, counterparty_id: nil, due_date_end: nil, due_date_start: nil, expected_payment_id: nil, metadata: nil, number: nil, originating_account_id: nil, payment_order_id: nil, per_page: nil, status: nil, request_options: {})
       #
       # @param after_cursor [String, nil]
+      #
       # @param counterparty_id [String]
-      # @param due_date_end [Date]
-      # @param due_date_start [Date]
+      #
+      # @param due_date_end [Date] An inclusive upper bound for searching due_date
+      #
+      # @param due_date_start [Date] An inclusive lower bound for searching due_date
+      #
       # @param expected_payment_id [String]
-      # @param metadata [Hash{Symbol=>String}]
-      # @param number [String]
+      #
+      # @param metadata [Hash{Symbol=>String}] For example, if you want to query for records with metadata key `Type` and value
+      #
+      # @param number [String] A unique record number assigned to each invoice that is issued.
+      #
       # @param originating_account_id [String]
+      #
       # @param payment_order_id [String]
+      #
       # @param per_page [Integer]
-      # @param status [Symbol, ModernTreasury::Models::InvoiceListParams::Status]
+      #
+      # @param status [Symbol, ModernTreasury::InvoiceListParams::Status]
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::Invoice>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Invoice>]
       #
       # @see ModernTreasury::Models::InvoiceListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::InvoiceListParams.dump_request(params)
+        parsed, options = ModernTreasury::InvoiceListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/invoices",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::Invoice,
+          model: ModernTreasury::Invoice,
           options: options
         )
       end
@@ -152,15 +224,17 @@ module ModernTreasury
       #
       # @overload add_payment_order(payment_order_id, id:, request_options: {})
       #
-      # @param payment_order_id [String]
-      # @param id [String]
+      # @param payment_order_id [String] payment_order_id
+      #
+      # @param id [String] id
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
       #
       # @see ModernTreasury::Models::InvoiceAddPaymentOrderParams
       def add_payment_order(payment_order_id, params)
-        parsed, options = ModernTreasury::Models::InvoiceAddPaymentOrderParams.dump_request(params)
+        parsed, options = ModernTreasury::InvoiceAddPaymentOrderParams.dump_request(params)
         id =
           parsed.delete(:id) do
             raise ArgumentError.new("missing required path argument #{_1}")

data/lib/modern_treasury/resources/ledger_account_balance_monitors.rb

@@ -3,26 +3,34 @@
 module ModernTreasury
   module Resources
     class LedgerAccountBalanceMonitors
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::LedgerAccountBalanceMonitorCreateParams} for more
+      # details.
+      #
       # Create a ledger account balance monitor.
       #
       # @overload create(alert_condition:, ledger_account_id:, description: nil, metadata: nil, request_options: {})
       #
-      # @param alert_condition [ModernTreasury::Models::LedgerAccountBalanceMonitorCreateParams::AlertCondition]
-      # @param ledger_account_id [String]
-      # @param description [String]
-      # @param metadata [Hash{Symbol=>String}]
+      # @param alert_condition [ModernTreasury::LedgerAccountBalanceMonitorCreateParams::AlertCondition] Describes the condition that must be satisfied for the monitor to be triggered.
+      #
+      # @param ledger_account_id [String] The ledger account associated with this balance monitor.
+      #
+      # @param description [String] An optional, free-form description for internal use.
+      #
+      # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::LedgerAccountBalanceMonitor]
+      # @return [ModernTreasury::LedgerAccountBalanceMonitor]
       #
       # @see ModernTreasury::Models::LedgerAccountBalanceMonitorCreateParams
       def create(params)
-        parsed, options = ModernTreasury::Models::LedgerAccountBalanceMonitorCreateParams.dump_request(params)
+        parsed, options = ModernTreasury::LedgerAccountBalanceMonitorCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/ledger_account_balance_monitors",
           body: parsed,
-          model: ModernTreasury::Models::LedgerAccountBalanceMonitor,
+          model: ModernTreasury::LedgerAccountBalanceMonitor,
           options: options
         )
       end
@@ -31,66 +39,83 @@ module ModernTreasury
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] id
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::LedgerAccountBalanceMonitor]
+      # @return [ModernTreasury::LedgerAccountBalanceMonitor]
       #
       # @see ModernTreasury::Models::LedgerAccountBalanceMonitorRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
           path: ["api/ledger_account_balance_monitors/%1$s", id],
-          model: ModernTreasury::Models::LedgerAccountBalanceMonitor,
+          model: ModernTreasury::LedgerAccountBalanceMonitor,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::LedgerAccountBalanceMonitorUpdateParams} for more
+      # details.
+      #
       # Update a ledger account balance monitor.
       #
       # @overload update(id, description: nil, metadata: nil, request_options: {})
       #
-      # @param id [String]
-      # @param description [String]
-      # @param metadata [Hash{Symbol=>String}]
+      # @param id [String] id
+      #
+      # @param description [String] An optional, free-form description for internal use.
+      #
+      # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::LedgerAccountBalanceMonitor]
+      # @return [ModernTreasury::LedgerAccountBalanceMonitor]
       #
       # @see ModernTreasury::Models::LedgerAccountBalanceMonitorUpdateParams
       def update(id, params = {})
-        parsed, options = ModernTreasury::Models::LedgerAccountBalanceMonitorUpdateParams.dump_request(params)
+        parsed, options = ModernTreasury::LedgerAccountBalanceMonitorUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["api/ledger_account_balance_monitors/%1$s", id],
           body: parsed,
-          model: ModernTreasury::Models::LedgerAccountBalanceMonitor,
+          model: ModernTreasury::LedgerAccountBalanceMonitor,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::LedgerAccountBalanceMonitorListParams} for more
+      # details.
+      #
       # Get a list of ledger account balance monitors.
       #
       # @overload list(id: nil, after_cursor: nil, ledger_account_id: nil, metadata: nil, per_page: nil, request_options: {})
       #
-      # @param id [Array<String>]
+      # @param id [Array<String>] If you have specific IDs to retrieve in bulk, you can pass them as query paramet
+      #
       # @param after_cursor [String, nil]
-      # @param ledger_account_id [String]
-      # @param metadata [Hash{Symbol=>String}]
+      #
+      # @param ledger_account_id [String] Query the balance monitors for a single ledger account.
+      #
+      # @param metadata [Hash{Symbol=>String}] For example, if you want to query for records with metadata key `Type` and value
+      #
       # @param per_page [Integer]
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::LedgerAccountBalanceMonitor>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::LedgerAccountBalanceMonitor>]
       #
       # @see ModernTreasury::Models::LedgerAccountBalanceMonitorListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::LedgerAccountBalanceMonitorListParams.dump_request(params)
+        parsed, options = ModernTreasury::LedgerAccountBalanceMonitorListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/ledger_account_balance_monitors",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::LedgerAccountBalanceMonitor,
+          model: ModernTreasury::LedgerAccountBalanceMonitor,
           options: options
         )
       end
@@ -99,17 +124,18 @@ module ModernTreasury
       #
       # @overload delete(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] id
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::LedgerAccountBalanceMonitor]
+      # @return [ModernTreasury::LedgerAccountBalanceMonitor]
       #
       # @see ModernTreasury::Models::LedgerAccountBalanceMonitorDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
           path: ["api/ledger_account_balance_monitors/%1$s", id],
-          model: ModernTreasury::Models::LedgerAccountBalanceMonitor,
+          model: ModernTreasury::LedgerAccountBalanceMonitor,
           options: params[:request_options]
         )
       end