modern-treasury 0.0.1

package/dist/cjs/resources/line-items.d.ts

@@ -0,0 +1,90 @@
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { Page, PageParams } from '../pagination';
+export declare class LineItems extends APIResource {
+  /**
+   * Get a single line item
+   */
+  retrieve(
+    itemizableType: string,
+    itemizableId: string,
+    id: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<LineItem>>;
+  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>>;
+  /**
+   * 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>;
+}
+export declare 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/dist/cjs/resources/line-items.js

@@ -0,0 +1,38 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.LineItemsPage = exports.LineItems = void 0;
+const resource_1 = require('../resource');
+const core_1 = require('../core');
+const pagination_1 = require('../pagination');
+class LineItems extends resource_1.APIResource {
+  /**
+   * Get a single line item
+   */
+  retrieve(itemizableType, itemizableId, id, options) {
+    return this.get(`/api/${itemizableType}/${itemizableId}/line_items/${id}`, options);
+  }
+  update(itemizableType, itemizableId, id, body = {}, options) {
+    if ((0, core_1.isRequestOptions)(body)) {
+      return this.update(itemizableType, itemizableId, id, {}, body);
+    }
+    return this.patch(
+      `/api/${itemizableType}/${itemizableId}/line_items/${id}`,
+      Object.assign({ body }, options),
+    );
+  }
+  list(itemizableType, id, query = {}, options) {
+    if ((0, core_1.isRequestOptions)(query)) {
+      return this.list(itemizableType, id, {}, query);
+    }
+    return this.getAPIList(
+      `/api/${itemizableType}/${id}/line_items`,
+      LineItemsPage,
+      Object.assign({ query }, options),
+    );
+  }
+}
+exports.LineItems = LineItems;
+class LineItemsPage extends pagination_1.Page {}
+exports.LineItemsPage = LineItemsPage;
+//# sourceMappingURL=line-items.js.map

package/dist/cjs/resources/line-items.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"line-items.js","sourceRoot":"","sources":["../../../resources/line-items.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,yCAAyC;AACzC,iCAA0C;AAC1C,6CAAgD;AAEhD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;OAEG;IACH,QAAQ,CACN,cAAsB,EACtB,YAAoB,EACpB,EAAU,EACV,OAA6B;QAE7B,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,cAAc,IAAI,YAAY,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAeD,MAAM,CACJ,cAAsB,EACtB,YAAoB,EACpB,EAAU,EACV,OAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,YAAY,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SAChE;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,cAAc,IAAI,YAAY,eAAe,EAAE,EAAE,kBAAI,IAAI,IAAK,OAAO,EAAG,CAAC;IACrG,CAAC;IAYD,IAAI,CACF,cAAsB,EACtB,EAAU,EACV,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACjD;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,cAAc,IAAI,EAAE,aAAa,EAAE,aAAa,kBAAI,KAAK,IAAK,OAAO,EAAG,CAAC;IAC1G,CAAC;CACF;AA9DD,8BA8DC;AAED,MAAa,aAAc,SAAQ,iBAAc;CAAG;AAApD,sCAAoD"}

package/dist/cjs/resources/paper-items.d.ts

@@ -0,0 +1,279 @@
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { Page, PageParams } from '../pagination';
+export declare class PaperItems extends APIResource {
+  /**
+   * Get details on a single paper item.
+   */
+  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<PaperItem>>;
+  /**
+   * Get a list of all paper items.
+   */
+  list(query?: PaperItemListParams, options?: Core.RequestOptions): Core.PagePromise<PaperItemsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<PaperItemsPage>;
+}
+export declare 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/dist/cjs/resources/paper-items.js

@@ -0,0 +1,25 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.PaperItemsPage = exports.PaperItems = void 0;
+const resource_1 = require('../resource');
+const core_1 = require('../core');
+const pagination_1 = require('../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);
+    }
+    return this.getAPIList('/api/paper_items', PaperItemsPage, Object.assign({ query }, options));
+  }
+}
+exports.PaperItems = PaperItems;
+class PaperItemsPage extends pagination_1.Page {}
+exports.PaperItemsPage = PaperItemsPage;
+//# sourceMappingURL=paper-items.js.map

package/dist/cjs/resources/paper-items.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paper-items.js","sourceRoot":"","sources":["../../../resources/paper-items.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,yCAAyC;AACzC,iCAA0C;AAC1C,6CAAgD;AAEhD,MAAa,UAAW,SAAQ,sBAAW;IACzC;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAOD,IAAI,CACF,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,EAAE,cAAc,kBAAI,KAAK,IAAK,OAAO,EAAG,CAAC;IACpF,CAAC;CACF;AAvBD,gCAuBC;AAED,MAAa,cAAe,SAAQ,iBAAe;CAAG;AAAtD,wCAAsD"}

package/dist/cjs/resources/payment-orders/index.d.ts

@@ -0,0 +1,2 @@
+export * from './payment-orders';
+export * from './reversals';

package/dist/cjs/resources/payment-orders/index.js

@@ -0,0 +1,33 @@
+'use strict';
+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);
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        o[k2] = m[k];
+      });
+var __exportStar =
+  (this && this.__exportStar) ||
+  function (m, exports) {
+    for (var p in m)
+      if (p !== 'default' && !Object.prototype.hasOwnProperty.call(exports, p))
+        __createBinding(exports, m, p);
+  };
+Object.defineProperty(exports, '__esModule', { value: true });
+// File generated from our OpenAPI spec by Stainless.
+__exportStar(require('./payment-orders'), exports);
+__exportStar(require('./reversals'), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/resources/payment-orders/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../resources/payment-orders/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAqD;AACrD,mDAAiC;AACjC,8CAA4B"}