modern-treasury 2.7.2 → 2.8.0

package/src/resources/payment-references.ts

@@ -3,8 +3,8 @@
 import * as Core from "../treasury/core";
 import { APIResource } from "../treasury/resource";
 import { isRequestOptions } from "../treasury/core";
-import * as API from './index';
-import { Page, PageParams } from "../treasury/pagination";
+import * as PaymentReferencesAPI from "../treasury/resources/payment-references";
+import { Page, type PageParams } from "../treasury/pagination";
 
 export class PaymentReferences extends APIResource {
   /**
@@ -39,8 +39,6 @@ export class PaymentReferences extends APIResource {
 }
 
 export class PaymentReferencesPage extends Page<PaymentReference> {}
-// alias so we can export it in the namespace
-type _PaymentReferencesPage = PaymentReferencesPage;
 
 export interface PaymentReference {
   id: string;
@@ -155,7 +153,7 @@ export interface PaymentReferenceListParams extends PageParams {
 }
 
 export namespace PaymentReferences {
-  export import PaymentReference = API.PaymentReference;
-  export type PaymentReferencesPage = _PaymentReferencesPage;
-  export import PaymentReferenceListParams = API.PaymentReferenceListParams;
+  export import PaymentReference = PaymentReferencesAPI.PaymentReference;
+  export import PaymentReferencesPage = PaymentReferencesAPI.PaymentReferencesPage;
+  export import PaymentReferenceListParams = PaymentReferencesAPI.PaymentReferenceListParams;
 }

package/src/resources/returns.ts

@@ -3,9 +3,9 @@
 import * as Core from "../treasury/core";
 import { APIResource } from "../treasury/resource";
 import { isRequestOptions } from "../treasury/core";
+import * as ReturnsAPI from "../treasury/resources/returns";
 import * as Shared from "../treasury/resources/shared";
-import * as API from './index';
-import { Page, PageParams } from "../treasury/pagination";
+import { Page, type PageParams } from "../treasury/pagination";
 
 export class Returns extends APIResource {
   /**
@@ -53,18 +53,10 @@ export class Returns extends APIResource {
 }
 
 export class ReturnObjectsPage extends Page<ReturnObject> {}
-// alias so we can export it in the namespace
-type _ReturnObjectsPage = ReturnObjectsPage;
 
 export interface ReturnObject {
   id: string;
 
-  /**
-   * Some returns may include additional information from the bank. In these cases,
-   * this string will be present.
-   */
-  additional_information: string | null;
-
   /**
    * Value in specified currency's smallest unit. e.g. $10 would be represented
    * as 1000.
@@ -223,6 +215,12 @@ export interface ReturnObject {
     | 'wire';
 
   updated_at: string;
+
+  /**
+   * Some returns may include additional information from the bank. In these cases,
+   * this string will be present.
+   */
+  additional_information?: string | null;
 }
 
 export namespace ReturnObject {
@@ -414,8 +412,8 @@ export interface ReturnListParams extends PageParams {
 }
 
 export namespace Returns {
-  export import ReturnObject = API.ReturnObject;
-  export type ReturnObjectsPage = _ReturnObjectsPage;
-  export import ReturnCreateParams = API.ReturnCreateParams;
-  export import ReturnListParams = API.ReturnListParams;
+  export import ReturnObject = ReturnsAPI.ReturnObject;
+  export import ReturnObjectsPage = ReturnsAPI.ReturnObjectsPage;
+  export import ReturnCreateParams = ReturnsAPI.ReturnCreateParams;
+  export import ReturnListParams = ReturnsAPI.ReturnListParams;
 }

package/src/resources/routing-details.ts

@@ -3,9 +3,9 @@
 import * as Core from "../treasury/core";
 import { APIResource } from "../treasury/resource";
 import { isRequestOptions } from "../treasury/core";
+import * as RoutingDetailsAPI from "../treasury/resources/routing-details";
 import * as Shared from "../treasury/resources/shared";
-import * as API from './index';
-import { Page, PageParams } from "../treasury/pagination";
+import { Page, type PageParams } from "../treasury/pagination";
 
 export class RoutingDetails extends APIResource {
   /**
@@ -89,8 +89,6 @@ export class RoutingDetails extends APIResource {
 }
 
 export class RoutingDetailsPage extends Page<RoutingDetail> {}
-// alias so we can export it in the namespace
-type _RoutingDetailsPage = RoutingDetailsPage;
 
 export interface RoutingDetail {
   id: string;
@@ -124,6 +122,7 @@ export interface RoutingDetail {
     | 'bacs'
     | 'book'
     | 'card'
+    | 'chats'
     | 'check'
     | 'cross_border'
     | 'eft'
@@ -131,6 +130,7 @@ export interface RoutingDetail {
     | 'masav'
     | 'neft'
     | 'nics'
+    | 'nz_becs'
     | 'provxchange'
     | 'rtp'
     | 'se_bankgirot'
@@ -148,7 +148,9 @@ export interface RoutingDetail {
   routing_number: string;
 
   /**
-   * One of `aba`, `swift`, `ca_cpa`, `au_bsb`, `gb_sort_code`, `in_ifsc`, `cnaps`.
+   * The type of routing number. See
+   * https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+   * more details.
    */
   routing_number_type:
     | 'aba'
@@ -158,9 +160,11 @@ export interface RoutingDetail {
     | 'chips'
     | 'cnaps'
     | 'gb_sort_code'
+    | 'hk_interbank_clearing_code'
     | 'in_ifsc'
     | 'jp_zengin_code'
     | 'my_branch_code'
+    | 'nz_national_clearing_code'
     | 'se_bankgiro_clearing_code'
     | 'swift';
 
@@ -216,7 +220,9 @@ export interface RoutingDetailCreateParams {
   routing_number: string;
 
   /**
-   * One of `aba`, `swift`, `ca_cpa`, `au_bsb`, `gb_sort_code`, `in_ifsc`, `cnaps`.
+   * The type of routing number. See
+   * https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+   * more details.
    */
   routing_number_type:
     | 'aba'
@@ -226,9 +232,11 @@ export interface RoutingDetailCreateParams {
     | 'chips'
     | 'cnaps'
     | 'gb_sort_code'
+    | 'hk_interbank_clearing_code'
     | 'in_ifsc'
     | 'jp_zengin_code'
     | 'my_branch_code'
+    | 'nz_national_clearing_code'
     | 'se_bankgiro_clearing_code'
     | 'swift';
 
@@ -242,6 +250,7 @@ export interface RoutingDetailCreateParams {
     | 'bacs'
     | 'book'
     | 'card'
+    | 'chats'
     | 'check'
     | 'cross_border'
     | 'eft'
@@ -249,6 +258,7 @@ export interface RoutingDetailCreateParams {
     | 'masav'
     | 'neft'
     | 'nics'
+    | 'nz_becs'
     | 'provxchange'
     | 'rtp'
     | 'se_bankgirot'
@@ -264,8 +274,8 @@ export interface RoutingDetailCreateParams {
 export interface RoutingDetailListParams extends PageParams {}
 
 export namespace RoutingDetails {
-  export import RoutingDetail = API.RoutingDetail;
-  export type RoutingDetailsPage = _RoutingDetailsPage;
-  export import RoutingDetailCreateParams = API.RoutingDetailCreateParams;
-  export import RoutingDetailListParams = API.RoutingDetailListParams;
+  export import RoutingDetail = RoutingDetailsAPI.RoutingDetail;
+  export import RoutingDetailsPage = RoutingDetailsAPI.RoutingDetailsPage;
+  export import RoutingDetailCreateParams = RoutingDetailsAPI.RoutingDetailCreateParams;
+  export import RoutingDetailListParams = RoutingDetailsAPI.RoutingDetailListParams;
 }

package/src/resources/shared.ts

@@ -202,3 +202,5 @@ export type Currency =
   | 'ZWN'
   | 'ZWR'
   | null;
+
+export type TransactionDirection = 'credit' | 'debit';

package/src/resources/top-level.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as API from './index';
+import * as TopLevelAPI from "../treasury/resources/top-level";
 
 export interface PingResponse {
   ping: string;
 }
 
 export namespace TopLevel {
-  export import PingResponse = API.PingResponse;
+  export import PingResponse = TopLevelAPI.PingResponse;
 }

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

@@ -3,8 +3,8 @@
 import * as Core from "../../treasury/core";
 import { APIResource } from "../../treasury/resource";
 import { isRequestOptions } from "../../treasury/core";
-import * as API from './index';
-import { Page, PageParams } from "../../treasury/pagination";
+import * as LineItemsAPI from "../../treasury/resources/transactions/line-items";
+import { Page, type PageParams } from "../../treasury/pagination";
 
 export class LineItems extends APIResource {
   /**
@@ -34,8 +34,6 @@ export class LineItems extends APIResource {
 }
 
 export class TransactionLineItemsPage extends Page<TransactionLineItem> {}
-// alias so we can export it in the namespace
-type _TransactionLineItemsPage = TransactionLineItemsPage;
 
 export interface TransactionLineItem {
   id: string;
@@ -77,6 +75,12 @@ export interface TransactionLineItem {
 
   object: string;
 
+  /**
+   * Describes whether this line item should be counted towards the corresponding
+   * transaction’s reconciliation.
+   */
+  reconcilable: boolean;
+
   /**
    * If a matching object exists in Modern Treasury, the ID will be populated here,
    * otherwise `null`.
@@ -119,7 +123,7 @@ export interface LineItemListParams extends PageParams {
 }
 
 export namespace LineItems {
-  export import TransactionLineItem = API.TransactionLineItem;
-  export type TransactionLineItemsPage = _TransactionLineItemsPage;
-  export import LineItemListParams = API.LineItemListParams;
+  export import TransactionLineItem = LineItemsAPI.TransactionLineItem;
+  export import TransactionLineItemsPage = LineItemsAPI.TransactionLineItemsPage;
+  export import LineItemListParams = LineItemsAPI.LineItemListParams;
 }

package/src/resources/transactions/transactions.ts

@@ -3,13 +3,13 @@
 import * as Core from "../../treasury/core";
 import { APIResource } from "../../treasury/resource";
 import { isRequestOptions } from "../../treasury/core";
+import * as TransactionsAPI from "../../treasury/resources/transactions/transactions";
 import * as Shared from "../../treasury/resources/shared";
-import { LineItems } from './line-items';
-import * as API from './index';
-import { Page, PageParams } from "../../treasury/pagination";
+import * as LineItemsAPI from "../../treasury/resources/transactions/line-items";
+import { Page, type PageParams } from "../../treasury/pagination";
 
 export class Transactions extends APIResource {
-  lineItems: LineItems = new LineItems(this.client);
+  lineItems: LineItemsAPI.LineItems = new LineItemsAPI.LineItems(this.client);
 
   /**
    * Get details on a single transaction.
@@ -58,8 +58,6 @@ export class Transactions extends APIResource {
 }
 
 export class TransactionsPage extends Page<Transaction> {}
-// alias so we can export it in the namespace
-type _TransactionsPage = TransactionsPage;
 
 export interface Transaction {
   id: string;
@@ -88,17 +86,6 @@ export interface Transaction {
    */
   currency: Shared.Currency | null;
 
-  /**
-   * This field contains additional information that the bank provided about the
-   * transaction. This is structured data. Some of the data in here might overlap
-   * with what is in the `vendor_description`. For example, the OBI could be a part
-   * of the vendor description, and it would also be included in here. The attributes
-   * that are passed through the details field will vary based on your banking
-   * partner. Currently, the following keys may be in the details object:
-   * `originator_name`, `originator_to_beneficiary_information`.
-   */
-  details: Record<string, string>;
-
   /**
    * Either `credit` or `debit`.
    */
@@ -147,6 +134,7 @@ export interface Transaction {
     | 'bacs'
     | 'book'
     | 'card'
+    | 'chats'
     | 'check'
     | 'cross_border'
     | 'eft'
@@ -154,6 +142,7 @@ export interface Transaction {
     | 'masav'
     | 'neft'
     | 'nics'
+    | 'nz_becs'
     | 'provxchange'
     | 'rtp'
     | 'se_bankgirot'
@@ -207,15 +196,26 @@ export interface Transaction {
   vendor_customer_id: string | null;
 
   /**
-   * The transaction detail text that often appears in on your bank statement and in
-   * your banking portal.
+   * An identifier given to this transaction by the bank.
+   */
+  vendor_id: string | null;
+
+  /**
+   * This field contains additional information that the bank provided about the
+   * transaction. This is structured data. Some of the data in here might overlap
+   * with what is in the `vendor_description`. For example, the OBI could be a part
+   * of the vendor description, and it would also be included in here. The attributes
+   * that are passed through the details field will vary based on your banking
+   * partner. Currently, the following keys may be in the details object:
+   * `originator_name`, `originator_to_beneficiary_information`.
    */
-  vendor_description: string | null;
+  details?: Record<string, string>;
 
   /**
-   * An identifier given to this transaction by the bank.
+   * The transaction detail text that often appears in on your bank statement and in
+   * your banking portal.
    */
-  vendor_id: string | null;
+  vendor_description?: string | null;
 }
 
 export interface TransactionUpdateParams {
@@ -280,13 +280,12 @@ export interface TransactionListParams extends PageParams {
 }
 
 export namespace Transactions {
-  export import Transaction = API.Transaction;
-  export type TransactionsPage = _TransactionsPage;
-  export import TransactionUpdateParams = API.TransactionUpdateParams;
-  export import TransactionListParams = API.TransactionListParams;
-
-  export import LineItems = API.LineItems;
-  export import TransactionLineItem = API.TransactionLineItem;
-  export import TransactionLineItemsPage = API.TransactionLineItemsPage;
-  export import LineItemListParams = API.LineItemListParams;
+  export import Transaction = TransactionsAPI.Transaction;
+  export import TransactionsPage = TransactionsAPI.TransactionsPage;
+  export import TransactionUpdateParams = TransactionsAPI.TransactionUpdateParams;
+  export import TransactionListParams = TransactionsAPI.TransactionListParams;
+  export import LineItems = LineItemsAPI.LineItems;
+  export import TransactionLineItem = LineItemsAPI.TransactionLineItem;
+  export import TransactionLineItemsPage = LineItemsAPI.TransactionLineItemsPage;
+  export import LineItemListParams = LineItemsAPI.LineItemListParams;
 }

package/src/resources/validations.ts

@@ -2,7 +2,7 @@
 
 import * as Core from "../treasury/core";
 import { APIResource } from "../treasury/resource";
-import * as API from './index';
+import * as ValidationsAPI from "../treasury/resources/validations";
 
 export class Validations extends APIResource {
   /**
@@ -34,10 +34,10 @@ export interface RoutingNumberLookupRequest {
   routing_number?: string;
 
   /**
-   * One of `aba`, `au_bsb`, `br_codigo`, `ca_cpa`, `cnaps`, `gb_sort_code`,
-   * `in_ifsc`, `my_branch_code`, `se_bankgiro_clearing_code`, or `swift`. In sandbox
-   * mode we currently only support `aba` and `swift` with routing numbers
-   * '123456789' and 'GRINUST0XXX' respectively.
+   * The type of routing number. See
+   * https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+   * more details. In sandbox mode we currently only support `aba` and `swift` with
+   * routing numbers '123456789' and 'GRINUST0XXX' respectively.
    */
   routing_number_type?:
     | 'aba'
@@ -45,6 +45,7 @@ export interface RoutingNumberLookupRequest {
     | 'ca_cpa'
     | 'gb_sort_code'
     | 'in_ifsc'
+    | 'nz_national_clearing_code'
     | 'se_bankgiro_clearing_code'
     | 'swift';
 
@@ -65,6 +66,7 @@ export interface RoutingNumberLookupRequest {
     | 'bacs'
     | 'book'
     | 'card'
+    | 'chats'
     | 'check'
     | 'cross_border'
     | 'eft'
@@ -72,6 +74,7 @@ export interface RoutingNumberLookupRequest {
     | 'masav'
     | 'neft'
     | 'nics'
+    | 'nz_becs'
     | 'provxchange'
     | 'rtp'
     | 'se_bankgirot'
@@ -122,10 +125,10 @@ export interface ValidationValidateRoutingNumberParams {
   routing_number: string;
 
   /**
-   * One of `aba`, `au_bsb`, `br_codigo`, `ca_cpa`, `cnaps`, `gb_sort_code`,
-   * `in_ifsc`, `my_branch_code`, `se_bankgiro_clearing_code`, or `swift`. In sandbox
-   * mode we currently only support `aba` and `swift` with routing numbers
-   * '123456789' and 'GRINUST0XXX' respectively.
+   * The type of routing number. See
+   * https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+   * more details. In sandbox mode we currently only support `aba` and `swift` with
+   * routing numbers '123456789' and 'GRINUST0XXX' respectively.
    */
   routing_number_type:
     | 'aba'
@@ -135,14 +138,16 @@ export interface ValidationValidateRoutingNumberParams {
     | 'chips'
     | 'cnaps'
     | 'gb_sort_code'
+    | 'hk_interbank_clearing_code'
     | 'in_ifsc'
     | 'jp_zengin_code'
     | 'my_branch_code'
+    | 'nz_national_clearing_code'
     | 'se_bankgiro_clearing_code'
     | 'swift';
 }
 
 export namespace Validations {
-  export import RoutingNumberLookupRequest = API.RoutingNumberLookupRequest;
-  export import ValidationValidateRoutingNumberParams = API.ValidationValidateRoutingNumberParams;
+  export import RoutingNumberLookupRequest = ValidationsAPI.RoutingNumberLookupRequest;
+  export import ValidationValidateRoutingNumberParams = ValidationsAPI.ValidationValidateRoutingNumberParams;
 }

package/src/resources/virtual-accounts.ts

@@ -3,10 +3,10 @@
 import * as Core from "../treasury/core";
 import { APIResource } from "../treasury/resource";
 import { isRequestOptions } from "../treasury/core";
-import * as AccountDetails from "../treasury/resources/account-details";
-import * as RoutingDetails from "../treasury/resources/routing-details";
-import * as API from './index';
-import { Page, PageParams } from "../treasury/pagination";
+import * as VirtualAccountsAPI from "../treasury/resources/virtual-accounts";
+import * as AccountDetailsAPI from "../treasury/resources/account-details";
+import * as RoutingDetailsAPI from "../treasury/resources/routing-details";
+import { Page, type PageParams } from "../treasury/pagination";
 
 export class VirtualAccounts extends APIResource {
   /**
@@ -81,8 +81,6 @@ export class VirtualAccounts extends APIResource {
 }
 
 export class VirtualAccountsPage extends Page<VirtualAccount> {}
-// alias so we can export it in the namespace
-type _VirtualAccountsPage = VirtualAccountsPage;
 
 export interface VirtualAccount {
   id: string;
@@ -90,7 +88,7 @@ export interface VirtualAccount {
   /**
    * An array of account detail objects.
    */
-  account_details: Array<AccountDetails.AccountDetail>;
+  account_details: Array<AccountDetailsAPI.AccountDetail>;
 
   /**
    * The ID of a counterparty that the virtual account belongs to. Optional.
@@ -148,7 +146,7 @@ export interface VirtualAccount {
    * An array of routing detail objects. These will be the routing details of the
    * internal account.
    */
-  routing_details: Array<RoutingDetails.RoutingDetail>;
+  routing_details: Array<RoutingDetailsAPI.RoutingDetail>;
 
   updated_at: string;
 }
@@ -226,7 +224,9 @@ export namespace VirtualAccountCreateParams {
     routing_number: string;
 
     /**
-     * One of `aba`, `swift`, `ca_cpa`, `au_bsb`, `gb_sort_code`, `in_ifsc`, `cnaps`.
+     * The type of routing number. See
+     * https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+     * more details.
      */
     routing_number_type:
       | 'aba'
@@ -236,9 +236,11 @@ export namespace VirtualAccountCreateParams {
       | 'chips'
       | 'cnaps'
       | 'gb_sort_code'
+      | 'hk_interbank_clearing_code'
       | 'in_ifsc'
       | 'jp_zengin_code'
       | 'my_branch_code'
+      | 'nz_national_clearing_code'
       | 'se_bankgiro_clearing_code'
       | 'swift';
 
@@ -252,6 +254,7 @@ export namespace VirtualAccountCreateParams {
       | 'bacs'
       | 'book'
       | 'card'
+      | 'chats'
       | 'check'
       | 'cross_border'
       | 'eft'
@@ -259,6 +262,7 @@ export namespace VirtualAccountCreateParams {
       | 'masav'
       | 'neft'
       | 'nics'
+      | 'nz_becs'
       | 'provxchange'
       | 'rtp'
       | 'se_bankgirot'
@@ -294,9 +298,9 @@ export interface VirtualAccountListParams extends PageParams {
 }
 
 export namespace VirtualAccounts {
-  export import VirtualAccount = API.VirtualAccount;
-  export type VirtualAccountsPage = _VirtualAccountsPage;
-  export import VirtualAccountCreateParams = API.VirtualAccountCreateParams;
-  export import VirtualAccountUpdateParams = API.VirtualAccountUpdateParams;
-  export import VirtualAccountListParams = API.VirtualAccountListParams;
+  export import VirtualAccount = VirtualAccountsAPI.VirtualAccount;
+  export import VirtualAccountsPage = VirtualAccountsAPI.VirtualAccountsPage;
+  export import VirtualAccountCreateParams = VirtualAccountsAPI.VirtualAccountCreateParams;
+  export import VirtualAccountUpdateParams = VirtualAccountsAPI.VirtualAccountUpdateParams;
+  export import VirtualAccountListParams = VirtualAccountsAPI.VirtualAccountListParams;
 }

package/src/resources/webhooks.ts

@@ -3,7 +3,7 @@
 import { APIResource } from "../treasury/resource";
 import { createHmac } from 'crypto';
 import type { HeadersLike } from "../treasury/core";
-import { getHeader } from "../treasury/core";
+import { getRequiredHeader } from "../treasury/core";
 
 export class Webhooks extends APIResource {
   /**
@@ -40,8 +40,9 @@ export class Webhooks extends APIResource {
     opts?: { key?: string | null | undefined },
   ): boolean {
     const signature = this.getSignature(payload, opts);
-    const expectedSignature = typeof headers === 'string' ? headers : getHeader(headers, 'X-Signature');
-    if (!expectedSignature) throw new Error('Could not find an X-Signature header');
+    const expectedSignature =
+      typeof headers === 'string' ? headers : getRequiredHeader(headers, 'X-Signature');
+    if (!expectedSignature) throw new Error('Could not find X-Signature header');
     return signature === expectedSignature;
   }
 }

package/src/shims/node.ts

@@ -45,6 +45,6 @@ declare module '../_shims/manual-types' {
     // @ts-ignore
     export type FsReadStream = types.FsReadStream;
     // @ts-ignore
-    export type ReadableStream = types.ReadableStream;
+    export import ReadableStream = types.ReadableStream;
   }
 }

package/src/shims/web.ts

@@ -45,6 +45,6 @@ declare module '../_shims/manual-types' {
     // @ts-ignore
     export type FsReadStream = types.FsReadStream;
     // @ts-ignore
-    export type ReadableStream = types.ReadableStream;
+    export import ReadableStream = types.ReadableStream;
   }
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.7.2'; // x-release-please-version
+export const VERSION = '2.8.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.7.2";
+export declare const VERSION = "2.8.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '2.7.2'; // x-release-please-version
+exports.VERSION = '2.8.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '2.7.2'; // x-release-please-version
+export const VERSION = '2.8.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map