modern-treasury 2.7.2 → 2.9.0

package/src/resources/payment-orders/payment-orders.ts

@@ -1,18 +1,20 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from "../../treasury/core";
-import { APIResource } from "../../treasury/resource";
-import { isRequestOptions } from "../../treasury/core";
-import * as Shared from "../../treasury/resources/shared";
-import * as Returns from "../../treasury/resources/returns";
-import * as ExternalAccounts from "../../treasury/resources/external-accounts";
-import { Reversals } from './reversals';
-import * as API from './index';
-import { type Uploadable, maybeMultipartFormRequestOptions } from "../../treasury/core";
-import { Page, PageParams } from "../../treasury/pagination";
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import { isRequestOptions } from "../../core";
+import * as PaymentOrdersAPI from "./payment-orders";
+import * as ExternalAccountsAPI from "../external-accounts";
+import * as ReturnsAPI from "../returns";
+import * as Shared from "../shared";
+import * as VirtualAccountsAPI from "../virtual-accounts";
+import * as InternalAccountsAPI from "../internal-accounts/internal-accounts";
+import * as ReversalsAPI from "./reversals";
+import { type Uploadable, maybeMultipartFormRequestOptions } from "../../core";
+import { Page, type PageParams } from "../../pagination";
 
 export class PaymentOrders extends APIResource {
-  reversals: Reversals = new Reversals(this.client);
+  reversals: ReversalsAPI.Reversals = new ReversalsAPI.Reversals(this.client);
 
   /**
    * Create a new Payment Order
@@ -103,8 +105,6 @@ export class PaymentOrders extends APIResource {
 }
 
 export class PaymentOrdersPage extends Page<PaymentOrder> {}
-// alias so we can export it in the namespace
-type _PaymentOrdersPage = PaymentOrdersPage;
 
 export interface PaymentOrder {
   id: string;
@@ -159,7 +159,7 @@ export interface PaymentOrder {
    * If the payment order's status is `returned`, this will include the return
    * object's data.
    */
-  current_return: Returns.ReturnObject | null;
+  current_return: ReturnsAPI.ReturnObject | null;
 
   /**
    * The ID of the compliance decision for the payment order, if transaction
@@ -330,11 +330,28 @@ export interface PaymentOrder {
 
   /**
    * One of `ach`, `bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`,
-   * `bacs`, `au_becs`, `interac`, `neft`, `nics`, `sic`, `signet`, `provexchange`,
-   * `zengin`.
+   * `bacs`, `au_becs`, `interac`, `neft`, `nics`, `nz_national_clearing_code`,
+   * `sic`, `signet`, `provexchange`, `zengin`.
    */
   type: PaymentOrderType;
 
+  /**
+   * The account to which the originating of this payment should be attributed to.
+   * Can be a `virtual_account` or `internal_account`.
+   */
+  ultimate_originating_account:
+    | VirtualAccountsAPI.VirtualAccount
+    | InternalAccountsAPI.InternalAccount
+    | null;
+
+  /**
+   * The ultimate originating account ID. Can be a `virtual_account` or
+   * `internal_account`.
+   */
+  ultimate_originating_account_id: string | null;
+
+  ultimate_originating_account_type: 'internal_account' | 'virtual_account' | null;
+
   /**
    * Identifier of the ultimate originator of the payment order.
    */
@@ -477,8 +494,8 @@ export type PaymentOrderSubtype =
 
 /**
  * One of `ach`, `bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`,
- * `bacs`, `au_becs`, `interac`, `neft`, `nics`, `sic`, `signet`, `provexchange`,
- * `zengin`.
+ * `bacs`, `au_becs`, `interac`, `neft`, `nics`, `nz_national_clearing_code`,
+ * `sic`, `signet`, `provexchange`, `zengin`.
  */
 export type PaymentOrderType =
   | 'ach'
@@ -486,6 +503,7 @@ export type PaymentOrderType =
   | 'bacs'
   | 'book'
   | 'card'
+  | 'chats'
   | 'check'
   | 'cross_border'
   | 'eft'
@@ -493,11 +511,13 @@ export type PaymentOrderType =
   | 'masav'
   | 'neft'
   | 'nics'
+  | 'nz_becs'
   | 'provxchange'
   | 'rtp'
   | 'se_bankgirot'
   | 'sen'
   | 'sepa'
+  | 'sg_giro'
   | 'sic'
   | 'signet'
   | 'wire'
@@ -525,8 +545,8 @@ export interface PaymentOrderCreateParams {
 
   /**
    * One of `ach`, `bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`,
-   * `bacs`, `au_becs`, `interac`, `neft`, `nics`, `sic`, `signet`, `provexchange`,
-   * `zengin`.
+   * `bacs`, `au_becs`, `interac`, `neft`, `nics`, `nz_national_clearing_code`,
+   * `sic`, `signet`, `provexchange`, `zengin`.
    */
   type: PaymentOrderType;
 
@@ -607,6 +627,14 @@ export interface PaymentOrderCreateParams {
    */
   ledger_transaction?: PaymentOrderCreateParams.LedgerTransaction;
 
+  /**
+   * Either ledger_transaction or ledger_transaction_id can be provided. Only a
+   * pending ledger transaction can be attached upon payment order creation. Once the
+   * payment order is created, the status of the ledger transaction tracks the
+   * payment order automatically.
+   */
+  ledger_transaction_id?: string;
+
   /**
    * An array of line items that must sum up to the amount of the payment order.
    */
@@ -746,6 +774,7 @@ export namespace PaymentOrderCreateParams {
       | 'counterparties'
       | 'expected_payments'
       | 'external_accounts'
+      | 'incoming_payment_details'
       | 'internal_accounts'
       | 'organizations'
       | 'paper_items'
@@ -846,7 +875,7 @@ export namespace PaymentOrderCreateParams {
        * `debit` pulls money from someone else's account to your own. Note that wire,
        * rtp, and check payments will always be `credit`.
        */
-      direction: 'credit' | 'debit';
+      direction: Shared.TransactionDirection;
 
       /**
        * The ledger account that this ledger entry is associated with.
@@ -932,7 +961,7 @@ export namespace PaymentOrderCreateParams {
     /**
      * Can be `checking`, `savings` or `other`.
      */
-    account_type?: ExternalAccounts.ExternalAccountType;
+    account_type?: ExternalAccountsAPI.ExternalAccountType;
 
     contact_details?: Array<ReceivingAccount.ContactDetail>;
 
@@ -1022,7 +1051,7 @@ export namespace PaymentOrderCreateParams {
       /**
        * The normal balance of the ledger account.
        */
-      normal_balance: 'credit' | 'debit';
+      normal_balance: Shared.TransactionDirection;
 
       /**
        * The currency exponent of the ledger account.
@@ -1095,30 +1124,35 @@ export namespace PaymentOrderCreateParams {
         | 'chips'
         | 'cnaps'
         | 'gb_sort_code'
+        | 'hk_interbank_clearing_code'
         | 'in_ifsc'
         | 'my_branch_code'
+        | 'nz_national_clearing_code'
         | 'swift'
         | 'jp_zengin_code';
 
       payment_type?:
         | 'ach'
         | 'au_becs'
-        | 'se_bankgirot'
         | 'bacs'
         | 'book'
         | 'card'
+        | 'chats'
         | 'check'
-        | 'eft'
         | 'cross_border'
+        | 'eft'
         | 'interac'
         | 'masav'
         | 'neft'
         | 'nics'
+        | 'nz_becs'
         | 'provxchange'
         | 'rtp'
+        | 'sg_giro'
+        | 'se_bankgirot'
         | 'sen'
-        | 'sic'
         | 'sepa'
+        | 'sic'
         | 'signet'
         | 'wire'
         | 'zengin';
@@ -1319,8 +1353,8 @@ export interface PaymentOrderUpdateParams {
 
   /**
    * One of `ach`, `bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`,
-   * `bacs`, `au_becs`, `interac`, `neft`, `nics`, `sic`, `signet`, `provexchange`,
-   * `zengin`.
+   * `bacs`, `au_becs`, `interac`, `neft`, `nics`, `nz_national_clearing_code`,
+   * `sic`, `signet`, `provexchange`, `zengin`.
    */
   type?: PaymentOrderType;
 
@@ -1405,7 +1439,7 @@ export namespace PaymentOrderUpdateParams {
     /**
      * Can be `checking`, `savings` or `other`.
      */
-    account_type?: ExternalAccounts.ExternalAccountType;
+    account_type?: ExternalAccountsAPI.ExternalAccountType;
 
     contact_details?: Array<ReceivingAccount.ContactDetail>;
 
@@ -1495,7 +1529,7 @@ export namespace PaymentOrderUpdateParams {
       /**
        * The normal balance of the ledger account.
        */
-      normal_balance: 'credit' | 'debit';
+      normal_balance: Shared.TransactionDirection;
 
       /**
        * The currency exponent of the ledger account.
@@ -1568,30 +1602,35 @@ export namespace PaymentOrderUpdateParams {
         | 'chips'
         | 'cnaps'
         | 'gb_sort_code'
+        | 'hk_interbank_clearing_code'
         | 'in_ifsc'
         | 'my_branch_code'
+        | 'nz_national_clearing_code'
         | 'swift'
         | 'jp_zengin_code';
 
       payment_type?:
         | 'ach'
         | 'au_becs'
-        | 'se_bankgirot'
         | 'bacs'
         | 'book'
         | 'card'
+        | 'chats'
         | 'check'
-        | 'eft'
         | 'cross_border'
+        | 'eft'
         | 'interac'
         | 'masav'
         | 'neft'
         | 'nics'
+        | 'nz_becs'
         | 'provxchange'
         | 'rtp'
+        | 'sg_giro'
+        | 'se_bankgirot'
         | 'sen'
-        | 'sic'
         | 'sepa'
+        | 'sic'
         | 'signet'
         | 'wire'
         | 'zengin';
@@ -1602,7 +1641,7 @@ export namespace PaymentOrderUpdateParams {
 export interface PaymentOrderListParams extends PageParams {
   counterparty_id?: string;
 
-  direction?: 'credit' | 'debit';
+  direction?: Shared.TransactionDirection;
 
   /**
    * An inclusive upper bound for searching effective_date
@@ -1659,6 +1698,7 @@ export interface PaymentOrderListParams extends PageParams {
     | 'bacs'
     | 'book'
     | 'card'
+    | 'chats'
     | 'check'
     | 'cross_border'
     | 'eft'
@@ -1666,11 +1706,13 @@ export interface PaymentOrderListParams extends PageParams {
     | 'masav'
     | 'neft'
     | 'nics'
+    | 'nz_becs'
     | 'provxchange'
     | 'rtp'
     | 'se_bankgirot'
     | 'sen'
     | 'sepa'
+    | 'sg_giro'
     | 'sic'
     | 'signet'
     | 'wire'
@@ -1699,8 +1741,8 @@ export interface PaymentOrderCreateAsyncParams {
 
   /**
    * One of `ach`, `bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`,
-   * `bacs`, `au_becs`, `interac`, `neft`, `nics`, `sic`, `signet`, `provexchange`,
-   * `zengin`.
+   * `bacs`, `au_becs`, `interac`, `neft`, `nics`, `nz_national_clearing_code`,
+   * `sic`, `signet`, `provexchange`, `zengin`.
    */
   type: PaymentOrderType;
 
@@ -1775,6 +1817,14 @@ export interface PaymentOrderCreateAsyncParams {
    */
   ledger_transaction?: PaymentOrderCreateAsyncParams.LedgerTransaction;
 
+  /**
+   * Either ledger_transaction or ledger_transaction_id can be provided. Only a
+   * pending ledger transaction can be attached upon payment order creation. Once the
+   * payment order is created, the status of the ledger transaction tracks the
+   * payment order automatically.
+   */
+  ledger_transaction_id?: string;
+
   /**
    * An array of line items that must sum up to the amount of the payment order.
    */
@@ -1987,7 +2037,7 @@ export namespace PaymentOrderCreateAsyncParams {
        * `debit` pulls money from someone else's account to your own. Note that wire,
        * rtp, and check payments will always be `credit`.
        */
-      direction: 'credit' | 'debit';
+      direction: Shared.TransactionDirection;
 
       /**
        * The ledger account that this ledger entry is associated with.
@@ -2073,7 +2123,7 @@ export namespace PaymentOrderCreateAsyncParams {
     /**
      * Can be `checking`, `savings` or `other`.
      */
-    account_type?: ExternalAccounts.ExternalAccountType;
+    account_type?: ExternalAccountsAPI.ExternalAccountType;
 
     contact_details?: Array<ReceivingAccount.ContactDetail>;
 
@@ -2163,7 +2213,7 @@ export namespace PaymentOrderCreateAsyncParams {
       /**
        * The normal balance of the ledger account.
        */
-      normal_balance: 'credit' | 'debit';
+      normal_balance: Shared.TransactionDirection;
 
       /**
        * The currency exponent of the ledger account.
@@ -2236,30 +2286,35 @@ export namespace PaymentOrderCreateAsyncParams {
         | 'chips'
         | 'cnaps'
         | 'gb_sort_code'
+        | 'hk_interbank_clearing_code'
         | 'in_ifsc'
         | 'my_branch_code'
+        | 'nz_national_clearing_code'
         | 'swift'
         | 'jp_zengin_code';
 
       payment_type?:
         | 'ach'
         | 'au_becs'
-        | 'se_bankgirot'
         | 'bacs'
         | 'book'
         | 'card'
+        | 'chats'
         | 'check'
-        | 'eft'
         | 'cross_border'
+        | 'eft'
         | 'interac'
         | 'masav'
         | 'neft'
         | 'nics'
+        | 'nz_becs'
         | 'provxchange'
         | 'rtp'
+        | 'sg_giro'
+        | 'se_bankgirot'
         | 'sen'
-        | 'sic'
         | 'sepa'
+        | 'sic'
         | 'signet'
         | 'wire'
         | 'zengin';
@@ -2268,18 +2323,17 @@ export namespace PaymentOrderCreateAsyncParams {
 }
 
 export namespace PaymentOrders {
-  export import PaymentOrder = API.PaymentOrder;
-  export import PaymentOrderSubtype = API.PaymentOrderSubtype;
-  export import PaymentOrderType = API.PaymentOrderType;
-  export type PaymentOrdersPage = _PaymentOrdersPage;
-  export import PaymentOrderCreateParams = API.PaymentOrderCreateParams;
-  export import PaymentOrderUpdateParams = API.PaymentOrderUpdateParams;
-  export import PaymentOrderListParams = API.PaymentOrderListParams;
-  export import PaymentOrderCreateAsyncParams = API.PaymentOrderCreateAsyncParams;
-
-  export import Reversals = API.Reversals;
-  export import Reversal = API.Reversal;
-  export import ReversalsPage = API.ReversalsPage;
-  export import ReversalCreateParams = API.ReversalCreateParams;
-  export import ReversalListParams = API.ReversalListParams;
+  export import PaymentOrder = PaymentOrdersAPI.PaymentOrder;
+  export import PaymentOrderSubtype = PaymentOrdersAPI.PaymentOrderSubtype;
+  export import PaymentOrderType = PaymentOrdersAPI.PaymentOrderType;
+  export import PaymentOrdersPage = PaymentOrdersAPI.PaymentOrdersPage;
+  export import PaymentOrderCreateParams = PaymentOrdersAPI.PaymentOrderCreateParams;
+  export import PaymentOrderUpdateParams = PaymentOrdersAPI.PaymentOrderUpdateParams;
+  export import PaymentOrderListParams = PaymentOrdersAPI.PaymentOrderListParams;
+  export import PaymentOrderCreateAsyncParams = PaymentOrdersAPI.PaymentOrderCreateAsyncParams;
+  export import Reversals = ReversalsAPI.Reversals;
+  export import Reversal = ReversalsAPI.Reversal;
+  export import ReversalsPage = ReversalsAPI.ReversalsPage;
+  export import ReversalCreateParams = ReversalsAPI.ReversalCreateParams;
+  export import ReversalListParams = ReversalsAPI.ReversalListParams;
 }

package/src/resources/payment-orders/reversals.ts

@@ -1,10 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-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 Core from "../../core";
+import { APIResource } from "../../resource";
+import { isRequestOptions } from "../../core";
+import * as ReversalsAPI from "./reversals";
+import * as Shared from "../shared";
+import { Page, type PageParams } from "../../pagination";
 
 export class Reversals extends APIResource {
   /**
@@ -65,8 +66,6 @@ export class Reversals extends APIResource {
 }
 
 export class ReversalsPage extends Page<Reversal> {}
-// alias so we can export it in the namespace
-type _ReversalsPage = ReversalsPage;
 
 export interface Reversal {
   id: string;
@@ -221,7 +220,7 @@ export namespace ReversalCreateParams {
        * `debit` pulls money from someone else's account to your own. Note that wire,
        * rtp, and check payments will always be `credit`.
        */
-      direction: 'credit' | 'debit';
+      direction: Shared.TransactionDirection;
 
       /**
        * The ledger account that this ledger entry is associated with.
@@ -275,8 +274,8 @@ export namespace ReversalCreateParams {
 export interface ReversalListParams extends PageParams {}
 
 export namespace Reversals {
-  export import Reversal = API.Reversal;
-  export type ReversalsPage = _ReversalsPage;
-  export import ReversalCreateParams = API.ReversalCreateParams;
-  export import ReversalListParams = API.ReversalListParams;
+  export import Reversal = ReversalsAPI.Reversal;
+  export import ReversalsPage = ReversalsAPI.ReversalsPage;
+  export import ReversalCreateParams = ReversalsAPI.ReversalCreateParams;
+  export import ReversalListParams = ReversalsAPI.ReversalListParams;
 }

package/src/resources/payment-references.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-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 Core from "../core";
+import { APIResource } from "../resource";
+import { isRequestOptions } from "../core";
+import * as PaymentReferencesAPI from "./payment-references";
+import { Page, type PageParams } from "../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

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from "../treasury/core";
-import { APIResource } from "../treasury/resource";
-import { isRequestOptions } from "../treasury/core";
-import * as Shared from "../treasury/resources/shared";
-import * as API from './index';
-import { Page, PageParams } from "../treasury/pagination";
+import * as Core from "../core";
+import { APIResource } from "../resource";
+import { isRequestOptions } from "../core";
+import * as ReturnsAPI from "./returns";
+import * as Shared from "./shared";
+import { Page, type PageParams } from "../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;
 }