postgrid-node 0.1.0-alpha.1

package/resources/letters.js

@@ -0,0 +1,55 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LettersList = exports.Letters = void 0;
+const resource_1 = require("../resource.js");
+const core_1 = require("../core.js");
+const pagination_1 = require("../pagination.js");
+class Letters extends resource_1.APIResource {
+    /**
+     * Create a letter. Note that you can supply one of the following:
+     *
+     * - HTML content for the letter
+     * - A template ID for the letter
+     * - A URL or file for a PDF for the letter
+     * - Upload the aforementioned PDF file via a multipart form upload request
+     */
+    create(body, options) {
+        return this._client.post('/letters', { body, ...options });
+    }
+    /**
+     * Retrieve a letter by ID.
+     */
+    retrieve(id, options) {
+        return this._client.get(`/letters/${id}`, options);
+    }
+    list(query = {}, options) {
+        if ((0, core_1.isRequestOptions)(query)) {
+            return this.list({}, query);
+        }
+        return this._client.getAPIList('/letters', LettersList, { query, ...options });
+    }
+    /**
+     * Cancel a letter by ID. Note that this operation cannot be undone.
+     */
+    delete(id, options) {
+        return this._client.delete(`/letters/${id}`, options);
+    }
+    /**
+     * Retrieve a letter 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.
+     */
+    url(id, options) {
+        return this._client.get(`/letters/${id}/url`, options);
+    }
+}
+exports.Letters = Letters;
+class LettersList extends pagination_1.List {
+}
+exports.LettersList = LettersList;
+Letters.LettersList = LettersList;
+//# sourceMappingURL=letters.js.map

package/resources/letters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"letters.js","sourceRoot":"","sources":["../src/resources/letters.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAI3C,iDAAsD;AAEtD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;OAOG;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;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,EAAU,EAAE,OAA6B;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AArDD,0BAqDC;AAED,MAAa,WAAY,SAAQ,iBAAY;CAAG;AAAhD,kCAAgD;AA0xBhD,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC"}

package/resources/letters.mjs

@@ -0,0 +1,50 @@
+// 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 Letters extends APIResource {
+    /**
+     * Create a letter. Note that you can supply one of the following:
+     *
+     * - HTML content for the letter
+     * - A template ID for the letter
+     * - A URL or file for a PDF for the letter
+     * - Upload the aforementioned PDF file via a multipart form upload request
+     */
+    create(body, options) {
+        return this._client.post('/letters', { body, ...options });
+    }
+    /**
+     * Retrieve a letter by ID.
+     */
+    retrieve(id, options) {
+        return this._client.get(`/letters/${id}`, options);
+    }
+    list(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list({}, query);
+        }
+        return this._client.getAPIList('/letters', LettersList, { query, ...options });
+    }
+    /**
+     * Cancel a letter by ID. Note that this operation cannot be undone.
+     */
+    delete(id, options) {
+        return this._client.delete(`/letters/${id}`, options);
+    }
+    /**
+     * Retrieve a letter 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.
+     */
+    url(id, options) {
+        return this._client.get(`/letters/${id}/url`, options);
+    }
+}
+export class LettersList extends List {
+}
+Letters.LettersList = LettersList;
+//# sourceMappingURL=letters.mjs.map

package/resources/letters.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"letters.mjs","sourceRoot":"","sources":["../src/resources/letters.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;OAOG;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;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,EAAU,EAAE,OAA6B;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,IAAY;CAAG;AA0xBhD,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC"}

package/resources/postcards.d.ts

@@ -0,0 +1,346 @@
+import { APIResource } from "../resource.js";
+import * as Core from "../core.js";
+import * as ContactsAPI from "./contacts.js";
+import * as Shared from "./shared.js";
+import { List, type ListParams } from "../pagination.js";
+export declare class Postcards extends APIResource {
+    /**
+     * Create a postcard. Note that you can supply one of the following:
+     *
+     * - HTML content for the front and back of the postcard
+     * - A template ID for the front and back of the postcard
+     * - A URL or file for a 2 page PDF where the first page is the front of the
+     *   postcard and the second page is the back
+     * - Upload the aforementioned PDF file via a multipart form upload request
+     */
+    create(body: PostcardCreateParams, options?: Core.RequestOptions): Core.APIPromise<Postcard>;
+    /**
+     * Retrieve a postcard by ID.
+     */
+    retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Postcard>;
+    /**
+     * Get a list of postcards.
+     */
+    list(query?: PostcardListParams, options?: Core.RequestOptions): Core.PagePromise<PostcardsList, Postcard>;
+    list(options?: Core.RequestOptions): Core.PagePromise<PostcardsList, Postcard>;
+    /**
+     * Cancel a postcard by ID. Note that this operation cannot be undone.
+     */
+    delete(id: string, options?: Core.RequestOptions): Core.APIPromise<Postcard>;
+    /**
+     * Retrieve a postcard 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.
+     */
+    url(id: string, options?: Core.RequestOptions): Core.APIPromise<PostcardURLResponse>;
+}
+export declare class PostcardsList extends List<Postcard> {
+}
+export interface Postcard {
+    /**
+     * A unique ID prefixed with postcard\_
+     */
+    id: string;
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * `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 `postcard`.
+     */
+    object: 'postcard';
+    /**
+     * 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 postcard sizes.
+     */
+    size: '6x4' | '9x6' | '11x6';
+    /**
+     * 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;
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * The contact information of the sender.
+     */
+    from?: ContactsAPI.Contact;
+    /**
+     * 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;
+    /**
+     * 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>;
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * 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 interface PostcardList {
+    data: Array<Postcard>;
+    limit: number;
+    object: 'list';
+    skip: number;
+    totalCount: number;
+}
+export interface PostcardURLResponse {
+    /**
+     * A unique ID prefixed with postcard\_
+     */
+    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 type PostcardCreateParams = PostcardCreateParams.PostcardCreateWithHTML | PostcardCreateParams.PostcardCreateWithTemplate | PostcardCreateParams.PostcardCreateWithPdfurl | PostcardCreateParams.PostcardCreateWithPdfFile;
+export declare namespace PostcardCreateParams {
+    interface PostcardCreateWithHTML {
+        /**
+         * The HTML content for the back of the postcard. You can supply _either_ this or
+         * `backTemplate` but not both.
+         */
+        backHTML: string;
+        /**
+         * The HTML content for the front of the postcard. You can supply _either_ this or
+         * `frontTemplate` but not both.
+         */
+        frontHTML: string;
+        /**
+         * Enum representing the supported postcard sizes.
+         */
+        size: '6x4' | '9x6' | '11x6';
+        /**
+         * 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;
+        /**
+         * An optional string describing this resource. Will be visible in the API and the
+         * dashboard.
+         */
+        description?: string;
+        /**
+         * The contact information of the sender. You can pass contact information inline
+         * here just like you can for the `to`. Unlike other order types, the sender
+         * address is optional for postcards.
+         */
+        from?: Shared.ContactCreateWithFirstName | Shared.ContactCreateWithCompanyName | 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';
+        /**
+         * 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>;
+        /**
+         * See the section on Metadata.
+         */
+        metadata?: Record<string, unknown>;
+        /**
+         * 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;
+    }
+    interface PostcardCreateWithTemplate {
+        /**
+         * The template ID for the back of the postcard. You can supply _either_ this or
+         * `backHTML` but not both.
+         */
+        backTemplate: string;
+        /**
+         * The template ID for the front of the postcard. You can supply _either_ this or
+         * `frontHTML` but not both.
+         */
+        frontTemplate: string;
+    }
+    interface PostcardCreateWithPdfurl {
+        /**
+         * A URL pointing to a 2 page PDF file. The first page is the front of the postcard
+         * and the second page is the back (where the address will be stamped on).
+         */
+        pdf: string;
+        /**
+         * Enum representing the supported postcard sizes.
+         */
+        size: '6x4' | '9x6' | '11x6';
+        /**
+         * 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;
+        /**
+         * An optional string describing this resource. Will be visible in the API and the
+         * dashboard.
+         */
+        description?: string;
+        /**
+         * The contact information of the sender. You can pass contact information inline
+         * here just like you can for the `to`. Unlike other order types, the sender
+         * address is optional for postcards.
+         */
+        from?: Shared.ContactCreateWithFirstName | Shared.ContactCreateWithCompanyName | 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';
+        /**
+         * 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>;
+        /**
+         * See the section on Metadata.
+         */
+        metadata?: Record<string, unknown>;
+        /**
+         * 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;
+    }
+    interface PostcardCreateWithPdfFile {
+        /**
+         * A 2 page PDF file. The first page is the front of the postcard and the second
+         * page is the back (where the address will be stamped on).
+         */
+        pdf: string;
+        /**
+         * Enum representing the supported postcard sizes.
+         */
+        size: '6x4' | '9x6' | '11x6';
+        /**
+         * 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;
+        /**
+         * An optional string describing this resource. Will be visible in the API and the
+         * dashboard.
+         */
+        description?: string;
+        /**
+         * The contact information of the sender. You can pass contact information inline
+         * here just like you can for the `to`. Unlike other order types, the sender
+         * address is optional for postcards.
+         */
+        from?: Shared.ContactCreateWithFirstName | Shared.ContactCreateWithCompanyName | 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';
+        /**
+         * 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>;
+        /**
+         * See the section on Metadata.
+         */
+        metadata?: Record<string, unknown>;
+        /**
+         * 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;
+    }
+}
+export interface PostcardListParams 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 Postcards {
+    export { type Postcard as Postcard, type PostcardList as PostcardList, type PostcardURLResponse as PostcardURLResponse, PostcardsList as PostcardsList, type PostcardCreateParams as PostcardCreateParams, type PostcardListParams as PostcardListParams, };
+}
+//# sourceMappingURL=postcards.d.ts.map

package/resources/postcards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"postcards.d.ts","sourceRoot":"","sources":["../src/resources/postcards.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;IAI5F;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;IAI9E;;OAEG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,QAAQ,CAAC;IAC1G,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,QAAQ,CAAC;IAW9E;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;IAI5E;;;;;;;OAOG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAGrF;AAED,qBAAa,aAAc,SAAQ,IAAI,CAAC,QAAQ,CAAC;CAAG;AAEpD,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;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,UAAU,CAAC;IAEnB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAE7B;;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,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;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;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAEtB,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;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,MAAM,oBAAoB,GAC5B,oBAAoB,CAAC,sBAAsB,GAC3C,oBAAoB,CAAC,0BAA0B,GAC/C,oBAAoB,CAAC,wBAAwB,GAC7C,oBAAoB,CAAC,yBAAyB,CAAC;AAEnD,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,UAAiB,sBAAsB;QACrC;;;WAGG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;QAE7B;;;;;WAKG;QACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAErF;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;WAIG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAExF;;;WAGG;QACH,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;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEzC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEnC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,0BAA0B;QACzC;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,aAAa,EAAE,MAAM,CAAC;KACvB;IAED,UAAiB,wBAAwB;QACvC;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;QAE7B;;;;;WAKG;QACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAErF;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;WAIG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAExF;;;WAGG;QACH,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;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEzC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEnC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,yBAAyB;QACxC;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;QAE7B;;;;;WAKG;QACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAErF;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;WAIG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAExF;;;WAGG;QACH,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;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEzC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEnC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,aAAa,IAAI,aAAa,EAC9B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/postcards.js

@@ -0,0 +1,56 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostcardsList = exports.Postcards = void 0;
+const resource_1 = require("../resource.js");
+const core_1 = require("../core.js");
+const pagination_1 = require("../pagination.js");
+class Postcards extends resource_1.APIResource {
+    /**
+     * Create a postcard. Note that you can supply one of the following:
+     *
+     * - HTML content for the front and back of the postcard
+     * - A template ID for the front and back of the postcard
+     * - A URL or file for a 2 page PDF where the first page is the front of the
+     *   postcard and the second page is the back
+     * - Upload the aforementioned PDF file via a multipart form upload request
+     */
+    create(body, options) {
+        return this._client.post('/postcards', { body, ...options });
+    }
+    /**
+     * Retrieve a postcard by ID.
+     */
+    retrieve(id, options) {
+        return this._client.get(`/postcards/${id}`, options);
+    }
+    list(query = {}, options) {
+        if ((0, core_1.isRequestOptions)(query)) {
+            return this.list({}, query);
+        }
+        return this._client.getAPIList('/postcards', PostcardsList, { query, ...options });
+    }
+    /**
+     * Cancel a postcard by ID. Note that this operation cannot be undone.
+     */
+    delete(id, options) {
+        return this._client.delete(`/postcards/${id}`, options);
+    }
+    /**
+     * Retrieve a postcard 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.
+     */
+    url(id, options) {
+        return this._client.get(`/postcards/${id}/url`, options);
+    }
+}
+exports.Postcards = Postcards;
+class PostcardsList extends pagination_1.List {
+}
+exports.PostcardsList = PostcardsList;
+Postcards.PostcardsList = PostcardsList;
+//# sourceMappingURL=postcards.js.map

package/resources/postcards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"postcards.js","sourceRoot":"","sources":["../src/resources/postcards.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAI3C,iDAAsD;AAEtD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;OAQG;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;IAOD,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,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,EAAU,EAAE,OAA6B;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAtDD,8BAsDC;AAED,MAAa,aAAc,SAAQ,iBAAc;CAAG;AAApD,sCAAoD;AAudpD,SAAS,CAAC,aAAa,GAAG,aAAa,CAAC"}

package/resources/postcards.mjs

@@ -0,0 +1,51 @@
+// 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 Postcards extends APIResource {
+    /**
+     * Create a postcard. Note that you can supply one of the following:
+     *
+     * - HTML content for the front and back of the postcard
+     * - A template ID for the front and back of the postcard
+     * - A URL or file for a 2 page PDF where the first page is the front of the
+     *   postcard and the second page is the back
+     * - Upload the aforementioned PDF file via a multipart form upload request
+     */
+    create(body, options) {
+        return this._client.post('/postcards', { body, ...options });
+    }
+    /**
+     * Retrieve a postcard by ID.
+     */
+    retrieve(id, options) {
+        return this._client.get(`/postcards/${id}`, options);
+    }
+    list(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list({}, query);
+        }
+        return this._client.getAPIList('/postcards', PostcardsList, { query, ...options });
+    }
+    /**
+     * Cancel a postcard by ID. Note that this operation cannot be undone.
+     */
+    delete(id, options) {
+        return this._client.delete(`/postcards/${id}`, options);
+    }
+    /**
+     * Retrieve a postcard 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.
+     */
+    url(id, options) {
+        return this._client.get(`/postcards/${id}/url`, options);
+    }
+}
+export class PostcardsList extends List {
+}
+Postcards.PostcardsList = PostcardsList;
+//# sourceMappingURL=postcards.mjs.map

package/resources/postcards.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"postcards.mjs","sourceRoot":"","sources":["../src/resources/postcards.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;OAQG;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;IAOD,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,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,EAAU,EAAE,OAA6B;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,IAAc;CAAG;AAudpD,SAAS,CAAC,aAAa,GAAG,aAAa,CAAC"}