modern-treasury 0.0.1

package/resources/incoming-payment-details.ts

@@ -0,0 +1,592 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+import { isRequestOptions } from '~/core';
+import { Page, PageParams } from '~/pagination';
+
+export class IncomingPaymentDetails extends APIResource {
+  /**
+   * Get an existing Incoming Payment Detail.
+   */
+  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<IncomingPaymentDetail>> {
+    return this.get(`/api/incoming_payment_details/${id}`, options);
+  }
+
+  /**
+   * Update an existing Incoming Payment Detail.
+   */
+  update(
+    id: string,
+    body?: IncomingPaymentDetailUpdateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<IncomingPaymentDetail>>;
+  update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<IncomingPaymentDetail>>;
+  update(
+    id: string,
+    body: IncomingPaymentDetailUpdateParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<IncomingPaymentDetail>> {
+    if (isRequestOptions(body)) {
+      return this.update(id, {}, body);
+    }
+
+    return this.patch(`/api/incoming_payment_details/${id}`, { body, ...options });
+  }
+
+  /**
+   * Get a list of Incoming Payment Details.
+   */
+  list(
+    query?: IncomingPaymentDetailListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<IncomingPaymentDetailsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<IncomingPaymentDetailsPage>;
+  list(
+    query: IncomingPaymentDetailListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<IncomingPaymentDetailsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+
+    return this.getAPIList('/api/incoming_payment_details', IncomingPaymentDetailsPage, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export class IncomingPaymentDetailsPage extends Page<IncomingPaymentDetail> {}
+
+export interface IncomingPaymentDetail {
+  /**
+   * Value in specified currency's smallest unit. e.g. $10 would be represented
+   * as 1000.
+   */
+  amount?: number;
+
+  /**
+   * The date on which the corresponding transaction will occur.
+   */
+  as_of_date?: string;
+
+  created_at?: string;
+
+  /**
+   * The currency of the incoming payment detail.
+   */
+  currency?:
+    | 'AED'
+    | 'AFN'
+    | 'ALL'
+    | 'AMD'
+    | 'ANG'
+    | 'AOA'
+    | 'ARS'
+    | 'AUD'
+    | 'AWG'
+    | 'AZN'
+    | 'BAM'
+    | 'BBD'
+    | 'BCH'
+    | 'BDT'
+    | 'BGN'
+    | 'BHD'
+    | 'BIF'
+    | 'BMD'
+    | 'BND'
+    | 'BOB'
+    | 'BRL'
+    | 'BSD'
+    | 'BTC'
+    | 'BTN'
+    | 'BWP'
+    | 'BYN'
+    | 'BYR'
+    | 'BZD'
+    | 'CAD'
+    | 'CDF'
+    | 'CHF'
+    | 'CLF'
+    | 'CLP'
+    | 'CNH'
+    | 'CNY'
+    | 'COP'
+    | 'CRC'
+    | 'CUC'
+    | 'CUP'
+    | 'CVE'
+    | 'CZK'
+    | 'DJF'
+    | 'DKK'
+    | 'DOP'
+    | 'DZD'
+    | 'EEK'
+    | 'EGP'
+    | 'ERN'
+    | 'ETB'
+    | 'EUR'
+    | 'FJD'
+    | 'FKP'
+    | 'GBP'
+    | 'GBX'
+    | 'GEL'
+    | 'GGP'
+    | 'GHS'
+    | 'GIP'
+    | 'GMD'
+    | 'GNF'
+    | 'GTQ'
+    | 'GYD'
+    | 'HKD'
+    | 'HNL'
+    | 'HRK'
+    | 'HTG'
+    | 'HUF'
+    | 'IDR'
+    | 'ILS'
+    | 'IMP'
+    | 'INR'
+    | 'IQD'
+    | 'IRR'
+    | 'ISK'
+    | 'JEP'
+    | 'JMD'
+    | 'JOD'
+    | 'JPY'
+    | 'KES'
+    | 'KGS'
+    | 'KHR'
+    | 'KMF'
+    | 'KPW'
+    | 'KRW'
+    | 'KWD'
+    | 'KYD'
+    | 'KZT'
+    | 'LAK'
+    | 'LBP'
+    | 'LKR'
+    | 'LRD'
+    | 'LSL'
+    | 'LTL'
+    | 'LVL'
+    | 'LYD'
+    | 'MAD'
+    | 'MDL'
+    | 'MGA'
+    | 'MKD'
+    | 'MMK'
+    | 'MNT'
+    | 'MOP'
+    | 'MRO'
+    | 'MRU'
+    | 'MTL'
+    | 'MUR'
+    | 'MVR'
+    | 'MWK'
+    | 'MXN'
+    | 'MYR'
+    | 'MZN'
+    | 'NAD'
+    | 'NGN'
+    | 'NIO'
+    | 'NOK'
+    | 'NPR'
+    | 'NZD'
+    | 'OMR'
+    | 'PAB'
+    | 'PEN'
+    | 'PGK'
+    | 'PHP'
+    | 'PKR'
+    | 'PLN'
+    | 'PYG'
+    | 'QAR'
+    | 'RON'
+    | 'RSD'
+    | 'RUB'
+    | 'RWF'
+    | 'SAR'
+    | 'SBD'
+    | 'SCR'
+    | 'SDG'
+    | 'SEK'
+    | 'SGD'
+    | 'SHP'
+    | 'SKK'
+    | 'SLL'
+    | 'SOS'
+    | 'SRD'
+    | 'SSP'
+    | 'STD'
+    | 'SVC'
+    | 'SYP'
+    | 'SZL'
+    | 'THB'
+    | 'TJS'
+    | 'TMM'
+    | 'TMT'
+    | 'TND'
+    | 'TOP'
+    | 'TRY'
+    | 'TTD'
+    | 'TWD'
+    | 'TZS'
+    | 'UAH'
+    | 'UGX'
+    | 'USD'
+    | 'UYU'
+    | 'UZS'
+    | 'VEF'
+    | 'VES'
+    | 'VND'
+    | 'VUV'
+    | 'WST'
+    | 'XAF'
+    | 'XAG'
+    | 'XAU'
+    | 'XBA'
+    | 'XBB'
+    | 'XBC'
+    | 'XBD'
+    | 'XCD'
+    | 'XDR'
+    | 'XFU'
+    | 'XOF'
+    | 'XPD'
+    | 'XPF'
+    | 'XPT'
+    | 'XTS'
+    | 'YER'
+    | 'ZAR'
+    | 'ZMK'
+    | 'ZMW'
+    | 'ZWD'
+    | 'ZWL'
+    | 'ZWN'
+    | 'ZWR';
+
+  /**
+   * The raw data from the payment pre-notification file that we get from the bank.
+   */
+  data?: unknown;
+
+  /**
+   * One of `credit` or `debit`.
+   */
+  direction?: 'credit' | 'debit';
+
+  id?: string;
+
+  /**
+   * The ID of the Internal Account for the incoming payment detail. This is always
+   * present.
+   */
+  internal_account_id?: 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 data represented as key-value pairs. Both the key and value must be
+   * strings.
+   */
+  metadata?: Record<string, string>;
+
+  object?: string;
+
+  /**
+   * The current status of the incoming payment order. One of `pending`, `completed`,
+   * or `returned`.
+   */
+  status?: 'completed' | 'pending' | 'returned';
+
+  /**
+   * The ID of the reconciled Transaction or `null`.
+   */
+  transaction_id?: string | null;
+
+  /**
+   * The ID of the reconciled Transaction Line Item or `null`.
+   */
+  transaction_line_item_id?: string | null;
+
+  /**
+   * One of: `ach`, `wire`, `check`, `rtp`, `sepa`, `signet`.
+   */
+  type?: 'ach' | 'book' | 'check' | 'rtp' | 'sepa' | 'signet' | 'wire';
+
+  updated_at?: string;
+
+  /**
+   * The identifier of the vendor bank.
+   */
+  vendor_id?: string | null;
+
+  /**
+   * If the incoming payment detail is in a virtual account, the serialized virtual
+   * account object.
+   */
+  virtual_account?: IncomingPaymentDetail.VirtualAccount | null;
+
+  /**
+   * If the incoming payment detail is in a virtual account, the ID of the Virtual
+   * Account.
+   */
+  virtual_account_id?: string | null;
+}
+
+export namespace IncomingPaymentDetail {
+  export interface VirtualAccount {
+    /**
+     * An array of account detail objects.
+     */
+    account_details?: Array<VirtualAccount.AccountDetails>;
+
+    /**
+     * The ID of a counterparty that the virtual account belongs to. Optional.
+     */
+    counterparty_id?: string | null;
+
+    created_at?: string;
+
+    /**
+     * The ID of a credit normal ledger account. When money enters the virtual account,
+     * this ledger account will be credited. Must be accompanied by a
+     * debit_ledger_account_id if present.
+     */
+    credit_ledger_account_id?: string | null;
+
+    /**
+     * The ID of a debit normal ledger account. When money enters the virtual account,
+     * this ledger account will be debited. Must be accompanied by a
+     * credit_ledger_account_id if present.
+     */
+    debit_ledger_account_id?: string | null;
+
+    /**
+     * An optional free-form description for internal use.
+     */
+    description?: string | null;
+
+    discarded_at?: string | null;
+
+    id?: string;
+
+    /**
+     * The ID of the internal account that the virtual account is in.
+     */
+    internal_account_id?: 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 data represented as key-value pairs. Both the key and value must be
+     * strings.
+     */
+    metadata?: Record<string, string>;
+
+    /**
+     * The name of the virtual account.
+     */
+    name?: string;
+
+    object?: string;
+
+    /**
+     * An array of routing detail objects. These will be the routing details of the
+     * internal account.
+     */
+    routing_details?: Array<VirtualAccount.RoutingDetails>;
+
+    updated_at?: string;
+  }
+
+  export namespace VirtualAccount {
+    export interface AccountDetails {
+      account_number?: string;
+
+      /**
+       * Supports iban and clabe, otherwise other if the bank account number is in a
+       * generic format.
+       */
+      account_number_type?: 'iban' | 'clabe' | 'wallet_address' | 'pan' | 'other';
+
+      created_at?: string;
+
+      discarded_at?: string | null;
+
+      id?: 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;
+
+      object?: string;
+
+      updated_at?: string;
+    }
+
+    export interface RoutingDetails {
+      bank_address?: RoutingDetails.BankAddress | null;
+
+      bank_name?: string;
+
+      created_at?: string;
+
+      discarded_at?: string | null;
+
+      id?: 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;
+
+      object?: string;
+
+      /**
+       * If the routing detail is to be used for a specific payment type this field will
+       * be populated, otherwise null.
+       */
+      payment_type?:
+        | 'ach'
+        | 'au_becs'
+        | 'bacs'
+        | 'book'
+        | 'card'
+        | 'check'
+        | 'eft'
+        | 'interac'
+        | 'provxchange'
+        | 'rtp'
+        | 'sen'
+        | 'sepa'
+        | 'signet'
+        | 'wire'
+        | null;
+
+      /**
+       * The routing number of the bank.
+       */
+      routing_number?: string;
+
+      routing_number_type?:
+        | 'aba'
+        | 'swift'
+        | 'au_bsb'
+        | 'ca_cpa'
+        | 'cnaps'
+        | 'gb_sort_code'
+        | 'in_ifsc'
+        | 'my_branch_code'
+        | 'br_codigo';
+
+      updated_at?: string;
+    }
+
+    export namespace RoutingDetails {
+      export interface BankAddress {
+        /**
+         * Country code conforms to [ISO 3166-1 alpha-2]
+         */
+        country?: string | null;
+
+        created_at?: string;
+
+        id?: string;
+
+        line1?: string | null;
+
+        line2?: string | null;
+
+        /**
+         * 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;
+
+        /**
+         * Locality or City.
+         */
+        locality?: string | null;
+
+        object?: string;
+
+        /**
+         * The postal code of the address.
+         */
+        postal_code?: string | null;
+
+        /**
+         * Region or State.
+         */
+        region?: string | null;
+
+        updated_at?: string;
+      }
+    }
+  }
+}
+
+export interface IncomingPaymentDetailUpdateParams {
+  /**
+   * Additional data in the form of key-value pairs. Pairs can be removed by passing
+   * an empty string or `null` as the value.
+   */
+  metadata?: Record<string, string>;
+}
+
+export interface IncomingPaymentDetailListParams extends PageParams {
+  /**
+   * Filters incoming payment details with an as_of_date starting on or before the
+   * specified date (YYYY-MM-DD).
+   */
+  as_of_date_end?: string;
+
+  /**
+   * Filters incoming payment details with an as_of_date starting on or after the
+   * specified date (YYYY-MM-DD).
+   */
+  as_of_date_start?: string;
+
+  /**
+   * One of `credit` or `debit`.
+   */
+  direction?: 'credit' | 'debit';
+
+  /**
+   * 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?: Record<string, string>;
+
+  /**
+   * The current status of the incoming payment order. One of `pending`, `completed`,
+   * or `returned`.
+   */
+  status?: 'completed' | 'pending' | 'returned';
+
+  /**
+   * One of: `ach`, `wire`, `check`, `rtp`, `sepa`, `signet`.
+   */
+  type?: 'ach' | 'book' | 'check' | 'rtp' | 'sepa' | 'signet' | 'wire';
+
+  /**
+   * If the incoming payment detail is in a virtual account, the ID of the Virtual
+   * Account.
+   */
+  virtual_account_id?: string;
+}

package/resources/index.ts

@@ -0,0 +1,16 @@
+// File generated from our OpenAPI spec by Stainless.
+export * from './counterparties';
+export * from './documents';
+export * from './events';
+export * from './expected-payments';
+export * from './external-accounts';
+export * from './incoming-payment-details';
+export * from './internal-accounts';
+export * from './line-items';
+export * from './paper-items';
+export * from './payment-orders/payment-orders';
+export * from './returns';
+export * from './top-level';
+export * from './transactions';
+export * from './validations';
+export * from './webhooks';