postgrid-node 0.1.0-alpha.4 → 0.2.0

package/resources/cheques/cheques.mjs

@@ -1,90 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../../resource.mjs";
-import { isRequestOptions } from "../../core.mjs";
-import * as URLAPI from "./url.mjs";
-import { URL } from "./url.mjs";
-import * as WithDepositReadyPdfAPI from "./with-deposit-ready-pdf.mjs";
-import { WithDepositReadyPdf } from "./with-deposit-ready-pdf.mjs";
-import { List } from "../../pagination.mjs";
-export class Cheques extends APIResource {
-    constructor() {
-        super(...arguments);
-        this.url = new URLAPI.URL(this._client);
-        this.withDepositReadyPdf = new WithDepositReadyPdfAPI.WithDepositReadyPdf(this._client);
-    }
-    /**
-     * Create a cheque.
-     *
-     * This endpoint allows you to create a new cheque with the specified details.
-     *
-     * If you would like to create a digitalOnly cheque, the digitalOnly object with
-     * the watermark will need to be passed in. Feature is available on request, e-mail
-     * support@postgrid.com for access.
-     *
-     * Example request body:
-     *
-     * ```json
-     * {
-     *   "from": "contact_123",
-     *   "bankAccount": "bank_123",
-     *   "amount": 1000,
-     *   "currencyCode": "USD",
-     *   "number": 123456,
-     *   "size": "us_letter",
-     *   "digitalOnly": {
-     *     "watermark": "VOID"
-     *   }
-     * }
-     * ```
-     *
-     * @example
-     * ```ts
-     * const cheque = await client.cheques.create({
-     *   amount: 1000,
-     *   bankAccount: 'bank_123',
-     *   from: 'contact_123',
-     *   to: 'contact_123',
-     *   currencyCode: 'USD',
-     *   number: 123456,
-     *   size: 'us_letter',
-     * });
-     * ```
-     */
-    create(body, options) {
-        return this._client.post('/cheques', { body, ...options });
-    }
-    /**
-     * Retrieve a cheque by ID.
-     *
-     * @example
-     * ```ts
-     * const cheque = await client.cheques.retrieve('id');
-     * ```
-     */
-    retrieve(id, options) {
-        return this._client.get(`/cheques/${id}`, options);
-    }
-    list(query = {}, options) {
-        if (isRequestOptions(query)) {
-            return this.list({}, query);
-        }
-        return this._client.getAPIList('/cheques', ChequesList, { query, ...options });
-    }
-    /**
-     * Cancel a cheque by ID. Note that this operation cannot be undone.
-     *
-     * @example
-     * ```ts
-     * const cheque = await client.cheques.cancel('id');
-     * ```
-     */
-    cancel(id, options) {
-        return this._client.delete(`/cheques/${id}`, options);
-    }
-}
-export class ChequesList extends List {
-}
-Cheques.ChequesList = ChequesList;
-Cheques.URL = URL;
-Cheques.WithDepositReadyPdf = WithDepositReadyPdf;
-//# sourceMappingURL=cheques.mjs.map

package/resources/cheques/cheques.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"cheques.mjs","sourceRoot":"","sources":["../../src/resources/cheques/cheques.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,KAAK,MAAM;OACX,EAAE,GAAG,EAAuB;OAC5B,KAAK,sBAAsB;OAC3B,EAAE,mBAAmB,EAAE;OACvB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,QAAG,GAAe,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/C,wBAAmB,GACjB,IAAI,sBAAsB,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA0FjE,CAAC;IAxFC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAeD,IAAI,CACF,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,IAAY;CAAG;AA+YhD,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;AAClC,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;AAClB,OAAO,CAAC,mBAAmB,GAAG,mBAAmB,CAAC"}

package/resources/cheques/index.d.ts

@@ -1,4 +0,0 @@
-export { ChequesList, Cheques, type Cheque, type ChequeList, type ChequeCreateParams, type ChequeListParams, } from "./cheques.js";
-export { URL, type URLRetrieveResponse } from "./url.js";
-export { WithDepositReadyPdf } from "./with-deposit-ready-pdf.js";
-//# sourceMappingURL=index.d.ts.map

package/resources/cheques/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/cheques/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,WAAW,EACX,OAAO,EACP,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,GACtB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,GAAG,EAAE,KAAK,mBAAmB,EAAE,MAAM,OAAO,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC"}

package/resources/cheques/index.js

@@ -1,12 +0,0 @@
-"use strict";
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WithDepositReadyPdf = exports.URL = exports.Cheques = exports.ChequesList = void 0;
-var cheques_1 = require("./cheques.js");
-Object.defineProperty(exports, "ChequesList", { enumerable: true, get: function () { return cheques_1.ChequesList; } });
-Object.defineProperty(exports, "Cheques", { enumerable: true, get: function () { return cheques_1.Cheques; } });
-var url_1 = require("./url.js");
-Object.defineProperty(exports, "URL", { enumerable: true, get: function () { return url_1.URL; } });
-var with_deposit_ready_pdf_1 = require("./with-deposit-ready-pdf.js");
-Object.defineProperty(exports, "WithDepositReadyPdf", { enumerable: true, get: function () { return with_deposit_ready_pdf_1.WithDepositReadyPdf; } });
-//# sourceMappingURL=index.js.map

package/resources/cheques/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/cheques/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wCAOmB;AANjB,sGAAA,WAAW,OAAA;AACX,kGAAA,OAAO,OAAA;AAMT,gCAAsD;AAA7C,0FAAA,GAAG,OAAA;AACZ,sEAA+D;AAAtD,6HAAA,mBAAmB,OAAA"}

package/resources/cheques/index.mjs

@@ -1,5 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-export { ChequesList, Cheques, } from "./cheques.mjs";
-export { URL } from "./url.mjs";
-export { WithDepositReadyPdf } from "./with-deposit-ready-pdf.mjs";
-//# sourceMappingURL=index.mjs.map

package/resources/cheques/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/cheques/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,WAAW,EACX,OAAO,GAKR;OACM,EAAE,GAAG,EAA4B;OACjC,EAAE,mBAAmB,EAAE"}

package/resources/cheques/url.d.ts

@@ -1,34 +0,0 @@
-import { APIResource } from "../../resource.js";
-import * as Core from "../../core.js";
-export declare class URL extends APIResource {
-    /**
-     * Retrieve a cheque preview URL.
-     *
-     * This is only available for customers with our document management addon, which
-     * offers document generation and hosting capabilities. This endpoint has a much
-     * higher rate limit than the regular order retrieval endpoint, so it is suitable
-     * for customer-facing use-cases.
-     *
-     * @example
-     * ```ts
-     * const url = await client.cheques.url.retrieve('id');
-     * ```
-     */
-    retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<URLRetrieveResponse>;
-}
-export interface URLRetrieveResponse {
-    /**
-     * A unique ID prefixed with cheque\_
-     */
-    id: string;
-    object: string;
-    /**
-     * A signed URL linking to the order preview PDF. The link remains valid for 15
-     * minutes from the time of the API call.
-     */
-    url: string;
-}
-export declare namespace URL {
-    export { type URLRetrieveResponse as URLRetrieveResponse };
-}
-//# sourceMappingURL=url.d.ts.map

package/resources/cheques/url.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../src/resources/cheques/url.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,GAAI,SAAQ,WAAW;IAClC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAG1F;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CAC5D"}

package/resources/cheques/url.js

@@ -1,25 +0,0 @@
-"use strict";
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.URL = void 0;
-const resource_1 = require("../../resource.js");
-class URL extends resource_1.APIResource {
-    /**
-     * Retrieve a cheque preview URL.
-     *
-     * This is only available for customers with our document management addon, which
-     * offers document generation and hosting capabilities. This endpoint has a much
-     * higher rate limit than the regular order retrieval endpoint, so it is suitable
-     * for customer-facing use-cases.
-     *
-     * @example
-     * ```ts
-     * const url = await client.cheques.url.retrieve('id');
-     * ```
-     */
-    retrieve(id, options) {
-        return this._client.get(`/cheques/${id}/url`, options);
-    }
-}
-exports.URL = URL;
-//# sourceMappingURL=url.js.map

package/resources/cheques/url.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"url.js","sourceRoot":"","sources":["../../src/resources/cheques/url.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,GAAI,SAAQ,sBAAW;IAClC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AAjBD,kBAiBC"}

package/resources/cheques/url.mjs

@@ -1,21 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../../resource.mjs";
-export class URL extends APIResource {
-    /**
-     * Retrieve a cheque preview URL.
-     *
-     * This is only available for customers with our document management addon, which
-     * offers document generation and hosting capabilities. This endpoint has a much
-     * higher rate limit than the regular order retrieval endpoint, so it is suitable
-     * for customer-facing use-cases.
-     *
-     * @example
-     * ```ts
-     * const url = await client.cheques.url.retrieve('id');
-     * ```
-     */
-    retrieve(id, options) {
-        return this._client.get(`/cheques/${id}/url`, options);
-    }
-}
-//# sourceMappingURL=url.mjs.map

package/resources/cheques/url.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"url.mjs","sourceRoot":"","sources":["../../src/resources/cheques/url.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,GAAI,SAAQ,WAAW;IAClC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF"}

package/resources/cheques/with-deposit-ready-pdf.d.ts

@@ -1,19 +0,0 @@
-import { APIResource } from "../../resource.js";
-import * as Core from "../../core.js";
-import * as ChequesAPI from "./cheques.js";
-export declare class WithDepositReadyPdf extends APIResource {
-    /**
-     * Retrieve the deposit-ready PDF for a digital-only cheque. The endpoint can only
-     * be called by users with 'Admin' role. In test mode, the preview PDF of the
-     * digitalOnly cheque and the deposit-ready PDF are the same. In live mode, the
-     * deposit-ready will have the full account number.
-     *
-     * @example
-     * ```ts
-     * const cheque =
-     *   await client.cheques.withDepositReadyPdf.retrieve('id');
-     * ```
-     */
-    retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<ChequesAPI.Cheque>;
-}
-//# sourceMappingURL=with-deposit-ready-pdf.d.ts.map

package/resources/cheques/with-deposit-ready-pdf.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"with-deposit-ready-pdf.d.ts","sourceRoot":"","sources":["../../src/resources/cheques/with-deposit-ready-pdf.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,UAAU,MAAM,WAAW,CAAC;AAExC,qBAAa,mBAAoB,SAAQ,WAAW;IAClD;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC;CAGxF"}

package/resources/cheques/with-deposit-ready-pdf.js

@@ -1,24 +0,0 @@
-"use strict";
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WithDepositReadyPdf = void 0;
-const resource_1 = require("../../resource.js");
-class WithDepositReadyPdf extends resource_1.APIResource {
-    /**
-     * Retrieve the deposit-ready PDF for a digital-only cheque. The endpoint can only
-     * be called by users with 'Admin' role. In test mode, the preview PDF of the
-     * digitalOnly cheque and the deposit-ready PDF are the same. In live mode, the
-     * deposit-ready will have the full account number.
-     *
-     * @example
-     * ```ts
-     * const cheque =
-     *   await client.cheques.withDepositReadyPdf.retrieve('id');
-     * ```
-     */
-    retrieve(id, options) {
-        return this._client.get(`/cheques/${id}/with_deposit_ready_pdf`, options);
-    }
-}
-exports.WithDepositReadyPdf = WithDepositReadyPdf;
-//# sourceMappingURL=with-deposit-ready-pdf.js.map

package/resources/cheques/with-deposit-ready-pdf.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"with-deposit-ready-pdf.js","sourceRoot":"","sources":["../../src/resources/cheques/with-deposit-ready-pdf.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAI7C,MAAa,mBAAoB,SAAQ,sBAAW;IAClD;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;CACF;AAhBD,kDAgBC"}

package/resources/cheques/with-deposit-ready-pdf.mjs

@@ -1,20 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../../resource.mjs";
-export class WithDepositReadyPdf extends APIResource {
-    /**
-     * Retrieve the deposit-ready PDF for a digital-only cheque. The endpoint can only
-     * be called by users with 'Admin' role. In test mode, the preview PDF of the
-     * digitalOnly cheque and the deposit-ready PDF are the same. In live mode, the
-     * deposit-ready will have the full account number.
-     *
-     * @example
-     * ```ts
-     * const cheque =
-     *   await client.cheques.withDepositReadyPdf.retrieve('id');
-     * ```
-     */
-    retrieve(id, options) {
-        return this._client.get(`/cheques/${id}/with_deposit_ready_pdf`, options);
-    }
-}
-//# sourceMappingURL=with-deposit-ready-pdf.mjs.map

package/resources/cheques/with-deposit-ready-pdf.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"with-deposit-ready-pdf.mjs","sourceRoot":"","sources":["../../src/resources/cheques/with-deposit-ready-pdf.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,mBAAoB,SAAQ,WAAW;IAClD;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;CACF"}

package/resources/cheques.d.ts

@@ -1,2 +0,0 @@
-export * from "./cheques/index.js";
-//# sourceMappingURL=cheques.d.ts.map

package/resources/cheques.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"cheques.d.ts","sourceRoot":"","sources":["../src/resources/cheques.ts"],"names":[],"mappings":"AAEA,cAAc,iBAAiB,CAAC"}

package/resources/cheques.js

@@ -1,19 +0,0 @@
-"use strict";
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-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 });
-__exportStar(require("./cheques/index.js"), exports);
-//# sourceMappingURL=cheques.js.map

package/resources/cheques.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"cheques.js","sourceRoot":"","sources":["../src/resources/cheques.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;AAEtF,qDAAgC"}

package/resources/cheques.mjs

@@ -1,3 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-export * from "./cheques/index.mjs";
-//# sourceMappingURL=cheques.mjs.map

package/resources/cheques.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"cheques.mjs","sourceRoot":"","sources":["../src/resources/cheques.ts"],"names":[],"mappings":"AAAA,sFAAsF"}