postgrid-node 0.1.0-alpha.1

package/resources/campaigns.js

@@ -0,0 +1,67 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CampaignListResponsesList = exports.Campaigns = void 0;
+const resource_1 = require("../resource.js");
+const core_1 = require("../core.js");
+const pagination_1 = require("../pagination.js");
+class Campaigns extends resource_1.APIResource {
+    /**
+     * Create a new campaign.
+     *
+     * A campaign links a mailing list with a specific mail piece profile (letter,
+     * postcard, cheque, or self-mailer) to send bulk mail. Upon creation, the campaign
+     * enters the `drafting` status while assets are validated.
+     */
+    create(body, options) {
+        return this._client.post('/campaigns', { body, ...options });
+    }
+    /**
+     * Retrieve a specific campaign by its ID.
+     */
+    retrieve(id, options) {
+        return this._client.get(`/campaigns/${id}`, options);
+    }
+    /**
+     * Update an existing campaign.
+     *
+     * Campaigns can only be updated if they are in the `draft` or `changes_required`
+     * status. Updating a campaign will trigger reprocessing and set its status back to
+     * `drafting`.
+     */
+    update(id, body, options) {
+        return this._client.post(`/campaigns/${id}`, { body, ...options });
+    }
+    list(query = {}, options) {
+        if ((0, core_1.isRequestOptions)(query)) {
+            return this.list({}, query);
+        }
+        return this._client.getAPIList('/campaigns', CampaignListResponsesList, { query, ...options });
+    }
+    /**
+     * Delete a campaign.
+     *
+     * Campaigns can only be deleted if they are in `draft`, `changes_required`, or
+     * `ready` status. This also permanently deletes associated resources. This
+     * operation cannot be undone.
+     */
+    delete(id, options) {
+        return this._client.delete(`/campaigns/${id}`, options);
+    }
+    /**
+     * Send a campaign for processing.
+     *
+     * This action transitions a campaign from the `draft` status to `creating_orders`.
+     * You can optionally specify a future `sendDate`. Once sent, the campaign cannot
+     * be updated.
+     */
+    send(id, body, options) {
+        return this._client.post(`/campaigns/${id}/send`, { body, ...options });
+    }
+}
+exports.Campaigns = Campaigns;
+class CampaignListResponsesList extends pagination_1.List {
+}
+exports.CampaignListResponsesList = CampaignListResponsesList;
+Campaigns.CampaignListResponsesList = CampaignListResponsesList;
+//# sourceMappingURL=campaigns.js.map

package/resources/campaigns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaigns.js","sourceRoot":"","sources":["../src/resources/campaigns.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAE3C,iDAAsD;AAEtD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;OAMG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CACJ,EAAU,EACV,IAA0B,EAC1B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAaD,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,EAAU,EACV,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF;AAhFD,8BAgFC;AAED,MAAa,yBAA0B,SAAQ,iBAA0B;CAAG;AAA5E,8DAA4E;AA2uB5E,SAAS,CAAC,yBAAyB,GAAG,yBAAyB,CAAC"}

package/resources/campaigns.mjs

@@ -0,0 +1,62 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../resource.mjs";
+import { isRequestOptions } from "../core.mjs";
+import { List } from "../pagination.mjs";
+export class Campaigns extends APIResource {
+    /**
+     * Create a new campaign.
+     *
+     * A campaign links a mailing list with a specific mail piece profile (letter,
+     * postcard, cheque, or self-mailer) to send bulk mail. Upon creation, the campaign
+     * enters the `drafting` status while assets are validated.
+     */
+    create(body, options) {
+        return this._client.post('/campaigns', { body, ...options });
+    }
+    /**
+     * Retrieve a specific campaign by its ID.
+     */
+    retrieve(id, options) {
+        return this._client.get(`/campaigns/${id}`, options);
+    }
+    /**
+     * Update an existing campaign.
+     *
+     * Campaigns can only be updated if they are in the `draft` or `changes_required`
+     * status. Updating a campaign will trigger reprocessing and set its status back to
+     * `drafting`.
+     */
+    update(id, body, options) {
+        return this._client.post(`/campaigns/${id}`, { body, ...options });
+    }
+    list(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list({}, query);
+        }
+        return this._client.getAPIList('/campaigns', CampaignListResponsesList, { query, ...options });
+    }
+    /**
+     * Delete a campaign.
+     *
+     * Campaigns can only be deleted if they are in `draft`, `changes_required`, or
+     * `ready` status. This also permanently deletes associated resources. This
+     * operation cannot be undone.
+     */
+    delete(id, options) {
+        return this._client.delete(`/campaigns/${id}`, options);
+    }
+    /**
+     * Send a campaign for processing.
+     *
+     * This action transitions a campaign from the `draft` status to `creating_orders`.
+     * You can optionally specify a future `sendDate`. Once sent, the campaign cannot
+     * be updated.
+     */
+    send(id, body, options) {
+        return this._client.post(`/campaigns/${id}/send`, { body, ...options });
+    }
+}
+export class CampaignListResponsesList extends List {
+}
+Campaigns.CampaignListResponsesList = CampaignListResponsesList;
+//# sourceMappingURL=campaigns.mjs.map

package/resources/campaigns.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaigns.mjs","sourceRoot":"","sources":["../src/resources/campaigns.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;OAMG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CACJ,EAAU,EACV,IAA0B,EAC1B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAaD,IAAI,CACF,QAAkD,EAAE,EACpD,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,YAAY,EAAE,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,EAAU,EACV,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,IAA0B;CAAG;AA2uB5E,SAAS,CAAC,yBAAyB,GAAG,yBAAyB,CAAC"}

package/resources/cheques/cheques.d.ts

@@ -0,0 +1,349 @@
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
+import * as ContactsAPI from "../contacts.js";
+import * as Shared from "../shared.js";
+import * as URLAPI from "./url.js";
+import { URL, URLRetrieveResponse } from "./url.js";
+import * as WithDepositReadyPdfAPI from "./with-deposit-ready-pdf.js";
+import { WithDepositReadyPdf } from "./with-deposit-ready-pdf.js";
+import { List, type ListParams } from "../../pagination.js";
+export declare class Cheques extends APIResource {
+    url: URLAPI.URL;
+    withDepositReadyPdf: WithDepositReadyPdfAPI.WithDepositReadyPdf;
+    /**
+     * 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"
+     *   }
+     * }
+     * ```
+     */
+    create(body: ChequeCreateParams, options?: Core.RequestOptions): Core.APIPromise<Cheque>;
+    /**
+     * Retrieve a cheque by ID.
+     */
+    retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Cheque>;
+    /**
+     * Get a list of cheques.
+     */
+    list(query?: ChequeListParams, options?: Core.RequestOptions): Core.PagePromise<ChequesList, Cheque>;
+    list(options?: Core.RequestOptions): Core.PagePromise<ChequesList, Cheque>;
+    /**
+     * Cancel a cheque by ID. Note that this operation cannot be undone.
+     */
+    cancel(id: string, options?: Core.RequestOptions): Core.APIPromise<Cheque>;
+}
+export declare class ChequesList extends List<Cheque> {
+}
+export interface Cheque {
+    /**
+     * A unique ID prefixed with cheque\_
+     */
+    id: string;
+    /**
+     * The amount of the cheque in cents.
+     */
+    amount: number;
+    /**
+     * The bank account (ID) associated with the cheque.
+     */
+    bankAccount: string;
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * The currency code of the cheque. This can be `USD` even if drawing from a
+     * Canadian bank account and vice versa. Defaults to the currency of the bank
+     * account country if not otherwise specified.
+     */
+    currencyCode: 'USD' | 'CAD';
+    /**
+     * The contact information of the sender.
+     */
+    from: ContactsAPI.Contact;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * The mailing class of this order. This determines the speed and cost of delivery.
+     * See `OrderMailingClass` for more details.
+     */
+    mailingClass: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
+    /**
+     * Always `cheque`.
+     */
+    object: 'cheque';
+    /**
+     * This order will transition from `ready` to `printing` on the day after this
+     * date. For example, if this is a date on Tuesday, the order will transition to
+     * `printing` on Wednesday at midnight eastern time.
+     */
+    sendDate: string;
+    /**
+     * Enum representing the supported cheque sizes.
+     */
+    size: 'us_letter' | 'us_legal';
+    /**
+     * See `OrderStatus` for more details on the status of this order.
+     */
+    status: 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled';
+    /**
+     * The recipient of this order. This will be provided even if you delete the
+     * underlying contact.
+     */
+    to: ContactsAPI.Contact;
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: string;
+    /**
+     * The cancellation details of this order. Populated if the order has been
+     * cancelled.
+     */
+    cancellation?: Shared.Cancellation;
+    /**
+     * A link to the deposit-ready PDF for a digital-only cheque, returned if requested
+     * and available.
+     */
+    depositReadyPDFURL?: string;
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * The digitalOnly object contains data for digital-only cheques. A watermark must
+     * be provided.
+     */
+    digitalOnly?: Cheque.DigitalOnly;
+    /**
+     * The envelope of the cheque. If a custom envelope ID is not specified, defaults
+     * to `standard`.
+     */
+    envelope?: 'standard' | (string & {});
+    /**
+     * The last date that the IMB status was updated. See `imbStatus` for more details.
+     */
+    imbDate?: string;
+    /**
+     * The Intelligent Mail Barcode (IMB) status of this order. Only populated for
+     * US-printed and US-destined orders. This is the most detailed way to track
+     * non-express/certified orders.
+     */
+    imbStatus?: 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender';
+    /**
+     * The most recent ZIP code of the USPS facility that the order has been processed
+     * through. Only populated when an `imbStatus` is present.
+     */
+    imbZIPCode?: string;
+    /**
+     * An optional logo URL for the cheque. This will be placed next to the recipient
+     * address at the top left corner of the cheque. This needs to be a public link to
+     * an image file (e.g. a PNG or JPEG file).
+     */
+    logoURL?: string;
+    /**
+     * The memo of the cheque.
+     */
+    memo?: string;
+    /**
+     * These will be merged with the variables in the template or HTML you create this
+     * order with. The keys in this object should match the variable names in the
+     * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
+     * PDFs uploaded with the order.
+     */
+    mergeVariables?: Record<string, unknown>;
+    /**
+     * The message of the cheque.
+     */
+    message?: string;
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * The number of the cheque. If you don't provide this, it will automatically be
+     * set to an incrementing number starting from 1 across your entire account,
+     * ensuring that every cheque has a unique number.
+     */
+    number?: number;
+    /**
+     * The tracking number of this order. Populated after an express/certified order
+     * has been processed for delivery.
+     */
+    trackingNumber?: string;
+    /**
+     * PostGrid renders a PDF preview for all orders. This should be inspected to
+     * ensure that the order is correct before it is sent out because it shows what
+     * will be printed and mailed to the recipient. Once the PDF preview is generated,
+     * this field will be returned by all `GET` endpoints which produce this order.
+     *
+     * This URL is a signed link to the PDF preview. It will expire after a short
+     * period of time. If you need to access this URL after it has expired, you can
+     * regenerate it by calling the `GET` endpoint again.
+     */
+    url?: string;
+}
+export declare namespace Cheque {
+    /**
+     * The digitalOnly object contains data for digital-only cheques. A watermark must
+     * be provided.
+     */
+    interface DigitalOnly {
+        /**
+         * Text to be displayed as a watermark on the digital cheque.
+         */
+        watermark: string;
+    }
+}
+export interface ChequeList {
+    data: Array<Cheque>;
+    limit: number;
+    object: 'list';
+    skip: number;
+    totalCount: number;
+}
+export interface ChequeCreateParams {
+    /**
+     * The amount of the cheque in cents.
+     */
+    amount: number;
+    /**
+     * The bank account (ID) associated with the cheque.
+     */
+    bankAccount: string;
+    /**
+     * The contact information of the sender. You can pass contact information inline
+     * here just like you can for the `to`.
+     */
+    from: Shared.ContactCreateWithFirstName | Shared.ContactCreateWithCompanyName | string;
+    /**
+     * The recipient of this order. You can either supply the contact information
+     * inline here or provide a contact ID. PostGrid will automatically deduplicate
+     * contacts regardless of whether you provide the information inline here or call
+     * the contact creation endpoint.
+     */
+    to: Shared.ContactCreateWithFirstName | Shared.ContactCreateWithCompanyName | string;
+    /**
+     * The currency code of the cheque. This will be set to the default currency of the
+     * bank account (`USD` for US bank accounts and `CAD` for Canadian bank accounts)
+     * if not provided. You can set this value to `USD` if you want to draw USD from a
+     * Canadian bank account or vice versa.
+     */
+    currencyCode?: 'USD' | 'CAD';
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * The digitalOnly object contains data for digital-only cheques. A watermark must
+     * be provided.
+     */
+    digitalOnly?: ChequeCreateParams.DigitalOnly;
+    /**
+     * The envelope of the cheque. If a custom envelope ID is not specified, defaults
+     * to `standard`.
+     */
+    envelope?: 'standard' | (string & {});
+    /**
+     * An optional logo URL for the cheque. This will be placed next to the recipient
+     * address at the top left corner of the cheque. This needs to be a public link to
+     * an image file (e.g. a PNG or JPEG file).
+     */
+    logoURL?: string;
+    /**
+     * The mailing class of this order. If not provided, automatically set to
+     * `first_class`.
+     */
+    mailingClass?: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
+    /**
+     * The memo of the cheque.
+     */
+    memo?: string;
+    /**
+     * These will be merged with the variables in the template or HTML you create this
+     * order with. The keys in this object should match the variable names in the
+     * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
+     * PDFs uploaded with the order.
+     */
+    mergeVariables?: Record<string, unknown>;
+    /**
+     * The message of the cheque.
+     */
+    message?: string;
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * The number of the cheque. If you don't provide this, it will automatically be
+     * set to an incrementing number starting from 1 across your entire account,
+     * ensuring that every cheque has a unique number.
+     */
+    number?: number;
+    /**
+     * Providing this inserts a blank page at the start of the cheque with the
+     * recipient you provide here. This leaves the cheque that follows intact, which
+     * means you can use this to intercept at cheque at the redirected address and then
+     * mail it forward to the final recipient yourself. One use case for this is
+     * signing cheques at your office before mailing them out yourself.
+     */
+    redirectTo?: Shared.ContactCreateWithFirstName | Shared.ContactCreateWithCompanyName | string;
+    /**
+     * This order will transition from `ready` to `printing` on the day after this
+     * date. You can use this parameter to schedule orders for a future date.
+     */
+    sendDate?: string;
+    /**
+     * Enum representing the supported cheque sizes.
+     */
+    size?: 'us_letter' | 'us_legal';
+}
+export declare namespace ChequeCreateParams {
+    /**
+     * The digitalOnly object contains data for digital-only cheques. A watermark must
+     * be provided.
+     */
+    interface DigitalOnly {
+        /**
+         * Text to be displayed as a watermark on the digital cheque.
+         */
+        watermark: string;
+    }
+}
+export interface ChequeListParams extends ListParams {
+    /**
+     * You can supply any string to help narrow down the list of resources. For
+     * example, if you pass `"New York"` (quoted), it will return resources that have
+     * that string present somewhere in their response. Alternatively, you can supply a
+     * structured search query. See the documentation on `StructuredSearchQuery` for
+     * more details.
+     */
+    search?: string;
+}
+export declare namespace Cheques {
+    export { type Cheque as Cheque, type ChequeList as ChequeList, ChequesList as ChequesList, type ChequeCreateParams as ChequeCreateParams, type ChequeListParams as ChequeListParams, };
+    export { URL as URL, type URLRetrieveResponse as URLRetrieveResponse };
+    export { WithDepositReadyPdf as WithDepositReadyPdf };
+}
+//# sourceMappingURL=cheques.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cheques.d.ts","sourceRoot":"","sources":["../../src/resources/cheques/cheques.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,WAAW,MAAM,aAAa,CAAC;AAC3C,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,MAAM,MAAM,OAAO,CAAC;AAChC,OAAO,EAAE,GAAG,EAAE,mBAAmB,EAAE,MAAM,OAAO,CAAC;AACjD,OAAO,KAAK,sBAAsB,MAAM,0BAA0B,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEzD,qBAAa,OAAQ,SAAQ,WAAW;IACtC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAgC;IAC/C,mBAAmB,EAAE,sBAAsB,CAAC,mBAAmB,CACA;IAE/D;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAIxF;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAI5E;;OAEG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC;IACpG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC;IAW1E;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;CAG3E;AAED,qBAAa,WAAY,SAAQ,IAAI,CAAC,MAAM,CAAC;CAAG;AAEhD,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,YAAY,EAAE,KAAK,GAAG,KAAK,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EACR,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,WAAW,GAAG,UAAU,CAAC;IAE/B;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;IAEpF;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC;IAEnC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;IAEjC;;;OAGG;IACH,QAAQ,CAAC,EAAE,UAAU,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IAEtC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,MAAM,CAAC;IACtB;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;IAEvF;;;;;OAKG;IACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;IAErF;;;;;OAKG;IACH,YAAY,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;IAE7B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC,WAAW,CAAC;IAE7C;;;OAGG;IACH,QAAQ,CAAC,EAAE,UAAU,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IAEtC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;IAE9F;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;CACjC;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAMD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,UAAU,IAAI,UAAU,EAC7B,WAAW,IAAI,WAAW,EAC1B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EAAE,GAAG,IAAI,GAAG,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;IAEvE,OAAO,EAAE,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CACvD"}

package/resources/cheques/cheques.js

@@ -0,0 +1,95 @@
+"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 __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);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChequesList = exports.Cheques = void 0;
+const resource_1 = require("../../resource.js");
+const core_1 = require("../../core.js");
+const URLAPI = __importStar(require("./url.js"));
+const url_1 = require("./url.js");
+const WithDepositReadyPdfAPI = __importStar(require("./with-deposit-ready-pdf.js"));
+const with_deposit_ready_pdf_1 = require("./with-deposit-ready-pdf.js");
+const pagination_1 = require("../../pagination.js");
+class Cheques extends resource_1.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"
+     *   }
+     * }
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/cheques', { body, ...options });
+    }
+    /**
+     * Retrieve a cheque by ID.
+     */
+    retrieve(id, options) {
+        return this._client.get(`/cheques/${id}`, options);
+    }
+    list(query = {}, options) {
+        if ((0, core_1.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.
+     */
+    cancel(id, options) {
+        return this._client.delete(`/cheques/${id}`, options);
+    }
+}
+exports.Cheques = Cheques;
+class ChequesList extends pagination_1.List {
+}
+exports.ChequesList = ChequesList;
+Cheques.ChequesList = ChequesList;
+Cheques.URL = url_1.URL;
+Cheques.WithDepositReadyPdf = with_deposit_ready_pdf_1.WithDepositReadyPdf;
+//# sourceMappingURL=cheques.js.map

package/resources/cheques/cheques.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cheques.js","sourceRoot":"","sources":["../../src/resources/cheques/cheques.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAI9C,iDAAgC;AAChC,kCAAiD;AACjD,oFAAmE;AACnE,wEAA+D;AAC/D,oDAAyD;AAEzD,MAAa,OAAQ,SAAQ,sBAAW;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;IA2DjE,CAAC;IAzDC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;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;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAOD,IAAI,CACF,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,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;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CACF;AA9DD,0BA8DC;AAED,MAAa,WAAY,SAAQ,iBAAY;CAAG;AAAhD,kCAAgD;AA+YhD,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;AAClC,OAAO,CAAC,GAAG,GAAG,SAAG,CAAC;AAClB,OAAO,CAAC,mBAAmB,GAAG,4CAAmB,CAAC"}

package/resources/cheques/cheques.mjs

@@ -0,0 +1,67 @@
+// 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"
+     *   }
+     * }
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/cheques', { body, ...options });
+    }
+    /**
+     * Retrieve a cheque by 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.
+     */
+    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

@@ -0,0 +1 @@
+{"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;IA2DjE,CAAC;IAzDC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;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;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAOD,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;;OAEG;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"}