modern-treasury 2.2.0 → 2.4.0

package/src/resources/internal-accounts/balance-reports.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-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';
+import * as Core from '../../core.js';
+import { APIResource } from '../../resource.js';
+import { isRequestOptions } from '../../core.js';
+import * as Shared from '../shared.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../../pagination.js';
 
 export class BalanceReports extends APIResource {
   /**
@@ -15,7 +15,7 @@ export class BalanceReports extends APIResource {
     internalAccountId: string,
     id: string,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<BalanceReport>> {
+  ): Core.APIPromise<BalanceReport> {
     return this.get(`/api/internal_accounts/${internalAccountId}/balance_reports/${id}`, options);
   }
 
@@ -26,13 +26,16 @@ export class BalanceReports extends APIResource {
     internalAccountId: string,
     query?: BalanceReportListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<BalanceReportsPage>;
-  list(internalAccountId: string, options?: Core.RequestOptions): Core.PagePromise<BalanceReportsPage>;
+  ): Core.PagePromise<BalanceReportsPage, BalanceReport>;
+  list(
+    internalAccountId: string,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<BalanceReportsPage, BalanceReport>;
   list(
     internalAccountId: string,
     query: BalanceReportListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<BalanceReportsPage> {
+  ): Core.PagePromise<BalanceReportsPage, BalanceReport> {
     if (isRequestOptions(query)) {
       return this.list(internalAccountId, {}, query);
     }

package/src/resources/internal-accounts/index.ts

@@ -5,7 +5,7 @@ export {
   BalanceReportListParams,
   BalanceReportsPage,
   BalanceReports,
-} from './balance-reports';
+} from './balance-reports.js';
 export {
   InternalAccount,
   InternalAccountCreateParams,
@@ -13,4 +13,4 @@ export {
   InternalAccountListParams,
   InternalAccountsPage,
   InternalAccounts,
-} from './internal-accounts';
+} from './internal-accounts.js';

package/src/resources/internal-accounts/internal-accounts.ts

@@ -1,15 +1,15 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core';
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as AccountDetails from '../account-details';
-import * as RoutingDetails from '../routing-details';
-import * as Connections from '../connections';
-import * as Shared from '../shared';
-import { BalanceReports } from './balance-reports';
-import * as API from './index';
-import { Page, PageParams } from '../../pagination';
+import * as Core from '../../core.js';
+import { APIResource } from '../../resource.js';
+import { isRequestOptions } from '../../core.js';
+import * as AccountDetails from '../account-details.js';
+import * as RoutingDetails from '../routing-details.js';
+import * as Connections from '../connections.js';
+import * as Shared from '../shared.js';
+import { BalanceReports } from './balance-reports.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../../pagination.js';
 
 export class InternalAccounts extends APIResource {
   balanceReports: BalanceReports = new BalanceReports(this.client);
@@ -20,19 +20,25 @@ export class InternalAccounts extends APIResource {
   create(
     params: InternalAccountCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<InternalAccount>> {
+  ): Core.APIPromise<InternalAccount> {
+    // @ts-expect-error idempotency key header isn't defined anymore but is included here for back-compat
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+    if (idempotencyKey) {
+      console.warn(
+        "The Idempotency-Key request param is deprecated, the 'idempotencyToken' option should be set instead",
+      );
+    }
     return this.post('/api/internal_accounts', {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
   /**
    * get internal account
    */
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<InternalAccount>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<InternalAccount> {
     return this.get(`/api/internal_accounts/${id}`, options);
   }
 
@@ -43,13 +49,13 @@ export class InternalAccounts extends APIResource {
     id: string,
     body?: InternalAccountUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<InternalAccount>>;
-  update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<InternalAccount>>;
+  ): Core.APIPromise<InternalAccount>;
+  update(id: string, options?: Core.RequestOptions): Core.APIPromise<InternalAccount>;
   update(
     id: string,
     body: InternalAccountUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<InternalAccount>> {
+  ): Core.APIPromise<InternalAccount> {
     if (isRequestOptions(body)) {
       return this.update(id, {}, body);
     }
@@ -62,12 +68,12 @@ export class InternalAccounts extends APIResource {
   list(
     query?: InternalAccountListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<InternalAccountsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<InternalAccountsPage>;
+  ): Core.PagePromise<InternalAccountsPage, InternalAccount>;
+  list(options?: Core.RequestOptions): Core.PagePromise<InternalAccountsPage, InternalAccount>;
   list(
     query: InternalAccountListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<InternalAccountsPage> {
+  ): Core.PagePromise<InternalAccountsPage, InternalAccount> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -209,52 +215,46 @@ export namespace InternalAccount {
 
 export interface InternalAccountCreateParams {
   /**
-   * Body param: The identifier of the financial institution the account belongs to.
+   * The identifier of the financial institution the account belongs to.
    */
   connection_id: string;
 
   /**
-   * Body param: Either "USD" or "CAD". Internal accounts created at Increase only
-   * supports "USD".
+   * Either "USD" or "CAD". Internal accounts created at Increase only supports
+   * "USD".
    */
   currency: 'USD' | 'CAD';
 
   /**
-   * Body param: The nickname of the account.
+   * The nickname of the account.
    */
   name: string;
 
   /**
-   * Body param: The legal name of the entity which owns the account.
+   * The legal name of the entity which owns the account.
    */
   party_name: string;
 
   /**
-   * Body param: The Counterparty associated to this account.
+   * The Counterparty associated to this account.
    */
   counterparty_id?: string;
 
   /**
-   * Body param: The parent internal account of this new account.
+   * The parent internal account of this new account.
    */
   parent_account_id?: string;
 
   /**
-   * Body param: The address associated with the owner or null.
+   * The address associated with the owner or null.
    */
   party_address?: InternalAccountCreateParams.PartyAddress;
 
   /**
-   * Body param: A hash of vendor specific attributes that will be used when creating
-   * the account at the vendor specified by the given connection.
+   * A hash of vendor specific attributes that will be used when creating the account
+   * at the vendor specified by the given connection.
    */
   vendor_attributes?: Record<string, string>;
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export namespace InternalAccountCreateParams {

package/src/resources/invoices/index.ts

@@ -7,7 +7,7 @@ export {
   InvoiceListParams,
   InvoicesPage,
   Invoices,
-} from './invoices';
+} from './invoices.js';
 export {
   InvoiceLineItem,
   LineItemCreateParams,
@@ -15,4 +15,4 @@ export {
   LineItemListParams,
   InvoiceLineItemsPage,
   LineItems,
-} from './line-items';
+} from './line-items.js';

package/src/resources/invoices/invoices.ts

@@ -1,13 +1,13 @@
 // File generated from our OpenAPI spec by Stainless.
 
-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 './index';
-import { Page, PageParams } from '../../pagination';
+import * as Core from '../../core.js';
+import { APIResource } from '../../resource.js';
+import { isRequestOptions } from '../../core.js';
+import * as PaymentOrders from '../payment-orders/index.js';
+import * as Shared from '../shared.js';
+import { LineItems } from './line-items.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../../pagination.js';
 
 export class Invoices extends APIResource {
   lineItems: LineItems = new LineItems(this.client);
@@ -15,36 +15,38 @@ export class Invoices extends APIResource {
   /**
    * create invoice
    */
-  create(params: InvoiceCreateParams, options?: Core.RequestOptions): Promise<Core.APIResponse<Invoice>> {
+  create(params: InvoiceCreateParams, options?: Core.RequestOptions): Core.APIPromise<Invoice> {
+    // @ts-expect-error idempotency key header isn't defined anymore but is included here for back-compat
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+    if (idempotencyKey) {
+      console.warn(
+        "The Idempotency-Key request param is deprecated, the 'idempotencyToken' option should be set instead",
+      );
+    }
     return this.post('/api/invoices', {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
   /**
    * get invoice
    */
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Invoice>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Invoice> {
     return this.get(`/api/invoices/${id}`, options);
   }
 
   /**
    * update invoice
    */
-  update(
-    id: string,
-    body?: InvoiceUpdateParams,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Invoice>>;
-  update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Invoice>>;
+  update(id: string, body?: InvoiceUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
+  update(id: string, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
   update(
     id: string,
     body: InvoiceUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Invoice>> {
+  ): Core.APIPromise<Invoice> {
     if (isRequestOptions(body)) {
       return this.update(id, {}, body);
     }
@@ -54,12 +56,12 @@ export class Invoices extends APIResource {
   /**
    * list invoices
    */
-  list(query?: InvoiceListParams, options?: Core.RequestOptions): Core.PagePromise<InvoicesPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<InvoicesPage>;
+  list(query?: InvoiceListParams, options?: Core.RequestOptions): Core.PagePromise<InvoicesPage, Invoice>;
+  list(options?: Core.RequestOptions): Core.PagePromise<InvoicesPage, Invoice>;
   list(
     query: InvoiceListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<InvoicesPage> {
+  ): Core.PagePromise<InvoicesPage, Invoice> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -127,6 +129,19 @@ export interface Invoice {
    */
   live_mode: boolean;
 
+  /**
+   * Emails in addition to the counterparty email to send invoice status
+   * notifications to. At least one email is required if notifications are enabled
+   * and the counterparty doesn't have an email.
+   */
+  notification_email_addresses: Array<string> | null;
+
+  /**
+   * If true, the invoice will send email notifications to the invoice recipients
+   * about invoice status changes.
+   */
+  notifications_enabled: boolean;
+
   /**
    * A unique record number assigned to each invoice that is issued.
    */
@@ -159,7 +174,7 @@ export interface Invoice {
   payment_orders: Array<PaymentOrders.PaymentOrder>;
 
   /**
-   * One of `ach` or `eft`
+   * One of `ach` or `eft`.
    */
   payment_type: 'eft' | 'ach' | null;
 
@@ -184,6 +199,11 @@ export interface Invoice {
    */
   total_amount: number;
 
+  /**
+   * IDs of transaction line items associated with an invoice.
+   */
+  transaction_line_item_ids: Array<string>;
+
   updated_at: string;
 }
 
@@ -300,73 +320,83 @@ export namespace Invoice {
 
 export interface InvoiceCreateParams {
   /**
-   * Body param: The ID of the counterparty receiving the invoice.
+   * The ID of the counterparty receiving the invoice.
    */
   counterparty_id: string;
 
   /**
-   * Body param: A future date by when the invoice needs to be paid.
+   * A future date by when the invoice needs to be paid.
    */
   due_date: string;
 
   /**
-   * Body param: The ID of the internal account the invoice should be paid to.
+   * The ID of the internal account the invoice should be paid to.
    */
   originating_account_id: string;
 
   /**
-   * Body param: The invoicer's contact details displayed at the top of the invoice.
+   * The invoicer's contact details displayed at the top of the invoice.
    */
   contact_details?: Array<InvoiceCreateParams.ContactDetail>;
 
   /**
-   * Body param: The counterparty's billing address.
+   * The counterparty's billing address.
    */
   counterparty_billing_address?: InvoiceCreateParams.CounterpartyBillingAddress | null;
 
   /**
-   * Body param: The counterparty's shipping address where physical goods should be
-   * delivered.
+   * The counterparty's shipping address where physical goods should be delivered.
    */
   counterparty_shipping_address?: InvoiceCreateParams.CounterpartyShippingAddress | null;
 
   /**
-   * Body param: Currency that the invoice is denominated in. Defaults to `USD` if
-   * not provided.
+   * Currency that the invoice is denominated in. Defaults to `USD` if not provided.
    */
   currency?: Shared.Currency | null;
 
   /**
-   * Body param: A free-form description of the invoice.
+   * A free-form description of the invoice.
    */
   description?: string;
 
   /**
-   * Body param: The invoice issuer's business address.
+   * The invoice issuer's business address.
    */
   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.
+   * Emails in addition to the counterparty email to send invoice status
+   * notifications to. At least one email is required if notifications are enabled
+   * and the counterparty doesn't have an email.
+   */
+  notification_email_addresses?: Array<string> | null;
+
+  /**
+   * If true, the invoice will send email notifications to the invoice recipients
+   * about invoice status changes.
+   */
+  notifications_enabled?: boolean;
+
+  /**
+   * 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`.
+   * 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`.
+   * One of `ach`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`, `bacs`,
+   * `au_becs`, `interac`, `signet`, `provexchange`.
    */
   payment_type?:
     | 'ach'
@@ -388,15 +418,9 @@ export interface InvoiceCreateParams {
     | 'wire';
 
   /**
-   * Body param: The receiving account ID. Can be an `external_account`.
+   * 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.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export namespace InvoiceCreateParams {
@@ -551,6 +575,19 @@ export interface InvoiceUpdateParams {
    */
   invoicer_address?: InvoiceUpdateParams.InvoicerAddress | null;
 
+  /**
+   * Emails in addition to the counterparty email to send invoice status
+   * notifications to. At least one email is required if notifications are enabled
+   * and the counterparty doesn't have an email.
+   */
+  notification_email_addresses?: Array<string> | null;
+
+  /**
+   * If true, the invoice will send email notifications to the invoice recipients
+   * about invoice status changes.
+   */
+  notifications_enabled?: boolean;
+
   /**
    * The ID of the internal account the invoice should be paid to.
    */
@@ -603,8 +640,8 @@ export interface InvoiceUpdateParams {
 
   /**
    * 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
-   * `draft` or `unpaid` to `voided`.
+   * other invoice attributes. Valid state transitions are `draft` to `unpaid`,
+   * `draft` or `unpaid` to `voided`, and `draft` or `unpaid` to `paid`.
    */
   status?: string;
 }