@trycourier/courier 7.9.0 → 7.10.1

package/src/resources/notifications/notifications.ts

@@ -12,15 +12,12 @@ import {
   CheckUpdateResponse,
   Checks,
 } from './checks';
-import * as DraftAPI from './draft';
-import { Draft } from './draft';
 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 Notifications extends APIResource {
-  draft: DraftAPI.Draft = new DraftAPI.Draft(this._client);
   checks: ChecksAPI.Checks = new ChecksAPI.Checks(this._client);
 
   /**
@@ -29,7 +26,7 @@ export class Notifications extends APIResource {
    *
    * @example
    * ```ts
-   * const notificationTemplateMutationResponse =
+   * const notificationTemplateGetResponse =
    *   await client.notifications.create({
    *     notification: {
    *       name: 'Welcome Email',
@@ -49,7 +46,7 @@ export class Notifications extends APIResource {
   create(
     body: NotificationCreateParams,
     options?: RequestOptions,
-  ): APIPromise<NotificationTemplateMutationResponse> {
+  ): APIPromise<NotificationTemplateGetResponse> {
     return this._client.post('/notifications', { body, ...options });
   }
 
@@ -139,12 +136,88 @@ export class Notifications extends APIResource {
     });
   }
 
+  /**
+   * Replace the elemental content of a notification template. Overwrites all
+   * elements in the template with the provided content. Only supported for V2
+   * (elemental) templates.
+   *
+   * @example
+   * ```ts
+   * const notificationContentMutationResponse =
+   *   await client.notifications.putContent('id', {
+   *     content: {
+   *       version: '2022-01-01',
+   *       elements: [{ type: 'channel' }],
+   *     },
+   *     state: 'DRAFT',
+   *   });
+   * ```
+   */
+  putContent(
+    id: string,
+    body: NotificationPutContentParams,
+    options?: RequestOptions,
+  ): APIPromise<NotificationContentMutationResponse> {
+    return this._client.put(path`/notifications/${id}/content`, { body, ...options });
+  }
+
+  /**
+   * Update a single element within a notification template. Only supported for V2
+   * (elemental) templates.
+   *
+   * @example
+   * ```ts
+   * const notificationContentMutationResponse =
+   *   await client.notifications.putElement('elementId', {
+   *     id: 'id',
+   *     type: 'text',
+   *     data: { content: 'Updated text content' },
+   *     state: 'DRAFT',
+   *   });
+   * ```
+   */
+  putElement(
+    elementID: string,
+    params: NotificationPutElementParams,
+    options?: RequestOptions,
+  ): APIPromise<NotificationContentMutationResponse> {
+    const { id, ...body } = params;
+    return this._client.put(path`/notifications/${id}/elements/${elementID}`, { body, ...options });
+  }
+
+  /**
+   * Set locale-specific content overrides for a notification template. Each element
+   * override must reference an existing element by ID. Only supported for V2
+   * (elemental) templates.
+   *
+   * @example
+   * ```ts
+   * const notificationContentMutationResponse =
+   *   await client.notifications.putLocale('localeId', {
+   *     id: 'id',
+   *     elements: [
+   *       { id: 'elem_1', content: 'Hola {{data.name}}.' },
+   *       { id: 'elem_2', title: 'Bienvenido!' },
+   *     ],
+   *     state: 'DRAFT',
+   *   });
+   * ```
+   */
+  putLocale(
+    localeID: string,
+    params: NotificationPutLocaleParams,
+    options?: RequestOptions,
+  ): APIPromise<NotificationContentMutationResponse> {
+    const { id, ...body } = params;
+    return this._client.put(path`/notifications/${id}/locales/${localeID}`, { body, ...options });
+  }
+
   /**
    * Replace a notification template. All fields are required.
    *
    * @example
    * ```ts
-   * const notificationTemplateMutationResponse =
+   * const notificationTemplateGetResponse =
    *   await client.notifications.replace('id', {
    *     notification: {
    *       name: 'Updated Name',
@@ -165,19 +238,29 @@ export class Notifications extends APIResource {
     id: string,
     body: NotificationReplaceParams,
     options?: RequestOptions,
-  ): APIPromise<NotificationTemplateMutationResponse> {
+  ): APIPromise<NotificationTemplateGetResponse> {
     return this._client.put(path`/notifications/${id}`, { body, ...options });
   }
 
   /**
+   * Retrieve the content of a notification template. The response shape depends on
+   * whether the template uses V1 (blocks/channels) or V2 (elemental) content. Use
+   * the `version` query parameter to select draft, published, or a specific
+   * historical version.
+   *
    * @example
    * ```ts
-   * const notificationGetContent =
-   *   await client.notifications.retrieveContent('id');
+   * const response = await client.notifications.retrieveContent(
+   *   'id',
+   * );
    * ```
    */
-  retrieveContent(id: string, options?: RequestOptions): APIPromise<NotificationGetContent> {
-    return this._client.get(path`/notifications/${id}/content`, options);
+  retrieveContent(
+    id: string,
+    query: NotificationRetrieveContentParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<NotificationRetrieveContentResponse> {
+    return this._client.get(path`/notifications/${id}/content`, { query, ...options });
   }
 }
 
@@ -193,6 +276,145 @@ export interface Check extends BaseCheck {
   updated: number;
 }
 
+/**
+ * An element with its content checksum and optional nested elements and locale
+ * checksums.
+ */
+export interface ElementWithChecksums {
+  /**
+   * MD5 hash of translatable content.
+   */
+  checksum: string;
+
+  /**
+   * Element type (text, meta, action, etc.).
+   */
+  type: string;
+
+  id?: string;
+
+  /**
+   * Nested child elements (for group-type elements).
+   */
+  elements?: Array<ElementWithChecksums>;
+
+  /**
+   * Locale-specific content with checksums.
+   */
+  locales?: { [key: string]: ElementWithChecksums.Locales };
+
+  [k: string]: unknown;
+}
+
+export namespace ElementWithChecksums {
+  export interface Locales {
+    checksum: string;
+  }
+}
+
+/**
+ * Elemental content response for V2 templates. Contains versioned elements with
+ * content checksums.
+ */
+export interface NotificationContentGetResponse {
+  elements: Array<ElementWithChecksums>;
+
+  /**
+   * Content version identifier.
+   */
+  version: string;
+}
+
+/**
+ * Shared mutation response for `PUT` content, `PUT` element, and `PUT` locale
+ * operations. Contains the template ID, content version, per-element checksums,
+ * and resulting state.
+ */
+export interface NotificationContentMutationResponse {
+  /**
+   * Template ID.
+   */
+  id: string;
+
+  elements: Array<NotificationContentMutationResponse.Element>;
+
+  /**
+   * Template state. Defaults to `DRAFT`.
+   */
+  state: NotificationTemplateState;
+
+  /**
+   * Content version identifier.
+   */
+  version: string;
+}
+
+export namespace NotificationContentMutationResponse {
+  export interface Element {
+    id: string;
+
+    checksum: string;
+  }
+}
+
+/**
+ * Request body for replacing the elemental content of a notification template.
+ */
+export interface NotificationContentPutRequest {
+  /**
+   * Elemental content payload. The server defaults `version` when omitted.
+   */
+  content: NotificationContentPutRequest.Content;
+
+  /**
+   * Template state. Defaults to `DRAFT`.
+   */
+  state?: NotificationTemplateState;
+}
+
+export namespace NotificationContentPutRequest {
+  /**
+   * Elemental content payload. The server defaults `version` when omitted.
+   */
+  export interface Content {
+    elements: Array<Shared.ElementalNode>;
+
+    /**
+     * Content version identifier (e.g., `2022-01-01`). Optional; server defaults when
+     * omitted.
+     */
+    version?: string;
+  }
+}
+
+/**
+ * Request body for updating a single element. Additional type-specific fields are
+ * allowed.
+ */
+export interface NotificationElementPutRequest {
+  /**
+   * Element type (text, meta, action, image, etc.).
+   */
+  type: string;
+
+  channels?: Array<string>;
+
+  data?: { [key: string]: unknown };
+
+  if?: string;
+
+  loop?: string;
+
+  ref?: string;
+
+  /**
+   * Template state. Defaults to `DRAFT`.
+   */
+  state?: NotificationTemplateState;
+
+  [k: string]: unknown;
+}
+
 export interface NotificationGetContent {
   blocks?: Array<NotificationGetContent.Block> | null;
 
@@ -259,6 +481,33 @@ export namespace NotificationGetContent {
   }
 }
 
+/**
+ * Request body for setting locale-specific content overrides. Each element
+ * override must include the target element ID.
+ */
+export interface NotificationLocalePutRequest {
+  /**
+   * Elements with locale-specific content overrides.
+   */
+  elements: Array<NotificationLocalePutRequest.Element>;
+
+  /**
+   * Template state. Defaults to `DRAFT`.
+   */
+  state?: NotificationTemplateState;
+}
+
+export namespace NotificationLocalePutRequest {
+  export interface Element {
+    /**
+     * Target element ID.
+     */
+    id: string;
+
+    [k: string]: unknown;
+  }
+}
+
 /**
  * Request body for creating a notification template.
  */
@@ -326,27 +575,6 @@ export namespace NotificationTemplateGetResponse {
   }
 }
 
-/**
- * Response returned by POST and PUT operations.
- */
-export interface NotificationTemplateMutationResponse {
-  notification: NotificationTemplateMutationResponse.Notification;
-
-  /**
-   * The template state after the operation. Always uppercase.
-   */
-  state: 'DRAFT' | 'PUBLISHED';
-}
-
-export namespace NotificationTemplateMutationResponse {
-  export interface Notification {
-    /**
-     * The ID of the created or updated template.
-     */
-    id: string;
-  }
-}
-
 /**
  * Full document shape used in POST and PUT request bodies, and returned inside the
  * GET response envelope.
@@ -417,6 +645,11 @@ export interface NotificationTemplatePublishRequest {
   version?: string;
 }
 
+/**
+ * Template state. Defaults to `DRAFT`.
+ */
+export type NotificationTemplateState = 'DRAFT' | 'PUBLISHED';
+
 /**
  * V2 (CDS) template summary returned in list responses.
  */
@@ -548,6 +781,12 @@ export namespace NotificationListResponse {
   }
 }
 
+/**
+ * Elemental content response for V2 templates. Contains versioned elements with
+ * content checksums.
+ */
+export type NotificationRetrieveContentResponse = NotificationContentGetResponse | NotificationGetContent;
+
 export interface NotificationCreateParams {
   /**
    * Full document shape used in POST and PUT request bodies, and returned inside the
@@ -606,6 +845,105 @@ export interface NotificationPublishParams {
   version?: string;
 }
 
+export interface NotificationPutContentParams {
+  /**
+   * Elemental content payload. The server defaults `version` when omitted.
+   */
+  content: NotificationPutContentParams.Content;
+
+  /**
+   * Template state. Defaults to `DRAFT`.
+   */
+  state?: NotificationTemplateState;
+}
+
+export namespace NotificationPutContentParams {
+  /**
+   * Elemental content payload. The server defaults `version` when omitted.
+   */
+  export interface Content {
+    elements: Array<Shared.ElementalNode>;
+
+    /**
+     * Content version identifier (e.g., `2022-01-01`). Optional; server defaults when
+     * omitted.
+     */
+    version?: string;
+  }
+}
+
+export interface NotificationPutElementParams {
+  /**
+   * Path param: Notification template ID (`nt_` prefix).
+   */
+  id: string;
+
+  /**
+   * Body param: Element type (text, meta, action, image, etc.).
+   */
+  type: string;
+
+  /**
+   * Body param
+   */
+  channels?: Array<string>;
+
+  /**
+   * Body param
+   */
+  data?: { [key: string]: unknown };
+
+  /**
+   * Body param
+   */
+  if?: string;
+
+  /**
+   * Body param
+   */
+  loop?: string;
+
+  /**
+   * Body param
+   */
+  ref?: string;
+
+  /**
+   * Body param: Template state. Defaults to `DRAFT`.
+   */
+  state?: NotificationTemplateState;
+
+  [k: string]: unknown;
+}
+
+export interface NotificationPutLocaleParams {
+  /**
+   * Path param: Notification template ID (`nt_` prefix).
+   */
+  id: string;
+
+  /**
+   * Body param: Elements with locale-specific content overrides.
+   */
+  elements: Array<NotificationPutLocaleParams.Element>;
+
+  /**
+   * Body param: Template state. Defaults to `DRAFT`.
+   */
+  state?: NotificationTemplateState;
+}
+
+export namespace NotificationPutLocaleParams {
+  export interface Element {
+    /**
+     * Target element ID.
+     */
+    id: string;
+
+    [k: string]: unknown;
+  }
+}
+
 export interface NotificationReplaceParams {
   /**
    * Full document shape used in POST and PUT request bodies, and returned inside the
@@ -620,34 +958,50 @@ export interface NotificationReplaceParams {
   state?: 'DRAFT' | 'PUBLISHED';
 }
 
-Notifications.Draft = Draft;
+export interface NotificationRetrieveContentParams {
+  /**
+   * Accepts `draft`, `published`, or a version string (e.g., `v001`). Defaults to
+   * `published`.
+   */
+  version?: string;
+}
+
 Notifications.Checks = Checks;
 
 export declare namespace Notifications {
   export {
     type BaseCheck as BaseCheck,
     type Check as Check,
+    type ElementWithChecksums as ElementWithChecksums,
+    type NotificationContentGetResponse as NotificationContentGetResponse,
+    type NotificationContentMutationResponse as NotificationContentMutationResponse,
+    type NotificationContentPutRequest as NotificationContentPutRequest,
+    type NotificationElementPutRequest as NotificationElementPutRequest,
     type NotificationGetContent as NotificationGetContent,
+    type NotificationLocalePutRequest as NotificationLocalePutRequest,
     type NotificationTemplateCreateRequest as NotificationTemplateCreateRequest,
     type NotificationTemplateGetResponse as NotificationTemplateGetResponse,
-    type NotificationTemplateMutationResponse as NotificationTemplateMutationResponse,
     type NotificationTemplatePayload as NotificationTemplatePayload,
     type NotificationTemplatePublishRequest as NotificationTemplatePublishRequest,
+    type NotificationTemplateState as NotificationTemplateState,
     type NotificationTemplateSummary as NotificationTemplateSummary,
     type NotificationTemplateUpdateRequest as NotificationTemplateUpdateRequest,
     type NotificationTemplateVersionListResponse as NotificationTemplateVersionListResponse,
     type VersionNode as VersionNode,
     type NotificationListResponse as NotificationListResponse,
+    type NotificationRetrieveContentResponse as NotificationRetrieveContentResponse,
     type NotificationCreateParams as NotificationCreateParams,
     type NotificationRetrieveParams as NotificationRetrieveParams,
     type NotificationListParams as NotificationListParams,
     type NotificationListVersionsParams as NotificationListVersionsParams,
     type NotificationPublishParams as NotificationPublishParams,
+    type NotificationPutContentParams as NotificationPutContentParams,
+    type NotificationPutElementParams as NotificationPutElementParams,
+    type NotificationPutLocaleParams as NotificationPutLocaleParams,
     type NotificationReplaceParams as NotificationReplaceParams,
+    type NotificationRetrieveContentParams as NotificationRetrieveContentParams,
   };
 
-  export { Draft as Draft };
-
   export {
     Checks as Checks,
     type CheckUpdateResponse as CheckUpdateResponse,

package/src/resources/providers/providers.ts

@@ -28,12 +28,14 @@ export class Providers extends APIResource {
   }
 
   /**
-   * Update an existing provider configuration. The `provider` key is required. All
-   * other fields are optional — omitted fields are cleared from the stored
-   * configuration (this is a full replacement, not a partial merge).
+   * Replace an existing provider configuration. The `provider` key is required and
+   * determines which provider-specific settings schema is applied. All other fields
+   * are optional — omitted fields are cleared from the stored configuration (this is
+   * a full replacement, not a partial merge). Changing the provider type for an
+   * existing configuration is not supported.
    */
   update(id: string, body: ProviderUpdateParams, options?: RequestOptions): APIPromise<Provider> {
-    return this._client.post(path`/providers/${id}`, { body, ...options });
+    return this._client.put(path`/providers/${id}`, { body, ...options });
   }
 
   /**
@@ -191,7 +193,8 @@ export interface ProviderCreateParams {
 
 export interface ProviderUpdateParams {
   /**
-   * The provider key identifying the type.
+   * The provider key identifying the type. Required on every request because it
+   * selects the provider-specific settings schema for validation.
    */
   provider: string;
 

package/src/resources/routing-strategies.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../core/resource';
 import * as Shared from './shared';
+import * as NotificationsAPI from './notifications/notifications';
 import { APIPromise } from '../core/api-promise';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
@@ -14,7 +15,7 @@ export class RoutingStrategies extends APIResource {
    *
    * @example
    * ```ts
-   * const routingStrategyMutationResponse =
+   * const routingStrategyGetResponse =
    *   await client.routingStrategies.create({
    *     name: 'Email via SendGrid',
    *     routing: { method: 'single', channels: ['email'] },
@@ -29,7 +30,7 @@ export class RoutingStrategies extends APIResource {
   create(
     body: RoutingStrategyCreateParams,
     options?: RequestOptions,
-  ): APIPromise<RoutingStrategyMutationResponse> {
+  ): APIPromise<RoutingStrategyGetResponse> {
     return this._client.post('/routing-strategies', { body, ...options });
   }
 
@@ -81,13 +82,31 @@ export class RoutingStrategies extends APIResource {
     });
   }
 
+  /**
+   * List notification templates associated with a routing strategy. Includes
+   * template metadata only, not full content.
+   *
+   * @example
+   * ```ts
+   * const associatedNotificationListResponse =
+   *   await client.routingStrategies.listNotifications('id');
+   * ```
+   */
+  listNotifications(
+    id: string,
+    query: RoutingStrategyListNotificationsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AssociatedNotificationListResponse> {
+    return this._client.get(path`/routing-strategies/${id}/notifications`, { query, ...options });
+  }
+
   /**
    * Replace a routing strategy. Full document replacement; the caller must send the
    * complete desired state. Missing optional fields are cleared.
    *
    * @example
    * ```ts
-   * const routingStrategyMutationResponse =
+   * const routingStrategyGetResponse =
    *   await client.routingStrategies.replace('id', {
    *     name: 'Email via SendGrid v2',
    *     routing: { method: 'single', channels: ['email'] },
@@ -102,11 +121,20 @@ export class RoutingStrategies extends APIResource {
     id: string,
     body: RoutingStrategyReplaceParams,
     options?: RequestOptions,
-  ): APIPromise<RoutingStrategyMutationResponse> {
+  ): APIPromise<RoutingStrategyGetResponse> {
     return this._client.put(path`/routing-strategies/${id}`, { body, ...options });
   }
 }
 
+/**
+ * Paginated list of notification templates associated with a routing strategy.
+ */
+export interface AssociatedNotificationListResponse {
+  paging: Shared.Paging;
+
+  results: Array<NotificationsAPI.NotificationTemplateSummary>;
+}
+
 /**
  * Request body for creating a routing strategy.
  */
@@ -211,16 +239,6 @@ export interface RoutingStrategyListResponse {
   results: Array<RoutingStrategySummary>;
 }
 
-/**
- * Response returned by create and replace operations.
- */
-export interface RoutingStrategyMutationResponse {
-  /**
-   * The routing strategy ID (rs\_ prefix).
-   */
-  id: string;
-}
-
 /**
  * Request body for replacing a routing strategy. Full document replacement;
  * missing optional fields are cleared.
@@ -347,6 +365,18 @@ export interface RoutingStrategyListParams {
   limit?: number;
 }
 
+export interface RoutingStrategyListNotificationsParams {
+  /**
+   * Opaque pagination cursor from a previous response. Omit for the first page.
+   */
+  cursor?: string | null;
+
+  /**
+   * Maximum number of results per page. Default 20, max 100.
+   */
+  limit?: number;
+}
+
 export interface RoutingStrategyReplaceParams {
   /**
    * Human-readable name for the routing strategy.
@@ -381,14 +411,15 @@ export interface RoutingStrategyReplaceParams {
 
 export declare namespace RoutingStrategies {
   export {
+    type AssociatedNotificationListResponse as AssociatedNotificationListResponse,
     type RoutingStrategyCreateRequest as RoutingStrategyCreateRequest,
     type RoutingStrategyGetResponse as RoutingStrategyGetResponse,
     type RoutingStrategyListResponse as RoutingStrategyListResponse,
-    type RoutingStrategyMutationResponse as RoutingStrategyMutationResponse,
     type RoutingStrategyReplaceRequest as RoutingStrategyReplaceRequest,
     type RoutingStrategySummary as RoutingStrategySummary,
     type RoutingStrategyCreateParams as RoutingStrategyCreateParams,
     type RoutingStrategyListParams as RoutingStrategyListParams,
+    type RoutingStrategyListNotificationsParams as RoutingStrategyListNotificationsParams,
     type RoutingStrategyReplaceParams as RoutingStrategyReplaceParams,
   };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '7.9.0'; // x-release-please-version
+export const VERSION = '7.10.1'; // x-release-please-version