modern-treasury 2.6.0 → 2.7.2

package/resources/paper-items.d.ts

@@ -1,107 +1,105 @@
 import * as Core from 'modern-treasury/core';
 import { APIResource } from 'modern-treasury/resource';
 import * as Shared from 'modern-treasury/resources/shared';
-import * as API from './index.js';
+import * as API from "./index.js";
 import { Page, PageParams } from 'modern-treasury/pagination';
 export declare class PaperItems extends APIResource {
-  /**
-   * Get details on a single paper item.
-   */
-  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<PaperItem>;
-  /**
-   * Get a list of all paper items.
-   */
-  list(
-    query?: PaperItemListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PaperItemsPage, PaperItem>;
-  list(options?: Core.RequestOptions): Core.PagePromise<PaperItemsPage, PaperItem>;
+    /**
+     * Get details on a single paper item.
+     */
+    retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<PaperItem>;
+    /**
+     * Get a list of all paper items.
+     */
+    list(query?: PaperItemListParams, options?: Core.RequestOptions): Core.PagePromise<PaperItemsPage, PaperItem>;
+    list(options?: Core.RequestOptions): Core.PagePromise<PaperItemsPage, PaperItem>;
+}
+export declare class PaperItemsPage extends Page<PaperItem> {
 }
-export declare class PaperItemsPage extends Page<PaperItem> {}
 type _PaperItemsPage = PaperItemsPage;
 export interface PaperItem {
-  id: string;
-  /**
-   * The account number on the paper item.
-   */
-  account_number: string | null;
-  /**
-   * The last 4 digits of the account_number.
-   */
-  account_number_safe: string | null;
-  /**
-   * The amount of the paper item.
-   */
-  amount: number;
-  /**
-   * The check number on the paper item.
-   */
-  check_number: string | null;
-  created_at: string;
-  /**
-   * The currency of the paper item.
-   */
-  currency: Shared.Currency | null;
-  /**
-   * The date the paper item was deposited into your organization's bank account.
-   */
-  deposit_date: 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;
-  /**
-   * The identifier for the lockbox assigned by the bank.
-   */
-  lockbox_number: string;
-  /**
-   * The memo field on the paper item.
-   */
-  memo_field: string | null;
-  object: string;
-  /**
-   * The name of the remitter on the paper item.
-   */
-  remitter_name: string | null;
-  /**
-   * The routing number on the paper item.
-   */
-  routing_number: string | null;
-  /**
-   * The current status of the paper item. 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;
-  updated_at: string;
+    id: string;
+    /**
+     * The account number on the paper item.
+     */
+    account_number: string | null;
+    /**
+     * The last 4 digits of the account_number.
+     */
+    account_number_safe: string | null;
+    /**
+     * The amount of the paper item.
+     */
+    amount: number;
+    /**
+     * The check number on the paper item.
+     */
+    check_number: string | null;
+    created_at: string;
+    /**
+     * The currency of the paper item.
+     */
+    currency: Shared.Currency | null;
+    /**
+     * The date the paper item was deposited into your organization's bank account.
+     */
+    deposit_date: 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;
+    /**
+     * The identifier for the lockbox assigned by the bank.
+     */
+    lockbox_number: string;
+    /**
+     * The memo field on the paper item.
+     */
+    memo_field: string | null;
+    object: string;
+    /**
+     * The name of the remitter on the paper item.
+     */
+    remitter_name: string | null;
+    /**
+     * The routing number on the paper item.
+     */
+    routing_number: string | null;
+    /**
+     * The current status of the paper item. 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;
+    updated_at: string;
 }
 export interface PaperItemListParams extends PageParams {
-  /**
-   * Specify an inclusive end date (YYYY-MM-DD) when filtering by deposit_date
-   */
-  deposit_date_end?: string;
-  /**
-   * Specify an inclusive start date (YYYY-MM-DD) when filtering by deposit_date
-   */
-  deposit_date_start?: string;
-  /**
-   * Specify `lockbox_number` if you wish to see paper items that are associated with
-   * a specific lockbox number.
-   */
-  lockbox_number?: string;
+    /**
+     * Specify an inclusive end date (YYYY-MM-DD) when filtering by deposit_date
+     */
+    deposit_date_end?: string;
+    /**
+     * Specify an inclusive start date (YYYY-MM-DD) when filtering by deposit_date
+     */
+    deposit_date_start?: string;
+    /**
+     * Specify `lockbox_number` if you wish to see paper items that are associated with
+     * a specific lockbox number.
+     */
+    lockbox_number?: string;
 }
 export declare namespace PaperItems {
-  export import PaperItem = API.PaperItem;
-  type PaperItemsPage = _PaperItemsPage;
-  export import PaperItemListParams = API.PaperItemListParams;
+    export import PaperItem = API.PaperItem;
+    type PaperItemsPage = _PaperItemsPage;
+    export import PaperItemListParams = API.PaperItemListParams;
 }
 export {};
-//# sourceMappingURL=paper-items.d.ts.map
+//# sourceMappingURL=paper-items.d.ts.map

package/resources/paper-items.js

@@ -1,26 +1,28 @@
-'use strict';
+"use strict";
 // File generated from our OpenAPI spec by Stainless.
-Object.defineProperty(exports, '__esModule', { value: true });
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.PaperItemsPage = exports.PaperItems = void 0;
-const resource_1 = require('modern-treasury/resource');
-const core_1 = require('modern-treasury/core');
-const pagination_1 = require('modern-treasury/pagination');
+const resource_1 = require("modern-treasury/resource");
+const core_1 = require("modern-treasury/core");
+const pagination_1 = require("modern-treasury/pagination");
 class PaperItems extends resource_1.APIResource {
-  /**
-   * Get details on a single paper item.
-   */
-  retrieve(id, options) {
-    return this.get(`/api/paper_items/${id}`, options);
-  }
-  list(query = {}, options) {
-    if ((0, core_1.isRequestOptions)(query)) {
-      return this.list({}, query);
+    /**
+     * Get details on a single paper item.
+     */
+    retrieve(id, options) {
+        return this.get(`/api/paper_items/${id}`, options);
+    }
+    list(query = {}, options) {
+        if ((0, core_1.isRequestOptions)(query)) {
+            return this.list({}, query);
+        }
+        return this.getAPIList('/api/paper_items', PaperItemsPage, { query, ...options });
     }
-    return this.getAPIList('/api/paper_items', PaperItemsPage, { query, ...options });
-  }
 }
 exports.PaperItems = PaperItems;
-class PaperItemsPage extends pagination_1.Page {}
+class PaperItemsPage extends pagination_1.Page {
+}
 exports.PaperItemsPage = PaperItemsPage;
-(function (PaperItems) {})((PaperItems = exports.PaperItems || (exports.PaperItems = {})));
-//# sourceMappingURL=paper-items.js.map
+(function (PaperItems) {
+})(PaperItems = exports.PaperItems || (exports.PaperItems = {}));
+//# sourceMappingURL=paper-items.js.map

package/resources/paper-items.mjs

@@ -3,19 +3,21 @@ import { APIResource } from 'modern-treasury/resource';
 import { isRequestOptions } from 'modern-treasury/core';
 import { Page } from 'modern-treasury/pagination';
 export class PaperItems extends APIResource {
-  /**
-   * Get details on a single paper item.
-   */
-  retrieve(id, options) {
-    return this.get(`/api/paper_items/${id}`, options);
-  }
-  list(query = {}, options) {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
+    /**
+     * Get details on a single paper item.
+     */
+    retrieve(id, options) {
+        return this.get(`/api/paper_items/${id}`, options);
     }
-    return this.getAPIList('/api/paper_items', PaperItemsPage, { query, ...options });
-  }
+    list(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list({}, query);
+        }
+        return this.getAPIList('/api/paper_items', PaperItemsPage, { query, ...options });
+    }
+}
+export class PaperItemsPage extends Page {
 }
-export class PaperItemsPage extends Page {}
-(function (PaperItems) {})(PaperItems || (PaperItems = {}));
-//# sourceMappingURL=paper-items.mjs.map
+(function (PaperItems) {
+})(PaperItems || (PaperItems = {}));
+//# sourceMappingURL=paper-items.mjs.map

package/resources/payment-flows.d.ts

@@ -1,155 +1,149 @@
 import * as Core from 'modern-treasury/core';
 import { APIResource } from 'modern-treasury/resource';
-import * as API from './index.js';
+import * as API from "./index.js";
 import { Page, PageParams } from 'modern-treasury/pagination';
 export declare class PaymentFlows extends APIResource {
-  /**
-   * create payment_flow
-   */
-  create(params: PaymentFlowCreateParams, options?: Core.RequestOptions): Core.APIPromise<PaymentFlow>;
-  /**
-   * get payment_flow
-   */
-  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<PaymentFlow>;
-  /**
-   * update payment_flow
-   */
-  update(
-    id: string,
-    params: PaymentFlowUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<PaymentFlow>;
-  /**
-   * list payment_flows
-   */
-  list(
-    query?: PaymentFlowListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PaymentFlowsPage, PaymentFlow>;
-  list(options?: Core.RequestOptions): Core.PagePromise<PaymentFlowsPage, PaymentFlow>;
+    /**
+     * create payment_flow
+     */
+    create(params: PaymentFlowCreateParams, options?: Core.RequestOptions): Core.APIPromise<PaymentFlow>;
+    /**
+     * get payment_flow
+     */
+    retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<PaymentFlow>;
+    /**
+     * update payment_flow
+     */
+    update(id: string, params: PaymentFlowUpdateParams, options?: Core.RequestOptions): Core.APIPromise<PaymentFlow>;
+    /**
+     * list payment_flows
+     */
+    list(query?: PaymentFlowListParams, options?: Core.RequestOptions): Core.PagePromise<PaymentFlowsPage, PaymentFlow>;
+    list(options?: Core.RequestOptions): Core.PagePromise<PaymentFlowsPage, PaymentFlow>;
+}
+export declare class PaymentFlowsPage extends Page<PaymentFlow> {
 }
-export declare class PaymentFlowsPage extends Page<PaymentFlow> {}
 type _PaymentFlowsPage = PaymentFlowsPage;
 export interface PaymentFlow {
-  id?: string;
-  /**
-   * Value in specified currency's smallest unit. e.g. $10 would be represented
-   * as 1000. Can be any integer up to 36 digits.
-   */
-  amount?: number;
-  /**
-   * The client token of the payment flow. This token can be used to embed a payment
-   * workflow in your client-side application.
-   */
-  client_token?: string;
-  /**
-   * The ID of a counterparty associated with the payment. As part of the payment
-   * workflow an external account will be associated with this counterparty.
-   */
-  counterparty_id?: string | null;
-  created_at?: string;
-  /**
-   * The currency of the payment.
-   */
-  currency?: string;
-  /**
-   * Describes the direction money is flowing in the transaction. Can only be
-   * `debit`. A `debit` pulls money from someone else's account to your own.
-   */
-  direction?: 'credit' | 'debit';
-  /**
-   * The due date for the flow. Can only be passed in when
-   * `effective_date_selection_enabled` is `true`.
-   */
-  due_date?: string | null;
-  /**
-   * When `true`, your end-user can schedule the payment `effective_date` while
-   * completing the pre-built UI.
-   */
-  effective_date_selection_enabled?: boolean;
-  /**
-   * 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;
-  /**
-   * The ID of one of your organization's internal accounts.
-   */
-  originating_account_id?: string | null;
-  /**
-   * If present, the ID of the payment order created using this flow.
-   */
-  payment_order_id?: string | null;
-  /**
-   * If present, the ID of the external account created using this flow.
-   */
-  receiving_account_id?: string | null;
-  /**
-   * This field is set after your end-user selects a payment date while completing
-   * the pre-built UI. This field is always `null` unless
-   * `effective_date_selection_enabled` is `true`.
-   */
-  selected_effective_date?: string | null;
-  /**
-   * The current status of the payment flow. One of `pending`, `completed`,
-   * `expired`, or `cancelled`.
-   */
-  status?: 'cancelled' | 'completed' | 'expired' | 'pending';
-  updated_at?: string;
+    id?: string;
+    /**
+     * Value in specified currency's smallest unit. e.g. $10 would be represented
+     * as 1000. Can be any integer up to 36 digits.
+     */
+    amount?: number;
+    /**
+     * The client token of the payment flow. This token can be used to embed a payment
+     * workflow in your client-side application.
+     */
+    client_token?: string;
+    /**
+     * The ID of a counterparty associated with the payment. As part of the payment
+     * workflow an external account will be associated with this counterparty.
+     */
+    counterparty_id?: string | null;
+    created_at?: string;
+    /**
+     * The currency of the payment.
+     */
+    currency?: string;
+    /**
+     * Describes the direction money is flowing in the transaction. Can only be
+     * `debit`. A `debit` pulls money from someone else's account to your own.
+     */
+    direction?: 'credit' | 'debit';
+    /**
+     * The due date for the flow. Can only be passed in when
+     * `effective_date_selection_enabled` is `true`.
+     */
+    due_date?: string | null;
+    /**
+     * When `true`, your end-user can schedule the payment `effective_date` while
+     * completing the pre-built UI.
+     */
+    effective_date_selection_enabled?: boolean;
+    /**
+     * 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;
+    /**
+     * The ID of one of your organization's internal accounts.
+     */
+    originating_account_id?: string | null;
+    /**
+     * If present, the ID of the payment order created using this flow.
+     */
+    payment_order_id?: string | null;
+    /**
+     * If present, the ID of the external account created using this flow.
+     */
+    receiving_account_id?: string | null;
+    /**
+     * This field is set after your end-user selects a payment date while completing
+     * the pre-built UI. This field is always `null` unless
+     * `effective_date_selection_enabled` is `true`.
+     */
+    selected_effective_date?: string | null;
+    /**
+     * The current status of the payment flow. One of `pending`, `completed`,
+     * `expired`, or `cancelled`.
+     */
+    status?: 'cancelled' | 'completed' | 'expired' | 'pending';
+    updated_at?: string;
 }
 export interface PaymentFlowCreateParams {
-  /**
-   * Required. Value in specified currency's smallest unit. e.g. $10 would be
-   * represented as 1000. Can be any integer up to 36 digits.
-   */
-  amount: number;
-  /**
-   * Required. The ID of a counterparty associated with the payment. As part of the
-   * payment workflow an external account will be associated with this model.
-   */
-  counterparty_id: string;
-  /**
-   * Required. The currency of the payment.
-   */
-  currency: string;
-  /**
-   * Required. Describes the direction money is flowing in the transaction. Can only
-   * be `debit`. A `debit` pulls money from someone else's account to your own.
-   */
-  direction: 'credit' | 'debit';
-  /**
-   * Required. The ID of one of your organization's internal accounts.
-   */
-  originating_account_id: string;
-  /**
-   * Optional. Can only be passed in when `effective_date_selection_enabled` is
-   * `true`. When set, the due date is shown to your end-user in the pre-built UI as
-   * they are selecting a payment `effective_date`.
-   */
-  due_date?: string;
+    /**
+     * Required. Value in specified currency's smallest unit. e.g. $10 would be
+     * represented as 1000. Can be any integer up to 36 digits.
+     */
+    amount: number;
+    /**
+     * Required. The ID of a counterparty associated with the payment. As part of the
+     * payment workflow an external account will be associated with this model.
+     */
+    counterparty_id: string;
+    /**
+     * Required. The currency of the payment.
+     */
+    currency: string;
+    /**
+     * Required. Describes the direction money is flowing in the transaction. Can only
+     * be `debit`. A `debit` pulls money from someone else's account to your own.
+     */
+    direction: 'credit' | 'debit';
+    /**
+     * Required. The ID of one of your organization's internal accounts.
+     */
+    originating_account_id: string;
+    /**
+     * Optional. Can only be passed in when `effective_date_selection_enabled` is
+     * `true`. When set, the due date is shown to your end-user in the pre-built UI as
+     * they are selecting a payment `effective_date`.
+     */
+    due_date?: string;
 }
 export interface PaymentFlowUpdateParams {
-  /**
-   * Required. The updated status of the payment flow. Can only be used to mark a
-   * flow as `cancelled`.
-   */
-  status: 'cancelled';
+    /**
+     * Required. The updated status of the payment flow. Can only be used to mark a
+     * flow as `cancelled`.
+     */
+    status: 'cancelled';
 }
 export interface PaymentFlowListParams extends PageParams {
-  client_token?: string;
-  counterparty_id?: string;
-  originating_account_id?: string;
-  payment_order_id?: string;
-  receiving_account_id?: string;
-  status?: string;
+    client_token?: string;
+    counterparty_id?: string;
+    originating_account_id?: string;
+    payment_order_id?: string;
+    receiving_account_id?: string;
+    status?: string;
 }
 export declare namespace PaymentFlows {
-  export import PaymentFlow = API.PaymentFlow;
-  type PaymentFlowsPage = _PaymentFlowsPage;
-  export import PaymentFlowCreateParams = API.PaymentFlowCreateParams;
-  export import PaymentFlowUpdateParams = API.PaymentFlowUpdateParams;
-  export import PaymentFlowListParams = API.PaymentFlowListParams;
+    export import PaymentFlow = API.PaymentFlow;
+    type PaymentFlowsPage = _PaymentFlowsPage;
+    export import PaymentFlowCreateParams = API.PaymentFlowCreateParams;
+    export import PaymentFlowUpdateParams = API.PaymentFlowUpdateParams;
+    export import PaymentFlowListParams = API.PaymentFlowListParams;
 }
 export {};
-//# sourceMappingURL=payment-flows.d.ts.map
+//# sourceMappingURL=payment-flows.d.ts.map