postgrid-node 0.1.0-alpha.4 → 0.2.0

package/resources/print-mail/sub-organizations.d.ts

@@ -0,0 +1,304 @@
+import { APIResource } from "../../core/resource.js";
+import * as SubOrganizationsAPI from "./sub-organizations.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class SubOrganizations extends APIResource {
+    /**
+     * Get a sub-organization.
+     *
+     * @example
+     * ```ts
+     * const subOrganization =
+     *   await client.printMail.subOrganizations.retrieve('id');
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<SubOrganization>;
+    /**
+     * When creating a user through the API, the verifiedEmail field will automatically
+     * be set to true. However, if public signups are used, the email will need to be
+     * verified by the user.
+     *
+     * @example
+     * ```ts
+     * const subOrganization =
+     *   await client.printMail.subOrganizations.update({
+     *     countryCode: 'CA',
+     *     email: 'suborg@postgrid.com',
+     *     name: 'Calvin',
+     *     organizationName: 'PostGrid',
+     *     password: 'very-strong-password',
+     *     phoneNumber: '9059059059',
+     *   });
+     * ```
+     */
+    update(body: SubOrganizationUpdateParams, options?: RequestOptions): APIPromise<SubOrganizationUpdateResponse>;
+    /**
+     * List sub-organizations.
+     *
+     * @example
+     * ```ts
+     * const subOrganizations =
+     *   await client.printMail.subOrganizations.list();
+     * ```
+     */
+    list(query?: SubOrganizationListParams | null | undefined, options?: RequestOptions): APIPromise<SubOrganizationListResponse>;
+    /**
+     * List users for a sub-organization.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.printMail.subOrganizations.retrieveUsers(
+     *     'id',
+     *   );
+     * ```
+     */
+    retrieveUsers(id: string, query?: SubOrganizationRetrieveUsersParams | null | undefined, options?: RequestOptions): APIPromise<SubOrganizationRetrieveUsersResponse>;
+}
+/**
+ * A set of preferences for how a user should receive emails.
+ */
+export interface EmailPreferences {
+    /**
+     * The list of preferences for receiving order preview emails.
+     */
+    orderPreviewSendPreference?: 'do_not_send' | 'send_live_only' | 'send_live_and_test';
+}
+/**
+ * The Sub-Organization object.
+ */
+export interface SubOrganization {
+    /**
+     * A unique ID prefixed with `sub_org_`.
+     */
+    id: string;
+    /**
+     * The country code of the sub-organization.
+     */
+    countryCode: string;
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * The limit of mailings the sub-organization can send before being charged
+     * overages for the month.
+     */
+    limit: number;
+    /**
+     * The name of the sub-organization.
+     */
+    name: string;
+    /**
+     * Always `sub_org`.
+     */
+    object: 'sub_org';
+    /**
+     * The current rolling charge for the sub-organization for the month, in cents.
+     */
+    spend: number;
+    /**
+     * The UTC time at which this resource was last update.
+     */
+    updatedAt: string;
+    /**
+     * The amount of mail the sub-organization has sent out this month.
+     */
+    usage: number;
+}
+export interface SubOrganizationUpdateResponse {
+    /**
+     * The Sub-Organization object.
+     */
+    subOrganization: SubOrganization;
+    /**
+     * The user object.
+     */
+    user: SubOrganizationUpdateResponse.User;
+}
+export declare namespace SubOrganizationUpdateResponse {
+    /**
+     * The user object.
+     */
+    interface User {
+        /**
+         * A unique ID prefixed with `user_`.
+         */
+        id: string;
+        /**
+         * The user's API keys. Contains live and test mode API keys.
+         */
+        apiKeys: Array<User.APIKey>;
+        /**
+         * The email of the user.
+         */
+        email: string;
+        /**
+         * The name of the user.
+         */
+        name: string;
+        /**
+         * A unique ID prefixed with `user_`.
+         */
+        organization: string;
+        /**
+         * Indicates if the user has a pending invite.
+         */
+        pendingInvite: boolean;
+        /**
+         * The roles given to the user. Roles can be used to restrict access for users.
+         */
+        roles: Array<string>;
+        /**
+         * Indicates if the user has a verified email or not.
+         */
+        verifiedEmail: boolean;
+        /**
+         * A set of preferences for how a user should receive emails.
+         */
+        emailPreferences?: SubOrganizationsAPI.EmailPreferences;
+        /**
+         * The date and time at which the user last logged in.
+         */
+        lastLoginTime?: string;
+        /**
+         * The phone number of the user.
+         */
+        phoneNumber?: string;
+        /**
+         * A list of emails the user has previously had. If a user has changed their email
+         * before, this list will be populated with all of the emails they once had.
+         */
+        previousEmails?: Array<string>;
+    }
+    namespace User {
+        /**
+         * An API key.
+         */
+        interface APIKey {
+            /**
+             * The value of the API key.
+             */
+            value: string;
+            /**
+             * An optional date which the API key is active until. After this date, the API key
+             * will no longer be valid.
+             */
+            activeUntil?: string;
+        }
+    }
+}
+export interface SubOrganizationListResponse {
+    data: Array<SubOrganization>;
+    limit: number;
+    object: 'list';
+    skip: number;
+    totalCount: number;
+}
+export type SubOrganizationRetrieveUsersResponse = Array<SubOrganizationRetrieveUsersResponse.SubOrganizationRetrieveUsersResponseItem>;
+export declare namespace SubOrganizationRetrieveUsersResponse {
+    /**
+     * The user object.
+     */
+    interface SubOrganizationRetrieveUsersResponseItem {
+        /**
+         * A unique ID prefixed with `user_`.
+         */
+        id: string;
+        /**
+         * The email of the user.
+         */
+        email: string;
+        /**
+         * The name of the user.
+         */
+        name: string;
+        /**
+         * A unique ID prefixed with `user_`.
+         */
+        organization: string;
+        /**
+         * Indicates if the user has a pending invite.
+         */
+        pendingInvite: boolean;
+        /**
+         * The roles given to the user. Roles can be used to restrict access for users.
+         */
+        roles: Array<string>;
+        /**
+         * Indicates if the user has a verified email or not.
+         */
+        verifiedEmail: boolean;
+        /**
+         * A set of preferences for how a user should receive emails.
+         */
+        emailPreferences?: SubOrganizationsAPI.EmailPreferences;
+        /**
+         * The date and time at which the user last logged in.
+         */
+        lastLoginTime?: string;
+        /**
+         * The phone number of the user.
+         */
+        phoneNumber?: string;
+        /**
+         * A list of emails the user has previously had. If a user has changed their email
+         * before, this list will be populated with all of the emails they once had.
+         */
+        previousEmails?: Array<string>;
+    }
+}
+export interface SubOrganizationUpdateParams {
+    /**
+     * The country code of the sub-organization.
+     */
+    countryCode: string;
+    /**
+     * The email of the user to be created alongside the sub-organization.
+     */
+    email: string;
+    /**
+     * The name of the user to be created alongside the sub-organization.
+     */
+    name: string;
+    /**
+     * The name of the sub-organization.
+     */
+    organizationName: string;
+    /**
+     * The password of the user to be created alongside the sub-organization.
+     */
+    password: string;
+    /**
+     * The phone number of the user to be created alongside the sub-organization.
+     */
+    phoneNumber?: string;
+}
+export interface SubOrganizationListParams {
+    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 interface SubOrganizationRetrieveUsersParams {
+    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 SubOrganizations {
+    export { type EmailPreferences as EmailPreferences, type SubOrganization as SubOrganization, type SubOrganizationUpdateResponse as SubOrganizationUpdateResponse, type SubOrganizationListResponse as SubOrganizationListResponse, type SubOrganizationRetrieveUsersResponse as SubOrganizationRetrieveUsersResponse, type SubOrganizationUpdateParams as SubOrganizationUpdateParams, type SubOrganizationListParams as SubOrganizationListParams, type SubOrganizationRetrieveUsersParams as SubOrganizationRetrieveUsersParams, };
+}
+//# sourceMappingURL=sub-organizations.d.ts.map

package/resources/print-mail/sub-organizations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sub-organizations.d.ts","sourceRoot":"","sources":["../../src/resources/print-mail/sub-organizations.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAI3E;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;;;;OAUG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;CAGpD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,0BAA0B,CAAC,EAAE,aAAa,GAAG,gBAAgB,GAAG,oBAAoB,CAAC;CACtF;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,eAAe,EAAE,eAAe,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,6BAA6B,CAAC,IAAI,CAAC;CAC1C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE5B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAErB;;WAEG;QACH,aAAa,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,gBAAgB,CAAC,EAAE,mBAAmB,CAAC,gBAAgB,CAAC;QAExD;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAChC;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAE7B,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,oCAAoC,GAC9C,KAAK,CAAC,oCAAoC,CAAC,wCAAwC,CAAC,CAAC;AAEvF,yBAAiB,oCAAoC,CAAC;IACpD;;OAEG;IACH,UAAiB,wCAAwC;QACvD;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAErB;;WAEG;QACH,aAAa,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,gBAAgB,CAAC,EAAE,mBAAmB,CAAC,gBAAgB,CAAC;QAExD;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAChC;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kCAAkC;IACjD,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,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,kCAAkC,IAAI,kCAAkC,GAC9E,CAAC;CACH"}

package/resources/print-mail/sub-organizations.js

@@ -0,0 +1,69 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubOrganizations = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+class SubOrganizations extends resource_1.APIResource {
+    /**
+     * Get a sub-organization.
+     *
+     * @example
+     * ```ts
+     * const subOrganization =
+     *   await client.printMail.subOrganizations.retrieve('id');
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/print-mail/v1/sub_organizations/${id}`, options);
+    }
+    /**
+     * When creating a user through the API, the verifiedEmail field will automatically
+     * be set to true. However, if public signups are used, the email will need to be
+     * verified by the user.
+     *
+     * @example
+     * ```ts
+     * const subOrganization =
+     *   await client.printMail.subOrganizations.update({
+     *     countryCode: 'CA',
+     *     email: 'suborg@postgrid.com',
+     *     name: 'Calvin',
+     *     organizationName: 'PostGrid',
+     *     password: 'very-strong-password',
+     *     phoneNumber: '9059059059',
+     *   });
+     * ```
+     */
+    update(body, options) {
+        return this._client.post('/print-mail/v1/sub_organizations', { body, ...options });
+    }
+    /**
+     * List sub-organizations.
+     *
+     * @example
+     * ```ts
+     * const subOrganizations =
+     *   await client.printMail.subOrganizations.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/print-mail/v1/sub_organizations', { query, ...options });
+    }
+    /**
+     * List users for a sub-organization.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.printMail.subOrganizations.retrieveUsers(
+     *     'id',
+     *   );
+     * ```
+     */
+    retrieveUsers(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/print-mail/v1/sub_organizations/${id}/users`, { query, ...options });
+    }
+}
+exports.SubOrganizations = SubOrganizations;
+//# sourceMappingURL=sub-organizations.js.map

package/resources/print-mail/sub-organizations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sub-organizations.js","sourceRoot":"","sources":["../../src/resources/print-mail/sub-organizations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAiD;AAEjD,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,oCAAoC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CACX,EAAU,EACV,QAA+D,EAAE,EACjE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,oCAAoC,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;CACF;AAzED,4CAyEC"}

package/resources/print-mail/sub-organizations.mjs

@@ -0,0 +1,65 @@
+// 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 SubOrganizations extends APIResource {
+    /**
+     * Get a sub-organization.
+     *
+     * @example
+     * ```ts
+     * const subOrganization =
+     *   await client.printMail.subOrganizations.retrieve('id');
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get(path `/print-mail/v1/sub_organizations/${id}`, options);
+    }
+    /**
+     * When creating a user through the API, the verifiedEmail field will automatically
+     * be set to true. However, if public signups are used, the email will need to be
+     * verified by the user.
+     *
+     * @example
+     * ```ts
+     * const subOrganization =
+     *   await client.printMail.subOrganizations.update({
+     *     countryCode: 'CA',
+     *     email: 'suborg@postgrid.com',
+     *     name: 'Calvin',
+     *     organizationName: 'PostGrid',
+     *     password: 'very-strong-password',
+     *     phoneNumber: '9059059059',
+     *   });
+     * ```
+     */
+    update(body, options) {
+        return this._client.post('/print-mail/v1/sub_organizations', { body, ...options });
+    }
+    /**
+     * List sub-organizations.
+     *
+     * @example
+     * ```ts
+     * const subOrganizations =
+     *   await client.printMail.subOrganizations.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/print-mail/v1/sub_organizations', { query, ...options });
+    }
+    /**
+     * List users for a sub-organization.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.printMail.subOrganizations.retrieveUsers(
+     *     'id',
+     *   );
+     * ```
+     */
+    retrieveUsers(id, query = {}, options) {
+        return this._client.get(path `/print-mail/v1/sub_organizations/${id}/users`, { query, ...options });
+    }
+}
+//# sourceMappingURL=sub-organizations.mjs.map

package/resources/print-mail/sub-organizations.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sub-organizations.mjs","sourceRoot":"","sources":["../../src/resources/print-mail/sub-organizations.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oCAAoC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CACX,EAAU,EACV,QAA+D,EAAE,EACjE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oCAAoC,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;CACF"}

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

@@ -0,0 +1,169 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Templates extends APIResource {
+    /**
+     * Create a template. Note that if you want to create a template that works with
+     * our template editor, you must use our dashboard.
+     *
+     * @example
+     * ```ts
+     * const template = await client.printMail.templates.create({
+     *   description: 'Test',
+     *   html: '<b>Hello</b> {{to.firstName}}',
+     * });
+     * ```
+     */
+    create(body: TemplateCreateParams, options?: RequestOptions): APIPromise<Template>;
+    /**
+     * Retrieve a template by ID.
+     *
+     * @example
+     * ```ts
+     * const template = await client.printMail.templates.retrieve(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<Template>;
+    /**
+     * Update a template by ID.
+     *
+     * @example
+     * ```ts
+     * const template = await client.printMail.templates.update(
+     *   'id',
+     *   {
+     *     description: 'Test',
+     *     html: '<b>Hello</b> {{to.firstName}}!',
+     *   },
+     * );
+     * ```
+     */
+    update(id: string, body: TemplateUpdateParams, options?: RequestOptions): APIPromise<Template>;
+    /**
+     * Get a list of templates.
+     *
+     * @example
+     * ```ts
+     * const templates = await client.printMail.templates.list();
+     * ```
+     */
+    list(query?: TemplateListParams | null | undefined, options?: RequestOptions): APIPromise<TemplateListResponse>;
+    /**
+     * Delete a template by ID. Note that this operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const template = await client.printMail.templates.delete(
+     *   'id',
+     * );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<TemplateDeleteResponse>;
+}
+export interface Template {
+    /**
+     * A unique ID prefixed with template\_
+     */
+    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;
+    /**
+     * Always `template`.
+     */
+    object: 'template';
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: string;
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * The HTML content of this template.
+     */
+    html?: string;
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+}
+export interface TemplateListResponse {
+    data: Array<Template>;
+    limit: number;
+    object: 'list';
+    skip: number;
+    totalCount: number;
+}
+export interface TemplateDeleteResponse {
+    /**
+     * A unique ID prefixed with template\_
+     */
+    id: string;
+    deleted: true;
+    /**
+     * Always `template`.
+     */
+    object: 'template';
+}
+export interface TemplateCreateParams {
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * The HTML content of this template.
+     */
+    html?: string;
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+}
+export interface TemplateUpdateParams {
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * The HTML content of this template.
+     */
+    html?: string;
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+}
+export interface TemplateListParams {
+    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 Templates {
+    export { type Template as Template, type TemplateListResponse as TemplateListResponse, type TemplateDeleteResponse as TemplateDeleteResponse, type TemplateCreateParams as TemplateCreateParams, type TemplateUpdateParams as TemplateUpdateParams, type TemplateListParams as TemplateListParams, };
+}
+//# sourceMappingURL=templates.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"templates.d.mts","sourceRoot":"","sources":["../../src/resources/print-mail/templates.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIlF;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIpE;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAI9F;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAInC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGjF;AAED,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;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,MAAM,WAAW,oBAAoB;IACnC,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,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,MAAM,WAAW,kBAAkB;IACjC,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,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}