@trycourier/courier 7.3.0 → 7.7.1

package/src/client.ts

@@ -11,7 +11,7 @@ import type { APIResponseProps } from './internal/parse';
 import { getPlatformHeaders } from './internal/detect-platform';
 import * as Shims from './internal/shims';
 import * as Opts from './internal/request-options';
-import * as qs from './internal/qs';
+import { stringifyQuery } from './internal/utils/query';
 import { VERSION } from './version';
 import * as Errors from './core/error';
 import * as Uploads from './core/uploads';
@@ -26,8 +26,6 @@ import {
   AudienceUpdateParams,
   AudienceUpdateResponse,
   Audiences,
-  Filter,
-  FilterConfig,
 } from './resources/audiences';
 import {
   AuditEvent,
@@ -87,7 +85,13 @@ import {
   TranslationUpdateParams,
   Translations,
 } from './resources/translations';
-import { AutomationInvokeResponse, Automations } from './resources/automations/automations';
+import {
+  AutomationInvokeResponse,
+  AutomationListParams,
+  AutomationTemplate,
+  AutomationTemplateListResponse,
+  Automations,
+} from './resources/automations/automations';
 import {
   ListListParams,
   ListListResponse,
@@ -118,6 +122,10 @@ import {
 import {
   BaseTemplateTenantAssociation,
   DefaultPreferences,
+  PostTenantTemplatePublishRequest,
+  PostTenantTemplatePublishResponse,
+  PutTenantTemplateRequest,
+  PutTenantTemplateResponse,
   SubscriptionTopicNew,
   Tenant,
   TenantAssociation,
@@ -125,6 +133,7 @@ import {
   TenantListResponse,
   TenantListUsersParams,
   TenantListUsersResponse,
+  TenantTemplateInput,
   TenantUpdateParams,
   Tenants,
 } from './resources/tenants/tenants';
@@ -322,8 +331,8 @@ export class Courier {
     return buildHeaders([{ Authorization: `Bearer ${this.apiKey}` }]);
   }
 
-  protected stringifyQuery(query: Record<string, unknown>): string {
-    return qs.stringify(query, { arrayFormat: 'comma' });
+  protected stringifyQuery(query: object | Record<string, unknown>): string {
+    return stringifyQuery(query);
   }
 
   private getUserAgent(): string {
@@ -360,7 +369,7 @@ export class Courier {
     }
 
     if (typeof query === 'object' && query && !Array.isArray(query)) {
-      url.search = this.stringifyQuery(query as Record<string, unknown>);
+      url.search = this.stringifyQuery(query);
     }
 
     return url.toString();
@@ -544,7 +553,7 @@ export class Courier {
       loggerFor(this).info(`${responseInfo} - ${retryMessage}`);
 
       const errText = await response.text().catch((err: any) => castToError(err).message);
-      const errJSON = safeJSON(errText);
+      const errJSON = safeJSON(errText) as any;
       const errMessage = errJSON ? undefined : errText;
 
       loggerFor(this).debug(
@@ -585,9 +594,10 @@ export class Courier {
     controller: AbortController,
   ): Promise<Response> {
     const { signal, method, ...options } = init || {};
-    if (signal) signal.addEventListener('abort', () => controller.abort());
+    const abort = this._makeAbort(controller);
+    if (signal) signal.addEventListener('abort', abort, { once: true });
 
-    const timeout = setTimeout(() => controller.abort(), ms);
+    const timeout = setTimeout(abort, ms);
 
     const isReadableBody =
       ((globalThis as any).ReadableStream && options.body instanceof (globalThis as any).ReadableStream) ||
@@ -754,6 +764,12 @@ export class Courier {
     return headers.values;
   }
 
+  private _makeAbort(controller: AbortController) {
+    // note: we can't just inline this method inside `fetchWithTimeout()` because then the closure
+    //       would capture all request options, and cause a memory leak.
+    return () => controller.abort();
+  }
+
   private buildBody({ options: { body, headers: rawHeaders } }: { options: FinalRequestOptions }): {
     bodyHeaders: HeadersLike;
     body: BodyInit | undefined;
@@ -786,6 +802,14 @@ export class Courier {
         (Symbol.iterator in body && 'next' in body && typeof body.next === 'function'))
     ) {
       return { bodyHeaders: undefined, body: Shims.ReadableStreamFrom(body as AsyncIterable<Uint8Array>) };
+    } else if (
+      typeof body === 'object' &&
+      headers.values.get('content-type') === 'application/x-www-form-urlencoded'
+    ) {
+      return {
+        bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
+        body: this.stringifyQuery(body),
+      };
     } else {
       return this.#encoder({ body, headers });
     }
@@ -857,8 +881,6 @@ export declare namespace Courier {
   export {
     Audiences as Audiences,
     type Audience as Audience,
-    type Filter as Filter,
-    type FilterConfig as FilterConfig,
     type AudienceUpdateResponse as AudienceUpdateResponse,
     type AudienceListResponse as AudienceListResponse,
     type AudienceListMembersResponse as AudienceListMembersResponse,
@@ -880,7 +902,13 @@ export declare namespace Courier {
     type AuthIssueTokenParams as AuthIssueTokenParams,
   };
 
-  export { Automations as Automations, type AutomationInvokeResponse as AutomationInvokeResponse };
+  export {
+    Automations as Automations,
+    type AutomationInvokeResponse as AutomationInvokeResponse,
+    type AutomationTemplate as AutomationTemplate,
+    type AutomationTemplateListResponse as AutomationTemplateListResponse,
+    type AutomationListParams as AutomationListParams,
+  };
 
   export {
     Brands as Brands,
@@ -969,9 +997,14 @@ export declare namespace Courier {
     Tenants as Tenants,
     type BaseTemplateTenantAssociation as BaseTemplateTenantAssociation,
     type DefaultPreferences as DefaultPreferences,
+    type PostTenantTemplatePublishRequest as PostTenantTemplatePublishRequest,
+    type PostTenantTemplatePublishResponse as PostTenantTemplatePublishResponse,
+    type PutTenantTemplateRequest as PutTenantTemplateRequest,
+    type PutTenantTemplateResponse as PutTenantTemplateResponse,
     type SubscriptionTopicNew as SubscriptionTopicNew,
     type Tenant as Tenant,
     type TenantAssociation as TenantAssociation,
+    type TenantTemplateInput as TenantTemplateInput,
     type TenantListResponse as TenantListResponse,
     type TenantListUsersResponse as TenantListUsersResponse,
     type TenantUpdateParams as TenantUpdateParams,
@@ -988,9 +1021,16 @@ export declare namespace Courier {
 
   export { Users as Users };
 
+  export type AirshipProfile = API.AirshipProfile;
+  export type AirshipProfileAudience = API.AirshipProfileAudience;
   export type Alignment = API.Alignment;
+  export type AudienceFilter = API.AudienceFilter;
+  export type AudienceFilterConfig = API.AudienceFilterConfig;
+  export type AudienceRecipient = API.AudienceRecipient;
   export type ChannelClassification = API.ChannelClassification;
   export type ChannelPreference = API.ChannelPreference;
+  export type DeviceType = API.DeviceType;
+  export type Discord = API.Discord;
   export type ElementalActionNodeWithType = API.ElementalActionNodeWithType;
   export type ElementalBaseNode = API.ElementalBaseNode;
   export type ElementalChannelNode = API.ElementalChannelNode;
@@ -1003,17 +1043,51 @@ export declare namespace Courier {
   export type ElementalNode = API.ElementalNode;
   export type ElementalQuoteNodeWithType = API.ElementalQuoteNodeWithType;
   export type ElementalTextNodeWithType = API.ElementalTextNodeWithType;
+  export type Expo = API.Expo;
+  export type FilterConfig = API.FilterConfig;
+  export type Intercom = API.Intercom;
+  export type IntercomRecipient = API.IntercomRecipient;
+  export type ListFilter = API.ListFilter;
+  export type ListPatternRecipient = API.ListPatternRecipient;
+  export type ListRecipient = API.ListRecipient;
   export type MessageContext = API.MessageContext;
   export type MessageRouting = API.MessageRouting;
   export type MessageRoutingChannel = API.MessageRoutingChannel;
+  export type MsTeams = API.MsTeams;
+  export type MsTeamsBaseProperties = API.MsTeamsBaseProperties;
+  export type MsTeamsRecipient = API.MsTeamsRecipient;
+  export type MultipleTokens = API.MultipleTokens;
   export type NotificationPreferenceDetails = API.NotificationPreferenceDetails;
+  export type Pagerduty = API.Pagerduty;
+  export type PagerdutyRecipient = API.PagerdutyRecipient;
   export type Paging = API.Paging;
   export type Preference = API.Preference;
   export type PreferenceStatus = API.PreferenceStatus;
-  export type Recipient = API.Recipient;
   export type RecipientPreferences = API.RecipientPreferences;
   export type Rule = API.Rule;
+  export type SendDirectMessage = API.SendDirectMessage;
+  export type SendToChannel = API.SendToChannel;
+  export type SendToMsTeamsChannelID = API.SendToMsTeamsChannelID;
+  export type SendToMsTeamsChannelName = API.SendToMsTeamsChannelName;
+  export type SendToMsTeamsConversationID = API.SendToMsTeamsConversationID;
+  export type SendToMsTeamsEmail = API.SendToMsTeamsEmail;
+  export type SendToMsTeamsUserID = API.SendToMsTeamsUserID;
+  export type SendToSlackChannel = API.SendToSlackChannel;
+  export type SendToSlackEmail = API.SendToSlackEmail;
+  export type SendToSlackUserID = API.SendToSlackUserID;
+  export type Slack = API.Slack;
+  export type SlackBaseProperties = API.SlackBaseProperties;
+  export type SlackRecipient = API.SlackRecipient;
   export type TextStyle = API.TextStyle;
+  export type Token = API.Token;
+  export type UserProfile = API.UserProfile;
+  export type UserProfileFirebaseToken = API.UserProfileFirebaseToken;
   export type UserRecipient = API.UserRecipient;
   export type Utm = API.Utm;
+  export type WebhookAuthMode = API.WebhookAuthMode;
+  export type WebhookAuthentication = API.WebhookAuthentication;
+  export type WebhookMethod = API.WebhookMethod;
+  export type WebhookProfile = API.WebhookProfile;
+  export type WebhookProfileType = API.WebhookProfileType;
+  export type WebhookRecipient = API.WebhookRecipient;
 }

package/src/internal/parse.ts

@@ -29,6 +29,12 @@ export async function defaultParseResponse<T>(client: Courier, props: APIRespons
     const mediaType = contentType?.split(';')[0]?.trim();
     const isJSON = mediaType?.includes('application/json') || mediaType?.endsWith('+json');
     if (isJSON) {
+      const contentLength = response.headers.get('content-length');
+      if (contentLength === '0') {
+        // if there is no content we can't do anything
+        return undefined as T;
+      }
+
       const json = await response.json();
       return json as T;
     }

package/src/internal/utils/query.ts

@@ -0,0 +1,7 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as qs from '../qs/stringify';
+
+export function stringifyQuery(query: object | Record<string, unknown>) {
+  return qs.stringify(query, { arrayFormat: 'comma' });
+}

package/src/internal/utils.ts

@@ -6,3 +6,4 @@ export * from './utils/env';
 export * from './utils/log';
 export * from './utils/uuid';
 export * from './utils/sleep';
+export * from './utils/query';

package/src/resources/audiences.ts

@@ -71,83 +71,22 @@ export interface Audience {
    */
   description: string;
 
-  /**
-   * A single filter to use for filtering
-   */
-  filter: Filter;
-
   /**
    * The name of the audience
    */
   name: string;
 
   updated_at: string;
-}
-
-export interface Filter {
-  /**
-   * The operator to use for filtering
-   */
-  operator:
-    | 'ENDS_WITH'
-    | 'EQ'
-    | 'EXISTS'
-    | 'GT'
-    | 'GTE'
-    | 'INCLUDES'
-    | 'IS_AFTER'
-    | 'IS_BEFORE'
-    | 'LT'
-    | 'LTE'
-    | 'NEQ'
-    | 'OMIT'
-    | 'STARTS_WITH'
-    | 'AND'
-    | 'OR';
-
-  /**
-   * The attribe name from profile whose value will be operated against the filter
-   * value
-   */
-  path: string;
 
   /**
-   * The value to use for filtering
+   * Filter configuration for audience membership containing an array of filter rules
    */
-  value: string;
-}
-
-export interface FilterConfig {
-  /**
-   * The operator to use for filtering
-   */
-  operator:
-    | 'ENDS_WITH'
-    | 'EQ'
-    | 'EXISTS'
-    | 'GT'
-    | 'GTE'
-    | 'INCLUDES'
-    | 'IS_AFTER'
-    | 'IS_BEFORE'
-    | 'LT'
-    | 'LTE'
-    | 'NEQ'
-    | 'OMIT'
-    | 'STARTS_WITH'
-    | 'AND'
-    | 'OR';
-
-  /**
-   * The attribe name from profile whose value will be operated against the filter
-   * value
-   */
-  path: string;
+  filter?: Shared.AudienceFilterConfig | null;
 
   /**
-   * The value to use for filtering
+   * The logical operator (AND/OR) for the top-level filter
    */
-  value: string;
+  operator?: 'AND' | 'OR';
 }
 
 export interface AudienceUpdateResponse {
@@ -187,14 +126,19 @@ export interface AudienceUpdateParams {
   description?: string | null;
 
   /**
-   * A single filter to use for filtering
+   * Filter configuration for audience membership containing an array of filter rules
    */
-  filter?: Filter | null;
+  filter?: Shared.AudienceFilterConfig | null;
 
   /**
    * The name of the audience
    */
   name?: string | null;
+
+  /**
+   * The logical operator (AND/OR) for the top-level filter
+   */
+  operator?: 'AND' | 'OR' | null;
 }
 
 export interface AudienceListParams {
@@ -214,8 +158,6 @@ export interface AudienceListMembersParams {
 export declare namespace Audiences {
   export {
     type Audience as Audience,
-    type Filter as Filter,
-    type FilterConfig as FilterConfig,
     type AudienceUpdateResponse as AudienceUpdateResponse,
     type AudienceListResponse as AudienceListResponse,
     type AudienceListMembersResponse as AudienceListMembersResponse,

package/src/resources/automations/automations.ts

@@ -3,19 +3,92 @@
 import { APIResource } from '../../core/resource';
 import * as InvokeAPI from './invoke';
 import { Invoke, InvokeInvokeAdHocParams, InvokeInvokeByTemplateParams } from './invoke';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
 
 export class Automations extends APIResource {
   invoke: InvokeAPI.Invoke = new InvokeAPI.Invoke(this._client);
+
+  /**
+   * Get the list of automations.
+   *
+   * @example
+   * ```ts
+   * const automationTemplateListResponse =
+   *   await client.automations.list();
+   * ```
+   */
+  list(
+    query: AutomationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AutomationTemplateListResponse> {
+    return this._client.get('/automations', { query, ...options });
+  }
 }
 
 export interface AutomationInvokeResponse {
   runId: string;
 }
 
+export interface AutomationTemplate {
+  /**
+   * The unique identifier of the automation template.
+   */
+  id: string;
+
+  /**
+   * The name of the automation template.
+   */
+  name: string;
+
+  /**
+   * The version of the template published or drafted.
+   */
+  version: 'published' | 'draft';
+
+  /**
+   * ISO 8601 timestamp when the template was created.
+   */
+  createdAt?: string;
+
+  /**
+   * ISO 8601 timestamp when the template was last updated.
+   */
+  updatedAt?: string;
+}
+
+export interface AutomationTemplateListResponse {
+  /**
+   * A cursor token for pagination. Present when there are more results available.
+   */
+  cursor?: string;
+
+  templates?: Array<AutomationTemplate>;
+}
+
+export interface AutomationListParams {
+  /**
+   * A cursor token for pagination. Use the cursor from the previous response to
+   * fetch the next page of results.
+   */
+  cursor?: string;
+
+  /**
+   * The version of templates to retrieve. Accepted values are published (for
+   * published templates) or draft (for draft templates). Defaults to published.
+   */
+  version?: 'published' | 'draft';
+}
+
 Automations.Invoke = Invoke;
 
 export declare namespace Automations {
-  export { type AutomationInvokeResponse as AutomationInvokeResponse };
+  export {
+    type AutomationInvokeResponse as AutomationInvokeResponse,
+    type AutomationTemplate as AutomationTemplate,
+    type AutomationTemplateListResponse as AutomationTemplateListResponse,
+    type AutomationListParams as AutomationListParams,
+  };
 
   export {
     Invoke as Invoke,

package/src/resources/automations/index.ts

@@ -1,4 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Automations, type AutomationInvokeResponse } from './automations';
+export {
+  Automations,
+  type AutomationInvokeResponse,
+  type AutomationTemplate,
+  type AutomationTemplateListResponse,
+  type AutomationListParams,
+} from './automations';
 export { Invoke, type InvokeInvokeAdHocParams, type InvokeInvokeByTemplateParams } from './invoke';

package/src/resources/bulk.ts

@@ -10,7 +10,11 @@ import { path } from '../internal/utils/path';
 
 export class Bulk extends APIResource {
   /**
-   * Ingest user data into a Bulk Job
+   * Ingest user data into a Bulk Job.
+   *
+   * **Important**: For email-based bulk jobs, each user must include `profile.email`
+   * for provider routing to work correctly. The `to.email` field is not sufficient
+   * for email provider routing.
    */
   addUsers(jobID: string, body: BulkAddUsersParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/bulk/${jobID}`, {
@@ -21,7 +25,13 @@ export class Bulk extends APIResource {
   }
 
   /**
-   * Create a bulk job
+   * Creates a new bulk job for sending messages to multiple recipients.
+   *
+   * **Required**: `message.event` (event ID or notification ID)
+   *
+   * **Optional (V2 format)**: `message.template` (notification ID) or
+   * `message.content` (Elemental content) can be provided to override the
+   * notification associated with the event.
    */
   createJob(body: BulkCreateJobParams, options?: RequestOptions): APIPromise<BulkCreateJobResponse> {
     return this._client.post('/bulk', { body, ...options });
@@ -56,52 +66,67 @@ export class Bulk extends APIResource {
   }
 }
 
-export type InboundBulkMessage =
-  | InboundBulkMessage.InboundBulkTemplateMessage
-  | InboundBulkMessage.InboundBulkContentMessage;
-
-export namespace InboundBulkMessage {
-  export interface InboundBulkTemplateMessage {
-    template: string;
-
-    brand?: string | null;
-
-    data?: { [key: string]: unknown } | null;
-
-    event?: string | null;
-
-    locale?: { [key: string]: { [key: string]: unknown } } | null;
-
-    override?: { [key: string]: unknown } | null;
-  }
+/**
+ * Bulk message definition. Supports two formats:
+ *
+ * - V1 format: Requires `event` field (event ID or notification ID)
+ * - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
+ *   content) in addition to `event`
+ */
+export interface InboundBulkMessage {
+  /**
+   * Event ID or Notification ID (required). Can be either a Notification ID (e.g.,
+   * "FRH3QXM9E34W4RKP7MRC8NZ1T8V8") or a custom Event ID (e.g., "welcome-email")
+   * mapped to a notification.
+   */
+  event: string;
 
-  export interface InboundBulkContentMessage {
-    /**
-     * Syntactic sugar to provide a fast shorthand for Courier Elemental Blocks.
-     */
-    content: Shared.ElementalContentSugar | Shared.ElementalContent;
+  brand?: string | null;
 
-    brand?: string | null;
+  /**
+   * Elemental content (optional, for V2 format). When provided, this will be used
+   * instead of the notification associated with the `event` field.
+   */
+  content?: Shared.ElementalContentSugar | Shared.ElementalContent | null;
 
-    data?: { [key: string]: unknown } | null;
+  data?: { [key: string]: unknown } | null;
 
-    event?: string | null;
+  locale?: { [key: string]: { [key: string]: unknown } } | null;
 
-    locale?: { [key: string]: { [key: string]: unknown } } | null;
+  override?: { [key: string]: unknown } | null;
 
-    override?: { [key: string]: unknown } | null;
-  }
+  /**
+   * Notification ID or template ID (optional, for V2 format). When provided, this
+   * will be used instead of the notification associated with the `event` field.
+   */
+  template?: string | null;
 }
 
 export interface InboundBulkMessageUser {
+  /**
+   * User-specific data that will be merged with message.data
+   */
   data?: unknown;
 
   preferences?: Shared.RecipientPreferences | null;
 
-  profile?: unknown;
+  /**
+   * User profile information. For email-based bulk jobs, `profile.email` is required
+   * for provider routing to determine if the message can be delivered. The email
+   * address should be provided here rather than in `to.email`.
+   */
+  profile?: { [key: string]: unknown } | null;
 
+  /**
+   * User ID (legacy field, use profile or to.user_id instead)
+   */
   recipient?: string | null;
 
+  /**
+   * Optional recipient information. Note: For email provider routing, use
+   * `profile.email` instead of `to.email`. The `to` field is primarily used for
+   * recipient identification and data merging.
+   */
   to?: Shared.UserRecipient | null;
 }
 
@@ -129,6 +154,13 @@ export interface BulkRetrieveJobResponse {
 
 export namespace BulkRetrieveJobResponse {
   export interface Job {
+    /**
+     * Bulk message definition. Supports two formats:
+     *
+     * - V1 format: Requires `event` field (event ID or notification ID)
+     * - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
+     *   content) in addition to `event`
+     */
     definition: BulkAPI.InboundBulkMessage;
 
     enqueued: number;
@@ -146,6 +178,13 @@ export interface BulkAddUsersParams {
 }
 
 export interface BulkCreateJobParams {
+  /**
+   * Bulk message definition. Supports two formats:
+   *
+   * - V1 format: Requires `event` field (event ID or notification ID)
+   * - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
+   *   content) in addition to `event`
+   */
   message: InboundBulkMessage;
 }
 

package/src/resources/inbound.ts

@@ -54,7 +54,7 @@ export interface InboundTrackEventParams {
   type: 'track';
 
   /**
-   * The user id associatiated with the track
+   * The user id associated with the track
    */
   userId?: string | null;
 }

package/src/resources/index.ts

@@ -4,8 +4,6 @@ export * from './shared';
 export {
   Audiences,
   type Audience,
-  type Filter,
-  type FilterConfig,
   type AudienceUpdateResponse,
   type AudienceListResponse,
   type AudienceListMembersResponse,
@@ -20,7 +18,13 @@ export {
   type AuditEventListParams,
 } from './audit-events';
 export { Auth, type AuthIssueTokenResponse, type AuthIssueTokenParams } from './auth';
-export { Automations, type AutomationInvokeResponse } from './automations/automations';
+export {
+  Automations,
+  type AutomationInvokeResponse,
+  type AutomationTemplate,
+  type AutomationTemplateListResponse,
+  type AutomationListParams,
+} from './automations/automations';
 export {
   Brands,
   type Brand,
@@ -97,9 +101,14 @@ export {
   Tenants,
   type BaseTemplateTenantAssociation,
   type DefaultPreferences,
+  type PostTenantTemplatePublishRequest,
+  type PostTenantTemplatePublishResponse,
+  type PutTenantTemplateRequest,
+  type PutTenantTemplateResponse,
   type SubscriptionTopicNew,
   type Tenant,
   type TenantAssociation,
+  type TenantTemplateInput,
   type TenantListResponse,
   type TenantListUsersResponse,
   type TenantUpdateParams,

package/src/resources/lists/subscriptions.ts

@@ -115,7 +115,7 @@ export interface SubscriptionSubscribeUserParams {
   list_id: string;
 
   /**
-   * Body param:
+   * Body param
    */
   preferences?: Shared.RecipientPreferences | null;
 }