@trycourier/courier 7.10.1 → 7.11.0

package/resources/journeys/templates.d.ts

@@ -0,0 +1,219 @@
+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 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>;
+}
+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 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 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 TemplateReplaceParams as TemplateReplaceParams, };
+}
+//# 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;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CACL,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC,0BAA0B,CAAC;CAItD;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,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,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,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/journeys/templates.js

@@ -0,0 +1,142 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Templates = void 0;
+const resource_1 = require("../../core/resource.js");
+const headers_1 = require("../../internal/headers.js");
+const path_1 = require("../../internal/utils/path.js");
+class Templates extends resource_1.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, body, options) {
+        return this._client.post((0, path_1.path) `/journeys/${templateID}/templates`, { body, ...options });
+    }
+    /**
+     * 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, params, options) {
+        const { templateId } = params;
+        return this._client.get((0, path_1.path) `/journeys/${templateId}/templates/${notificationID}`, options);
+    }
+    /**
+     * 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, query = {}, options) {
+        return this._client.get((0, path_1.path) `/journeys/${templateID}/templates`, { query, ...options });
+    }
+    /**
+     * Archive the journey-scoped notification template. Archived templates cannot be
+     * sent.
+     *
+     * @example
+     * ```ts
+     * await client.journeys.templates.archive('x', {
+     *   templateId: 'x',
+     * });
+     * ```
+     */
+    archive(notificationID, params, options) {
+        const { templateId } = params;
+        return this._client.delete((0, path_1.path) `/journeys/${templateId}/templates/${notificationID}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * 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, params, options) {
+        const { templateId } = params;
+        return this._client.get((0, path_1.path) `/journeys/${templateId}/templates/${notificationID}/versions`, options);
+    }
+    /**
+     * 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, params, options) {
+        const { templateId, ...body } = params;
+        return this._client.post((0, path_1.path) `/journeys/${templateId}/templates/${notificationID}/publish`, {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * 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, params, options) {
+        const { templateId, ...body } = params;
+        return this._client.put((0, path_1.path) `/journeys/${templateId}/templates/${notificationID}`, { body, ...options });
+    }
+}
+exports.Templates = Templates;
+//# sourceMappingURL=templates.js.map

package/resources/journeys/templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../src/resources/journeys/templates.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CACJ,UAAkB,EAClB,IAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,cAAsB,EACtB,MAA8B,EAC9B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,cAAc,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CACF,UAAkB,EAClB,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,cAAsB,EAAE,MAA6B,EAAE,OAAwB;QACrF,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,cAAc,cAAc,EAAE,EAAE;YACpF,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,cAAsB,EACtB,MAAkC,EAClC,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,cAAc,cAAc,WAAW,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,cAAsB,EAAE,MAA6B,EAAE,OAAwB;QACrF,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,cAAc,cAAc,UAAU,EAAE;YAC1F,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CACL,cAAsB,EACtB,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,cAAc,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;CACF;AA9JD,8BA8JC"}

package/resources/journeys/templates.mjs

@@ -0,0 +1,138 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export 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, body, options) {
+        return this._client.post(path `/journeys/${templateID}/templates`, { body, ...options });
+    }
+    /**
+     * 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, params, options) {
+        const { templateId } = params;
+        return this._client.get(path `/journeys/${templateId}/templates/${notificationID}`, options);
+    }
+    /**
+     * 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, query = {}, options) {
+        return this._client.get(path `/journeys/${templateID}/templates`, { query, ...options });
+    }
+    /**
+     * Archive the journey-scoped notification template. Archived templates cannot be
+     * sent.
+     *
+     * @example
+     * ```ts
+     * await client.journeys.templates.archive('x', {
+     *   templateId: 'x',
+     * });
+     * ```
+     */
+    archive(notificationID, params, options) {
+        const { templateId } = params;
+        return this._client.delete(path `/journeys/${templateId}/templates/${notificationID}`, {
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * 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, params, options) {
+        const { templateId } = params;
+        return this._client.get(path `/journeys/${templateId}/templates/${notificationID}/versions`, options);
+    }
+    /**
+     * 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, params, options) {
+        const { templateId, ...body } = params;
+        return this._client.post(path `/journeys/${templateId}/templates/${notificationID}/publish`, {
+            body,
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * 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, params, options) {
+        const { templateId, ...body } = params;
+        return this._client.put(path `/journeys/${templateId}/templates/${notificationID}`, { body, ...options });
+    }
+}
+//# sourceMappingURL=templates.mjs.map

package/resources/journeys/templates.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.mjs","sourceRoot":"","sources":["../../src/resources/journeys/templates.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAKlD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CACJ,UAAkB,EAClB,IAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,UAAU,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,cAAsB,EACtB,MAA8B,EAC9B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,UAAU,cAAc,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CACF,UAAkB,EAClB,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,UAAU,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,cAAsB,EAAE,MAA6B,EAAE,OAAwB;QACrF,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,UAAU,cAAc,cAAc,EAAE,EAAE;YACpF,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,cAAsB,EACtB,MAAkC,EAClC,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,UAAU,cAAc,cAAc,WAAW,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,cAAsB,EAAE,MAA6B,EAAE,OAAwB;QACrF,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,UAAU,cAAc,cAAc,UAAU,EAAE;YAC1F,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CACL,cAAsB,EACtB,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,UAAU,cAAc,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;CACF"}

package/resources/journeys.d.mts

@@ -1,143 +1,2 @@
-import { APIResource } from "../core/resource.mjs";
-import { APIPromise } from "../core/api-promise.mjs";
-import { RequestOptions } from "../internal/request-options.mjs";
-export declare class Journeys extends APIResource {
-    /**
-     * Get the list of journeys.
-     *
-     * @example
-     * ```ts
-     * const journeysListResponse = await client.journeys.list();
-     * ```
-     */
-    list(query?: JourneyListParams | null | undefined, options?: RequestOptions): APIPromise<JourneysListResponse>;
-    /**
-     * Invoke a journey run from a journey template.
-     *
-     * @example
-     * ```ts
-     * const journeysInvokeResponse = await client.journeys.invoke(
-     *   'templateId',
-     *   {
-     *     data: { order_id: 'order-456', amount: 99.99 },
-     *     user_id: 'user-123',
-     *   },
-     * );
-     * ```
-     */
-    invoke(templateID: string, body: JourneyInvokeParams, options?: RequestOptions): APIPromise<JourneysInvokeResponse>;
-}
-/**
- * A journey template representing an automation workflow.
- */
-export interface Journey {
-    /**
-     * The unique identifier of the journey.
-     */
-    id: string;
-    /**
-     * The name of the journey.
-     */
-    name: string;
-    /**
-     * The version of the journey (published or draft).
-     */
-    version: 'published' | 'draft';
-    /**
-     * ISO 8601 timestamp when the journey was created.
-     */
-    createdAt?: string;
-    /**
-     * ISO 8601 timestamp when the journey was last updated.
-     */
-    updatedAt?: string;
-}
-/**
- * Request body for invoking a journey. Requires either a user identifier or a
- * profile with contact information. User identifiers can be provided via user_id
- * field, or resolved from profile/data objects (user_id, userId, or anonymousId
- * fields).
- */
-export interface JourneysInvokeRequest {
-    /**
-     * Data payload passed to the journey. The expected shape can be predefined using
-     * the schema builder in the journey editor. This data is available in journey
-     * steps for condition evaluation and template variable interpolation. Can also
-     * contain user identifiers (user_id, userId, anonymousId) if not provided
-     * elsewhere.
-     */
-    data?: {
-        [key: string]: unknown;
-    };
-    /**
-     * Profile data for the user. Can contain contact information (email,
-     * phone_number), user identifiers (user_id, userId, anonymousId), or any custom
-     * profile fields. Profile fields are merged with any existing stored profile for
-     * the user. Include context.tenant_id to load a tenant-scoped profile for
-     * multi-tenant scenarios.
-     */
-    profile?: {
-        [key: string]: unknown;
-    };
-    /**
-     * A unique identifier for the user. If not provided, the system will attempt to
-     * resolve the user identifier from profile or data objects.
-     */
-    user_id?: string;
-}
-export interface JourneysInvokeResponse {
-    /**
-     * A unique identifier for the journey run that was created.
-     */
-    runId: string;
-}
-export interface JourneysListResponse {
-    /**
-     * A cursor token for pagination. Present when there are more results available.
-     */
-    cursor?: string;
-    templates?: Array<Journey>;
-}
-export interface JourneyListParams {
-    /**
-     * A cursor token for pagination. Use the cursor from the previous response to
-     * fetch the next page of results.
-     */
-    cursor?: string;
-    /**
-     * The version of journeys to retrieve. Accepted values are published (for
-     * published journeys) or draft (for draft journeys). Defaults to published.
-     */
-    version?: 'published' | 'draft';
-}
-export interface JourneyInvokeParams {
-    /**
-     * Data payload passed to the journey. The expected shape can be predefined using
-     * the schema builder in the journey editor. This data is available in journey
-     * steps for condition evaluation and template variable interpolation. Can also
-     * contain user identifiers (user_id, userId, anonymousId) if not provided
-     * elsewhere.
-     */
-    data?: {
-        [key: string]: unknown;
-    };
-    /**
-     * Profile data for the user. Can contain contact information (email,
-     * phone_number), user identifiers (user_id, userId, anonymousId), or any custom
-     * profile fields. Profile fields are merged with any existing stored profile for
-     * the user. Include context.tenant_id to load a tenant-scoped profile for
-     * multi-tenant scenarios.
-     */
-    profile?: {
-        [key: string]: unknown;
-    };
-    /**
-     * A unique identifier for the user. If not provided, the system will attempt to
-     * resolve the user identifier from profile or data objects.
-     */
-    user_id?: string;
-}
-export declare namespace Journeys {
-    export { type Journey as Journey, type JourneysInvokeRequest as JourneysInvokeRequest, type JourneysInvokeResponse as JourneysInvokeResponse, type JourneysListResponse as JourneysListResponse, type JourneyListParams as JourneyListParams, type JourneyInvokeParams as JourneyInvokeParams, };
-}
+export * from "./journeys/index.mjs";
 //# sourceMappingURL=journeys.d.mts.map

package/resources/journeys.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"journeys.d.mts","sourceRoot":"","sources":["../src/resources/journeys.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAInC;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;CAGtC;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;;OAMG;IACH,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAElC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC;CACjC;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;OAMG;IACH,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAElC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"journeys.d.mts","sourceRoot":"","sources":["../src/resources/journeys.ts"],"names":[],"mappings":"AAEA,qCAAiC"}