@trycourier/courier 7.11.0 → 7.19.2

package/src/resources/journeys/journeys.ts

@@ -10,7 +10,10 @@ import {
   TemplateListParams,
   TemplateListVersionsParams,
   TemplatePublishParams,
+  TemplatePutContentParams,
+  TemplatePutLocaleParams,
   TemplateReplaceParams,
+  TemplateRetrieveContentParams,
   TemplateRetrieveParams,
   Templates,
 } from './templates';
@@ -99,6 +102,25 @@ export class Journeys extends APIResource {
     });
   }
 
+  /**
+   * Cancel journey runs. The request body must include EXACTLY ONE of
+   * `cancelation_token` (cancels every run associated with the token) or `run_id`
+   * (cancels a single tenant-scoped run). Supplying both or neither returns a `400`.
+   * A `run_id` that does not match a run for the tenant returns `404`. Cancelation
+   * is idempotent: a run that has already finished (`PROCESSED`/`ERROR`) or was
+   * already `CANCELED` is left unchanged and its current status is returned.
+   *
+   * @example
+   * ```ts
+   * const cancelJourneyResponse = await client.journeys.cancel({
+   *   cancelation_token: 'order-1234',
+   * });
+   * ```
+   */
+  cancel(body: JourneyCancelParams, options?: RequestOptions): APIPromise<CancelJourneyResponse> {
+    return this._client.post('/journeys/cancel', { body, ...options });
+  }
+
   /**
    * Invoke a journey by id or alias to start a new run. The response includes a
    * `runId` identifying the run.
@@ -179,6 +201,48 @@ export class Journeys extends APIResource {
   }
 }
 
+/**
+ * Request body for `POST /journeys/cancel`. Provide EXACTLY ONE of
+ * `cancelation_token` (cancels every run associated with the token) or `run_id`
+ * (cancels a single tenant-scoped run).
+ */
+export type CancelJourneyRequest = CancelJourneyRequest.ByCancelationToken | CancelJourneyRequest.ByRunID;
+
+export namespace CancelJourneyRequest {
+  export interface ByCancelationToken {
+    cancelation_token: string;
+  }
+
+  export interface ByRunID {
+    run_id: string;
+  }
+}
+
+/**
+ * `202 Accepted` body for `POST /journeys/cancel`, returning the submitted
+ * identifier. When called with `cancelation_token`, returns
+ * `{ cancelation_token }`; when called with `run_id`, returns
+ * `{ run_id, status }`.
+ */
+export type CancelJourneyResponse = CancelJourneyResponse.TokenBranch | CancelJourneyResponse.RunIDBranch;
+
+export namespace CancelJourneyResponse {
+  export interface TokenBranch {
+    cancelation_token: string;
+  }
+
+  export interface RunIDBranch {
+    run_id: string;
+
+    /**
+     * The run's resulting status. `CANCELED` when the run was active and has been
+     * canceled; `PROCESSED` or `ERROR` when the run had already finished and was left
+     * unchanged; `CANCELED` for an already-canceled run.
+     */
+    status: string;
+  }
+}
+
 /**
  * Request body for creating a journey.
  */
@@ -379,6 +443,60 @@ export interface JourneyExitNode {
   id?: string;
 }
 
+/**
+ * A/B experiment config for a send node. The recipient is deterministically
+ * bucketed by `bucketingKey` and routed to one of the `variants` in proportion to
+ * its `weight`. Present on a send node INSTEAD OF `message.template`.
+ */
+export interface JourneyExperiment {
+  /**
+   * The value used to deterministically assign a recipient to a variant. Must be
+   * non-empty with no leading or trailing whitespace.
+   */
+  bucketingKey: string;
+
+  /**
+   * Between 2 and 10 weighted template variants.
+   */
+  variants: Array<JourneyExperimentVariant>;
+
+  /**
+   * Unique experiment id (prefixed `exp_`). Omit to have one generated
+   * automatically; when supplied it must be a valid `exp_` id.
+   */
+  id?: string;
+
+  /**
+   * Optional display name for the experiment.
+   */
+  name?: string;
+}
+
+/**
+ * A single weighted variant of an experiment. Variant ids must be unique within
+ * the experiment and the sum of all variant weights must be greater than 0.
+ * Weights are relative (no sum-to-100 requirement) — routing normalizes them
+ * proportionally.
+ */
+export interface JourneyExperimentVariant {
+  id: string;
+
+  /**
+   * The notification template sent for this variant.
+   */
+  templateId: string;
+
+  /**
+   * Relative routing weight. Must be non-negative.
+   */
+  weight: number;
+
+  /**
+   * Optional display name for the variant.
+   */
+  name?: string;
+}
+
 /**
  * Issue an HTTP GET or DELETE request and merge the response into the journey
  * state per `merge_strategy`.
@@ -472,10 +590,104 @@ export type JourneyNode =
   | JourneyAINode
   | JourneyThrottleStaticNode
   | JourneyThrottleDynamicNode
+  | JourneyNode.JourneyBatchNode
+  | JourneyNode.JourneyAddToDigestNode
   | JourneyExitNode
   | JourneyNode.JourneyBranchNode;
 
 export namespace JourneyNode {
+  /**
+   * Collect events arriving at the node into a single batch and fire one downstream
+   * step with the aggregated payload. The first event into a batch owns the run;
+   * later contributing events terminate at the batch step. The batch releases when
+   * any of `max_items` is reached, a quiet window of `wait_period` elapses, or the
+   * `max_wait_period` ceiling hits.
+   */
+  export interface JourneyBatchNode {
+    /**
+     * ISO 8601 duration. Hard ceiling from the first event into the batch; releases
+     * the batch unconditionally when it elapses.
+     */
+    max_wait_period: string;
+
+    /**
+     * How to select which collected events to retain in the aggregated payload when
+     * the batch releases.
+     */
+    retain: JourneyBatchNode.Retain;
+
+    scope: 'user';
+
+    type: 'batch';
+
+    /**
+     * ISO 8601 duration. Quiet window that releases the batch when it elapses with no
+     * new contributing events. Must be less than `max_wait_period`.
+     */
+    wait_period: string;
+
+    id?: string;
+
+    /**
+     * Optional partition key. Events with the same `category_key` are batched
+     * together; events with different values are batched separately.
+     */
+    category_key?: string;
+
+    /**
+     * Condition spec for a journey node. Accepts a single condition atom, an AND/OR
+     * group, or an AND/OR nested group. Omit the `conditions` property entirely to
+     * express "no conditions".
+     */
+    conditions?: JourneysAPI.JourneyConditionsField;
+
+    /**
+     * Releases the batch once this many events have been collected.
+     */
+    max_items?: number;
+  }
+
+  export namespace JourneyBatchNode {
+    /**
+     * How to select which collected events to retain in the aggregated payload when
+     * the batch releases.
+     */
+    export interface Retain {
+      count: number;
+
+      type: 'first' | 'last' | 'highest' | 'lowest';
+
+      /**
+       * Dot-path into the event payload (e.g. `data.priority`). Required when `type` is
+       * `highest` or `lowest`.
+       */
+      sort_key?: string;
+    }
+  }
+
+  /**
+   * Add the current event to a digest keyed by the given subscription topic. The
+   * digest accumulates events and releases them on the schedule configured for the
+   * topic.
+   */
+  export interface JourneyAddToDigestNode {
+    /**
+     * The subscription topic that owns the digest the event is added to.
+     */
+    subscription_topic_id: string;
+
+    type: 'add-to-digest';
+
+    id?: string;
+
+    /**
+     * Condition spec for a journey node. Accepts a single condition atom, an AND/OR
+     * group, or an AND/OR nested group. Omit the `conditions` property entirely to
+     * express "no conditions".
+     */
+    conditions?: JourneysAPI.JourneyConditionsField;
+  }
+
   /**
    * Branch node. Routes to the first entry in `paths[]` whose `conditions` match,
    * else falls through to `default.nodes`.
@@ -571,8 +783,11 @@ export interface JourneySegmentTriggerNode {
 }
 
 /**
- * Send a notification template to the recipient. Optionally override the recipient
- * address, delay the send, or attach `data`.
+ * Send to the recipient. A send node sources its content from EXACTLY ONE of
+ * `message.template` (a single notification template) or `experiment` (an A/B
+ * split across weighted template variants) — supplying both, or neither, is
+ * rejected. Optionally override the recipient address, delay the send, or attach
+ * `data`.
  */
 export interface JourneySendNode {
   message: JourneySendNode.Message;
@@ -587,16 +802,23 @@ export interface JourneySendNode {
    * express "no conditions".
    */
   conditions?: JourneyConditionsField;
+
+  /**
+   * A/B experiment config for a send node. The recipient is deterministically
+   * bucketed by `bucketingKey` and routed to one of the `variants` in proportion to
+   * its `weight`. Present on a send node INSTEAD OF `message.template`.
+   */
+  experiment?: JourneyExperiment;
 }
 
 export namespace JourneySendNode {
   export interface Message {
-    template: string;
-
     data?: { [key: string]: unknown };
 
     delay?: Message.Delay;
 
+    template?: string;
+
     to?: Message.To;
   }
 
@@ -946,6 +1168,18 @@ export interface JourneyListParams {
   version?: 'published' | 'draft';
 }
 
+export type JourneyCancelParams = JourneyCancelParams.ByCancelationToken | JourneyCancelParams.ByRunID;
+
+export declare namespace JourneyCancelParams {
+  export interface ByCancelationToken {
+    cancelation_token: string;
+  }
+
+  export interface ByRunID {
+    run_id: string;
+  }
+}
+
 export interface JourneyInvokeParams {
   /**
    * Data payload passed to the journey. The expected shape can be predefined using
@@ -993,6 +1227,8 @@ Journeys.Templates = Templates;
 
 export declare namespace Journeys {
   export {
+    type CancelJourneyRequest as CancelJourneyRequest,
+    type CancelJourneyResponse as CancelJourneyResponse,
     type CreateJourneyRequest as CreateJourneyRequest,
     type Journey as Journey,
     type JourneyAINode as JourneyAINode,
@@ -1004,6 +1240,8 @@ export declare namespace Journeys {
     type JourneyDelayDurationNode as JourneyDelayDurationNode,
     type JourneyDelayUntilNode as JourneyDelayUntilNode,
     type JourneyExitNode as JourneyExitNode,
+    type JourneyExperiment as JourneyExperiment,
+    type JourneyExperimentVariant as JourneyExperimentVariant,
     type JourneyFetchGetDeleteNode as JourneyFetchGetDeleteNode,
     type JourneyFetchPostPutNode as JourneyFetchPostPutNode,
     type JourneyMergeStrategy as JourneyMergeStrategy,
@@ -1029,6 +1267,7 @@ export declare namespace Journeys {
     type JourneyCreateParams as JourneyCreateParams,
     type JourneyRetrieveParams as JourneyRetrieveParams,
     type JourneyListParams as JourneyListParams,
+    type JourneyCancelParams as JourneyCancelParams,
     type JourneyInvokeParams as JourneyInvokeParams,
     type JourneyPublishParams as JourneyPublishParams,
     type JourneyReplaceParams as JourneyReplaceParams,
@@ -1042,6 +1281,9 @@ export declare namespace Journeys {
     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,
   };
 }

package/src/resources/journeys/templates.ts

@@ -141,6 +141,65 @@ export class Templates extends APIResource {
     });
   }
 
+  /**
+   * 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> {
+    const { templateId, ...body } = params;
+    return this._client.put(path`/journeys/${templateId}/templates/${notificationID}/content`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * 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> {
+    const { templateId, notificationId, ...body } = params;
+    return this._client.put(path`/journeys/${templateId}/templates/${notificationId}/locales/${localeID}`, {
+      body,
+      ...options,
+    });
+  }
+
   /**
    * Replace the journey-scoped notification template draft.
    *
@@ -167,6 +226,33 @@ export class Templates extends APIResource {
     const { templateId, ...body } = params;
     return this._client.put(path`/journeys/${templateId}/templates/${notificationID}`, { body, ...options });
   }
+
+  /**
+   * 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> {
+    const { templateId, ...query } = params;
+    return this._client.get(path`/journeys/${templateId}/templates/${notificationID}/content`, {
+      query,
+      ...options,
+    });
+  }
 }
 
 export interface TemplateCreateParams {
@@ -256,6 +342,72 @@ export interface TemplatePublishParams {
   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 namespace TemplatePutContentParams {
+  /**
+   * 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 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 namespace TemplatePutLocaleParams {
+  export interface Element {
+    /**
+     * Target element ID.
+     */
+    id: string;
+
+    [k: string]: unknown;
+  }
+}
+
 export interface TemplateReplaceParams {
   /**
    * Path param: Journey id
@@ -305,6 +457,19 @@ export namespace TemplateReplaceParams {
   }
 }
 
+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,
@@ -313,6 +478,9 @@ export declare namespace Templates {
     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,
   };
 }

package/src/resources/messages.ts

@@ -52,6 +52,17 @@ export class Messages extends APIResource {
   ): APIPromise<MessageHistoryResponse> {
     return this._client.get(path`/messages/${messageID}/history`, { query, ...options });
   }
+
+  /**
+   * Resend a previously sent message. The original send request is loaded from
+   * storage and a brand-new send is enqueued for the same recipient and content,
+   * producing a **new** `messageId` — the original message is not modified.
+   * Throttled by a per-message rate limit; a repeat inside the limit window returns
+   * `429 Too Many Requests`.
+   */
+  resend(messageID: string, options?: RequestOptions): APIPromise<MessageResendResponse> {
+    return this._client.post(path`/messages/${messageID}/resend`, options);
+  }
 }
 
 export interface MessageDetails {
@@ -244,6 +255,14 @@ export interface MessageHistoryResponse {
   results: Array<{ [key: string]: unknown }>;
 }
 
+export interface MessageResendResponse {
+  /**
+   * The new message id for the resent message. It is distinct from the id of the
+   * original message that was resent.
+   */
+  messageId: string;
+}
+
 export interface MessageListParams {
   /**
    * A boolean value that indicates whether archived messages should be included in
@@ -339,6 +358,7 @@ export declare namespace Messages {
     type MessageListResponse as MessageListResponse,
     type MessageContentResponse as MessageContentResponse,
     type MessageHistoryResponse as MessageHistoryResponse,
+    type MessageResendResponse as MessageResendResponse,
     type MessageListParams as MessageListParams,
     type MessageHistoryParams as MessageHistoryParams,
   };

package/src/resources/notifications/checks.ts

@@ -9,7 +9,7 @@ import { path } from '../../internal/utils/path';
 
 export class Checks extends APIResource {
   /**
-   * Replace the checks for a notification template submission.
+   * Replace the submission checks for a notification template.
    *
    * @example
    * ```ts
@@ -38,7 +38,7 @@ export class Checks extends APIResource {
   }
 
   /**
-   * Retrieve the checks for a notification template submission.
+   * Retrieve the submission checks for a notification template.
    *
    * @example
    * ```ts
@@ -58,7 +58,7 @@ export class Checks extends APIResource {
   }
 
   /**
-   * Cancel a notification template submission.
+   * Cancel a submission for a notification template.
    *
    * @example
    * ```ts

package/src/resources/notifications/notifications.ts

@@ -30,9 +30,13 @@ export class Notifications extends APIResource {
    *     notification: {
    *       name: 'Welcome Email',
    *       tags: ['onboarding', 'welcome'],
-   *       brand: { id: 'brand_abc' },
-   *       subscription: { topic_id: 'marketing' },
-   *       routing: { strategy_id: 'rs_123' },
+   *       brand: { id: 'bnd_01kx4mrd0pfzw8wt7pn7p2fzag' },
+   *       subscription: {
+   *         topic_id: 'pt_01kx4h2jdafq8bk9a26x0kvd1t',
+   *       },
+   *       routing: {
+   *         strategy_id: 'rs_01kx4h2jdafq8bk9amzvy6hbv0',
+   *       },
    *       content: {
    *         version: '2022-01-01',
    *         elements: [{ type: 'channel' }],

package/src/resources/shared.ts

@@ -33,6 +33,13 @@ export interface AudienceFilterConfig {
    * Array of filter rules (single conditions or nested groups)
    */
   filters: Array<FilterConfig>;
+
+  /**
+   * The logical operator (AND/OR) combining the rules in `filters`. Required when
+   * `filters` contains more than one rule. If omitted, the top-level `operator`
+   * field on the request is used instead.
+   */
+  operator?: 'AND' | 'OR';
 }
 
 /**

package/src/resources/users/index.ts

@@ -2,11 +2,17 @@
 
 export {
   Preferences,
+  type BulkPreferenceTopic,
   type TopicPreference,
   type PreferenceRetrieveResponse,
+  type PreferenceBulkReplaceResponse,
+  type PreferenceBulkUpdateResponse,
   type PreferenceRetrieveTopicResponse,
   type PreferenceUpdateOrCreateTopicResponse,
   type PreferenceRetrieveParams,
+  type PreferenceBulkReplaceParams,
+  type PreferenceBulkUpdateParams,
+  type PreferenceDeleteTopicParams,
   type PreferenceRetrieveTopicParams,
   type PreferenceUpdateOrCreateTopicParams,
 } from './preferences';