modern-treasury 2.0.0 → 2.2.0

package/src/resources/invoices/invoices.ts

@@ -1,13 +1,13 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as PaymentOrders from 'modern-treasury/resources/payment-orders/index';
-import * as Shared from 'modern-treasury/resources/shared';
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as PaymentOrders from '../payment-orders/index';
+import * as Shared from '../shared';
 import { LineItems } from './line-items';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as API from './index';
+import { Page, PageParams } from '../../pagination';
 
 export class Invoices extends APIResource {
   lineItems: LineItems = new LineItems(this.client);
@@ -139,17 +139,40 @@ export interface Invoice {
    */
   originating_account_id: string;
 
+  /**
+   * Date transactions are to be posted to the participants' account. Defaults to the
+   * current business day or the next business day if the current day is a bank
+   * holiday or weekend. Format: yyyy-mm-dd.
+   */
+  payment_effective_date: string | null;
+
+  /**
+   * When opening an invoice, whether to show the embedded payment UI , automatically
+   * debit the recipient, or rely on manual payment from the recipient.
+   */
+  payment_method: 'ui' | 'manual' | 'automatic' | null;
+
   /**
    * The payment orders created for paying the invoice through the invoice payment
    * UI.
    */
   payment_orders: Array<PaymentOrders.PaymentOrder>;
 
+  /**
+   * One of `ach` or `eft`
+   */
+  payment_type: 'eft' | 'ach' | null;
+
   /**
    * The URL where the invoice PDF can be downloaded.
    */
   pdf_url: string | null;
 
+  /**
+   * The receiving account ID. Can be an `internal_account`.
+   */
+  receiving_account_id: string | null;
+
   /**
    * The status of the invoice.
    */
@@ -323,6 +346,52 @@ export interface InvoiceCreateParams {
    */
   invoicer_address?: InvoiceCreateParams.InvoicerAddress | null;
 
+  /**
+   * Body param: Date transactions are to be posted to the participants' account.
+   * Defaults to the current business day or the next business day if the current day
+   * is a bank holiday or weekend. Format: yyyy-mm-dd.
+   */
+  payment_effective_date?: string;
+
+  /**
+   * Body param: The method by which the invoice can be paid. `ui` will show the
+   * embedded payment collection flow. `automatic` will automatically initiate
+   * payment based upon the account details of the receiving_account id.\nIf the
+   * invoice amount is positive, the automatically initiated payment order's
+   * direction will be debit. If the invoice amount is negative, the automatically
+   * initiated payment order's direction will be credit. One of `manual`, `ui`, or
+   * `automatic`.
+   */
+  payment_method?: 'ui' | 'manual' | 'automatic';
+
+  /**
+   * Body param: One of `ach`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`,
+   * `bacs`, `au_becs`, `interac`, `signet`, `provexchange`.
+   */
+  payment_type?:
+    | 'ach'
+    | 'au_becs'
+    | 'bacs'
+    | 'book'
+    | 'card'
+    | 'check'
+    | 'eft'
+    | 'cross_border'
+    | 'interac'
+    | 'masav'
+    | 'neft'
+    | 'provxchange'
+    | 'rtp'
+    | 'sen'
+    | 'sepa'
+    | 'signet'
+    | 'wire';
+
+  /**
+   * Body param: The receiving account ID. Can be an `external_account`.
+   */
+  receiving_account_id?: string;
+
   /**
    * Header param: This key should be something unique, preferably something like an
    * UUID.
@@ -477,12 +546,6 @@ export interface InvoiceUpdateParams {
    */
   due_date?: string;
 
-  /**
-   * When opening an invoice, whether to show the embedded payment UI with the
-   * invoice. Default true.
-   */
-  include_payment_ui?: boolean;
-
   /**
    * The invoice issuer's business address.
    */
@@ -493,6 +556,51 @@ export interface InvoiceUpdateParams {
    */
   originating_account_id?: string;
 
+  /**
+   * Date transactions are to be posted to the participants' account. Defaults to the
+   * current business day or the next business day if the current day is a bank
+   * holiday or weekend. Format: yyyy-mm-dd.
+   */
+  payment_effective_date?: string;
+
+  /**
+   * The method by which the invoice can be paid. `ui` will show the embedded payment
+   * collection flow. `automatic` will automatically initiate payment based upon the
+   * account details of the receiving_account id.\nIf the invoice amount is positive,
+   * the automatically initiated payment order's direction will be debit. If the
+   * invoice amount is negative, the automatically initiated payment order's
+   * direction will be credit. One of `manual`, `ui`, or `automatic`.
+   */
+  payment_method?: 'ui' | 'manual' | 'automatic';
+
+  /**
+   * One of `ach`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`, `bacs`,
+   * `au_becs`, `interac`, `signet`, `provexchange`.
+   */
+  payment_type?:
+    | 'ach'
+    | 'au_becs'
+    | 'bacs'
+    | 'book'
+    | 'card'
+    | 'check'
+    | 'eft'
+    | 'cross_border'
+    | 'interac'
+    | 'masav'
+    | 'neft'
+    | 'provxchange'
+    | 'rtp'
+    | 'sen'
+    | 'sepa'
+    | 'signet'
+    | 'wire';
+
+  /**
+   * The receiving account ID. Can be an `external_account`.
+   */
+  receiving_account_id?: string;
+
   /**
    * Invoice status must be updated in a `PATCH` request that does not modify any
    * other invoice attributes. Valid state transitions are `draft` to `unpaid` and

package/src/resources/invoices/line-items.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as Shared from 'modern-treasury/resources/shared';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Shared from '../shared';
+import * as API from './index';
+import { Page, PageParams } from '../../pagination';
 
 export class LineItems extends APIResource {
   /**
@@ -233,6 +233,51 @@ export interface LineItemUpdateParams {
    * The ID of the internal account the invoice should be paid to.
    */
   originating_account_id?: string;
+
+  /**
+   * Date transactions are to be posted to the participants' account. Defaults to the
+   * current business day or the next business day if the current day is a bank
+   * holiday or weekend. Format: yyyy-mm-dd.
+   */
+  payment_effective_date?: string;
+
+  /**
+   * The method by which the invoice can be paid. `ui` will show the embedded payment
+   * collection flow. `automatic` will automatically initiate payment based upon the
+   * account details of the receiving_account id.\nIf the invoice amount is positive,
+   * the automatically initiated payment order's direction will be debit. If the
+   * invoice amount is negative, the automatically initiated payment order's
+   * direction will be credit. One of `manual`, `ui`, or `automatic`.
+   */
+  payment_method?: 'ui' | 'manual' | 'automatic';
+
+  /**
+   * One of `ach`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`, `bacs`,
+   * `au_becs`, `interac`, `signet`, `provexchange`.
+   */
+  payment_type?:
+    | 'ach'
+    | 'au_becs'
+    | 'bacs'
+    | 'book'
+    | 'card'
+    | 'check'
+    | 'eft'
+    | 'cross_border'
+    | 'interac'
+    | 'masav'
+    | 'neft'
+    | 'provxchange'
+    | 'rtp'
+    | 'sen'
+    | 'sepa'
+    | 'signet'
+    | 'wire';
+
+  /**
+   * The receiving account ID. Can be an `external_account`.
+   */
+  receiving_account_id?: string;
 }
 
 export namespace LineItemUpdateParams {

package/src/resources/ledger-account-categories.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as API from './index';
+import { Page, PageParams } from '../pagination';
 
 export class LedgerAccountCategories extends APIResource {
   /**

package/src/resources/ledger-account-payouts.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as API from './index';
+import { Page, PageParams } from '../pagination';
 
 export class LedgerAccountPayouts extends APIResource {
   /**

package/src/resources/ledger-account-statements.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import * as API from './';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import * as API from './index';
 
 export class LedgerAccountStatements extends APIResource {
   /**

package/src/resources/ledger-accounts.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as API from './index';
+import { Page, PageParams } from '../pagination';
 
 export class LedgerAccounts extends APIResource {
   /**
@@ -328,24 +328,30 @@ export interface LedgerAccountCreateParams {
 
 export interface LedgerAccountRetrieveParams {
   /**
-   * Use balances[effective_at_lower_bound] and balances[effective_at_upper_bound] to
-   * get the balances change between the two timestamps. The lower bound is inclusive
-   * while the upper bound is exclusive of the provided timestamps. If no value is
-   * supplied the balances will be retrieved not including that bound.
+   * Use `balances[effective_at_lower_bound]` and
+   * `balances[effective_at_upper_bound]` to get the balances change between the two
+   * timestamps. The lower bound is inclusive while the upper bound is exclusive of
+   * the provided timestamps. If no value is supplied the balances will be retrieved
+   * not including that bound. Use `balances[as_of_lock_version]` to retrieve a
+   * balance as of a specific Ledger Account `lock_version`.
    */
   balances?: LedgerAccountRetrieveParams.Balances;
 }
 
 export namespace LedgerAccountRetrieveParams {
   /**
-   * Use balances[effective_at_lower_bound] and balances[effective_at_upper_bound] to
-   * get the balances change between the two timestamps. The lower bound is inclusive
-   * while the upper bound is exclusive of the provided timestamps. If no value is
-   * supplied the balances will be retrieved not including that bound.
+   * Use `balances[effective_at_lower_bound]` and
+   * `balances[effective_at_upper_bound]` to get the balances change between the two
+   * timestamps. The lower bound is inclusive while the upper bound is exclusive of
+   * the provided timestamps. If no value is supplied the balances will be retrieved
+   * not including that bound. Use `balances[as_of_lock_version]` to retrieve a
+   * balance as of a specific Ledger Account `lock_version`.
    */
   export interface Balances {
     as_of_date?: string;
 
+    as_of_lock_version?: number;
+
     effective_at?: string;
 
     effective_at_lower_bound?: string;
@@ -376,10 +382,11 @@ export interface LedgerAccountListParams extends PageParams {
   id?: string;
 
   /**
-   * Use balances[effective_at_lower_bound] and balances[effective_at_upper_bound] to
-   * get the balances change between the two timestamps. The lower bound is inclusive
-   * while the upper bound is exclusive of the provided timestamps. If no value is
-   * supplied the balances will be retrieved not including that bound.
+   * Use `balances[effective_at_lower_bound]` and
+   * `balances[effective_at_upper_bound]` to get the balances change between the two
+   * timestamps. The lower bound is inclusive while the upper bound is exclusive of
+   * the provided timestamps. If no value is supplied the balances will be retrieved
+   * not including that bound.
    */
   balances?: LedgerAccountListParams.Balances;
 
@@ -413,10 +420,11 @@ export interface LedgerAccountListParams extends PageParams {
 
 export namespace LedgerAccountListParams {
   /**
-   * Use balances[effective_at_lower_bound] and balances[effective_at_upper_bound] to
-   * get the balances change between the two timestamps. The lower bound is inclusive
-   * while the upper bound is exclusive of the provided timestamps. If no value is
-   * supplied the balances will be retrieved not including that bound.
+   * Use `balances[effective_at_lower_bound]` and
+   * `balances[effective_at_upper_bound]` to get the balances change between the two
+   * timestamps. The lower bound is inclusive while the upper bound is exclusive of
+   * the provided timestamps. If no value is supplied the balances will be retrieved
+   * not including that bound.
    */
   export interface Balances {
     as_of_date?: string;

package/src/resources/ledger-entries.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as API from './index';
+import { Page, PageParams } from '../pagination';
 
 export class LedgerEntries extends APIResource {
   /**

package/src/resources/ledger-event-handlers.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as API from './index';
+import { Page, PageParams } from '../pagination';
 
 export class LedgerEventHandlers extends APIResource {
   /**
@@ -497,6 +497,11 @@ export interface LedgerEventHandlerCreateParams {
    */
   description?: string | null;
 
+  /**
+   * Body param: The id of the ledger that this account belongs to.
+   */
+  ledger_id?: string;
+
   /**
    * Body param: Additional data represented as key-value pairs. Both the key and
    * value must be strings.

package/src/resources/ledger-transactions/ledger-transactions.ts

@@ -1,12 +1,12 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as LedgerEntries from 'modern-treasury/resources/ledger-entries';
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as LedgerEntries from '../ledger-entries';
 import { Versions } from './versions';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as API from './index';
+import { Page, PageParams } from '../../pagination';
 
 export class LedgerTransactions extends APIResource {
   versions: Versions = new Versions(this.client);
@@ -196,10 +196,10 @@ export interface LedgerTransaction {
 
 export interface LedgerTransactionCreateParams {
   /**
-   * Body param: The date (YYYY-MM-DD) on which the ledger transaction happened for
-   * reporting purposes.
+   * Body param: The timestamp (ISO8601 format) at which the ledger transaction
+   * happened for reporting purposes.
    */
-  effective_date: string;
+  effective_at: string;
 
   /**
    * Body param: An array of ledger entry objects.
@@ -211,6 +211,12 @@ export interface LedgerTransactionCreateParams {
    */
   description?: string | null;
 
+  /**
+   * Body param: The date (YYYY-MM-DD) on which the ledger transaction happened for
+   * reporting purposes.
+   */
+  effective_date?: string;
+
   /**
    * Body param: A unique string to represent the ledger transaction. Only one
    * pending or posted ledger transaction may have this ID in the ledger.

package/src/resources/ledger-transactions/versions.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as API from './index';
+import { Page, PageParams } from '../../pagination';
 
 export class Versions extends APIResource {
   /**

package/src/resources/ledgerable-events.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import * as API from './';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import * as API from './index';
 
 export class LedgerableEvents extends APIResource {
   /**
@@ -90,16 +90,6 @@ export interface LedgerableEvent {
 
   object: string;
 
-  /**
-   * The ledger account that initiates the money movement.
-   */
-  originating_ledger_account_id: string | null;
-
-  /**
-   * The ledger account that receives the money movement.
-   */
-  receiving_ledger_account_id: string | null;
-
   updated_at: string;
 }
 
@@ -147,16 +137,6 @@ export interface LedgerableEventCreateParams {
    */
   metadata?: Record<string, string>;
 
-  /**
-   * Body param: The ledger account that initiates the money movement.
-   */
-  originating_ledger_account_id?: string | null;
-
-  /**
-   * Body param: The ledger account that receives the money movement.
-   */
-  receiving_ledger_account_id?: string | null;
-
   /**
    * Header param: This key should be something unique, preferably something like an
    * UUID.

package/src/resources/ledgers.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as API from './index';
+import { Page, PageParams } from '../pagination';
 
 export class Ledgers extends APIResource {
   /**

package/src/resources/line-items.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as API from './index';
+import { Page, PageParams } from '../pagination';
 
 export class LineItems extends APIResource {
   /**

package/src/resources/paper-items.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as Shared from 'modern-treasury/resources/shared';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Shared from './shared';
+import * as API from './index';
+import { Page, PageParams } from '../pagination';
 
 export class PaperItems extends APIResource {
   /**

package/src/resources/payment-flows.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as API from './index';
+import { Page, PageParams } from '../pagination';
 
 export class PaymentFlows extends APIResource {
   /**