@trycourier/courier 7.7.1 → 7.9.0

package/resources/tenants/tenants.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"tenants.mjs","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,cAAc;OACnB,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAML,SAAS,GACV;OAEM,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2E/E,CAAC;IAzEC;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAwB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE;YACrD,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;;;;;;;;;OASG;IACH,SAAS,CACP,QAAgB,EAChB,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF;AAqZD,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;AAClC,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC"}
+{"version":3,"file":"tenants.mjs","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,cAAc;OACnB,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAML,SAAS,GACV;OAEM,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2E/E,CAAC;IAzEC;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAwB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE;YACrD,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;;;;;;;;;OASG;IACH,SAAS,CACP,QAAgB,EAChB,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF;AAkVD,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;AAClC,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC"}

package/src/client.ts

@@ -67,6 +67,15 @@ import {
   InboundBulkMessageUser,
 } from './resources/bulk';
 import { Inbound, InboundTrackEventParams, InboundTrackEventResponse } from './resources/inbound';
+import {
+  Journey,
+  JourneyInvokeParams,
+  JourneyListParams,
+  Journeys,
+  JourneysInvokeRequest,
+  JourneysInvokeResponse,
+  JourneysListResponse,
+} from './resources/journeys';
 import {
   MessageContentResponse,
   MessageDetails,
@@ -78,6 +87,18 @@ import {
   Messages,
 } from './resources/messages';
 import { Requests } from './resources/requests';
+import {
+  RoutingStrategies,
+  RoutingStrategyCreateParams,
+  RoutingStrategyCreateRequest,
+  RoutingStrategyGetResponse,
+  RoutingStrategyListParams,
+  RoutingStrategyListResponse,
+  RoutingStrategyMutationResponse,
+  RoutingStrategyReplaceParams,
+  RoutingStrategyReplaceRequest,
+  RoutingStrategySummary,
+} from './resources/routing-strategies';
 import { Send, SendMessageParams, SendMessageResponse } from './resources/send';
 import {
   TranslationRetrieveParams,
@@ -104,10 +125,24 @@ import {
 import {
   BaseCheck,
   Check,
+  NotificationCreateParams,
   NotificationGetContent,
   NotificationListParams,
   NotificationListResponse,
+  NotificationListVersionsParams,
+  NotificationPublishParams,
+  NotificationReplaceParams,
+  NotificationRetrieveParams,
+  NotificationTemplateCreateRequest,
+  NotificationTemplateGetResponse,
+  NotificationTemplateMutationResponse,
+  NotificationTemplatePayload,
+  NotificationTemplatePublishRequest,
+  NotificationTemplateSummary,
+  NotificationTemplateUpdateRequest,
+  NotificationTemplateVersionListResponse,
   Notifications,
+  VersionNode,
 } from './resources/notifications/notifications';
 import {
   ProfileCreateParams,
@@ -119,6 +154,15 @@ import {
   Profiles,
   SubscribeToListsRequestItem,
 } from './resources/profiles/profiles';
+import {
+  Provider,
+  ProviderCreateParams,
+  ProviderListParams,
+  ProviderListResponse,
+  ProviderUpdateParams,
+  Providers,
+  ProvidersCatalogEntry,
+} from './resources/providers/providers';
 import {
   BaseTemplateTenantAssociation,
   DefaultPreferences,
@@ -364,8 +408,9 @@ export class Courier {
       : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
-    if (!isEmptyObj(defaultQuery)) {
-      query = { ...defaultQuery, ...query };
+    const pathQuery = Object.fromEntries(url.searchParams);
+    if (!isEmptyObj(defaultQuery) || !isEmptyObj(pathQuery)) {
+      query = { ...pathQuery, ...defaultQuery, ...query };
     }
 
     if (typeof query === 'object' && query && !Array.isArray(query)) {
@@ -674,9 +719,9 @@ export class Courier {
       }
     }
 
-    // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
-    // just do what it says, but otherwise calculate a default
-    if (!(timeoutMillis && 0 <= timeoutMillis && timeoutMillis < 60 * 1000)) {
+    // If the API asks us to wait a certain amount of time, just do what it
+    // says, but otherwise calculate a default
+    if (timeoutMillis === undefined) {
       const maxRetries = options.maxRetries ?? this.maxRetries;
       timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
     }
@@ -836,9 +881,11 @@ export class Courier {
 
   send: API.Send = new API.Send(this);
   audiences: API.Audiences = new API.Audiences(this);
+  providers: API.Providers = new API.Providers(this);
   auditEvents: API.AuditEvents = new API.AuditEvents(this);
   auth: API.Auth = new API.Auth(this);
   automations: API.Automations = new API.Automations(this);
+  journeys: API.Journeys = new API.Journeys(this);
   brands: API.Brands = new API.Brands(this);
   bulk: API.Bulk = new API.Bulk(this);
   inbound: API.Inbound = new API.Inbound(this);
@@ -846,6 +893,7 @@ export class Courier {
   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);
   profiles: API.Profiles = new API.Profiles(this);
   tenants: API.Tenants = new API.Tenants(this);
   translations: API.Translations = new API.Translations(this);
@@ -854,9 +902,11 @@ export class Courier {
 
 Courier.Send = Send;
 Courier.Audiences = Audiences;
+Courier.Providers = Providers;
 Courier.AuditEvents = AuditEvents;
 Courier.Auth = Auth;
 Courier.Automations = Automations;
+Courier.Journeys = Journeys;
 Courier.Brands = Brands;
 Courier.Bulk = Bulk;
 Courier.Inbound = Inbound;
@@ -864,6 +914,7 @@ Courier.Lists = Lists;
 Courier.Messages = Messages;
 Courier.Requests = Requests;
 Courier.Notifications = Notifications;
+Courier.RoutingStrategies = RoutingStrategies;
 Courier.Profiles = Profiles;
 Courier.Tenants = Tenants;
 Courier.Translations = Translations;
@@ -889,6 +940,16 @@ export declare namespace Courier {
     type AudienceListMembersParams as AudienceListMembersParams,
   };
 
+  export {
+    Providers as Providers,
+    type Provider as Provider,
+    type ProvidersCatalogEntry as ProvidersCatalogEntry,
+    type ProviderListResponse as ProviderListResponse,
+    type ProviderCreateParams as ProviderCreateParams,
+    type ProviderUpdateParams as ProviderUpdateParams,
+    type ProviderListParams as ProviderListParams,
+  };
+
   export {
     AuditEvents as AuditEvents,
     type AuditEvent as AuditEvent,
@@ -910,6 +971,16 @@ export declare namespace Courier {
     type AutomationListParams as AutomationListParams,
   };
 
+  export {
+    Journeys as Journeys,
+    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 {
     Brands as Brands,
     type Brand as Brand,
@@ -978,8 +1049,35 @@ export declare namespace Courier {
     type BaseCheck as BaseCheck,
     type Check as Check,
     type NotificationGetContent as NotificationGetContent,
+    type NotificationTemplateCreateRequest as NotificationTemplateCreateRequest,
+    type NotificationTemplateGetResponse as NotificationTemplateGetResponse,
+    type NotificationTemplateMutationResponse as NotificationTemplateMutationResponse,
+    type NotificationTemplatePayload as NotificationTemplatePayload,
+    type NotificationTemplatePublishRequest as NotificationTemplatePublishRequest,
+    type NotificationTemplateSummary as NotificationTemplateSummary,
+    type NotificationTemplateUpdateRequest as NotificationTemplateUpdateRequest,
+    type NotificationTemplateVersionListResponse as NotificationTemplateVersionListResponse,
+    type VersionNode as VersionNode,
     type NotificationListResponse as NotificationListResponse,
+    type NotificationCreateParams as NotificationCreateParams,
+    type NotificationRetrieveParams as NotificationRetrieveParams,
     type NotificationListParams as NotificationListParams,
+    type NotificationListVersionsParams as NotificationListVersionsParams,
+    type NotificationPublishParams as NotificationPublishParams,
+    type NotificationReplaceParams as NotificationReplaceParams,
+  };
+
+  export {
+    RoutingStrategies as RoutingStrategies,
+    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 RoutingStrategyReplaceParams as RoutingStrategyReplaceParams,
   };
 
   export {
@@ -1027,7 +1125,9 @@ export declare namespace Courier {
   export type AudienceFilter = API.AudienceFilter;
   export type AudienceFilterConfig = API.AudienceFilterConfig;
   export type AudienceRecipient = API.AudienceRecipient;
+  export type Channel = API.Channel;
   export type ChannelClassification = API.ChannelClassification;
+  export type ChannelMetadata = API.ChannelMetadata;
   export type ChannelPreference = API.ChannelPreference;
   export type DeviceType = API.DeviceType;
   export type Discord = API.Discord;
@@ -1038,6 +1138,7 @@ export declare namespace Courier {
   export type ElementalContent = API.ElementalContent;
   export type ElementalContentSugar = API.ElementalContentSugar;
   export type ElementalDividerNodeWithType = API.ElementalDividerNodeWithType;
+  export type ElementalHTMLNodeWithType = API.ElementalHTMLNodeWithType;
   export type ElementalImageNodeWithType = API.ElementalImageNodeWithType;
   export type ElementalMetaNodeWithType = API.ElementalMetaNodeWithType;
   export type ElementalNode = API.ElementalNode;
@@ -1050,9 +1151,13 @@ export declare namespace Courier {
   export type ListFilter = API.ListFilter;
   export type ListPatternRecipient = API.ListPatternRecipient;
   export type ListRecipient = API.ListRecipient;
+  export type MessageChannels = API.MessageChannels;
   export type MessageContext = API.MessageContext;
+  export type MessageProviders = API.MessageProviders;
+  export type MessageProvidersType = API.MessageProvidersType;
   export type MessageRouting = API.MessageRouting;
   export type MessageRoutingChannel = API.MessageRoutingChannel;
+  export type Metadata = API.Metadata;
   export type MsTeams = API.MsTeams;
   export type MsTeamsBaseProperties = API.MsTeamsBaseProperties;
   export type MsTeamsRecipient = API.MsTeamsRecipient;
@@ -1079,6 +1184,7 @@ export declare namespace Courier {
   export type SlackBaseProperties = API.SlackBaseProperties;
   export type SlackRecipient = API.SlackRecipient;
   export type TextStyle = API.TextStyle;
+  export type Timeouts = API.Timeouts;
   export type Token = API.Token;
   export type UserProfile = API.UserProfile;
   export type UserProfileFirebaseToken = API.UserProfileFirebaseToken;

package/src/resources/index.ts

@@ -58,6 +58,15 @@ export {
   type BulkListUsersParams,
 } from './bulk';
 export { Inbound, type InboundTrackEventResponse, type InboundTrackEventParams } from './inbound';
+export {
+  Journeys,
+  type Journey,
+  type JourneysInvokeRequest,
+  type JourneysInvokeResponse,
+  type JourneysListResponse,
+  type JourneyListParams,
+  type JourneyInvokeParams,
+} from './journeys';
 export {
   Lists,
   type PutSubscriptionsRecipient,
@@ -82,8 +91,22 @@ export {
   type BaseCheck,
   type Check,
   type NotificationGetContent,
+  type NotificationTemplateCreateRequest,
+  type NotificationTemplateGetResponse,
+  type NotificationTemplateMutationResponse,
+  type NotificationTemplatePayload,
+  type NotificationTemplatePublishRequest,
+  type NotificationTemplateSummary,
+  type NotificationTemplateUpdateRequest,
+  type NotificationTemplateVersionListResponse,
+  type VersionNode,
   type NotificationListResponse,
+  type NotificationCreateParams,
+  type NotificationRetrieveParams,
   type NotificationListParams,
+  type NotificationListVersionsParams,
+  type NotificationPublishParams,
+  type NotificationReplaceParams,
 } from './notifications/notifications';
 export {
   Profiles,
@@ -95,7 +118,28 @@ export {
   type ProfileUpdateParams,
   type ProfileReplaceParams,
 } from './profiles/profiles';
+export {
+  Providers,
+  type Provider,
+  type ProvidersCatalogEntry,
+  type ProviderListResponse,
+  type ProviderCreateParams,
+  type ProviderUpdateParams,
+  type ProviderListParams,
+} from './providers/providers';
 export { Requests } from './requests';
+export {
+  RoutingStrategies,
+  type RoutingStrategyCreateRequest,
+  type RoutingStrategyGetResponse,
+  type RoutingStrategyListResponse,
+  type RoutingStrategyMutationResponse,
+  type RoutingStrategyReplaceRequest,
+  type RoutingStrategySummary,
+  type RoutingStrategyCreateParams,
+  type RoutingStrategyListParams,
+  type RoutingStrategyReplaceParams,
+} from './routing-strategies';
 export { Send, type SendMessageResponse, type SendMessageParams } from './send';
 export {
   Tenants,

package/src/resources/journeys.ts

@@ -0,0 +1,174 @@
+// 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,
+  };
+}

package/src/resources/messages.ts

@@ -61,18 +61,6 @@ export interface MessageDetails {
    */
   id: string;
 
-  /**
-   * A UTC timestamp at which the recipient clicked on a tracked link for the first
-   * time. Stored as a millisecond representation of the Unix epoch.
-   */
-  clicked: number;
-
-  /**
-   * A UTC timestamp at which the Integration provider delivered the message. Stored
-   * as a millisecond representation of the Unix epoch.
-   */
-  delivered: number;
-
   /**
    * A UTC timestamp at which Courier received the message request. Stored as a
    * millisecond representation of the Unix epoch.
@@ -89,23 +77,11 @@ export interface MessageDetails {
    */
   notification: string;
 
-  /**
-   * A UTC timestamp at which the recipient opened a message for the first time.
-   * Stored as a millisecond representation of the Unix epoch.
-   */
-  opened: number;
-
   /**
    * A unique identifier associated with the recipient of the delivered message.
    */
   recipient: string;
 
-  /**
-   * A UTC timestamp at which Courier passed the message to the Integration provider.
-   * Stored as a millisecond representation of the Unix epoch.
-   */
-  sent: number;
-
   /**
    * The current status of the message.
    */
@@ -126,11 +102,29 @@ export interface MessageDetails {
     | 'UNMAPPED'
     | 'UNROUTABLE';
 
+  /**
+   * A UTC timestamp at which the recipient clicked on a tracked link for the first
+   * time. Stored as a millisecond representation of the Unix epoch.
+   */
+  clicked?: number;
+
+  /**
+   * A UTC timestamp at which the Integration provider delivered the message. Stored
+   * as a millisecond representation of the Unix epoch.
+   */
+  delivered?: number;
+
   /**
    * A message describing the error that occurred.
    */
   error?: string | null;
 
+  /**
+   * A UTC timestamp at which the recipient opened a message for the first time.
+   * Stored as a millisecond representation of the Unix epoch.
+   */
+  opened?: number;
+
   /**
    * The reason for the current status of the message.
    */
@@ -145,6 +139,12 @@ export interface MessageDetails {
     | 'UNPUBLISHED'
     | 'UNSUBSCRIBED'
     | null;
+
+  /**
+   * A UTC timestamp at which Courier passed the message to the Integration provider.
+   * Stored as a millisecond representation of the Unix epoch.
+   */
+  sent?: number;
 }
 
 export interface MessageRetrieveResponse extends MessageDetails {

package/src/resources/notifications/checks.ts

@@ -8,6 +8,24 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class Checks extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * const check = await client.notifications.checks.update(
+   *   'submissionId',
+   *   {
+   *     id: 'id',
+   *     checks: [
+   *       {
+   *         id: 'id',
+   *         status: 'RESOLVED',
+   *         type: 'custom',
+   *       },
+   *     ],
+   *   },
+   * );
+   * ```
+   */
   update(
     submissionID: string,
     params: CheckUpdateParams,
@@ -17,6 +35,15 @@ export class Checks extends APIResource {
     return this._client.put(path`/notifications/${id}/${submissionID}/checks`, { body, ...options });
   }
 
+  /**
+   * @example
+   * ```ts
+   * const checks = await client.notifications.checks.list(
+   *   'submissionId',
+   *   { id: 'id' },
+   * );
+   * ```
+   */
   list(
     submissionID: string,
     params: CheckListParams,
@@ -26,6 +53,14 @@ export class Checks extends APIResource {
     return this._client.get(path`/notifications/${id}/${submissionID}/checks`, options);
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.notifications.checks.delete('submissionId', {
+   *   id: 'id',
+   * });
+   * ```
+   */
   delete(submissionID: string, params: CheckDeleteParams, options?: RequestOptions): APIPromise<void> {
     const { id } = params;
     return this._client.delete(path`/notifications/${id}/${submissionID}/checks`, {

package/src/resources/notifications/draft.ts

@@ -7,6 +7,13 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class Draft extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * const notificationGetContent =
+   *   await client.notifications.draft.retrieveContent('id');
+   * ```
+   */
   retrieveContent(id: string, options?: RequestOptions): APIPromise<NotificationsAPI.NotificationGetContent> {
     return this._client.get(path`/notifications/${id}/draft/content`, options);
   }

package/src/resources/notifications/index.ts

@@ -14,6 +14,20 @@ export {
   type BaseCheck,
   type Check,
   type NotificationGetContent,
+  type NotificationTemplateCreateRequest,
+  type NotificationTemplateGetResponse,
+  type NotificationTemplateMutationResponse,
+  type NotificationTemplatePayload,
+  type NotificationTemplatePublishRequest,
+  type NotificationTemplateSummary,
+  type NotificationTemplateUpdateRequest,
+  type NotificationTemplateVersionListResponse,
+  type VersionNode,
   type NotificationListResponse,
+  type NotificationCreateParams,
+  type NotificationRetrieveParams,
   type NotificationListParams,
+  type NotificationListVersionsParams,
+  type NotificationPublishParams,
+  type NotificationReplaceParams,
 } from './notifications';