postgrid-node 0.4.2 → 0.6.1

package/resources/print-mail/template-editor-sessions.d.mts

@@ -0,0 +1,355 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { PagePromise, SkipLimit, type SkipLimitParams } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ *  You can use template editor sessions to bring the capabilities of our
+ *  template editor to your website. When you create a session, you provide the
+ *  `template` which you want to edit, and we return a session with a `url` that
+ *  you can `iframe` or redirect your customers to.
+ *
+ *  When users save their changes in the editor session, it will update the
+ *  underlying template. Note that sessions are only valid for 24 hours, after
+ *  which point they are automatically deleted for security reasons.
+ *
+ *  You can have multiple sessions active for the same template at the same time.
+ *  In general, we recommend creating a new session every time you present our
+ *  editor to your users.
+ *
+ *  Note: you can use the template editor to modify templates created using HTML,
+ *  but saving a session from the editor will override the original HTML content.
+ */
+export declare class TemplateEditorSessions extends APIResource {
+    /**
+     * Create a Template Editor Session.
+     *
+     * Note that if no `backURL` is supplied, PostGrid removes the Back button from the
+     * editor page. This is ideal for when you `iframe` the editor.
+     *
+     * @example
+     * ```ts
+     * const templateEditorSession =
+     *   await client.printMail.templateEditorSessions.create({
+     *     template: 'template_eYxcbMKPZEZPk71ZJPA6Yz',
+     *     backURL: 'https://postgrid.com',
+     *     title: 'My Editor Session',
+     *     trackers: [
+     *       'tracker_123456789abcdefghijklmnopqrstuvwxyz',
+     *     ],
+     *   });
+     * ```
+     */
+    create(body: TemplateEditorSessionCreateParams, options?: RequestOptions): APIPromise<TemplateEditorSessionCreateResponse>;
+    /**
+     * Retrieve a paginated list of Template Editor Sessions.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const templateEditorSessionListResponse of client.printMail.templateEditorSessions.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: TemplateEditorSessionListParams | null | undefined, options?: RequestOptions): PagePromise<TemplateEditorSessionListResponsesSkipLimit, TemplateEditorSessionListResponse>;
+    /**
+     * Delete a Template Editor Session by ID.
+     *
+     * @example
+     * ```ts
+     * const templateEditorSession =
+     *   await client.printMail.templateEditorSessions.delete(
+     *     'id',
+     *   );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<TemplateEditorSessionDeleteResponse>;
+}
+export type TemplateEditorSessionListResponsesSkipLimit = SkipLimit<TemplateEditorSessionListResponse>;
+export interface TemplateEditorSessionCreateResponse {
+    /**
+     * A unique ID prefixed with `template_editor_session_`.
+     */
+    id: string;
+    /**
+     * The UTC time at which this session was created.
+     */
+    createdAt: string;
+    /**
+     * `true` if this is a live mode session else `false`.
+     */
+    live: boolean;
+    /**
+     * Always `template_editor_session`.
+     */
+    object: 'template_editor_session';
+    /**
+     * ID of the underlying template that this edits.
+     */
+    template: string;
+    /**
+     * A URL that can be iframed or redirected to for editing the template.
+     */
+    url: string;
+    /**
+     * The URL supplied when this editor session was created.
+     */
+    backURL?: string;
+    /**
+     * Style overrides for the template editor session.
+     */
+    styles?: TemplateEditorSessionCreateResponse.Styles;
+    /**
+     * The title supplied when this editor session was created.
+     */
+    title?: string;
+    /**
+     * Controls which Trackers are displayed in the template editor session.
+     */
+    trackers?: 'all' | 'none' | Array<string>;
+}
+export declare namespace TemplateEditorSessionCreateResponse {
+    /**
+     * Style overrides for the template editor session.
+     */
+    interface Styles {
+        /**
+         * Style overrides for the template editor canvas.
+         */
+        canvas?: Styles.Canvas;
+        /**
+         * Style overrides for template editor panel text.
+         */
+        panelText?: Styles.PanelText;
+        /**
+         * Style overrides for the template editor save button.
+         */
+        saveButton?: Styles.SaveButton;
+    }
+    namespace Styles {
+        /**
+         * Style overrides for the template editor canvas.
+         */
+        interface Canvas {
+            /**
+             * The canvas background color.
+             */
+            backgroundColor?: string;
+        }
+        /**
+         * Style overrides for template editor panel text.
+         */
+        interface PanelText {
+            /**
+             * The panel text color.
+             */
+            color?: string;
+        }
+        /**
+         * Style overrides for the template editor save button.
+         */
+        interface SaveButton {
+            /**
+             * The save button background color.
+             */
+            backgroundColor?: string;
+            /**
+             * The save button text color.
+             */
+            textColor?: string;
+        }
+    }
+}
+export interface TemplateEditorSessionListResponse {
+    /**
+     * A unique ID prefixed with `template_editor_session_`.
+     */
+    id: string;
+    /**
+     * The UTC time at which this session was created.
+     */
+    createdAt: string;
+    /**
+     * `true` if this is a live mode session else `false`.
+     */
+    live: boolean;
+    /**
+     * Always `template_editor_session`.
+     */
+    object: 'template_editor_session';
+    /**
+     * ID of the underlying template that this edits.
+     */
+    template: string;
+    /**
+     * A URL that can be iframed or redirected to for editing the template.
+     */
+    url: string;
+    /**
+     * The URL supplied when this editor session was created.
+     */
+    backURL?: string;
+    /**
+     * Style overrides for the template editor session.
+     */
+    styles?: TemplateEditorSessionListResponse.Styles;
+    /**
+     * The title supplied when this editor session was created.
+     */
+    title?: string;
+    /**
+     * Controls which Trackers are displayed in the template editor session.
+     */
+    trackers?: 'all' | 'none' | Array<string>;
+}
+export declare namespace TemplateEditorSessionListResponse {
+    /**
+     * Style overrides for the template editor session.
+     */
+    interface Styles {
+        /**
+         * Style overrides for the template editor canvas.
+         */
+        canvas?: Styles.Canvas;
+        /**
+         * Style overrides for template editor panel text.
+         */
+        panelText?: Styles.PanelText;
+        /**
+         * Style overrides for the template editor save button.
+         */
+        saveButton?: Styles.SaveButton;
+    }
+    namespace Styles {
+        /**
+         * Style overrides for the template editor canvas.
+         */
+        interface Canvas {
+            /**
+             * The canvas background color.
+             */
+            backgroundColor?: string;
+        }
+        /**
+         * Style overrides for template editor panel text.
+         */
+        interface PanelText {
+            /**
+             * The panel text color.
+             */
+            color?: string;
+        }
+        /**
+         * Style overrides for the template editor save button.
+         */
+        interface SaveButton {
+            /**
+             * The save button background color.
+             */
+            backgroundColor?: string;
+            /**
+             * The save button text color.
+             */
+            textColor?: string;
+        }
+    }
+}
+export interface TemplateEditorSessionDeleteResponse {
+    /**
+     * A unique ID prefixed with `template_editor_session_`.
+     */
+    id: string;
+    deleted: true;
+    /**
+     * Always `template_editor_session`.
+     */
+    object: 'template_editor_session';
+}
+export interface TemplateEditorSessionCreateParams {
+    /**
+     * ID of the underlying template that this edits.
+     */
+    template: string;
+    /**
+     * The URL supplied when this editor session was created.
+     */
+    backURL?: string;
+    /**
+     * Style overrides for the template editor session.
+     */
+    styles?: TemplateEditorSessionCreateParams.Styles;
+    /**
+     * The title supplied when this editor session was created.
+     */
+    title?: string;
+    /**
+     * Controls which Trackers are displayed in the template editor session.
+     */
+    trackers?: 'all' | 'none' | Array<string>;
+}
+export declare namespace TemplateEditorSessionCreateParams {
+    /**
+     * Style overrides for the template editor session.
+     */
+    interface Styles {
+        /**
+         * Style overrides for the template editor canvas.
+         */
+        canvas?: Styles.Canvas;
+        /**
+         * Style overrides for template editor panel text.
+         */
+        panelText?: Styles.PanelText;
+        /**
+         * Style overrides for the template editor save button.
+         */
+        saveButton?: Styles.SaveButton;
+    }
+    namespace Styles {
+        /**
+         * Style overrides for the template editor canvas.
+         */
+        interface Canvas {
+            /**
+             * The canvas background color.
+             */
+            backgroundColor?: string;
+        }
+        /**
+         * Style overrides for template editor panel text.
+         */
+        interface PanelText {
+            /**
+             * The panel text color.
+             */
+            color?: string;
+        }
+        /**
+         * Style overrides for the template editor save button.
+         */
+        interface SaveButton {
+            /**
+             * The save button background color.
+             */
+            backgroundColor?: string;
+            /**
+             * The save button text color.
+             */
+            textColor?: string;
+        }
+    }
+}
+export interface TemplateEditorSessionListParams extends SkipLimitParams {
+    /**
+     * 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 TemplateEditorSessions {
+    export { type TemplateEditorSessionCreateResponse as TemplateEditorSessionCreateResponse, type TemplateEditorSessionListResponse as TemplateEditorSessionListResponse, type TemplateEditorSessionDeleteResponse as TemplateEditorSessionDeleteResponse, type TemplateEditorSessionListResponsesSkipLimit as TemplateEditorSessionListResponsesSkipLimit, type TemplateEditorSessionCreateParams as TemplateEditorSessionCreateParams, type TemplateEditorSessionListParams as TemplateEditorSessionListParams, };
+}
+//# sourceMappingURL=template-editor-sessions.d.mts.map

package/resources/print-mail/template-editor-sessions.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-editor-sessions.d.mts","sourceRoot":"","sources":["../../src/resources/print-mail/template-editor-sessions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE;OAChD,EAAE,cAAc,EAAE;AAGzB;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;IACrD;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,IAAI,EAAE,iCAAiC,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAIlD;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2CAA2C,EAAE,iCAAiC,CAAC;IAQ9F;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mCAAmC,CAAC;CAG9F;AAED,MAAM,MAAM,2CAA2C,GAAG,SAAS,CAAC,iCAAiC,CAAC,CAAC;AAEvG,MAAM,WAAW,mCAAmC;IAClD;;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,yBAAyB,CAAC;IAElC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,mCAAmC,CAAC,MAAM,CAAC;IAEpD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3C;AAED,yBAAiB,mCAAmC,CAAC;IACnD;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC;QAE7B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;KAChC;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;SAC1B;QAED;;WAEG;QACH,UAAiB,SAAS;YACxB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB;KACF;CACF;AAED,MAAM,WAAW,iCAAiC;IAChD;;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,yBAAyB,CAAC;IAElC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,iCAAiC,CAAC,MAAM,CAAC;IAElD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3C;AAED,yBAAiB,iCAAiC,CAAC;IACjD;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC;QAE7B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;KAChC;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;SAC1B;QAED;;WAEG;QACH,UAAiB,SAAS;YACxB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB;KACF;CACF;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC;CACnC;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,iCAAiC,CAAC,MAAM,CAAC;IAElD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3C;AAED,yBAAiB,iCAAiC,CAAC;IACjD;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC;QAE7B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;KAChC;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;SAC1B;QAED;;WAEG;QACH,UAAiB,SAAS;YACxB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB;KACF;CACF;AAED,MAAM,WAAW,+BAAgC,SAAQ,eAAe;IACtE;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC;IAC9C,OAAO,EACL,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,2CAA2C,IAAI,2CAA2C,EAC/F,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}