@trycourier/courier 7.10.1 → 7.11.0

package/src/resources/journeys/templates.ts

@@ -0,0 +1,318 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import * as JourneysAPI from './journeys';
+import * as NotificationsAPI from '../notifications/notifications';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+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: string,
+    body: TemplateCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<JourneysAPI.JourneyTemplateGetResponse> {
+    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: string,
+    params: TemplateRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<JourneysAPI.JourneyTemplateGetResponse> {
+    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: string,
+    query: TemplateListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<JourneysAPI.JourneyTemplateListResponse> {
+    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: string, params: TemplateArchiveParams, options?: RequestOptions): APIPromise<void> {
+    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: string,
+    params: TemplateListVersionsParams,
+    options?: RequestOptions,
+  ): APIPromise<NotificationsAPI.NotificationTemplateVersionListResponse> {
+    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: string, params: TemplatePublishParams, options?: RequestOptions): APIPromise<void> {
+    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: string,
+    params: TemplateReplaceParams,
+    options?: RequestOptions,
+  ): APIPromise<JourneysAPI.JourneyTemplateGetResponse> {
+    const { templateId, ...body } = params;
+    return this._client.put(path`/journeys/${templateId}/templates/${notificationID}`, { body, ...options });
+  }
+}
+
+export interface TemplateCreateParams {
+  channel: string;
+
+  notification: TemplateCreateParams.Notification;
+
+  providerKey?: string;
+
+  state?: string;
+}
+
+export namespace TemplateCreateParams {
+  export interface Notification {
+    brand: Notification.Brand | null;
+
+    content: Notification.Content;
+
+    name: string;
+
+    subscription: Notification.Subscription | null;
+
+    tags: Array<string>;
+  }
+
+  export namespace Notification {
+    export interface Brand {
+      id: string;
+    }
+
+    export interface Content {
+      elements: Array<Shared.ElementalNode>;
+
+      version: '2022-01-01';
+
+      scope?: 'default' | 'strict';
+    }
+
+    export 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 namespace TemplateReplaceParams {
+  export interface Notification {
+    brand: Notification.Brand | null;
+
+    content: Notification.Content;
+
+    name: string;
+
+    subscription: Notification.Subscription | null;
+
+    tags: Array<string>;
+  }
+
+  export namespace Notification {
+    export interface Brand {
+      id: string;
+    }
+
+    export interface Content {
+      elements: Array<Shared.ElementalNode>;
+
+      version: '2022-01-01';
+
+      scope?: 'default' | 'strict';
+    }
+
+    export 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,
+  };
+}

package/src/resources/journeys.ts

@@ -1,174 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../core/resource';
-import { APIPromise } from '../core/api-promise';
-import { RequestOptions } from '../internal/request-options';
-import { path } from '../internal/utils/path';
-
-export 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> {
-    return this._client.get('/journeys', { query, ...options });
-  }
-
-  /**
-   * 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> {
-    return this._client.post(path`/journeys/${templateID}/invoke`, { body, ...options });
-  }
-}
-
-/**
- * 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';

package/src/resources/notifications/checks.ts

@@ -9,6 +9,8 @@ import { path } from '../../internal/utils/path';
 
 export class Checks extends APIResource {
   /**
+   * Replace the checks for a notification template submission.
+   *
    * @example
    * ```ts
    * const check = await client.notifications.checks.update(
@@ -36,6 +38,8 @@ export class Checks extends APIResource {
   }
 
   /**
+   * Retrieve the checks for a notification template submission.
+   *
    * @example
    * ```ts
    * const checks = await client.notifications.checks.list(
@@ -54,6 +58,8 @@ export class Checks extends APIResource {
   }
 
   /**
+   * Cancel a notification template submission.
+   *
    * @example
    * ```ts
    * await client.notifications.checks.delete('submissionId', {
@@ -80,7 +86,7 @@ export interface CheckListResponse {
 
 export interface CheckUpdateParams {
   /**
-   * Path param
+   * Path param: Notification template ID.
    */
   id: string;
 
@@ -91,10 +97,16 @@ export interface CheckUpdateParams {
 }
 
 export interface CheckListParams {
+  /**
+   * Notification template ID.
+   */
   id: string;
 }
 
 export interface CheckDeleteParams {
+  /**
+   * Notification template ID.
+   */
   id: string;
 }
 

package/src/resources/notifications/index.ts

@@ -20,9 +20,9 @@ export {
   type NotificationGetContent,
   type NotificationLocalePutRequest,
   type NotificationTemplateCreateRequest,
-  type NotificationTemplateGetResponse,
   type NotificationTemplatePayload,
   type NotificationTemplatePublishRequest,
+  type NotificationTemplateResponse,
   type NotificationTemplateState,
   type NotificationTemplateSummary,
   type NotificationTemplateUpdateRequest,