modern-treasury 3.3.0 → 4.4.2

package/src/resources/documents.ts

@@ -56,7 +56,7 @@ export interface Document {
   /**
    * The unique identifier for the associated object.
    */
-  documentable_id: string;
+  documentable_id: string | null;
 
   /**
    * The type of the associated object. Currently can be one of `payment_order`,
@@ -64,16 +64,18 @@ export interface Document {
    * `internal_account`, `decision`, or `external_account`.
    */
   documentable_type:
+    | 'connection'
     | 'counterparty'
     | 'expected_payment'
     | 'external_account'
     | 'identification'
     | 'incoming_payment_detail'
     | 'internal_account'
+    | 'legal_entity'
     | 'organization'
     | 'payment_order'
     | 'transaction'
-    | 'connection';
+    | null;
 
   file: Document.File;
 
@@ -135,29 +137,30 @@ export namespace Document {
 }
 
 export interface DocumentCreateParams {
+  file: Uploadable;
+
+  /**
+   * A category given to the document, can be `null`.
+   */
+  document_type?: string;
+
   /**
    * The unique identifier for the associated object.
    */
-  documentable_id: string;
+  documentable_id?: string;
 
-  documentable_type:
+  documentable_type?:
+    | 'connections'
     | 'counterparties'
     | 'expected_payments'
     | 'external_accounts'
     | 'identifications'
     | 'incoming_payment_details'
     | 'internal_accounts'
+    | 'legal_entities'
     | 'organizations'
     | 'payment_orders'
-    | 'transactions'
-    | 'connections';
-
-  file: Uploadable;
-
-  /**
-   * A category given to the document, can be `null`.
-   */
-  document_type?: string;
+    | 'transactions';
 }
 
 export interface DocumentListParams extends PageParams {
@@ -172,16 +175,17 @@ export interface DocumentListParams extends PageParams {
    * `internal_account`, `decision`, or `external_account`.
    */
   documentable_type?:
+    | 'connections'
     | 'counterparties'
     | 'expected_payments'
     | 'external_accounts'
     | 'identifications'
     | 'incoming_payment_details'
     | 'internal_accounts'
+    | 'legal_entities'
     | 'organizations'
     | 'payment_orders'
-    | 'transactions'
-    | 'connections';
+    | 'transactions';
 }
 
 export declare namespace Documents {

package/src/resources/expected-payments.ts

@@ -97,6 +97,30 @@ export interface ExpectedPayment {
    */
   amount_lower_bound: number | null;
 
+  /**
+   * The amount reconciled for this expected payment. Value in specified currency's
+   * smallest unit. e.g. $10 would be represented as 1000.
+   */
+  amount_reconciled: number | null;
+
+  /**
+   * One of credit or debit. Indicates whether amount_reconciled is a credit or debit
+   * amount.
+   */
+  amount_reconciled_direction: 'credit' | 'debit' | null;
+
+  /**
+   * The amount that remains unreconciled for this expected payment. Value in
+   * specified currency's smallest unit. e.g. $10 would be represented as 1000.
+   */
+  amount_unreconciled: number | null;
+
+  /**
+   * One of credit or debit. Indicates whether amount_unreconciled is a credit or
+   * debit amount.
+   */
+  amount_unreconciled_direction: 'credit' | 'debit' | null;
+
   /**
    * The highest amount this expected payment may be equal to. Value in specified
    * currency's smallest unit. e.g. $10 would be represented as 1000.
@@ -367,6 +391,30 @@ export interface ExpectedPaymentCreateParams {
    */
   amount_lower_bound?: number | null;
 
+  /**
+   * The amount reconciled for this expected payment. Value in specified currency's
+   * smallest unit. e.g. $10 would be represented as 1000.
+   */
+  amount_reconciled?: number | null;
+
+  /**
+   * One of credit or debit. Indicates whether amount_reconciled is a credit or debit
+   * amount.
+   */
+  amount_reconciled_direction?: 'credit' | 'debit' | null;
+
+  /**
+   * The amount that remains unreconciled for this expected payment. Value in
+   * specified currency's smallest unit. e.g. $10 would be represented as 1000.
+   */
+  amount_unreconciled?: number | null;
+
+  /**
+   * One of credit or debit. Indicates whether amount_unreconciled is a credit or
+   * debit amount.
+   */
+  amount_unreconciled_direction?: 'credit' | 'debit' | null;
+
   /**
    * The highest amount this expected payment may be equal to. Value in specified
    * currency's smallest unit. e.g. $10 would be represented as 1000.
@@ -509,6 +557,30 @@ export interface ExpectedPaymentUpdateParams {
    */
   amount_lower_bound?: number | null;
 
+  /**
+   * The amount reconciled for this expected payment. Value in specified currency's
+   * smallest unit. e.g. $10 would be represented as 1000.
+   */
+  amount_reconciled?: number | null;
+
+  /**
+   * One of credit or debit. Indicates whether amount_reconciled is a credit or debit
+   * amount.
+   */
+  amount_reconciled_direction?: 'credit' | 'debit' | null;
+
+  /**
+   * The amount that remains unreconciled for this expected payment. Value in
+   * specified currency's smallest unit. e.g. $10 would be represented as 1000.
+   */
+  amount_unreconciled?: number | null;
+
+  /**
+   * One of credit or debit. Indicates whether amount_unreconciled is a credit or
+   * debit amount.
+   */
+  amount_unreconciled_direction?: 'credit' | 'debit' | null;
+
   /**
    * The highest amount this expected payment may be equal to. Value in specified
    * currency's smallest unit. e.g. $10 would be represented as 1000.

package/src/resources/external-accounts.ts

@@ -379,6 +379,7 @@ export namespace ExternalAccountCreateParams {
     account_number_type?:
       | 'au_number'
       | 'base_address'
+      | 'card_token'
       | 'clabe'
       | 'ethereum_address'
       | 'hk_number'

package/src/resources/holds.ts

@@ -0,0 +1,336 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { Page, type PageParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Holds extends APIResource {
+  /**
+   * Create a new hold
+   */
+  create(body: HoldCreateParams, options?: RequestOptions): APIPromise<HoldCreateResponse> {
+    return this._client.post('/api/holds', { body, ...options });
+  }
+
+  /**
+   * Get a specific hold
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<HoldRetrieveResponse> {
+    return this._client.get(path`/api/holds/${id}`, options);
+  }
+
+  /**
+   * Update a hold
+   */
+  update(id: string, body: HoldUpdateParams, options?: RequestOptions): APIPromise<HoldUpdateResponse> {
+    return this._client.patch(path`/api/holds/${id}`, { body, ...options });
+  }
+
+  /**
+   * Get a list of holds.
+   */
+  list(
+    query: HoldListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<HoldListResponsesPage, HoldListResponse> {
+    return this._client.getAPIList('/api/holds', Page<HoldListResponse>, { query, ...options });
+  }
+}
+
+export type HoldListResponsesPage = Page<HoldListResponse>;
+
+export interface HoldCreateResponse {
+  id: string;
+
+  created_at: string;
+
+  /**
+   * The type of object
+   */
+  object: 'hold';
+
+  /**
+   * The status of the hold
+   */
+  status: 'active' | 'resolved';
+
+  /**
+   * The ID of the target being held
+   */
+  target_id: string;
+
+  /**
+   * The type of target being held
+   */
+  target_type: 'payment_order';
+
+  updated_at: string;
+
+  /**
+   * This field will be true if this object exists in the live environment or false
+   * if it exists in the test environment.
+   */
+  live_mode?: boolean;
+
+  /**
+   * Additional metadata for the hold
+   */
+  metadata?: { [key: string]: string } | null;
+
+  /**
+   * The reason for the hold
+   */
+  reason?: string | null;
+
+  /**
+   * The resolution of the hold
+   */
+  resolution?: string | null;
+
+  /**
+   * When the hold was resolved
+   */
+  resolved_at?: string | null;
+}
+
+export interface HoldRetrieveResponse {
+  id: string;
+
+  created_at: string;
+
+  /**
+   * The type of object
+   */
+  object: 'hold';
+
+  /**
+   * The status of the hold
+   */
+  status: 'active' | 'resolved';
+
+  /**
+   * The ID of the target being held
+   */
+  target_id: string;
+
+  /**
+   * The type of target being held
+   */
+  target_type: 'payment_order';
+
+  updated_at: string;
+
+  /**
+   * This field will be true if this object exists in the live environment or false
+   * if it exists in the test environment.
+   */
+  live_mode?: boolean;
+
+  /**
+   * Additional metadata for the hold
+   */
+  metadata?: { [key: string]: string } | null;
+
+  /**
+   * The reason for the hold
+   */
+  reason?: string | null;
+
+  /**
+   * The resolution of the hold
+   */
+  resolution?: string | null;
+
+  /**
+   * When the hold was resolved
+   */
+  resolved_at?: string | null;
+}
+
+export interface HoldUpdateResponse {
+  id: string;
+
+  created_at: string;
+
+  /**
+   * The type of object
+   */
+  object: 'hold';
+
+  /**
+   * The status of the hold
+   */
+  status: 'active' | 'resolved';
+
+  /**
+   * The ID of the target being held
+   */
+  target_id: string;
+
+  /**
+   * The type of target being held
+   */
+  target_type: 'payment_order';
+
+  updated_at: string;
+
+  /**
+   * This field will be true if this object exists in the live environment or false
+   * if it exists in the test environment.
+   */
+  live_mode?: boolean;
+
+  /**
+   * Additional metadata for the hold
+   */
+  metadata?: { [key: string]: string } | null;
+
+  /**
+   * The reason for the hold
+   */
+  reason?: string | null;
+
+  /**
+   * The resolution of the hold
+   */
+  resolution?: string | null;
+
+  /**
+   * When the hold was resolved
+   */
+  resolved_at?: string | null;
+}
+
+export interface HoldListResponse {
+  id: string;
+
+  created_at: string;
+
+  /**
+   * The type of object
+   */
+  object: 'hold';
+
+  /**
+   * The status of the hold
+   */
+  status: 'active' | 'resolved';
+
+  /**
+   * The ID of the target being held
+   */
+  target_id: string;
+
+  /**
+   * The type of target being held
+   */
+  target_type: 'payment_order';
+
+  updated_at: string;
+
+  /**
+   * This field will be true if this object exists in the live environment or false
+   * if it exists in the test environment.
+   */
+  live_mode?: boolean;
+
+  /**
+   * Additional metadata for the hold
+   */
+  metadata?: { [key: string]: string } | null;
+
+  /**
+   * The reason for the hold
+   */
+  reason?: string | null;
+
+  /**
+   * The resolution of the hold
+   */
+  resolution?: string | null;
+
+  /**
+   * When the hold was resolved
+   */
+  resolved_at?: string | null;
+}
+
+export interface HoldCreateParams {
+  /**
+   * The status of the hold
+   */
+  status: 'active';
+
+  /**
+   * The ID of the target to hold
+   */
+  target_id: string;
+
+  /**
+   * The type of target to hold
+   */
+  target_type: 'payment_order';
+
+  /**
+   * Additional metadata for the hold
+   */
+  metadata?: { [key: string]: string } | null;
+
+  /**
+   * The reason for the hold
+   */
+  reason?: string | null;
+}
+
+export interface HoldUpdateParams {
+  /**
+   * The new status of the hold
+   */
+  status: 'resolved';
+
+  /**
+   * The resolution of the hold
+   */
+  resolution?: string | null;
+}
+
+export interface HoldListParams extends PageParams {
+  /**
+   * For example, if you want to query for records with metadata key `Type` and value
+   * `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+   * parameters.
+   */
+  metadata?: { [key: string]: string };
+
+  /**
+   * Translation missing: en.openapi.descriptions.payment_order.query_params.status
+   */
+  status?: 'active' | 'resolved' | null;
+
+  /**
+   * Translation missing:
+   * en.openapi.descriptions.payment_order.query_params.target_id
+   */
+  target_id?: string | null;
+
+  /**
+   * Translation missing:
+   * en.openapi.descriptions.payment_order.query_params.target_type
+   */
+  target_type?: 'payment_order' | null;
+}
+
+export declare namespace Holds {
+  export {
+    type HoldCreateResponse as HoldCreateResponse,
+    type HoldRetrieveResponse as HoldRetrieveResponse,
+    type HoldUpdateResponse as HoldUpdateResponse,
+    type HoldListResponse as HoldListResponse,
+    type HoldListResponsesPage as HoldListResponsesPage,
+    type HoldCreateParams as HoldCreateParams,
+    type HoldUpdateParams as HoldUpdateParams,
+    type HoldListParams as HoldListParams,
+  };
+}

package/src/resources/incoming-payment-details.ts

@@ -122,6 +122,7 @@ export interface IncomingPaymentDetail {
   originating_account_number_type:
     | 'au_number'
     | 'base_address'
+    | 'card_token'
     | 'clabe'
     | 'ethereum_address'
     | 'hk_number'
@@ -198,16 +199,21 @@ export interface IncomingPaymentDetail {
     | 'ach'
     | 'au_becs'
     | 'bacs'
+    | 'base'
     | 'book'
     | 'check'
     | 'eft'
+    | 'ethereum'
     | 'interac'
     | 'neft'
     | 'nz_becs'
+    | 'polygon'
     | 'rtp'
     | 'sepa'
     | 'signet'
-    | 'wire';
+    | 'solana'
+    | 'wire'
+    | 'zengin';
 
   updated_at: string;
 
@@ -232,6 +238,22 @@ export interface IncomingPaymentDetail {
    * The account number of the originating account for the incoming payment detail.
    */
   originating_account_number?: string | null;
+
+  /**
+   * The address of the originating party for the incoming payment detail, or `null`.
+   */
+  originating_party_address?: Shared.Address | null;
+
+  /**
+   * The name of the originating party for the incoming payment detail.
+   */
+  originating_party_name?: string | null;
+
+  /**
+   * The vendor-assigned identifier for the originating party of the incoming payment
+   * detail, or `null`.
+   */
+  originating_party_vendor_identifier?: string | null;
 }
 
 export interface IncomingPaymentDetailUpdateParams {
@@ -281,16 +303,21 @@ export interface IncomingPaymentDetailListParams extends PageParams {
     | 'ach'
     | 'au_becs'
     | 'bacs'
+    | 'base'
     | 'book'
     | 'check'
     | 'eft'
+    | 'ethereum'
     | 'interac'
     | 'neft'
     | 'nz_becs'
+    | 'polygon'
     | 'rtp'
     | 'sepa'
     | 'signet'
-    | 'wire';
+    | 'solana'
+    | 'wire'
+    | 'zengin';
 
   /**
    * If the incoming payment detail is in a virtual account, the ID of the Virtual
@@ -344,16 +371,21 @@ export interface IncomingPaymentDetailCreateAsyncParams {
     | 'ach'
     | 'au_becs'
     | 'bacs'
+    | 'base'
     | 'book'
     | 'check'
     | 'eft'
+    | 'ethereum'
     | 'interac'
     | 'neft'
     | 'nz_becs'
+    | 'polygon'
     | 'rtp'
     | 'sepa'
     | 'signet'
-    | 'wire';
+    | 'solana'
+    | 'wire'
+    | 'zengin';
 
   /**
    * An optional parameter to associate the incoming payment detail to a virtual

package/src/resources/index.ts

@@ -87,6 +87,17 @@ export {
   type ForeignExchangeQuoteListParams,
   type ForeignExchangeQuotesPage,
 } from './foreign-exchange-quotes';
+export {
+  Holds,
+  type HoldCreateResponse,
+  type HoldRetrieveResponse,
+  type HoldUpdateResponse,
+  type HoldListResponse,
+  type HoldCreateParams,
+  type HoldUpdateParams,
+  type HoldListParams,
+  type HoldListResponsesPage,
+} from './holds';
 export {
   IncomingPaymentDetails,
   type IncomingPaymentDetail,
@@ -114,6 +125,8 @@ export {
   type InvoiceAddPaymentOrderParams,
   type InvoicesPage,
 } from './invoices/invoices';
+export { JournalEntries, type JournalEntryListParams } from './journal-entries';
+export { JournalReports, type JournalReportUpdateParams } from './journal-reports';
 export {
   LedgerAccountBalanceMonitors,
   type LedgerAccountBalanceMonitor,
@@ -194,6 +207,7 @@ export {
 } from './legal-entities';
 export {
   LegalEntityAssociations,
+  type ChildLegalEntity,
   type LegalEntityAssociation,
   type LegalEntityAssociationCreateParams,
 } from './legal-entity-associations';