@trycourier/courier 7.10.2 → 7.19.1

package/resources/journeys/templates.d.mts

@@ -0,0 +1,338 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as Shared from "../shared.mjs";
+import * as JourneysAPI from "./journeys.mjs";
+import * as NotificationsAPI from "../notifications/notifications.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Templates extends APIResource {
+    /**
+     * Create a notification template scoped to this journey. Defaults to `DRAFT`
+     * state; pass `state: "PUBLISHED"` to publish on create.
+     *
+     * @example
+     * ```ts
+     * const journeyTemplateGetResponse =
+     *   await client.journeys.templates.create('x', {
+     *     channel: 'email',
+     *     notification: {
+     *       name: 'Welcome email',
+     *       tags: [],
+     *       brand: null,
+     *       subscription: null,
+     *       content: {
+     *         version: '2022-01-01',
+     *         elements: [{ type: 'text' }],
+     *       },
+     *     },
+     *   });
+     * ```
+     */
+    create(templateID: string, body: TemplateCreateParams, options?: RequestOptions): APIPromise<JourneysAPI.JourneyTemplateGetResponse>;
+    /**
+     * Fetch a journey-scoped notification template by id. Pass `?version=draft`
+     * (default `published`) to retrieve the working draft, or `?version=vN` for a
+     * historical version.
+     *
+     * @example
+     * ```ts
+     * const journeyTemplateGetResponse =
+     *   await client.journeys.templates.retrieve('x', {
+     *     templateId: 'x',
+     *   });
+     * ```
+     */
+    retrieve(notificationID: string, params: TemplateRetrieveParams, options?: RequestOptions): APIPromise<JourneysAPI.JourneyTemplateGetResponse>;
+    /**
+     * List notification templates scoped to this journey. Journey-scoped notification
+     * templates can only be referenced from `send` nodes within the same journey.
+     *
+     * @example
+     * ```ts
+     * const journeyTemplateListResponse =
+     *   await client.journeys.templates.list('x');
+     * ```
+     */
+    list(templateID: string, query?: TemplateListParams | null | undefined, options?: RequestOptions): APIPromise<JourneysAPI.JourneyTemplateListResponse>;
+    /**
+     * Archive the journey-scoped notification template. Archived templates cannot be
+     * sent.
+     *
+     * @example
+     * ```ts
+     * await client.journeys.templates.archive('x', {
+     *   templateId: 'x',
+     * });
+     * ```
+     */
+    archive(notificationID: string, params: TemplateArchiveParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * List published versions of the journey-scoped notification template, ordered
+     * most recent first.
+     *
+     * @example
+     * ```ts
+     * const notificationTemplateVersionListResponse =
+     *   await client.journeys.templates.listVersions('x', {
+     *     templateId: 'x',
+     *   });
+     * ```
+     */
+    listVersions(notificationID: string, params: TemplateListVersionsParams, options?: RequestOptions): APIPromise<NotificationsAPI.NotificationTemplateVersionListResponse>;
+    /**
+     * Publish the current draft of the journey-scoped notification template as a new
+     * version. Optionally roll back to a prior version by passing
+     * `{ "version": "vN" }`.
+     *
+     * @example
+     * ```ts
+     * await client.journeys.templates.publish('x', {
+     *   templateId: 'x',
+     * });
+     * ```
+     */
+    publish(notificationID: string, params: TemplatePublishParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Replace the elemental content of a journey-scoped notification template.
+     * Overwrites all elements in the template draft with the provided content.
+     *
+     * @example
+     * ```ts
+     * const notificationContentMutationResponse =
+     *   await client.journeys.templates.putContent('x', {
+     *     templateId: 'x',
+     *     content: {
+     *       version: '2022-01-01',
+     *       elements: [{ type: 'channel' }],
+     *     },
+     *     state: 'DRAFT',
+     *   });
+     * ```
+     */
+    putContent(notificationID: string, params: TemplatePutContentParams, options?: RequestOptions): APIPromise<NotificationsAPI.NotificationContentMutationResponse>;
+    /**
+     * Set locale-specific content overrides for a journey-scoped notification
+     * template. Each element override must reference an existing element by ID.
+     *
+     * @example
+     * ```ts
+     * const notificationContentMutationResponse =
+     *   await client.journeys.templates.putLocale('x', {
+     *     templateId: 'x',
+     *     notificationId: 'x',
+     *     elements: [
+     *       { id: 'elem_1', content: 'Hola {{data.name}}.' },
+     *       { id: 'elem_2', title: 'Bienvenido!' },
+     *     ],
+     *     state: 'DRAFT',
+     *   });
+     * ```
+     */
+    putLocale(localeID: string, params: TemplatePutLocaleParams, options?: RequestOptions): APIPromise<NotificationsAPI.NotificationContentMutationResponse>;
+    /**
+     * Replace the journey-scoped notification template draft.
+     *
+     * @example
+     * ```ts
+     * const journeyTemplateGetResponse =
+     *   await client.journeys.templates.replace('x', {
+     *     templateId: 'x',
+     *     notification: {
+     *       brand: { id: 'id' },
+     *       content: { elements: [{}], version: '2022-01-01' },
+     *       name: 'name',
+     *       subscription: { topic_id: 'topic_id' },
+     *       tags: ['string'],
+     *     },
+     *   });
+     * ```
+     */
+    replace(notificationID: string, params: TemplateReplaceParams, options?: RequestOptions): APIPromise<JourneysAPI.JourneyTemplateGetResponse>;
+    /**
+     * Retrieve the elemental content of a journey-scoped notification template. The
+     * response contains the versioned elements along with their content checksums,
+     * which can be used to detect changes between versions. Pass `?version=draft`
+     * (default `published`) to retrieve the working draft, or `?version=vN` for a
+     * historical version.
+     *
+     * @example
+     * ```ts
+     * const notificationContentGetResponse =
+     *   await client.journeys.templates.retrieveContent('x', {
+     *     templateId: 'x',
+     *   });
+     * ```
+     */
+    retrieveContent(notificationID: string, params: TemplateRetrieveContentParams, options?: RequestOptions): APIPromise<NotificationsAPI.NotificationContentGetResponse>;
+}
+export interface TemplateCreateParams {
+    channel: string;
+    notification: TemplateCreateParams.Notification;
+    providerKey?: string;
+    state?: string;
+}
+export declare namespace TemplateCreateParams {
+    interface Notification {
+        brand: Notification.Brand | null;
+        content: Notification.Content;
+        name: string;
+        subscription: Notification.Subscription | null;
+        tags: Array<string>;
+    }
+    namespace Notification {
+        interface Brand {
+            id: string;
+        }
+        interface Content {
+            elements: Array<Shared.ElementalNode>;
+            version: '2022-01-01';
+            scope?: 'default' | 'strict';
+        }
+        interface Subscription {
+            topic_id: string;
+        }
+    }
+}
+export interface TemplateRetrieveParams {
+    /**
+     * Journey id
+     */
+    templateId: string;
+}
+export interface TemplateListParams {
+    /**
+     * Pagination cursor from a prior response.
+     */
+    cursor?: string;
+    /**
+     * Page size. Minimum 1, maximum 100.
+     */
+    limit?: number;
+}
+export interface TemplateArchiveParams {
+    /**
+     * Journey id
+     */
+    templateId: string;
+}
+export interface TemplateListVersionsParams {
+    /**
+     * Journey id
+     */
+    templateId: string;
+}
+export interface TemplatePublishParams {
+    /**
+     * Path param: Journey id
+     */
+    templateId: string;
+    /**
+     * Body param
+     */
+    version?: string;
+}
+export interface TemplatePutContentParams {
+    /**
+     * Path param: Journey id
+     */
+    templateId: string;
+    /**
+     * Body param: Elemental content payload. The server defaults `version` when
+     * omitted.
+     */
+    content: TemplatePutContentParams.Content;
+    /**
+     * Body param: Template state. Defaults to `DRAFT`.
+     */
+    state?: NotificationsAPI.NotificationTemplateState;
+}
+export declare namespace TemplatePutContentParams {
+    /**
+     * Elemental content payload. The server defaults `version` when omitted.
+     */
+    interface Content {
+        elements: Array<Shared.ElementalNode>;
+        /**
+         * Content version identifier (e.g., `2022-01-01`). Optional; server defaults when
+         * omitted.
+         */
+        version?: string;
+    }
+}
+export interface TemplatePutLocaleParams {
+    /**
+     * Path param: Journey id
+     */
+    templateId: string;
+    /**
+     * Path param: Notification template id
+     */
+    notificationId: string;
+    /**
+     * Body param: Elements with locale-specific content overrides.
+     */
+    elements: Array<TemplatePutLocaleParams.Element>;
+    /**
+     * Body param: Template state. Defaults to `DRAFT`.
+     */
+    state?: NotificationsAPI.NotificationTemplateState;
+}
+export declare namespace TemplatePutLocaleParams {
+    interface Element {
+        /**
+         * Target element ID.
+         */
+        id: string;
+        [k: string]: unknown;
+    }
+}
+export interface TemplateReplaceParams {
+    /**
+     * Path param: Journey id
+     */
+    templateId: string;
+    /**
+     * Body param
+     */
+    notification: TemplateReplaceParams.Notification;
+    /**
+     * Body param
+     */
+    state?: string;
+}
+export declare namespace TemplateReplaceParams {
+    interface Notification {
+        brand: Notification.Brand | null;
+        content: Notification.Content;
+        name: string;
+        subscription: Notification.Subscription | null;
+        tags: Array<string>;
+    }
+    namespace Notification {
+        interface Brand {
+            id: string;
+        }
+        interface Content {
+            elements: Array<Shared.ElementalNode>;
+            version: '2022-01-01';
+            scope?: 'default' | 'strict';
+        }
+        interface Subscription {
+            topic_id: string;
+        }
+    }
+}
+export interface TemplateRetrieveContentParams {
+    /**
+     * Path param: Journey id
+     */
+    templateId: string;
+    /**
+     * Query param: Accepts `draft`, `published`, or a version string (e.g., `v001`).
+     * Defaults to `published`.
+     */
+    version?: string;
+}
+export declare namespace Templates {
+    export { type TemplateCreateParams as TemplateCreateParams, type TemplateRetrieveParams as TemplateRetrieveParams, type TemplateListParams as TemplateListParams, type TemplateArchiveParams as TemplateArchiveParams, type TemplateListVersionsParams as TemplateListVersionsParams, type TemplatePublishParams as TemplatePublishParams, type TemplatePutContentParams as TemplatePutContentParams, type TemplatePutLocaleParams as TemplatePutLocaleParams, type TemplateReplaceParams as TemplateReplaceParams, type TemplateRetrieveContentParams as TemplateRetrieveContentParams, };
+}
+//# sourceMappingURL=templates.d.mts.map

package/resources/journeys/templates.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.d.mts","sourceRoot":"","sources":["../../src/resources/journeys/templates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,KAAK,gBAAgB,2CAAuC;AACnE,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC,0BAA0B,CAAC;IAIrD;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC,0BAA0B,CAAC;IAKrD;;;;;;;;;OASG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC,2BAA2B,CAAC;IAItD;;;;;;;;;;OAUG;IACH,OAAO,CAAC,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ1G;;;;;;;;;;;OAWG;IACH,YAAY,CACV,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,uCAAuC,CAAC;IAKvE;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAS1G;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CACR,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,mCAAmC,CAAC;IAQnE;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CACP,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,mCAAmC,CAAC;IAQnE;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CACL,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC,0BAA0B,CAAC;IAKrD;;;;;;;;;;;;;;OAcG;IACH,eAAe,CACb,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,6BAA6B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,8BAA8B,CAAC;CAO/D;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAEhB,YAAY,EAAE,oBAAoB,CAAC,YAAY,CAAC;IAEhD,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,YAAY;QAC3B,KAAK,EAAE,YAAY,CAAC,KAAK,GAAG,IAAI,CAAC;QAEjC,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;QAE9B,IAAI,EAAE,MAAM,CAAC;QAEb,YAAY,EAAE,YAAY,CAAC,YAAY,GAAG,IAAI,CAAC;QAE/C,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACrB;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,KAAK;YACpB,EAAE,EAAE,MAAM,CAAC;SACZ;QAED,UAAiB,OAAO;YACtB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YAEtC,OAAO,EAAE,YAAY,CAAC;YAEtB,KAAK,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;SAC9B;QAED,UAAiB,YAAY;YAC3B,QAAQ,EAAE,MAAM,CAAC;SAClB;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,OAAO,EAAE,wBAAwB,CAAC,OAAO,CAAC;IAE1C;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,yBAAyB,CAAC;CACpD;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,OAAO;QACtB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAEtC;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAEjD;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,yBAAyB,CAAC;CACpD;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,qBAAqB,CAAC,YAAY,CAAC;IAEjD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,YAAY;QAC3B,KAAK,EAAE,YAAY,CAAC,KAAK,GAAG,IAAI,CAAC;QAEjC,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;QAE9B,IAAI,EAAE,MAAM,CAAC;QAEb,YAAY,EAAE,YAAY,CAAC,YAAY,GAAG,IAAI,CAAC;QAE/C,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACrB;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,KAAK;YACpB,EAAE,EAAE,MAAM,CAAC;SACZ;QAED,UAAiB,OAAO;YACtB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YAEtC,OAAO,EAAE,YAAY,CAAC;YAEtB,KAAK,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;SAC9B;QAED,UAAiB,YAAY;YAC3B,QAAQ,EAAE,MAAM,CAAC;SAClB;KACF;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}

package/resources/journeys/templates.d.ts

@@ -0,0 +1,338 @@
+import { APIResource } from "../../core/resource.js";
+import * as Shared from "../shared.js";
+import * as JourneysAPI from "./journeys.js";
+import * as NotificationsAPI from "../notifications/notifications.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Templates extends APIResource {
+    /**
+     * Create a notification template scoped to this journey. Defaults to `DRAFT`
+     * state; pass `state: "PUBLISHED"` to publish on create.
+     *
+     * @example
+     * ```ts
+     * const journeyTemplateGetResponse =
+     *   await client.journeys.templates.create('x', {
+     *     channel: 'email',
+     *     notification: {
+     *       name: 'Welcome email',
+     *       tags: [],
+     *       brand: null,
+     *       subscription: null,
+     *       content: {
+     *         version: '2022-01-01',
+     *         elements: [{ type: 'text' }],
+     *       },
+     *     },
+     *   });
+     * ```
+     */
+    create(templateID: string, body: TemplateCreateParams, options?: RequestOptions): APIPromise<JourneysAPI.JourneyTemplateGetResponse>;
+    /**
+     * Fetch a journey-scoped notification template by id. Pass `?version=draft`
+     * (default `published`) to retrieve the working draft, or `?version=vN` for a
+     * historical version.
+     *
+     * @example
+     * ```ts
+     * const journeyTemplateGetResponse =
+     *   await client.journeys.templates.retrieve('x', {
+     *     templateId: 'x',
+     *   });
+     * ```
+     */
+    retrieve(notificationID: string, params: TemplateRetrieveParams, options?: RequestOptions): APIPromise<JourneysAPI.JourneyTemplateGetResponse>;
+    /**
+     * List notification templates scoped to this journey. Journey-scoped notification
+     * templates can only be referenced from `send` nodes within the same journey.
+     *
+     * @example
+     * ```ts
+     * const journeyTemplateListResponse =
+     *   await client.journeys.templates.list('x');
+     * ```
+     */
+    list(templateID: string, query?: TemplateListParams | null | undefined, options?: RequestOptions): APIPromise<JourneysAPI.JourneyTemplateListResponse>;
+    /**
+     * Archive the journey-scoped notification template. Archived templates cannot be
+     * sent.
+     *
+     * @example
+     * ```ts
+     * await client.journeys.templates.archive('x', {
+     *   templateId: 'x',
+     * });
+     * ```
+     */
+    archive(notificationID: string, params: TemplateArchiveParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * List published versions of the journey-scoped notification template, ordered
+     * most recent first.
+     *
+     * @example
+     * ```ts
+     * const notificationTemplateVersionListResponse =
+     *   await client.journeys.templates.listVersions('x', {
+     *     templateId: 'x',
+     *   });
+     * ```
+     */
+    listVersions(notificationID: string, params: TemplateListVersionsParams, options?: RequestOptions): APIPromise<NotificationsAPI.NotificationTemplateVersionListResponse>;
+    /**
+     * Publish the current draft of the journey-scoped notification template as a new
+     * version. Optionally roll back to a prior version by passing
+     * `{ "version": "vN" }`.
+     *
+     * @example
+     * ```ts
+     * await client.journeys.templates.publish('x', {
+     *   templateId: 'x',
+     * });
+     * ```
+     */
+    publish(notificationID: string, params: TemplatePublishParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Replace the elemental content of a journey-scoped notification template.
+     * Overwrites all elements in the template draft with the provided content.
+     *
+     * @example
+     * ```ts
+     * const notificationContentMutationResponse =
+     *   await client.journeys.templates.putContent('x', {
+     *     templateId: 'x',
+     *     content: {
+     *       version: '2022-01-01',
+     *       elements: [{ type: 'channel' }],
+     *     },
+     *     state: 'DRAFT',
+     *   });
+     * ```
+     */
+    putContent(notificationID: string, params: TemplatePutContentParams, options?: RequestOptions): APIPromise<NotificationsAPI.NotificationContentMutationResponse>;
+    /**
+     * Set locale-specific content overrides for a journey-scoped notification
+     * template. Each element override must reference an existing element by ID.
+     *
+     * @example
+     * ```ts
+     * const notificationContentMutationResponse =
+     *   await client.journeys.templates.putLocale('x', {
+     *     templateId: 'x',
+     *     notificationId: 'x',
+     *     elements: [
+     *       { id: 'elem_1', content: 'Hola {{data.name}}.' },
+     *       { id: 'elem_2', title: 'Bienvenido!' },
+     *     ],
+     *     state: 'DRAFT',
+     *   });
+     * ```
+     */
+    putLocale(localeID: string, params: TemplatePutLocaleParams, options?: RequestOptions): APIPromise<NotificationsAPI.NotificationContentMutationResponse>;
+    /**
+     * Replace the journey-scoped notification template draft.
+     *
+     * @example
+     * ```ts
+     * const journeyTemplateGetResponse =
+     *   await client.journeys.templates.replace('x', {
+     *     templateId: 'x',
+     *     notification: {
+     *       brand: { id: 'id' },
+     *       content: { elements: [{}], version: '2022-01-01' },
+     *       name: 'name',
+     *       subscription: { topic_id: 'topic_id' },
+     *       tags: ['string'],
+     *     },
+     *   });
+     * ```
+     */
+    replace(notificationID: string, params: TemplateReplaceParams, options?: RequestOptions): APIPromise<JourneysAPI.JourneyTemplateGetResponse>;
+    /**
+     * Retrieve the elemental content of a journey-scoped notification template. The
+     * response contains the versioned elements along with their content checksums,
+     * which can be used to detect changes between versions. Pass `?version=draft`
+     * (default `published`) to retrieve the working draft, or `?version=vN` for a
+     * historical version.
+     *
+     * @example
+     * ```ts
+     * const notificationContentGetResponse =
+     *   await client.journeys.templates.retrieveContent('x', {
+     *     templateId: 'x',
+     *   });
+     * ```
+     */
+    retrieveContent(notificationID: string, params: TemplateRetrieveContentParams, options?: RequestOptions): APIPromise<NotificationsAPI.NotificationContentGetResponse>;
+}
+export interface TemplateCreateParams {
+    channel: string;
+    notification: TemplateCreateParams.Notification;
+    providerKey?: string;
+    state?: string;
+}
+export declare namespace TemplateCreateParams {
+    interface Notification {
+        brand: Notification.Brand | null;
+        content: Notification.Content;
+        name: string;
+        subscription: Notification.Subscription | null;
+        tags: Array<string>;
+    }
+    namespace Notification {
+        interface Brand {
+            id: string;
+        }
+        interface Content {
+            elements: Array<Shared.ElementalNode>;
+            version: '2022-01-01';
+            scope?: 'default' | 'strict';
+        }
+        interface Subscription {
+            topic_id: string;
+        }
+    }
+}
+export interface TemplateRetrieveParams {
+    /**
+     * Journey id
+     */
+    templateId: string;
+}
+export interface TemplateListParams {
+    /**
+     * Pagination cursor from a prior response.
+     */
+    cursor?: string;
+    /**
+     * Page size. Minimum 1, maximum 100.
+     */
+    limit?: number;
+}
+export interface TemplateArchiveParams {
+    /**
+     * Journey id
+     */
+    templateId: string;
+}
+export interface TemplateListVersionsParams {
+    /**
+     * Journey id
+     */
+    templateId: string;
+}
+export interface TemplatePublishParams {
+    /**
+     * Path param: Journey id
+     */
+    templateId: string;
+    /**
+     * Body param
+     */
+    version?: string;
+}
+export interface TemplatePutContentParams {
+    /**
+     * Path param: Journey id
+     */
+    templateId: string;
+    /**
+     * Body param: Elemental content payload. The server defaults `version` when
+     * omitted.
+     */
+    content: TemplatePutContentParams.Content;
+    /**
+     * Body param: Template state. Defaults to `DRAFT`.
+     */
+    state?: NotificationsAPI.NotificationTemplateState;
+}
+export declare namespace TemplatePutContentParams {
+    /**
+     * Elemental content payload. The server defaults `version` when omitted.
+     */
+    interface Content {
+        elements: Array<Shared.ElementalNode>;
+        /**
+         * Content version identifier (e.g., `2022-01-01`). Optional; server defaults when
+         * omitted.
+         */
+        version?: string;
+    }
+}
+export interface TemplatePutLocaleParams {
+    /**
+     * Path param: Journey id
+     */
+    templateId: string;
+    /**
+     * Path param: Notification template id
+     */
+    notificationId: string;
+    /**
+     * Body param: Elements with locale-specific content overrides.
+     */
+    elements: Array<TemplatePutLocaleParams.Element>;
+    /**
+     * Body param: Template state. Defaults to `DRAFT`.
+     */
+    state?: NotificationsAPI.NotificationTemplateState;
+}
+export declare namespace TemplatePutLocaleParams {
+    interface Element {
+        /**
+         * Target element ID.
+         */
+        id: string;
+        [k: string]: unknown;
+    }
+}
+export interface TemplateReplaceParams {
+    /**
+     * Path param: Journey id
+     */
+    templateId: string;
+    /**
+     * Body param
+     */
+    notification: TemplateReplaceParams.Notification;
+    /**
+     * Body param
+     */
+    state?: string;
+}
+export declare namespace TemplateReplaceParams {
+    interface Notification {
+        brand: Notification.Brand | null;
+        content: Notification.Content;
+        name: string;
+        subscription: Notification.Subscription | null;
+        tags: Array<string>;
+    }
+    namespace Notification {
+        interface Brand {
+            id: string;
+        }
+        interface Content {
+            elements: Array<Shared.ElementalNode>;
+            version: '2022-01-01';
+            scope?: 'default' | 'strict';
+        }
+        interface Subscription {
+            topic_id: string;
+        }
+    }
+}
+export interface TemplateRetrieveContentParams {
+    /**
+     * Path param: Journey id
+     */
+    templateId: string;
+    /**
+     * Query param: Accepts `draft`, `published`, or a version string (e.g., `v001`).
+     * Defaults to `published`.
+     */
+    version?: string;
+}
+export declare namespace Templates {
+    export { type TemplateCreateParams as TemplateCreateParams, type TemplateRetrieveParams as TemplateRetrieveParams, type TemplateListParams as TemplateListParams, type TemplateArchiveParams as TemplateArchiveParams, type TemplateListVersionsParams as TemplateListVersionsParams, type TemplatePublishParams as TemplatePublishParams, type TemplatePutContentParams as TemplatePutContentParams, type TemplatePutLocaleParams as TemplatePutLocaleParams, type TemplateReplaceParams as TemplateReplaceParams, type TemplateRetrieveContentParams as TemplateRetrieveContentParams, };
+}
+//# sourceMappingURL=templates.d.ts.map

package/resources/journeys/templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../src/resources/journeys/templates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,KAAK,gBAAgB,0CAAuC;AACnE,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC,0BAA0B,CAAC;IAIrD;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC,0BAA0B,CAAC;IAKrD;;;;;;;;;OASG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC,2BAA2B,CAAC;IAItD;;;;;;;;;;OAUG;IACH,OAAO,CAAC,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ1G;;;;;;;;;;;OAWG;IACH,YAAY,CACV,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,uCAAuC,CAAC;IAKvE;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAS1G;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CACR,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,mCAAmC,CAAC;IAQnE;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CACP,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,mCAAmC,CAAC;IAQnE;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CACL,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC,0BAA0B,CAAC;IAKrD;;;;;;;;;;;;;;OAcG;IACH,eAAe,CACb,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,6BAA6B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,8BAA8B,CAAC;CAO/D;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAEhB,YAAY,EAAE,oBAAoB,CAAC,YAAY,CAAC;IAEhD,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,YAAY;QAC3B,KAAK,EAAE,YAAY,CAAC,KAAK,GAAG,IAAI,CAAC;QAEjC,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;QAE9B,IAAI,EAAE,MAAM,CAAC;QAEb,YAAY,EAAE,YAAY,CAAC,YAAY,GAAG,IAAI,CAAC;QAE/C,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACrB;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,KAAK;YACpB,EAAE,EAAE,MAAM,CAAC;SACZ;QAED,UAAiB,OAAO;YACtB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YAEtC,OAAO,EAAE,YAAY,CAAC;YAEtB,KAAK,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;SAC9B;QAED,UAAiB,YAAY;YAC3B,QAAQ,EAAE,MAAM,CAAC;SAClB;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,OAAO,EAAE,wBAAwB,CAAC,OAAO,CAAC;IAE1C;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,yBAAyB,CAAC;CACpD;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,OAAO;QACtB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAEtC;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAEjD;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,yBAAyB,CAAC;CACpD;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,qBAAqB,CAAC,YAAY,CAAC;IAEjD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,YAAY;QAC3B,KAAK,EAAE,YAAY,CAAC,KAAK,GAAG,IAAI,CAAC;QAEjC,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;QAE9B,IAAI,EAAE,MAAM,CAAC;QAEb,YAAY,EAAE,YAAY,CAAC,YAAY,GAAG,IAAI,CAAC;QAE/C,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACrB;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,KAAK;YACpB,EAAE,EAAE,MAAM,CAAC;SACZ;QAED,UAAiB,OAAO;YACtB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YAEtC,OAAO,EAAE,YAAY,CAAC;YAEtB,KAAK,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;SAC9B;QAED,UAAiB,YAAY;YAC3B,QAAQ,EAAE,MAAM,CAAC;SAClB;KACF;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}