postgrid-node 0.1.0-alpha.5 → 0.3.0

package/resources/print-mail/contacts.d.ts

@@ -0,0 +1,475 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Contacts extends APIResource {
+    /**
+     * Creates a contact. This will also verify the contact's address **if you create
+     * it using a live API key**. To sucessfully create a contact, either a
+     * `firstName`, a `companyName`, or both are required. You can supply both, but you
+     * **cannot** supply neither.
+     *
+     * You have the option to supply the entire address (except for `countryCode`) via
+     * `addressLine1`, in which case PostGrid will parse it automatically. However,
+     * this is **not guaranteed to be correct**, so we recommend passing along the
+     * structured address fields (`city`, `provinceOrState`, etc) if you have them.
+     *
+     * _Note that if you create a contact that has identical information to another
+     * contact, this will simply update the description of the existing contact and
+     * return it. This avoids creating duplicate contacts._
+     *
+     * @example
+     * ```ts
+     * const contact = await client.printMail.contacts.create({
+     *   addressLine1: '90 Canal St Suite 600, Boston MA 90210',
+     *   countryCode: 'US',
+     *   firstName: 'Kevin',
+     *   companyName: 'PostGrid',
+     * });
+     * ```
+     */
+    create(body: ContactCreateParams, options?: RequestOptions): APIPromise<Contact>;
+    /**
+     * Retrieve a contact.
+     *
+     * @example
+     * ```ts
+     * const contact = await client.printMail.contacts.retrieve(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<Contact>;
+    /**
+     * Get a list of contacts.
+     *
+     * @example
+     * ```ts
+     * const contacts = await client.printMail.contacts.list();
+     * ```
+     */
+    list(query?: ContactListParams | null | undefined, options?: RequestOptions): APIPromise<ContactListResponse>;
+    /**
+     * Delete a contact. Note that this will not affect orders that were sent to this
+     * contact.
+     *
+     * @example
+     * ```ts
+     * const contact = await client.printMail.contacts.delete(
+     *   'id',
+     * );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<ContactDeleteResponse>;
+}
+export interface Contact {
+    /**
+     * A unique ID prefixed with contact\_
+     */
+    id: string;
+    /**
+     * The first line of the contact's address.
+     */
+    addressLine1: string;
+    /**
+     * One of `verified`, `corrected`, or `failed`.
+     */
+    addressStatus: 'verified' | 'corrected' | 'failed';
+    /**
+     * The ISO 3611-1 country code of the contact's address.
+     */
+    countryCode: string;
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * Always `contact`.
+     */
+    object: 'contact';
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: string;
+    /**
+     * A series of human-readable errors/warnings that were raised when running the
+     * provided address through our address verification.
+     */
+    addressErrors?: string;
+    /**
+     * Second line of the contact's address, if applicable.
+     */
+    addressLine2?: string;
+    /**
+     * The city of the contact's address.
+     */
+    city?: string;
+    /**
+     * Company name of the contact.
+     */
+    companyName?: string;
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * Email of the contact.
+     */
+    email?: string;
+    /**
+     * First name of the contact.
+     */
+    firstName?: string;
+    /**
+     * If `true`, PostGrid will force this contact to have an `addressStatus` of
+     * `verified` even if our address verification system says otherwise.
+     */
+    forceVerifiedStatus?: boolean;
+    /**
+     * Job title of the contact.
+     */
+    jobTitle?: string;
+    /**
+     * Last name of the contact.
+     */
+    lastName?: string;
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Phone number of the contact.
+     */
+    phoneNumber?: string;
+    /**
+     * The postal or ZIP code of the contact's address.
+     */
+    postalOrZip?: string;
+    /**
+     * Province or state of the contact's address.
+     */
+    provinceOrState?: string;
+    /**
+     * If `true`, PostGrid will skip running this contact's address through our address
+     * verification system.
+     */
+    skipVerification?: boolean;
+}
+export type ContactCreate = ContactCreate.ContactCreateWithFirstName | ContactCreate.ContactCreateWithCompanyName;
+export declare namespace ContactCreate {
+    interface ContactCreateWithFirstName {
+        /**
+         * The first line of the contact's address.
+         */
+        addressLine1: string;
+        /**
+         * The ISO 3611-1 country code of the contact's address.
+         */
+        countryCode: string;
+        firstName: string;
+        /**
+         * Second line of the contact's address, if applicable.
+         */
+        addressLine2?: string;
+        /**
+         * The city of the contact's address.
+         */
+        city?: string;
+        /**
+         * Company name of the contact.
+         */
+        companyName?: string;
+        /**
+         * An optional string describing this resource. Will be visible in the API and the
+         * dashboard.
+         */
+        description?: string;
+        /**
+         * Email of the contact.
+         */
+        email?: string;
+        /**
+         * If `true`, PostGrid will force this contact to have an `addressStatus` of
+         * `verified` even if our address verification system says otherwise.
+         */
+        forceVerifiedStatus?: boolean;
+        /**
+         * Job title of the contact.
+         */
+        jobTitle?: string;
+        /**
+         * Last name of the contact.
+         */
+        lastName?: string;
+        /**
+         * See the section on Metadata.
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * Phone number of the contact.
+         */
+        phoneNumber?: string;
+        /**
+         * The postal or ZIP code of the contact's address.
+         */
+        postalOrZip?: string;
+        /**
+         * Province or state of the contact's address.
+         */
+        provinceOrState?: string;
+        /**
+         * If `true`, PostGrid will skip running this contact's address through our address
+         * verification system.
+         */
+        skipVerification?: boolean;
+    }
+    interface ContactCreateWithCompanyName {
+        /**
+         * The first line of the contact's address.
+         */
+        addressLine1: string;
+        companyName: string;
+        /**
+         * The ISO 3611-1 country code of the contact's address.
+         */
+        countryCode: string;
+        /**
+         * Second line of the contact's address, if applicable.
+         */
+        addressLine2?: string;
+        /**
+         * The city of the contact's address.
+         */
+        city?: string;
+        /**
+         * An optional string describing this resource. Will be visible in the API and the
+         * dashboard.
+         */
+        description?: string;
+        /**
+         * Email of the contact.
+         */
+        email?: string;
+        /**
+         * First name of the contact.
+         */
+        firstName?: string;
+        /**
+         * If `true`, PostGrid will force this contact to have an `addressStatus` of
+         * `verified` even if our address verification system says otherwise.
+         */
+        forceVerifiedStatus?: boolean;
+        /**
+         * Job title of the contact.
+         */
+        jobTitle?: string;
+        /**
+         * Last name of the contact.
+         */
+        lastName?: string;
+        /**
+         * See the section on Metadata.
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * Phone number of the contact.
+         */
+        phoneNumber?: string;
+        /**
+         * The postal or ZIP code of the contact's address.
+         */
+        postalOrZip?: string;
+        /**
+         * Province or state of the contact's address.
+         */
+        provinceOrState?: string;
+        /**
+         * If `true`, PostGrid will skip running this contact's address through our address
+         * verification system.
+         */
+        skipVerification?: boolean;
+    }
+}
+export interface ContactListResponse {
+    data: Array<Contact>;
+    limit: number;
+    object: 'list';
+    skip: number;
+    totalCount: number;
+}
+export interface ContactDeleteResponse {
+    /**
+     * A unique ID prefixed with contact\_
+     */
+    id: string;
+    deleted: true;
+    /**
+     * Always `contact`.
+     */
+    object: 'contact';
+}
+export type ContactCreateParams = ContactCreateParams.ContactCreateWithFirstName | ContactCreateParams.ContactCreateWithCompanyName;
+export declare namespace ContactCreateParams {
+    interface ContactCreateWithFirstName {
+        /**
+         * The first line of the contact's address.
+         */
+        addressLine1: string;
+        /**
+         * The ISO 3611-1 country code of the contact's address.
+         */
+        countryCode: string;
+        firstName: string;
+        /**
+         * Second line of the contact's address, if applicable.
+         */
+        addressLine2?: string;
+        /**
+         * The city of the contact's address.
+         */
+        city?: string;
+        /**
+         * Company name of the contact.
+         */
+        companyName?: string;
+        /**
+         * An optional string describing this resource. Will be visible in the API and the
+         * dashboard.
+         */
+        description?: string;
+        /**
+         * Email of the contact.
+         */
+        email?: string;
+        /**
+         * If `true`, PostGrid will force this contact to have an `addressStatus` of
+         * `verified` even if our address verification system says otherwise.
+         */
+        forceVerifiedStatus?: boolean;
+        /**
+         * Job title of the contact.
+         */
+        jobTitle?: string;
+        /**
+         * Last name of the contact.
+         */
+        lastName?: string;
+        /**
+         * See the section on Metadata.
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * Phone number of the contact.
+         */
+        phoneNumber?: string;
+        /**
+         * The postal or ZIP code of the contact's address.
+         */
+        postalOrZip?: string;
+        /**
+         * Province or state of the contact's address.
+         */
+        provinceOrState?: string;
+        /**
+         * If `true`, PostGrid will skip running this contact's address through our address
+         * verification system.
+         */
+        skipVerification?: boolean;
+    }
+    interface ContactCreateWithCompanyName {
+        /**
+         * The first line of the contact's address.
+         */
+        addressLine1: string;
+        companyName: string;
+        /**
+         * The ISO 3611-1 country code of the contact's address.
+         */
+        countryCode: string;
+        /**
+         * Second line of the contact's address, if applicable.
+         */
+        addressLine2?: string;
+        /**
+         * The city of the contact's address.
+         */
+        city?: string;
+        /**
+         * An optional string describing this resource. Will be visible in the API and the
+         * dashboard.
+         */
+        description?: string;
+        /**
+         * Email of the contact.
+         */
+        email?: string;
+        /**
+         * First name of the contact.
+         */
+        firstName?: string;
+        /**
+         * If `true`, PostGrid will force this contact to have an `addressStatus` of
+         * `verified` even if our address verification system says otherwise.
+         */
+        forceVerifiedStatus?: boolean;
+        /**
+         * Job title of the contact.
+         */
+        jobTitle?: string;
+        /**
+         * Last name of the contact.
+         */
+        lastName?: string;
+        /**
+         * See the section on Metadata.
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * Phone number of the contact.
+         */
+        phoneNumber?: string;
+        /**
+         * The postal or ZIP code of the contact's address.
+         */
+        postalOrZip?: string;
+        /**
+         * Province or state of the contact's address.
+         */
+        provinceOrState?: string;
+        /**
+         * If `true`, PostGrid will skip running this contact's address through our address
+         * verification system.
+         */
+        skipVerification?: boolean;
+    }
+}
+export interface ContactListParams {
+    limit?: number;
+    /**
+     * 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;
+    skip?: number;
+}
+export declare namespace Contacts {
+    export { type Contact as Contact, type ContactCreate as ContactCreate, type ContactListResponse as ContactListResponse, type ContactDeleteResponse as ContactDeleteResponse, type ContactCreateParams as ContactCreateParams, type ContactListParams as ContactListParams, };
+}
+//# sourceMappingURL=contacts.d.ts.map

package/resources/print-mail/contacts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contacts.d.ts","sourceRoot":"","sources":["../../src/resources/print-mail/contacts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIhF;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInE;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGhF;AAED,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,UAAU,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEnD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,MAAM,aAAa,GACrB,aAAa,CAAC,0BAA0B,GACxC,aAAa,CAAC,4BAA4B,CAAC;AAE/C,yBAAiB,aAAa,CAAC;IAC7B,UAAiB,0BAA0B;QACzC;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAE9B;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;;WAGG;QACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC5B;IAED,UAAiB,4BAA4B;QAC3C;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAE9B;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;;WAGG;QACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAErB,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,0BAA0B,GAC9C,mBAAmB,CAAC,4BAA4B,CAAC;AAErD,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,0BAA0B;QACzC;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAE9B;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;;WAGG;QACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC5B;IAED,UAAiB,4BAA4B;QAC3C;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAE9B;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;;WAGG;QACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/print-mail/contacts.js

@@ -0,0 +1,76 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Contacts = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+class Contacts extends resource_1.APIResource {
+    /**
+     * Creates a contact. This will also verify the contact's address **if you create
+     * it using a live API key**. To sucessfully create a contact, either a
+     * `firstName`, a `companyName`, or both are required. You can supply both, but you
+     * **cannot** supply neither.
+     *
+     * You have the option to supply the entire address (except for `countryCode`) via
+     * `addressLine1`, in which case PostGrid will parse it automatically. However,
+     * this is **not guaranteed to be correct**, so we recommend passing along the
+     * structured address fields (`city`, `provinceOrState`, etc) if you have them.
+     *
+     * _Note that if you create a contact that has identical information to another
+     * contact, this will simply update the description of the existing contact and
+     * return it. This avoids creating duplicate contacts._
+     *
+     * @example
+     * ```ts
+     * const contact = await client.printMail.contacts.create({
+     *   addressLine1: '90 Canal St Suite 600, Boston MA 90210',
+     *   countryCode: 'US',
+     *   firstName: 'Kevin',
+     *   companyName: 'PostGrid',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/print-mail/v1/contacts', { body, ...options });
+    }
+    /**
+     * Retrieve a contact.
+     *
+     * @example
+     * ```ts
+     * const contact = await client.printMail.contacts.retrieve(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/print-mail/v1/contacts/${id}`, options);
+    }
+    /**
+     * Get a list of contacts.
+     *
+     * @example
+     * ```ts
+     * const contacts = await client.printMail.contacts.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/print-mail/v1/contacts', { query, ...options });
+    }
+    /**
+     * Delete a contact. Note that this will not affect orders that were sent to this
+     * contact.
+     *
+     * @example
+     * ```ts
+     * const contact = await client.printMail.contacts.delete(
+     *   'id',
+     * );
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete((0, path_1.path) `/print-mail/v1/contacts/${id}`, options);
+    }
+}
+exports.Contacts = Contacts;
+//# sourceMappingURL=contacts.js.map

package/resources/print-mail/contacts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contacts.js","sourceRoot":"","sources":["../../src/resources/print-mail/contacts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAiD;AAEjD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,2BAA2B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,2BAA2B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;CACF;AAzED,4BAyEC"}

package/resources/print-mail/contacts.mjs

@@ -0,0 +1,72 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class Contacts extends APIResource {
+    /**
+     * Creates a contact. This will also verify the contact's address **if you create
+     * it using a live API key**. To sucessfully create a contact, either a
+     * `firstName`, a `companyName`, or both are required. You can supply both, but you
+     * **cannot** supply neither.
+     *
+     * You have the option to supply the entire address (except for `countryCode`) via
+     * `addressLine1`, in which case PostGrid will parse it automatically. However,
+     * this is **not guaranteed to be correct**, so we recommend passing along the
+     * structured address fields (`city`, `provinceOrState`, etc) if you have them.
+     *
+     * _Note that if you create a contact that has identical information to another
+     * contact, this will simply update the description of the existing contact and
+     * return it. This avoids creating duplicate contacts._
+     *
+     * @example
+     * ```ts
+     * const contact = await client.printMail.contacts.create({
+     *   addressLine1: '90 Canal St Suite 600, Boston MA 90210',
+     *   countryCode: 'US',
+     *   firstName: 'Kevin',
+     *   companyName: 'PostGrid',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/print-mail/v1/contacts', { body, ...options });
+    }
+    /**
+     * Retrieve a contact.
+     *
+     * @example
+     * ```ts
+     * const contact = await client.printMail.contacts.retrieve(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get(path `/print-mail/v1/contacts/${id}`, options);
+    }
+    /**
+     * Get a list of contacts.
+     *
+     * @example
+     * ```ts
+     * const contacts = await client.printMail.contacts.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/print-mail/v1/contacts', { query, ...options });
+    }
+    /**
+     * Delete a contact. Note that this will not affect orders that were sent to this
+     * contact.
+     *
+     * @example
+     * ```ts
+     * const contact = await client.printMail.contacts.delete(
+     *   'id',
+     * );
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete(path `/print-mail/v1/contacts/${id}`, options);
+    }
+}
+//# sourceMappingURL=contacts.mjs.map

package/resources/print-mail/contacts.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"contacts.mjs","sourceRoot":"","sources":["../../src/resources/print-mail/contacts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,2BAA2B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,2BAA2B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;CACF"}

package/resources/print-mail/index.d.mts

@@ -0,0 +1,16 @@
+export { BankAccounts, type BankAccount, type BankAccountCountryCode, type BankAccountListResponse, type BankAccountDeleteResponse, type BankAccountCreateParams, type BankAccountListParams, } from "./bank-accounts.mjs";
+export { Boxes, type Box, type BoxChequeBase, type Cancellation, type OrderImbStatus, type OrderMailingClass, type OrderStatus, type BoxListResponse, type BoxCreateParams, type BoxListParams, } from "./boxes.mjs";
+export { Campaigns, type Campaign, type CampaignListResponse, type CampaignDeleteResponse, type CampaignCreateParams, type CampaignUpdateParams, type CampaignListParams, type CampaignSendParams, } from "./campaigns.mjs";
+export { Cheques, type Cheque, type ChequeSize, type DigitalOnly, type ChequeListResponse, type ChequeRetrieveURLResponse, type ChequeCreateParams, type ChequeListParams, } from "./cheques.mjs";
+export { Contacts, type Contact, type ContactCreate, type ContactListResponse, type ContactDeleteResponse, type ContactCreateParams, type ContactListParams, } from "./contacts.mjs";
+export { Letters, type AddressPlacement, type AttachedPdf, type Letter, type LetterSize, type PlasticCard, type LetterListResponse, type LetterRetrieveURLResponse, type LetterCreateParams, type LetterListParams, } from "./letters.mjs";
+export { MailingListImports, type FileType, type MailingListImportResponse, type VerificationStatusCount, type MailingListImportListResponse, type MailingListImportDeleteResponse, type MailingListImportCreateParams, type MailingListImportUpdateParams, type MailingListImportListParams, } from "./mailing-list-imports.mjs";
+export { MailingLists, type MailingList, type MailingListUpdate, type MailingListListResponse, type MailingListDeleteResponse, type MailingListCreateParams, type MailingListUpdateParams, type MailingListListParams, type MailingListJobsParams, } from "./mailing-lists.mjs";
+export { OrderProfiles } from "./order-profiles/index.mjs";
+export { Postcards, type Postcard, type PostcardListResponse, type PostcardRetrieveURLResponse, type PostcardCreateParams, type PostcardListParams, } from "./postcards.mjs";
+export { PrintMail } from "./print-mail.mjs";
+export { Reports, type DeletedResponse, type Report, type ReportListResponse, type ReportCreateParams, type ReportUpdateParams, type ReportListParams, type ReportSampleParams, } from "./reports/index.mjs";
+export { SelfMailers, type SelfMailer, type SelfMailerListResponse, type SelfMailerRetrieveURLResponse, type SelfMailerCreateParams, type SelfMailerListParams, } from "./self-mailers.mjs";
+export { SubOrganizations, type EmailPreferences, type SubOrganization, type SubOrganizationUpdateResponse, type SubOrganizationListResponse, type SubOrganizationRetrieveUsersResponse, type SubOrganizationUpdateParams, type SubOrganizationListParams, type SubOrganizationRetrieveUsersParams, } from "./sub-organizations.mjs";
+export { Templates, type Template, type TemplateListResponse, type TemplateDeleteResponse, type TemplateCreateParams, type TemplateUpdateParams, type TemplateListParams, } from "./templates.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/print-mail/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/print-mail/index.ts"],"names":[],"mappings":"OAEO,EACL,YAAY,EACZ,KAAK,WAAW,EAChB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,GAC3B;OACM,EACL,KAAK,EACL,KAAK,GAAG,EACR,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,aAAa,GACnB;OACM,EACL,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,GACxB;OACM,EACL,OAAO,EACP,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,GACtB;OACM,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,GACvB;OACM,EACL,OAAO,EACP,KAAK,gBAAgB,EACrB,KAAK,WAAW,EAChB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,GACtB;OACM,EACL,kBAAkB,EAClB,KAAK,QAAQ,EACb,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,6BAA6B,EAClC,KAAK,+BAA+B,EACpC,KAAK,6BAA6B,EAClC,KAAK,6BAA6B,EAClC,KAAK,2BAA2B,GACjC;OACM,EACL,YAAY,EACZ,KAAK,WAAW,EAChB,KAAK,iBAAiB,EACtB,KAAK,uBAAuB,EAC5B,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,GAC3B;OACM,EAAE,aAAa,EAAE;OACjB,EACL,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,oBAAoB,EACzB,KAAK,2BAA2B,EAChC,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,GACxB;OACM,EAAE,SAAS,EAAE;OACb,EACL,OAAO,EACP,KAAK,eAAe,EACpB,KAAK,MAAM,EACX,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,GACxB;OACM,EACL,WAAW,EACX,KAAK,UAAU,EACf,KAAK,sBAAsB,EAC3B,KAAK,6BAA6B,EAClC,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,GAC1B;OACM,EACL,gBAAgB,EAChB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,6BAA6B,EAClC,KAAK,2BAA2B,EAChC,KAAK,oCAAoC,EACzC,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,EAC9B,KAAK,kCAAkC,GACxC;OACM,EACL,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,GACxB"}