@trycourier/courier 7.2.0 → 7.7.1

package/src/resources/notifications/checks.ts

@@ -45,12 +45,12 @@ export interface CheckListResponse {
 
 export interface CheckUpdateParams {
   /**
-   * Path param:
+   * Path param
    */
   id: string;
 
   /**
-   * Body param:
+   * Body param
    */
   checks: Array<NotificationsAPI.BaseCheck>;
 }

package/src/resources/send.ts

@@ -13,7 +13,7 @@ export class Send extends APIResource {
    * ```ts
    * const response = await client.send.message({
    *   message: {
-   *     to: { user_id: 'example_user' },
+   *     to: { user_id: 'user_id' },
    *     template: 'template_id',
    *     data: { foo: 'bar' },
    *   },
@@ -89,7 +89,26 @@ export namespace SendMessageParams {
     /**
      * The recipient or a list of recipients of the message
      */
-    to?: Shared.UserRecipient | Array<Shared.Recipient> | null;
+    to?:
+      | Shared.UserRecipient
+      | Shared.AudienceRecipient
+      | Shared.ListRecipient
+      | Shared.ListPatternRecipient
+      | Shared.SlackRecipient
+      | Shared.MsTeamsRecipient
+      | Shared.PagerdutyRecipient
+      | Shared.WebhookRecipient
+      | Array<
+          | Shared.UserRecipient
+          | Shared.AudienceRecipient
+          | Shared.ListRecipient
+          | Shared.ListPatternRecipient
+          | Shared.SlackRecipient
+          | Shared.MsTeamsRecipient
+          | Shared.PagerdutyRecipient
+          | Shared.WebhookRecipient
+        >
+      | null;
   }
 
   export namespace Message {
@@ -142,6 +161,13 @@ export namespace SendMessageParams {
        */
       duration?: number | null;
 
+      /**
+       * IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Used when
+       * resolving opening hours expressions. Takes precedence over user profile timezone
+       * settings.
+       */
+      timezone?: string | null;
+
       /**
        * ISO 8601 timestamp or opening_hours-like format.
        */

package/src/resources/shared.ts

@@ -1,13 +1,65 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+import * as Shared from './shared';
+
+export interface AirshipProfile {
+  audience: AirshipProfileAudience;
+
+  device_types: Array<DeviceType>;
+}
+
+export interface AirshipProfileAudience {
+  named_user: string;
+}
+
 export type Alignment = 'center' | 'left' | 'right' | 'full';
 
+export interface AudienceFilter {
+  /**
+   * Send to users only if they are member of the account
+   */
+  operator: 'MEMBER_OF';
+
+  path: 'account_id';
+
+  value: string;
+}
+
+/**
+ * Filter configuration for audience membership containing an array of filter rules
+ */
+export interface AudienceFilterConfig {
+  /**
+   * Array of filter rules (single conditions or nested groups)
+   */
+  filters: Array<FilterConfig>;
+}
+
+/**
+ * Send to all users in an audience
+ */
+export interface AudienceRecipient {
+  /**
+   * A unique identifier associated with an Audience. A message will be sent to each
+   * user in the audience.
+   */
+  audience_id: string;
+
+  data?: { [key: string]: unknown } | null;
+
+  filters?: Array<AudienceFilter> | null;
+}
+
 export type ChannelClassification = 'direct_message' | 'email' | 'push' | 'sms' | 'webhook' | 'inbox';
 
 export interface ChannelPreference {
   channel: ChannelClassification;
 }
 
+export type DeviceType = string;
+
+export type Discord = SendToChannel | SendDirectMessage;
+
 export interface ElementalActionNodeWithType extends ElementalBaseNode {
   type?: 'action';
 }
@@ -39,7 +91,7 @@ export interface ElementalChannelNode extends ElementalBaseNode {
    * The channel the contents of this element should be applied to. Can be `email`,
    * `push`, `direct_message`, `sms` or a provider such as slack
    */
-  channel: string;
+  channel?: string;
 
   /**
    * Raw data to apply to the channel. If `elements` has not been specified, `raw` is
@@ -71,8 +123,6 @@ export interface ElementalContent {
    * For example, "2022-01-01"
    */
   version: string;
-
-  brand?: string | null;
 }
 
 /**
@@ -131,6 +181,81 @@ export interface ElementalTextNodeWithType extends ElementalBaseNode {
   type?: 'text';
 }
 
+export type Expo = Token | MultipleTokens;
+
+/**
+ * A filter rule that can be either a single condition (with path/value) or a
+ * nested group (with filters array). Use comparison operators (EQ, GT, etc.) for
+ * single conditions, and logical operators (AND, OR) for nested groups.
+ */
+export interface FilterConfig {
+  /**
+   * The operator for this filter. Use comparison operators (EQ, GT, LT, GTE, LTE,
+   * NEQ, EXISTS, INCLUDES, STARTS_WITH, ENDS_WITH, IS_BEFORE, IS_AFTER, OMIT) for
+   * single conditions, or logical operators (AND, OR) for nested filter groups.
+   */
+  operator: string;
+
+  /**
+   * Nested filter rules to combine with AND/OR. Required for nested filter groups,
+   * not used for single filter conditions.
+   */
+  filters?: Array<FilterConfig>;
+
+  /**
+   * The attribute path from the user profile to filter on. Required for single
+   * filter conditions, not used for nested filter groups.
+   */
+  path?: string;
+
+  /**
+   * The value to compare against. Required for single filter conditions, not used
+   * for nested filter groups.
+   */
+  value?: string;
+}
+
+export interface Intercom {
+  from: string;
+
+  to: IntercomRecipient;
+}
+
+export interface IntercomRecipient {
+  id: string;
+}
+
+export interface ListFilter {
+  /**
+   * Send to users only if they are member of the account
+   */
+  operator: 'MEMBER_OF';
+
+  path: 'account_id';
+
+  value: string;
+}
+
+/**
+ * Send to users in lists matching a pattern
+ */
+export interface ListPatternRecipient {
+  data?: { [key: string]: unknown } | null;
+
+  list_pattern?: string | null;
+}
+
+/**
+ * Send to all users in a specific list
+ */
+export interface ListRecipient {
+  data?: { [key: string]: unknown } | null;
+
+  filters?: Array<ListFilter> | null;
+
+  list_id?: string | null;
+}
+
 export interface MessageContext {
   /**
    * Tenant id used to load brand/default preferences/context.
@@ -146,6 +271,30 @@ export interface MessageRouting {
 
 export type MessageRoutingChannel = string | MessageRouting;
 
+export type MsTeams =
+  | SendToMsTeamsUserID
+  | SendToMsTeamsEmail
+  | SendToMsTeamsChannelID
+  | SendToMsTeamsConversationID
+  | SendToMsTeamsChannelName;
+
+export interface MsTeamsBaseProperties {
+  service_url: string;
+
+  tenant_id: string;
+}
+
+/**
+ * Send via Microsoft Teams
+ */
+export interface MsTeamsRecipient {
+  ms_teams: MsTeams;
+}
+
+export interface MultipleTokens {
+  tokens: Array<Token>;
+}
+
 export interface NotificationPreferenceDetails {
   status: PreferenceStatus;
 
@@ -154,6 +303,23 @@ export interface NotificationPreferenceDetails {
   rules?: Array<Rule> | null;
 }
 
+export interface Pagerduty {
+  event_action?: string | null;
+
+  routing_key?: string | null;
+
+  severity?: string | null;
+
+  source?: string | null;
+}
+
+/**
+ * Send via PagerDuty
+ */
+export interface PagerdutyRecipient {
+  pagerduty: Pagerduty;
+}
+
 export interface Paging {
   more: boolean;
 
@@ -172,15 +338,192 @@ export interface Preference {
 
 export type PreferenceStatus = 'OPTED_IN' | 'OPTED_OUT' | 'REQUIRED';
 
-export interface ProfilePreferences {
-  notifications: { [key: string]: Preference };
+export interface RecipientPreferences {
+  categories?: { [key: string]: NotificationPreferenceDetails } | null;
+
+  notifications?: { [key: string]: NotificationPreferenceDetails } | null;
+}
+
+export interface Rule {
+  until: string;
+
+  start?: string | null;
+}
+
+export interface SendDirectMessage {
+  user_id: string;
+}
+
+export interface SendToChannel {
+  channel_id: string;
+}
+
+export interface SendToMsTeamsChannelID {
+  channel_id: string;
+
+  service_url: string;
+
+  tenant_id: string;
+}
+
+export interface SendToMsTeamsChannelName {
+  channel_name: string;
+
+  service_url: string;
+
+  team_id: string;
+
+  tenant_id: string;
+}
+
+export interface SendToMsTeamsConversationID {
+  conversation_id: string;
+
+  service_url: string;
+
+  tenant_id: string;
+}
+
+export interface SendToMsTeamsEmail {
+  email: string;
+
+  service_url: string;
 
-  categories?: { [key: string]: Preference } | null;
+  tenant_id: string;
+}
+
+export interface SendToMsTeamsUserID {
+  service_url: string;
+
+  tenant_id: string;
+
+  user_id: string;
+}
+
+export interface SendToSlackChannel {
+  access_token: string;
+
+  channel: string;
+}
+
+export interface SendToSlackEmail {
+  access_token: string;
+
+  email: string;
+}
+
+export interface SendToSlackUserID {
+  access_token: string;
+
+  user_id: string;
+}
+
+export type Slack = SendToSlackChannel | SendToSlackEmail | SendToSlackUserID;
+
+export interface SlackBaseProperties {
+  access_token: string;
+}
+
+/**
+ * Send via Slack (channel, email, or user_id)
+ */
+export interface SlackRecipient {
+  slack: Slack;
+}
+
+export type TextStyle = 'text' | 'h1' | 'h2' | 'subtext';
+
+export interface Token {
+  token: string;
+}
+
+export interface UserProfile {
+  address?: UserProfile.Address | null;
+
+  airship?: AirshipProfile | null;
+
+  apn?: string | null;
+
+  birthdate?: string | null;
+
+  /**
+   * A free form object. Due to a limitation of the API Explorer, you can only enter
+   * string key/values below, but this API accepts more complex object structures.
+   */
+  custom?: { [key: string]: unknown } | null;
+
+  discord?: Discord | null;
+
+  email?: string | null;
+
+  email_verified?: boolean | null;
+
+  expo?: Expo | null;
+
+  facebookPSID?: string | null;
+
+  family_name?: string | null;
+
+  firebaseToken?: UserProfileFirebaseToken | null;
+
+  gender?: string | null;
+
+  given_name?: string | null;
+
+  intercom?: Intercom | null;
+
+  locale?: string | null;
+
+  middle_name?: string | null;
+
+  ms_teams?: MsTeams | null;
+
+  name?: string | null;
+
+  nickname?: string | null;
+
+  phone_number?: string | null;
+
+  phone_number_verified?: boolean | null;
+
+  picture?: string | null;
+
+  preferred_name?: string | null;
+
+  profile?: string | null;
+
+  slack?: Slack | null;
+
+  sub?: string | null;
+
+  target_arn?: string | null;
+
+  updated_at?: string | null;
+
+  website?: string | null;
 
-  templateId?: string | null;
+  zoneinfo?: string | null;
 }
 
-export interface Recipient {
+export namespace UserProfile {
+  export interface Address {
+    country: string;
+
+    formatted: string;
+
+    locality: string;
+
+    postal_code: string;
+
+    region: string;
+
+    street_address: string;
+  }
+}
+
+export type UserProfileFirebaseToken = string | Array<string>;
+
+export interface UserRecipient {
   /**
    * Deprecated - Use `tenant_id` instead.
    */
@@ -213,7 +556,7 @@ export interface Recipient {
    */
   phone_number?: string | null;
 
-  preferences?: ProfilePreferences | null;
+  preferences?: UserRecipient.Preferences | null;
 
   /**
    * The id of the tenant the user is associated with.
@@ -227,75 +570,88 @@ export interface Recipient {
   user_id?: string | null;
 }
 
-export interface RecipientPreferences {
-  categories?: { [key: string]: NotificationPreferenceDetails } | null;
+export namespace UserRecipient {
+  export interface Preferences {
+    notifications: { [key: string]: Shared.Preference };
 
-  notifications?: { [key: string]: NotificationPreferenceDetails } | null;
+    categories?: { [key: string]: Shared.Preference } | null;
+
+    templateId?: string | null;
+  }
 }
 
-export interface Rule {
-  until: string;
+export interface Utm {
+  campaign?: string | null;
 
-  start?: string | null;
+  content?: string | null;
+
+  medium?: string | null;
+
+  source?: string | null;
+
+  term?: string | null;
 }
 
-export type TextStyle = 'text' | 'h1' | 'h2' | 'subtext';
+export type WebhookAuthMode = 'none' | 'basic' | 'bearer';
 
-export interface UserRecipient {
+export interface WebhookAuthentication {
   /**
-   * Deprecated - Use `tenant_id` instead.
+   * The authentication mode to use. Defaults to 'none' if not specified.
    */
-  account_id?: string | null;
+  mode: WebhookAuthMode;
 
   /**
-   * Context such as tenant_id to send the notification with.
+   * Token for bearer authentication.
    */
-  context?: MessageContext | null;
-
-  data?: { [key: string]: unknown } | null;
+  token?: string | null;
 
   /**
-   * The user's email address.
+   * Password for basic authentication.
    */
-  email?: string | null;
+  password?: string | null;
 
   /**
-   * The id of the list to send the message to.
+   * Username for basic authentication.
    */
-  list_id?: string | null;
+  username?: string | null;
+}
+
+export type WebhookMethod = 'POST' | 'PUT';
 
+export interface WebhookProfile {
   /**
-   * The user's preferred ISO 639-1 language code.
+   * The URL to send the webhook request to.
    */
-  locale?: string | null;
+  url: string;
 
   /**
-   * The user's phone number.
+   * Authentication configuration for the webhook request.
    */
-  phone_number?: string | null;
+  authentication?: WebhookAuthentication | null;
 
-  preferences?: ProfilePreferences | null;
+  /**
+   * Custom headers to include in the webhook request.
+   */
+  headers?: { [key: string]: string } | null;
 
   /**
-   * The id of the tenant the user is associated with.
+   * The HTTP method to use for the webhook request. Defaults to POST if not
+   * specified.
    */
-  tenant_id?: string | null;
+  method?: WebhookMethod | null;
 
   /**
-   * The user's unique identifier. Typically, this will match the user id of a user
-   * in your system.
+   * Specifies what profile information is included in the request payload. Defaults
+   * to 'limited' if not specified.
    */
-  user_id?: string | null;
+  profile?: WebhookProfileType | null;
 }
 
-export interface Utm {
-  campaign?: string | null;
-
-  content?: string | null;
+export type WebhookProfileType = 'limited' | 'expanded';
 
-  medium?: string | null;
-
-  source?: string | null;
-
-  term?: string | null;
+/**
+ * Send via webhook
+ */
+export interface WebhookRecipient {
+  webhook: WebhookProfile;
 }

package/src/resources/tenants/index.ts

@@ -6,14 +6,21 @@ export {
   type TemplateListResponse,
   type TemplateRetrieveParams,
   type TemplateListParams,
-} from './templates';
+  type TemplatePublishParams,
+  type TemplateReplaceParams,
+} from './templates/index';
 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/tenants/preferences/items.ts

@@ -56,7 +56,7 @@ export interface ItemUpdateParams {
   tenant_id: string;
 
   /**
-   * Body param:
+   * Body param
    */
   status: 'OPTED_OUT' | 'OPTED_IN' | 'REQUIRED';
 
@@ -68,7 +68,7 @@ export interface ItemUpdateParams {
 
   /**
    * Body param: Override channel routing with custom preferences. This will override
-   * any template prefernces that are set, but a user can still customize their
+   * any template preferences that are set, but a user can still customize their
    * preferences
    */
   has_custom_routing?: boolean | null;

package/src/resources/tenants/templates/index.ts

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Templates,
+  type TemplateListResponse,
+  type TemplateRetrieveParams,
+  type TemplateListParams,
+  type TemplatePublishParams,
+  type TemplateReplaceParams,
+} from './templates';
+export { Versions, type VersionRetrieveParams } from './versions';