modern-treasury 0.0.1

package/resources/line-items.ts

@@ -0,0 +1,138 @@
+// 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 LineItems extends APIResource {
+  /**
+   * Get a single line item
+   */
+  retrieve(
+    itemizableType: string,
+    itemizableId: string,
+    id: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<LineItem>> {
+    return this.get(`/api/${itemizableType}/${itemizableId}/line_items/${id}`, options);
+  }
+
+  update(
+    itemizableType: string,
+    itemizableId: string,
+    id: string,
+    body?: LineItemUpdateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<LineItem>>;
+  update(
+    itemizableType: string,
+    itemizableId: string,
+    id: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<LineItem>>;
+  update(
+    itemizableType: string,
+    itemizableId: string,
+    id: string,
+    body: LineItemUpdateParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<LineItem>> {
+    if (isRequestOptions(body)) {
+      return this.update(itemizableType, itemizableId, id, {}, body);
+    }
+
+    return this.patch(`/api/${itemizableType}/${itemizableId}/line_items/${id}`, { body, ...options });
+  }
+
+  /**
+   * Get a list of line items
+   */
+  list(
+    itemizableType: string,
+    id: string,
+    query?: LineItemListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<LineItemsPage>;
+  list(itemizableType: string, id: string, options?: Core.RequestOptions): Core.PagePromise<LineItemsPage>;
+  list(
+    itemizableType: string,
+    id: string,
+    query: LineItemListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<LineItemsPage> {
+    if (isRequestOptions(query)) {
+      return this.list(itemizableType, id, {}, query);
+    }
+
+    return this.getAPIList(`/api/${itemizableType}/${id}/line_items`, LineItemsPage, { query, ...options });
+  }
+}
+
+export class LineItemsPage extends Page<LineItem> {}
+
+export interface LineItem {
+  /**
+   * The ID of one of your accounting categories. Note that these will only be
+   * accessible if your accounting system has been connected.
+   */
+  accounting_category_id?: string | null;
+
+  /**
+   * The ID of one of the class objects in your accounting system. Class objects
+   * track segments of your business independent of client or project. Note that
+   * these will only be accessible if your accounting system has been connected.
+   */
+  accounting_ledger_class_id?: string | null;
+
+  /**
+   * Value in specified currency's smallest unit. e.g. $10 would be represented
+   * as 1000.
+   */
+  amount?: number;
+
+  created_at?: string;
+
+  /**
+   * A free-form description of the line item.
+   */
+  description?: string | null;
+
+  id?: string;
+
+  /**
+   * The ID of the payment order or expected payment.
+   */
+  itemizable_id?: string;
+
+  /**
+   * One of `payment_orders` or `expected_payments`.
+   */
+  itemizable_type?: 'ExpectedPayment' | 'PaymentOrder';
+
+  /**
+   * 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;
+
+  updated_at?: string;
+}
+
+export interface LineItemUpdateParams {
+  /**
+   * Additional data represented as key-value pairs. Both the key and value must be
+   * strings.
+   */
+  metadata?: Record<string, string>;
+}
+
+export interface LineItemListParams extends PageParams {}

package/resources/paper-items.ts

@@ -0,0 +1,317 @@
+// 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 PaperItems extends APIResource {
+  /**
+   * Get details on a single paper item.
+   */
+  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<PaperItem>> {
+    return this.get(`/api/paper_items/${id}`, options);
+  }
+
+  /**
+   * Get a list of all paper items.
+   */
+  list(query?: PaperItemListParams, options?: Core.RequestOptions): Core.PagePromise<PaperItemsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<PaperItemsPage>;
+  list(
+    query: PaperItemListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PaperItemsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+
+    return this.getAPIList('/api/paper_items', PaperItemsPage, { query, ...options });
+  }
+}
+
+export class PaperItemsPage extends Page<PaperItem> {}
+
+export interface PaperItem {
+  /**
+   * The account number on the paper item.
+   */
+  account_number?: 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?:
+    | '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 date the paper item was deposited into your organization's bank account.
+   */
+  deposit_date?: string;
+
+  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;
+
+  /**
+   * 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;
+}

package/resources/payment-orders/index.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless.
+export * from './payment-orders';
+export * from './reversals';