modern-treasury 2.6.0 → 2.7.2

package/resources/transactions/transactions.d.ts

@@ -1,227 +1,179 @@
 import * as Core from 'modern-treasury/core';
 import { APIResource } from 'modern-treasury/resource';
 import * as Shared from 'modern-treasury/resources/shared';
-import { LineItems } from './line-items.js';
-import * as API from './index.js';
+import { LineItems } from "./line-items.js";
+import * as API from "./index.js";
 import { Page, PageParams } from 'modern-treasury/pagination';
 export declare class Transactions extends APIResource {
-  lineItems: LineItems;
-  /**
-   * Get details on a single transaction.
-   */
-  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Transaction>;
-  /**
-   * Update a single transaction.
-   */
-  update(
-    id: string,
-    body?: TransactionUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<Transaction>;
-  update(id: string, options?: Core.RequestOptions): Core.APIPromise<Transaction>;
-  /**
-   * Get a list of all transactions.
-   */
-  list(
-    query?: TransactionListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<TransactionsPage, Transaction>;
-  list(options?: Core.RequestOptions): Core.PagePromise<TransactionsPage, Transaction>;
+    lineItems: LineItems;
+    /**
+     * Get details on a single transaction.
+     */
+    retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Transaction>;
+    /**
+     * Update a single transaction.
+     */
+    update(id: string, body?: TransactionUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Transaction>;
+    update(id: string, options?: Core.RequestOptions): Core.APIPromise<Transaction>;
+    /**
+     * Get a list of all transactions.
+     */
+    list(query?: TransactionListParams, options?: Core.RequestOptions): Core.PagePromise<TransactionsPage, Transaction>;
+    list(options?: Core.RequestOptions): Core.PagePromise<TransactionsPage, Transaction>;
+}
+export declare class TransactionsPage extends Page<Transaction> {
 }
-export declare class TransactionsPage extends Page<Transaction> {}
 type _TransactionsPage = TransactionsPage;
 export interface Transaction {
-  id: string;
-  /**
-   * 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: 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`.
-   */
-  direction: string;
-  discarded_at: string | null;
-  /**
-   * 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'
-    | 'cross_border'
-    | 'eft'
-    | 'interac'
-    | 'masav'
-    | 'neft'
-    | 'nics'
-    | 'provxchange'
-    | 'rtp'
-    | 'se_bankgirot'
-    | 'sen'
-    | 'sepa'
-    | 'sic'
-    | 'signet'
-    | 'wire'
-    | 'zengin';
-  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`, `bankprov`,
-   * `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
-   * `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
-   * `swift`, or `us_bank`.
-   */
-  vendor_code_type:
-    | 'bai2'
-    | 'bankprov'
-    | 'bnk_dev'
-    | 'cleartouch'
-    | 'column'
-    | 'cross_river'
-    | 'currencycloud'
-    | 'dc_bank'
-    | 'dwolla'
-    | 'evolve'
-    | 'goldman_sachs'
-    | 'iso20022'
-    | 'jpmc'
-    | 'mx'
-    | 'plaid'
-    | 'rspec_vendor'
-    | 'signet'
-    | 'silvergate'
-    | 'swift'
-    | 'us_bank'
-    | 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;
+    id: string;
+    /**
+     * 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: 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`.
+     */
+    direction: string;
+    discarded_at: string | null;
+    /**
+     * 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' | 'cross_border' | 'eft' | 'interac' | 'masav' | 'neft' | 'nics' | 'provxchange' | 'rtp' | 'se_bankgirot' | 'sen' | 'sepa' | 'sic' | 'signet' | 'wire' | 'zengin';
+    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`, `bankprov`,
+     * `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
+     * `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
+     * `swift`, or `us_bank`.
+     */
+    vendor_code_type: 'bai2' | 'bankprov' | 'bnk_dev' | 'cleartouch' | 'column' | 'cross_river' | 'currencycloud' | 'dc_bank' | 'dwolla' | 'evolve' | 'goldman_sachs' | 'iso20022' | 'jpmc' | 'mx' | 'plaid' | 'rspec_vendor' | 'signet' | 'silvergate' | 'swift' | 'us_bank' | 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>;
+    /**
+     * 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;
-  /**
-   * Filters for transactions including the queried vendor id (an identifier given to
-   * transactions by the bank).
-   */
-  vendor_id?: string;
-  virtual_account_id?: string;
+    /**
+     * 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;
+    /**
+     * Filters for transactions including the queried vendor id (an identifier given to
+     * transactions by the bank).
+     */
+    vendor_id?: string;
+    virtual_account_id?: string;
 }
 export declare namespace Transactions {
-  export import Transaction = API.Transaction;
-  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 = API.Transaction;
+    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 {};
-//# sourceMappingURL=transactions.d.ts.map
+//# sourceMappingURL=transactions.d.ts.map

package/resources/transactions/transactions.js

@@ -1,81 +1,65 @@
-'use strict';
+"use strict";
 // File generated from our OpenAPI spec by Stainless.
-var __createBinding =
-  (this && this.__createBinding) ||
-  (Object.create ?
-    function (o, m, k, k2) {
-      if (k2 === undefined) k2 = k;
-      var desc = Object.getOwnPropertyDescriptor(m, k);
-      if (!desc || ('get' in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-        desc = {
-          enumerable: true,
-          get: function () {
-            return m[k];
-          },
-        };
-      }
-      Object.defineProperty(o, k2, desc);
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
     }
-  : function (o, m, k, k2) {
-      if (k2 === undefined) k2 = k;
-      o[k2] = m[k];
-    });
-var __setModuleDefault =
-  (this && this.__setModuleDefault) ||
-  (Object.create ?
-    function (o, v) {
-      Object.defineProperty(o, 'default', { enumerable: true, value: v });
-    }
-  : function (o, v) {
-      o['default'] = v;
-    });
-var __importStar =
-  (this && this.__importStar) ||
-  function (mod) {
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null)
-      for (var k in mod)
-        if (k !== 'default' && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
-  };
-Object.defineProperty(exports, '__esModule', { value: true });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.TransactionsPage = exports.Transactions = void 0;
-const resource_1 = require('modern-treasury/resource');
-const core_1 = require('modern-treasury/core');
-const line_items_1 = require('./line-items.js');
-const API = __importStar(require('./index.js'));
-const pagination_1 = require('modern-treasury/pagination');
+const resource_1 = require("modern-treasury/resource");
+const core_1 = require("modern-treasury/core");
+const line_items_1 = require("./line-items.js");
+const API = __importStar(require("./index.js"));
+const pagination_1 = require("modern-treasury/pagination");
 class Transactions extends resource_1.APIResource {
-  constructor() {
-    super(...arguments);
-    this.lineItems = new line_items_1.LineItems(this.client);
-  }
-  /**
-   * Get details on a single transaction.
-   */
-  retrieve(id, options) {
-    return this.get(`/api/transactions/${id}`, options);
-  }
-  update(id, body = {}, options) {
-    if ((0, core_1.isRequestOptions)(body)) {
-      return this.update(id, {}, body);
+    constructor() {
+        super(...arguments);
+        this.lineItems = new line_items_1.LineItems(this.client);
+    }
+    /**
+     * Get details on a single transaction.
+     */
+    retrieve(id, options) {
+        return this.get(`/api/transactions/${id}`, options);
     }
-    return this.patch(`/api/transactions/${id}`, { body, ...options });
-  }
-  list(query = {}, options) {
-    if ((0, core_1.isRequestOptions)(query)) {
-      return this.list({}, query);
+    update(id, body = {}, options) {
+        if ((0, core_1.isRequestOptions)(body)) {
+            return this.update(id, {}, body);
+        }
+        return this.patch(`/api/transactions/${id}`, { body, ...options });
+    }
+    list(query = {}, options) {
+        if ((0, core_1.isRequestOptions)(query)) {
+            return this.list({}, query);
+        }
+        return this.getAPIList('/api/transactions', TransactionsPage, { query, ...options });
     }
-    return this.getAPIList('/api/transactions', TransactionsPage, { query, ...options });
-  }
 }
 exports.Transactions = Transactions;
-class TransactionsPage extends pagination_1.Page {}
+class TransactionsPage extends pagination_1.Page {
+}
 exports.TransactionsPage = TransactionsPage;
 (function (Transactions) {
-  Transactions.LineItems = API.LineItems;
-  Transactions.TransactionLineItemsPage = API.TransactionLineItemsPage;
-})((Transactions = exports.Transactions || (exports.Transactions = {})));
-//# sourceMappingURL=transactions.js.map
+    Transactions.LineItems = API.LineItems;
+    Transactions.TransactionLineItemsPage = API.TransactionLineItemsPage;
+})(Transactions = exports.Transactions || (exports.Transactions = {}));
+//# sourceMappingURL=transactions.js.map

package/resources/transactions/transactions.mjs

@@ -1,36 +1,37 @@
 // File generated from our OpenAPI spec by Stainless.
 import { APIResource } from 'modern-treasury/resource';
 import { isRequestOptions } from 'modern-treasury/core';
-import { LineItems } from './line-items.mjs';
-import * as API from './index.mjs';
+import { LineItems } from "./line-items.mjs";
+import * as API from "./index.mjs";
 import { Page } from 'modern-treasury/pagination';
 export class Transactions extends APIResource {
-  constructor() {
-    super(...arguments);
-    this.lineItems = new LineItems(this.client);
-  }
-  /**
-   * Get details on a single transaction.
-   */
-  retrieve(id, options) {
-    return this.get(`/api/transactions/${id}`, options);
-  }
-  update(id, body = {}, options) {
-    if (isRequestOptions(body)) {
-      return this.update(id, {}, body);
+    constructor() {
+        super(...arguments);
+        this.lineItems = new LineItems(this.client);
     }
-    return this.patch(`/api/transactions/${id}`, { body, ...options });
-  }
-  list(query = {}, options) {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
+    /**
+     * Get details on a single transaction.
+     */
+    retrieve(id, options) {
+        return this.get(`/api/transactions/${id}`, options);
     }
-    return this.getAPIList('/api/transactions', TransactionsPage, { query, ...options });
-  }
+    update(id, body = {}, options) {
+        if (isRequestOptions(body)) {
+            return this.update(id, {}, body);
+        }
+        return this.patch(`/api/transactions/${id}`, { body, ...options });
+    }
+    list(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list({}, query);
+        }
+        return this.getAPIList('/api/transactions', TransactionsPage, { query, ...options });
+    }
+}
+export class TransactionsPage extends Page {
 }
-export class TransactionsPage extends Page {}
 (function (Transactions) {
-  Transactions.LineItems = API.LineItems;
-  Transactions.TransactionLineItemsPage = API.TransactionLineItemsPage;
+    Transactions.LineItems = API.LineItems;
+    Transactions.TransactionLineItemsPage = API.TransactionLineItemsPage;
 })(Transactions || (Transactions = {}));
-//# sourceMappingURL=transactions.mjs.map
+//# sourceMappingURL=transactions.mjs.map