@trycourier/courier 7.11.0 → 7.19.2

package/src/client.ts

@@ -74,6 +74,7 @@ import {
   MessageHistoryResponse,
   MessageListParams,
   MessageListResponse,
+  MessageResendResponse,
   MessageRetrieveResponse,
   Messages,
 } from './resources/messages';
@@ -106,10 +107,19 @@ import {
   Automations,
 } from './resources/automations/automations';
 import {
+  DigestCategory,
+  DigestInstance,
+  DigestInstanceListResponse,
+  Digests,
+} from './resources/digests/digests';
+import {
+  CancelJourneyRequest,
+  CancelJourneyResponse,
   CreateJourneyRequest,
   Journey,
   JourneyAINode,
   JourneyAPIInvokeTriggerNode,
+  JourneyCancelParams,
   JourneyConditionAtom,
   JourneyConditionGroup,
   JourneyConditionNestedGroup,
@@ -118,6 +128,8 @@ import {
   JourneyDelayDurationNode,
   JourneyDelayUntilNode,
   JourneyExitNode,
+  JourneyExperiment,
+  JourneyExperimentVariant,
   JourneyFetchGetDeleteNode,
   JourneyFetchPostPutNode,
   JourneyInvokeParams,
@@ -227,6 +239,22 @@ import {
   Tenants,
 } from './resources/tenants/tenants';
 import { Users } from './resources/users/users';
+import {
+  PublishPreferencesRequest,
+  PublishPreferencesResponse,
+  WorkspacePreferenceCreateParams,
+  WorkspacePreferenceCreateRequest,
+  WorkspacePreferenceGetResponse,
+  WorkspacePreferenceListResponse,
+  WorkspacePreferencePublishParams,
+  WorkspacePreferenceReplaceParams,
+  WorkspacePreferenceReplaceRequest,
+  WorkspacePreferenceTopicCreateRequest,
+  WorkspacePreferenceTopicGetResponse,
+  WorkspacePreferenceTopicListResponse,
+  WorkspacePreferenceTopicReplaceRequest,
+  WorkspacePreferences,
+} from './resources/workspace-preferences/workspace-preferences';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -872,11 +900,19 @@ export class Courier {
     return () => controller.abort();
   }
 
-  private buildBody({ options: { body, headers: rawHeaders } }: { options: FinalRequestOptions }): {
+  private buildBody({ options }: { options: FinalRequestOptions }): {
     bodyHeaders: HeadersLike;
     body: BodyInit | undefined;
   } {
+    const { body, headers: rawHeaders } = options;
     if (!body) {
+      // A resource method always passes a `body` key when its operation defines a
+      // request body, even if the caller omitted an optional body param. Keep the
+      // content-type for those, and only elide it for operations with no body at
+      // all (e.g. GET/DELETE).
+      if (body == null && 'body' in options) {
+        return this.#encoder({ body, headers: buildHeaders([rawHeaders]) });
+      }
       return { bodyHeaders: undefined, body: undefined };
     }
     const headers = buildHeaders([rawHeaders]);
@@ -945,12 +981,14 @@ export class Courier {
   journeys: API.Journeys = new API.Journeys(this);
   brands: API.Brands = new API.Brands(this);
   bulk: API.Bulk = new API.Bulk(this);
+  digests: API.Digests = new API.Digests(this);
   inbound: API.Inbound = new API.Inbound(this);
   lists: API.Lists = new API.Lists(this);
   messages: API.Messages = new API.Messages(this);
   requests: API.Requests = new API.Requests(this);
   notifications: API.Notifications = new API.Notifications(this);
   routingStrategies: API.RoutingStrategies = new API.RoutingStrategies(this);
+  workspacePreferences: API.WorkspacePreferences = new API.WorkspacePreferences(this);
   profiles: API.Profiles = new API.Profiles(this);
   tenants: API.Tenants = new API.Tenants(this);
   translations: API.Translations = new API.Translations(this);
@@ -966,12 +1004,14 @@ Courier.Automations = Automations;
 Courier.Journeys = Journeys;
 Courier.Brands = Brands;
 Courier.Bulk = Bulk;
+Courier.Digests = Digests;
 Courier.Inbound = Inbound;
 Courier.Lists = Lists;
 Courier.Messages = Messages;
 Courier.Requests = Requests;
 Courier.Notifications = Notifications;
 Courier.RoutingStrategies = RoutingStrategies;
+Courier.WorkspacePreferences = WorkspacePreferences;
 Courier.Profiles = Profiles;
 Courier.Tenants = Tenants;
 Courier.Translations = Translations;
@@ -1030,6 +1070,8 @@ export declare namespace Courier {
 
   export {
     Journeys as Journeys,
+    type CancelJourneyRequest as CancelJourneyRequest,
+    type CancelJourneyResponse as CancelJourneyResponse,
     type CreateJourneyRequest as CreateJourneyRequest,
     type Journey as Journey,
     type JourneyAINode as JourneyAINode,
@@ -1041,6 +1083,8 @@ export declare namespace Courier {
     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,
@@ -1066,6 +1110,7 @@ export declare namespace Courier {
     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,
@@ -1105,6 +1150,13 @@ export declare namespace Courier {
     type BulkListUsersParams as BulkListUsersParams,
   };
 
+  export {
+    Digests as Digests,
+    type DigestCategory as DigestCategory,
+    type DigestInstance as DigestInstance,
+    type DigestInstanceListResponse as DigestInstanceListResponse,
+  };
+
   export {
     Inbound as Inbound,
     type InboundTrackEventResponse as InboundTrackEventResponse,
@@ -1128,6 +1180,7 @@ export declare namespace Courier {
     type MessageListResponse as MessageListResponse,
     type MessageContentResponse as MessageContentResponse,
     type MessageHistoryResponse as MessageHistoryResponse,
+    type MessageResendResponse as MessageResendResponse,
     type MessageListParams as MessageListParams,
     type MessageHistoryParams as MessageHistoryParams,
   };
@@ -1182,6 +1235,23 @@ export declare namespace Courier {
     type RoutingStrategyReplaceParams as RoutingStrategyReplaceParams,
   };
 
+  export {
+    WorkspacePreferences as WorkspacePreferences,
+    type PublishPreferencesRequest as PublishPreferencesRequest,
+    type PublishPreferencesResponse as PublishPreferencesResponse,
+    type WorkspacePreferenceCreateRequest as WorkspacePreferenceCreateRequest,
+    type WorkspacePreferenceGetResponse as WorkspacePreferenceGetResponse,
+    type WorkspacePreferenceListResponse as WorkspacePreferenceListResponse,
+    type WorkspacePreferenceReplaceRequest as WorkspacePreferenceReplaceRequest,
+    type WorkspacePreferenceTopicCreateRequest as WorkspacePreferenceTopicCreateRequest,
+    type WorkspacePreferenceTopicGetResponse as WorkspacePreferenceTopicGetResponse,
+    type WorkspacePreferenceTopicListResponse as WorkspacePreferenceTopicListResponse,
+    type WorkspacePreferenceTopicReplaceRequest as WorkspacePreferenceTopicReplaceRequest,
+    type WorkspacePreferenceCreateParams as WorkspacePreferenceCreateParams,
+    type WorkspacePreferencePublishParams as WorkspacePreferencePublishParams,
+    type WorkspacePreferenceReplaceParams as WorkspacePreferenceReplaceParams,
+  };
+
   export {
     Profiles as Profiles,
     type SubscribeToListsRequestItem as SubscribeToListsRequestItem,

package/src/resources/audiences.ts

@@ -84,7 +84,8 @@ export interface Audience {
   filter?: Shared.AudienceFilterConfig | null;
 
   /**
-   * The logical operator (AND/OR) for the top-level filter
+   * The logical operator (AND/OR) combining the top-level `filter.filters`.
+   * Convenience alias for `filter.operator`.
    */
   operator?: 'AND' | 'OR';
 }
@@ -136,7 +137,9 @@ export interface AudienceUpdateParams {
   name?: string | null;
 
   /**
-   * The logical operator (AND/OR) for the top-level filter
+   * The logical operator (AND/OR) combining the top-level `filter.filters`.
+   * Convenience alias for `filter.operator`: if set, it is applied to the top-level
+   * filter group. Prefer setting `operator` directly inside `filter`.
    */
   operator?: 'AND' | 'OR' | null;
 }

package/src/resources/brands.ts

@@ -10,7 +10,18 @@ import { path } from '../internal/utils/path';
 
 export class Brands extends APIResource {
   /**
-   * Create a new brand
+   * Create a new brand. Requires `name` and `settings` (with at least
+   * `colors.primary` and `colors.secondary`).
+   *
+   * @example
+   * ```ts
+   * const brand = await client.brands.create({
+   *   name: 'My Brand',
+   *   settings: {
+   *     colors: { primary: '#9D3789', secondary: '#FFFFFF' },
+   *   },
+   * });
+   * ```
    */
   create(body: BrandCreateParams, options?: RequestOptions): APIPromise<Brand> {
     return this._client.post('/brands', { body, ...options });
@@ -18,6 +29,11 @@ export class Brands extends APIResource {
 
   /**
    * Fetch a specific brand by brand ID.
+   *
+   * @example
+   * ```ts
+   * const brand = await client.brands.retrieve('brand_id');
+   * ```
    */
   retrieve(brandID: string, options?: RequestOptions): APIPromise<Brand> {
     return this._client.get(path`/brands/${brandID}`, options);
@@ -25,6 +41,13 @@ export class Brands extends APIResource {
 
   /**
    * Replace an existing brand with the supplied values.
+   *
+   * @example
+   * ```ts
+   * const brand = await client.brands.update('brand_id', {
+   *   name: 'name',
+   * });
+   * ```
    */
   update(brandID: string, body: BrandUpdateParams, options?: RequestOptions): APIPromise<Brand> {
     return this._client.put(path`/brands/${brandID}`, { body, ...options });
@@ -32,6 +55,11 @@ export class Brands extends APIResource {
 
   /**
    * Get the list of brands.
+   *
+   * @example
+   * ```ts
+   * const brands = await client.brands.list();
+   * ```
    */
   list(
     query: BrandListParams | null | undefined = {},
@@ -42,6 +70,11 @@ export class Brands extends APIResource {
 
   /**
    * Delete a brand by brand ID.
+   *
+   * @example
+   * ```ts
+   * await client.brands.delete('brand_id');
+   * ```
    */
   delete(brandID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/brands/${brandID}`, {
@@ -194,9 +227,9 @@ export interface BrandListResponse {
 export interface BrandCreateParams {
   name: string;
 
-  id?: string | null;
+  settings: BrandSettings;
 
-  settings?: BrandSettings | null;
+  id?: string | null;
 
   snippets?: BrandSnippets | null;
 }

package/src/resources/digests/digests.ts

@@ -0,0 +1,120 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as SchedulesAPI from './schedules';
+import { ScheduleListInstancesParams, Schedules } from './schedules';
+
+export class Digests extends APIResource {
+  schedules: SchedulesAPI.Schedules = new SchedulesAPI.Schedules(this._client);
+}
+
+export interface DigestCategory {
+  /**
+   * The key that identifies the category within the digest.
+   */
+  category_key: string;
+
+  /**
+   * Which events to keep when the number of events exceeds the retention limit for
+   * the category.
+   */
+  retain: 'first' | 'last' | 'highest' | 'lowest' | 'none';
+
+  /**
+   * The data key used to order events when `retain` is `highest` or `lowest`.
+   */
+  sort_key?: string;
+}
+
+export interface DigestInstance {
+  /**
+   * A unique identifier for the digest instance.
+   */
+  digest_instance_id: string;
+
+  /**
+   * The total number of events received for this instance.
+   */
+  event_count: number;
+
+  /**
+   * The status of the digest instance. `IN_PROGRESS` instances are still
+   * accumulating events; `COMPLETED` instances have been released.
+   */
+  status: 'IN_PROGRESS' | 'COMPLETED';
+
+  /**
+   * The ID of the user this digest instance belongs to.
+   */
+  user_id: string;
+
+  /**
+   * The categories configured for the digest.
+   */
+  categories?: Array<DigestCategory>;
+
+  /**
+   * A map of category key to the number of events received for that category.
+   */
+  category_key_counts?: { [key: string]: number };
+
+  /**
+   * An ISO 8601 timestamp of when the digest instance was created.
+   */
+  created_at?: string;
+
+  /**
+   * Whether the digest instance has been disabled.
+   */
+  disabled?: boolean;
+
+  /**
+   * The ID of the tenant this digest instance belongs to, if any.
+   */
+  tenant_id?: string | null;
+}
+
+export interface DigestInstanceListResponse {
+  /**
+   * Whether there are more digest instances to fetch using the cursor.
+   */
+  has_more: boolean;
+
+  /**
+   * The digest instances for this page of results.
+   */
+  items: Array<DigestInstance>;
+
+  /**
+   * Always `list` for a paginated list response.
+   */
+  type: 'list';
+
+  /**
+   * A cursor token for fetching the next page of results, or null when there are
+   * none.
+   */
+  cursor?: string | null;
+
+  /**
+   * The path to fetch the next page of results, or null when there are none.
+   */
+  next_url?: string | null;
+
+  /**
+   * The path of the current request.
+   */
+  url?: string;
+}
+
+Digests.Schedules = Schedules;
+
+export declare namespace Digests {
+  export {
+    type DigestCategory as DigestCategory,
+    type DigestInstance as DigestInstance,
+    type DigestInstanceListResponse as DigestInstanceListResponse,
+  };
+
+  export { Schedules as Schedules, type ScheduleListInstancesParams as ScheduleListInstancesParams };
+}

package/src/resources/digests/index.ts

@@ -0,0 +1,9 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Digests,
+  type DigestCategory,
+  type DigestInstance,
+  type DigestInstanceListResponse,
+} from './digests';
+export { Schedules, type ScheduleListInstancesParams } from './schedules';

package/src/resources/digests/schedules.ts

@@ -0,0 +1,51 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as DigestsAPI from './digests';
+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 Schedules extends APIResource {
+  /**
+   * List the digest instances for a schedule. Each instance represents the events
+   * accumulated for a single user against the schedule, and can be used to monitor
+   * digest accumulation before the digest is released.
+   */
+  listInstances(
+    scheduleID: string,
+    query: ScheduleListInstancesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DigestsAPI.DigestInstanceListResponse> {
+    return this._client.get(path`/digests/schedules/${scheduleID}/instances`, { query, ...options });
+  }
+
+  /**
+   * Send a digest now instead of waiting for its scheduled time, so your users get
+   * what they have collected so far right away.
+   */
+  release(scheduleID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/digests/schedules/${scheduleID}/trigger`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface ScheduleListInstancesParams {
+  /**
+   * A cursor token from a previous response, used to fetch the next page of results.
+   */
+  cursor?: string;
+
+  /**
+   * The maximum number of digest instances to return. Defaults to 20, with a maximum
+   * of 100.
+   */
+  limit?: number;
+}
+
+export declare namespace Schedules {
+  export { type ScheduleListInstancesParams as ScheduleListInstancesParams };
+}

package/src/resources/digests.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './digests/index';

package/src/resources/index.ts

@@ -57,9 +57,17 @@ export {
   type BulkCreateJobParams,
   type BulkListUsersParams,
 } from './bulk';
+export {
+  Digests,
+  type DigestCategory,
+  type DigestInstance,
+  type DigestInstanceListResponse,
+} from './digests/digests';
 export { Inbound, type InboundTrackEventResponse, type InboundTrackEventParams } from './inbound';
 export {
   Journeys,
+  type CancelJourneyRequest,
+  type CancelJourneyResponse,
   type CreateJourneyRequest,
   type Journey,
   type JourneyAINode,
@@ -71,6 +79,8 @@ export {
   type JourneyDelayDurationNode,
   type JourneyDelayUntilNode,
   type JourneyExitNode,
+  type JourneyExperiment,
+  type JourneyExperimentVariant,
   type JourneyFetchGetDeleteNode,
   type JourneyFetchPostPutNode,
   type JourneyMergeStrategy,
@@ -96,6 +106,7 @@ export {
   type JourneyCreateParams,
   type JourneyRetrieveParams,
   type JourneyListParams,
+  type JourneyCancelParams,
   type JourneyInvokeParams,
   type JourneyPublishParams,
   type JourneyReplaceParams,
@@ -116,6 +127,7 @@ export {
   type MessageListResponse,
   type MessageContentResponse,
   type MessageHistoryResponse,
+  type MessageResendResponse,
   type MessageListParams,
   type MessageHistoryParams,
 } from './messages';
@@ -211,3 +223,19 @@ export {
   type TranslationUpdateParams,
 } from './translations';
 export { Users } from './users/users';
+export {
+  WorkspacePreferences,
+  type PublishPreferencesRequest,
+  type PublishPreferencesResponse,
+  type WorkspacePreferenceCreateRequest,
+  type WorkspacePreferenceGetResponse,
+  type WorkspacePreferenceListResponse,
+  type WorkspacePreferenceReplaceRequest,
+  type WorkspacePreferenceTopicCreateRequest,
+  type WorkspacePreferenceTopicGetResponse,
+  type WorkspacePreferenceTopicListResponse,
+  type WorkspacePreferenceTopicReplaceRequest,
+  type WorkspacePreferenceCreateParams,
+  type WorkspacePreferencePublishParams,
+  type WorkspacePreferenceReplaceParams,
+} from './workspace-preferences/workspace-preferences';

package/src/resources/journeys/index.ts

@@ -2,6 +2,8 @@
 
 export {
   Journeys,
+  type CancelJourneyRequest,
+  type CancelJourneyResponse,
   type CreateJourneyRequest,
   type Journey,
   type JourneyAINode,
@@ -13,6 +15,8 @@ export {
   type JourneyDelayDurationNode,
   type JourneyDelayUntilNode,
   type JourneyExitNode,
+  type JourneyExperiment,
+  type JourneyExperimentVariant,
   type JourneyFetchGetDeleteNode,
   type JourneyFetchPostPutNode,
   type JourneyMergeStrategy,
@@ -38,6 +42,7 @@ export {
   type JourneyCreateParams,
   type JourneyRetrieveParams,
   type JourneyListParams,
+  type JourneyCancelParams,
   type JourneyInvokeParams,
   type JourneyPublishParams,
   type JourneyReplaceParams,
@@ -50,5 +55,8 @@ export {
   type TemplateArchiveParams,
   type TemplateListVersionsParams,
   type TemplatePublishParams,
+  type TemplatePutContentParams,
+  type TemplatePutLocaleParams,
   type TemplateReplaceParams,
+  type TemplateRetrieveContentParams,
 } from './templates';