modern-treasury 0.0.1

package/resources/transactions.ts

@@ -0,0 +1,441 @@
+// 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 Transactions extends APIResource {
+  /**
+   * Get details on a single transaction.
+   */
+  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Transaction>> {
+    return this.get(`/api/transactions/${id}`, options);
+  }
+
+  /**
+   * Update a single transaction.
+   */
+  update(
+    id: string,
+    body?: TransactionUpdateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<Transaction>>;
+  update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Transaction>>;
+  update(
+    id: string,
+    body: TransactionUpdateParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<Transaction>> {
+    if (isRequestOptions(body)) {
+      return this.update(id, {}, body);
+    }
+
+    return this.patch(`/api/transactions/${id}`, { body, ...options });
+  }
+
+  /**
+   * Get a list of all transactions.
+   */
+  list(query?: TransactionListParams, options?: Core.RequestOptions): Core.PagePromise<TransactionsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<TransactionsPage>;
+  list(
+    query: TransactionListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<TransactionsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+
+    return this.getAPIList('/api/transactions', TransactionsPage, { query, ...options });
+  }
+}
+
+export class TransactionsPage extends Page<Transaction> {}
+
+export interface Transaction {
+  /**
+   * Value in specified currency's smallest unit. e.g. $10 would be represented
+   * as 1000.
+   */
+  amount?: number;
+
+  /**
+   * The date on which the transaction occurred.
+   */
+  as_of_date?: string | null;
+
+  /**
+   * The time on which the transaction occurred. Depending on the granularity of the
+   * timestamp information received from the bank, it may be `null`.
+   */
+  as_of_time?: string | null;
+
+  created_at?: string;
+
+  /**
+   * Currency that this transaction is denominated in.
+   */
+  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';
+
+  /**
+   * 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`.
+   */
+  direction?: string;
+
+  discarded_at?: string | null;
+
+  id?: string;
+
+  /**
+   * The ID of the relevant Internal Account.
+   */
+  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;
+
+  /**
+   * This field will be `true` if the transaction has posted to the account.
+   */
+  posted?: boolean;
+
+  /**
+   * This field will be `true` if a transaction is reconciled by the Modern Treasury
+   * system. This means that it has transaction line items that sum up to the
+   * transaction's amount.
+   */
+  reconciled?: boolean;
+
+  /**
+   * The type of the transaction. Can be one of `ach`, `wire`, `check`, `rtp`,
+   * `book`, or `sen`.
+   */
+  type?:
+    | 'ach'
+    | 'au_becs'
+    | 'bacs'
+    | 'book'
+    | 'card'
+    | 'check'
+    | 'eft'
+    | 'interac'
+    | 'provxchange'
+    | 'rtp'
+    | 'sen'
+    | 'sepa'
+    | 'signet'
+    | 'wire';
+
+  updated_at?: string;
+
+  /**
+   * When applicable, the bank-given code that determines the transaction's category.
+   * For most banks this is the BAI2/BTRS transaction code.
+   */
+  vendor_code?: string | null;
+
+  /**
+   * The type of vendor_code being reported. Can be one of `bai2`, `swift`,
+   * `cleartouch`, or `silvergate`.
+   */
+  vendor_code_type?:
+    | 'bai2'
+    | 'bankprov'
+    | 'bnk_dev'
+    | 'cleartouch'
+    | 'cross_river'
+    | 'currencycloud'
+    | 'dc_bank'
+    | 'dwolla'
+    | 'goldman_sachs'
+    | 'iso20022'
+    | 'jpmc'
+    | 'mx'
+    | 'signet'
+    | 'silvergate'
+    | 'swift'
+    | null;
+
+  /**
+   * An identifier given to this transaction by the bank, often `null`.
+   */
+  vendor_customer_id?: string | null;
+
+  /**
+   * The transaction detail text that often appears in on your bank statement and in
+   * your banking portal.
+   */
+  vendor_description?: string | null;
+
+  /**
+   * An identifier given to this transaction by the bank.
+   */
+  vendor_id?: string | null;
+}
+
+export interface TransactionUpdateParams {
+  /**
+   * 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 TransactionListParams extends PageParams {
+  /**
+   * Filters transactions with an `as_of_date` starting on or before the specified
+   * date (YYYY-MM-DD).
+   */
+  as_of_date_end?: string;
+
+  /**
+   * Filters transactions with an `as_of_date` starting on or after the specified
+   * date (YYYY-MM-DD).
+   */
+  as_of_date_start?: string;
+
+  counterparty_id?: string;
+
+  /**
+   * Filters for transactions including the queried string in the description.
+   */
+  description?: string;
+
+  direction?: string;
+
+  /**
+   * Specify `internal_account_id` if you wish to see transactions to/from a specific
+   * account.
+   */
+  internal_account_id?: string;
+
+  /**
+   * 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>;
+
+  payment_type?: string;
+
+  /**
+   * Either `true` or `false`.
+   */
+  posted?: boolean;
+
+  transactable_type?: string;
+
+  virtual_account_id?: string;
+}

package/resources/validations.ts

@@ -0,0 +1,115 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+
+export class Validations extends APIResource {
+  /**
+   * Validates the routing number information supplied without creating a routing
+   * detail
+   */
+  validateRoutingNumber(
+    query: ValidationValidateRoutingNumberParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<RoutingNumberLookupRequest>> {
+    return this.get('/api/validations/routing_numbers', { query, ...options });
+  }
+}
+
+export interface RoutingNumberLookupRequest {
+  /**
+   * The address of the bank.
+   */
+  bank_address?: RoutingNumberLookupRequest.BankAddress;
+
+  /**
+   * The name of the bank.
+   */
+  bank_name?: string;
+
+  /**
+   * The routing number of the bank.
+   */
+  routing_number?: string;
+
+  /**
+   * One of `aba`, `au_bsb`, `br_codigo`, `ca_cpa`, `cnaps`, `gb_sort_code`,
+   * `in_ifsc`, `my_branch_code`, or `swift`. In sandbox mode we currently only
+   * support `aba` and `swift` with routing numbers '123456789' and 'GRINUST0XXX'
+   * respectively.
+   */
+  routing_number_type?: 'aba' | 'au_bsb' | 'ca_cpa' | 'gb_sort_code' | 'swift';
+
+  /**
+   * An array of payment types that are supported for this routing number. This can
+   * include `ach`, `wire`, `rtp`, `sepa`, `bacs`, `au_becs` currently.
+   */
+  supported_payment_types?: Array<
+    | 'ach'
+    | 'au_becs'
+    | 'bacs'
+    | 'book'
+    | 'card'
+    | 'check'
+    | 'eft'
+    | 'interac'
+    | 'provxchange'
+    | 'rtp'
+    | 'sen'
+    | 'sepa'
+    | 'signet'
+    | 'wire'
+  >;
+}
+
+export namespace RoutingNumberLookupRequest {
+  export interface BankAddress {
+    /**
+     * Country code conforms to [ISO 3166-1 alpha-2]
+     */
+    country?: string | null;
+
+    line1?: string | null;
+
+    line2?: string | null;
+
+    /**
+     * Locality or City.
+     */
+    locality?: string | null;
+
+    /**
+     * The postal code of the address.
+     */
+    postal_code?: string | null;
+
+    /**
+     * Region or State.
+     */
+    region?: string | null;
+  }
+}
+
+export interface ValidationValidateRoutingNumberParams {
+  /**
+   * The routing number that is being validated.
+   */
+  routing_number: string;
+
+  /**
+   * One of `aba`, `au_bsb`, `br_codigo`, `ca_cpa`, `cnaps`, `gb_sort_code`,
+   * `in_ifsc`, `my_branch_code`, or `swift`. In sandbox mode we currently only
+   * support `aba` and `swift` with routing numbers '123456789' and 'GRINUST0XXX'
+   * respectively.
+   */
+  routing_number_type:
+    | 'aba'
+    | 'au_bsb'
+    | 'br_codigo'
+    | 'ca_cpa'
+    | 'cnaps'
+    | 'gb_sort_code'
+    | 'in_ifsc'
+    | 'my_branch_code'
+    | 'swift';
+}

package/resources/webhooks.ts

@@ -0,0 +1,48 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import { APIResource } from '~/resource';
+import { createHmac } from 'crypto';
+
+import type { HeadersLike } from '~/core';
+import { getHeader } from '~/core';
+
+export class Webhooks extends APIResource {
+  /**
+   * To verify that a webhook was actually sent by Modern Treasury, every payload is
+   * signed with a signature that is passed through the `X-Signature` HTTP header.
+   *
+   * This method will generate a signature based off of your webhook key which can be
+   * found in the Developer Settings,
+   * https://app.moderntreasury.com/developers/webhooks, and the webhook payload.
+   *
+   * You can then compare the generated signature with the signature sent with the
+   * request, if they match then the webhook was sent by Modern Treasury.
+   */
+  getSignature(payload: string, opts?: { key?: string | null | undefined }): string {
+    const key = opts?.key || this.client.webhookKey;
+    if (key == null) {
+      throw new Error(
+        "The webhook key must either be set using the env var, MODERN_TREASURY_WEBHOOK_KEY, on the client class, new ModernTreasury({ webhookKey: '123' }) or passed to this function",
+      );
+    }
+    if (!key) {
+      throw new Error('The webhook key is set but appears to be empty.');
+    }
+
+    return createHmac('sha256', key).update(payload, 'utf8').digest('hex');
+  }
+
+  /**
+   * Returns whether or not the webhook payload was sent by Modern Treasury.
+   */
+  validateSignature(
+    payload: string,
+    headers: string | HeadersLike,
+    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');
+    return signature === expectedSignature;
+  }
+}