@trycourier/courier 6.6.1-alpha0 → 6.7.0-alpha2

package/src/resources/brands.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as BrandsAPI from './brands';
 import * as AudiencesAPI from './audiences';
 import { APIPromise } from '../core/api-promise';
 import { buildHeaders } from '../internal/headers';
@@ -51,80 +52,137 @@ export class Brands extends APIResource {
 }
 
 export interface Brand {
-  /**
-   * The date/time of when the brand was created. Represented in milliseconds since
-   * Unix epoch.
-   */
+  id: string;
+
   created: number;
 
-  /**
-   * Brand name
-   */
   name: string;
 
-  /**
-   * The date/time of when the brand was published. Represented in milliseconds since
-   * Unix epoch.
-   */
-  published: number;
-
-  settings: BrandSettings;
-
-  /**
-   * The date/time of when the brand was updated. Represented in milliseconds since
-   * Unix epoch.
-   */
   updated: number;
 
-  /**
-   * The version identifier for the brand
-   */
-  version: string;
+  published?: number | null;
 
-  /**
-   * Brand Identifier
-   */
-  id?: string | null;
+  settings?: BrandSettings | null;
 
   snippets?: BrandSnippets | null;
+
+  version?: string | null;
+}
+
+export interface BrandColors {
+  primary?: string;
+
+  secondary?: string;
+
+  [k: string]: string | undefined;
 }
 
 export interface BrandSettings {
-  colors?: BrandSettings.Colors | null;
+  colors?: BrandColors | null;
 
-  email?: BrandSettings.Email | null;
+  email?: BrandSettingsEmail | null;
 
-  inapp?: unknown;
+  inapp?: BrandSettingsInApp | null;
 }
 
-export namespace BrandSettings {
-  export interface Colors {
-    primary?: string | null;
+export interface BrandSettingsEmail {
+  footer?: EmailFooter | null;
 
-    secondary?: string | null;
+  head?: EmailHead | null;
 
-    tertiary?: string | null;
-  }
+  header?: EmailHeader | null;
+
+  templateOverride?: BrandSettingsEmail.TemplateOverride | null;
+}
+
+export namespace BrandSettingsEmail {
+  export interface TemplateOverride extends BrandsAPI.BrandTemplate {
+    mjml: BrandsAPI.BrandTemplate;
 
-  export interface Email {
-    footer: unknown;
+    footerBackgroundColor?: string | null;
 
-    header: unknown;
+    footerFullWidth?: boolean | null;
   }
 }
 
+export interface BrandSettingsInApp {
+  colors: BrandColors;
+
+  icons: Icons;
+
+  widgetBackground: WidgetBackground;
+
+  borderRadius?: string | null;
+
+  disableMessageIcon?: boolean | null;
+
+  fontFamily?: string | null;
+
+  placement?: 'top' | 'bottom' | 'left' | 'right' | null;
+}
+
+export interface BrandSnippet {
+  name: string;
+
+  value: string;
+}
+
 export interface BrandSnippets {
-  items: Array<BrandSnippets.Item>;
+  items?: Array<BrandSnippet> | null;
 }
 
-export namespace BrandSnippets {
-  export interface Item {
-    format: 'handlebars';
+export interface BrandTemplate {
+  enabled: boolean;
 
-    name: string;
+  backgroundColor?: string | null;
 
-    value: string;
-  }
+  blocksBackgroundColor?: string | null;
+
+  footer?: string | null;
+
+  head?: string | null;
+
+  header?: string | null;
+
+  width?: string | null;
+}
+
+export interface EmailFooter {
+  content?: string | null;
+
+  inheritDefault?: boolean | null;
+}
+
+export interface EmailHead {
+  inheritDefault: boolean;
+
+  content?: string | null;
+}
+
+export interface EmailHeader {
+  logo: Logo;
+
+  barColor?: string | null;
+
+  inheritDefault?: boolean | null;
+}
+
+export interface Icons {
+  bell?: string | null;
+
+  message?: string | null;
+}
+
+export interface Logo {
+  href?: string | null;
+
+  image?: string | null;
+}
+
+export interface WidgetBackground {
+  bottomColor?: string | null;
+
+  topColor?: string | null;
 }
 
 export interface BrandListResponse {
@@ -134,15 +192,12 @@ export interface BrandListResponse {
 }
 
 export interface BrandCreateParams {
-  /**
-   * The name of the brand.
-   */
   name: string;
 
-  settings: BrandSettings;
-
   id?: string | null;
 
+  settings?: BrandSettings | null;
+
   snippets?: BrandSnippets | null;
 }
 
@@ -167,8 +222,19 @@ export interface BrandListParams {
 export declare namespace Brands {
   export {
     type Brand as Brand,
+    type BrandColors as BrandColors,
     type BrandSettings as BrandSettings,
+    type BrandSettingsEmail as BrandSettingsEmail,
+    type BrandSettingsInApp as BrandSettingsInApp,
+    type BrandSnippet as BrandSnippet,
     type BrandSnippets as BrandSnippets,
+    type BrandTemplate as BrandTemplate,
+    type EmailFooter as EmailFooter,
+    type EmailHead as EmailHead,
+    type EmailHeader as EmailHeader,
+    type Icons as Icons,
+    type Logo as Logo,
+    type WidgetBackground as WidgetBackground,
     type BrandListResponse as BrandListResponse,
     type BrandCreateParams as BrandCreateParams,
     type BrandUpdateParams as BrandUpdateParams,

package/src/resources/bulk.ts

@@ -4,9 +4,9 @@ import { APIResource } from '../core/resource';
 import * as BulkAPI from './bulk';
 import * as AudiencesAPI from './audiences';
 import * as SendAPI from './send';
+import * as Shared from './shared';
 import * as SubscriptionsAPI from './lists/subscriptions';
-import * as PreferencesAPI from './users/preferences';
-import * as ItemsAPI from './tenants/default-preferences/items';
+import * as TemplatesAPI from './tenants/templates';
 import { APIPromise } from '../core/api-promise';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
@@ -60,64 +60,40 @@ export class Bulk extends APIResource {
   }
 }
 
-export interface InboundBulkMessage {
-  /**
-   * A unique identifier that represents the brand that should be used for rendering
-   * the notification.
-   */
-  brand?: string | null;
+export type InboundBulkMessage =
+  | InboundBulkMessage.InboundBulkTemplateMessage
+  | InboundBulkMessage.InboundBulkContentMessage;
 
-  /**
-   * JSON that includes any data you want to pass to a message template. The data
-   * will populate the corresponding template variables.
-   */
-  data?: { [key: string]: unknown } | null;
+export namespace InboundBulkMessage {
+  export interface InboundBulkTemplateMessage {
+    template: string;
 
-  event?: string | null;
+    brand?: string | null;
 
-  locale?: { [key: string]: unknown } | null;
+    data?: { [key: string]: unknown } | null;
 
-  /**
-   * Describes the content of the message in a way that will work for email, push,
-   * chat, or any channel.
-   */
-  message?:
-    | InboundBulkMessage.InboundBulkTemplateMessage
-    | InboundBulkMessage.InboundBulkContentMessage
-    | null;
+    event?: string | null;
 
-  /**
-   * JSON that is merged into the request sent by Courier to the provider to override
-   * properties or to gain access to features in the provider API that are not
-   * natively supported by Courier.
-   */
-  override?: unknown;
-}
+    locale?: { [key: string]: { [key: string]: unknown } } | null;
 
-export namespace InboundBulkMessage {
-  /**
-   * Describes the content of the message in a way that will work for email, push,
-   * chat, or any channel.
-   */
-  export interface InboundBulkTemplateMessage extends SendAPI.BaseMessage {
-    /**
-     * The id of the notification template to be rendered and sent to the recipient(s).
-     * This field or the content field must be supplied.
-     */
-    template: string;
+    override?: { [key: string]: unknown } | null;
   }
 
-  /**
-   * A template for a type of message that can be sent more than once. For example,
-   * you might create an "Appointment Reminder" Notification or “Reset Password”
-   * Notifications.
-   */
-  export interface InboundBulkContentMessage extends SendAPI.BaseMessage {
+  export interface InboundBulkContentMessage {
     /**
-     * Describes the content of the message in a way that will work for email, push,
-     * chat, or any channel. Either this or template must be specified.
+     * Syntactic sugar to provide a fast shorthand for Courier Elemental Blocks.
      */
-    content: SendAPI.Content;
+    content: Shared.ElementalContentSugar | TemplatesAPI.ElementalContent;
+
+    brand?: string | null;
+
+    data?: { [key: string]: unknown } | null;
+
+    event?: string | null;
+
+    locale?: { [key: string]: { [key: string]: unknown } } | null;
+
+    override?: { [key: string]: unknown } | null;
   }
 }
 
@@ -135,12 +111,12 @@ export interface InboundBulkMessageUser {
 
 export interface UserRecipient {
   /**
-   * Use `tenant_id` instad.
+   * Use `tenant_id` instead.
    */
   account_id?: string | null;
 
   /**
-   * Context information such as tenant_id to send the notification with.
+   * Context such as tenant_id to send the notification with.
    */
   context?: SendAPI.MessageContext | null;
 
@@ -158,10 +134,7 @@ export interface UserRecipient {
   preferences?: UserRecipient.Preferences | null;
 
   /**
-   * An id of a tenant,
-   * [see tenants api docs](https://www.courier.com/docs/reference/tenants). Will
-   * load brand, default preferences and any other base context data associated with
-   * this tenant.
+   * Tenant id. Will load brand, default preferences and base context data.
    */
   tenant_id?: string | null;
 
@@ -170,58 +143,12 @@ export interface UserRecipient {
 
 export namespace UserRecipient {
   export interface Preferences {
-    notifications: { [key: string]: Preferences.Notifications };
+    notifications: { [key: string]: Shared.Preference };
 
-    categories?: { [key: string]: Preferences.Categories } | null;
+    categories?: { [key: string]: Shared.Preference } | null;
 
     templateId?: string | null;
   }
-
-  export namespace Preferences {
-    export interface Notifications {
-      status: PreferencesAPI.PreferenceStatus;
-
-      channel_preferences?: Array<Notifications.ChannelPreference> | null;
-
-      rules?: Array<Notifications.Rule> | null;
-
-      source?: 'subscription' | 'list' | 'recipient' | null;
-    }
-
-    export namespace Notifications {
-      export interface ChannelPreference {
-        channel: ItemsAPI.ChannelClassification;
-      }
-
-      export interface Rule {
-        until: string;
-
-        start?: string | null;
-      }
-    }
-
-    export interface Categories {
-      status: PreferencesAPI.PreferenceStatus;
-
-      channel_preferences?: Array<Categories.ChannelPreference> | null;
-
-      rules?: Array<Categories.Rule> | null;
-
-      source?: 'subscription' | 'list' | 'recipient' | null;
-    }
-
-    export namespace Categories {
-      export interface ChannelPreference {
-        channel: ItemsAPI.ChannelClassification;
-      }
-
-      export interface Rule {
-        until: string;
-
-        start?: string | null;
-      }
-    }
-  }
 }
 
 export interface BulkCreateJobResponse {

package/src/resources/inbound.ts

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

package/src/resources/index.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export * from './shared';
 export {
   Audiences,
   type Audience,
   type Filter,
   type FilterConfig,
-  type NestedFilterConfig,
   type Paging,
   type AudienceUpdateResponse,
   type AudienceListResponse,
@@ -21,16 +21,23 @@ export {
   type AuditEventListParams,
 } from './audit-events';
 export { Auth, type AuthIssueTokenResponse, type AuthIssueTokenParams } from './auth';
-export {
-  Automations,
-  type AutomationInvokeAdHocParams,
-  type AutomationInvokeByTemplateParams,
-} from './automations/automations';
+export { Automations } from './automations/automations';
 export {
   Brands,
   type Brand,
+  type BrandColors,
   type BrandSettings,
+  type BrandSettingsEmail,
+  type BrandSettingsInApp,
+  type BrandSnippet,
   type BrandSnippets,
+  type BrandTemplate,
+  type EmailFooter,
+  type EmailHead,
+  type EmailHeader,
+  type Icons,
+  type Logo,
+  type WidgetBackground,
   type BrandListResponse,
   type BrandCreateParams,
   type BrandUpdateParams,
@@ -55,21 +62,20 @@ export {
   type ListListResponse,
   type ListUpdateParams,
   type ListListParams,
+  type ListRestoreParams,
 } from './lists/lists';
 export {
   Messages,
   type MessageDetails,
   type MessageRetrieveResponse,
   type MessageListResponse,
-  type MessageGetContentResponse,
+  type MessageContentResponse,
   type MessageHistoryResponse,
   type MessageListParams,
   type MessageHistoryParams,
 } from './messages';
 export {
   Notifications,
-  type MessageRouting,
-  type MessageRoutingChannel,
   type NotificationGetContent,
   type NotificationListResponse,
   type NotificationListParams,
@@ -86,21 +92,13 @@ export {
 export { Requests } from './requests';
 export {
   Send,
-  type BaseMessage,
-  type BaseMessageSendTo,
-  type Content,
   type ElementalChannelNode,
-  type ElementalGroupNode,
   type ElementalNode,
-  type Message,
   type MessageContext,
-  type MsTeamsBaseProperties,
   type Recipient,
-  type RoutingMethod,
-  type SlackBaseProperties,
   type Utm,
-  type SendSendMessageResponse,
-  type SendSendMessageParams,
+  type SendMessageResponse,
+  type SendMessageParams,
 } from './send';
 export {
   Tenants,

package/src/resources/lists/index.ts

@@ -1,8 +1,16 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Lists, type List, type ListListResponse, type ListUpdateParams, type ListListParams } from './lists';
+export {
+  Lists,
+  type List,
+  type ListListResponse,
+  type ListUpdateParams,
+  type ListListParams,
+  type ListRestoreParams,
+} from './lists';
 export {
   Subscriptions,
+  type NotificationPreferenceDetails,
   type PutSubscriptionsRecipient,
   type RecipientPreferences,
   type SubscriptionListResponse,

package/src/resources/lists/lists.ts

@@ -4,6 +4,7 @@ import { APIResource } from '../../core/resource';
 import * as AudiencesAPI from '../audiences';
 import * as SubscriptionsAPI from './subscriptions';
 import {
+  NotificationPreferenceDetails,
   PutSubscriptionsRecipient,
   RecipientPreferences,
   SubscriptionAddParams,
@@ -32,8 +33,12 @@ export class Lists extends APIResource {
   /**
    * Create or replace an existing list with the supplied values.
    */
-  update(listID: string, body: ListUpdateParams, options?: RequestOptions): APIPromise<List> {
-    return this._client.put(path`/lists/${listID}`, { body, ...options });
+  update(listID: string, body: ListUpdateParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.put(path`/lists/${listID}`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
   }
 
   /**
@@ -59,8 +64,9 @@ export class Lists extends APIResource {
   /**
    * Restore a previously deleted list.
    */
-  restore(listID: string, options?: RequestOptions): APIPromise<void> {
+  restore(listID: string, body: ListRestoreParams, options?: RequestOptions): APIPromise<void> {
     return this._client.put(path`/lists/${listID}/restore`, {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -72,9 +78,9 @@ export interface List {
 
   name: string;
 
-  created?: number | null;
+  created?: string | null;
 
-  updated?: number | null;
+  updated?: string | null;
 }
 
 export interface ListListResponse {
@@ -104,6 +110,8 @@ export interface ListListParams {
   pattern?: string | null;
 }
 
+export interface ListRestoreParams {}
+
 Lists.Subscriptions = Subscriptions;
 
 export declare namespace Lists {
@@ -112,10 +120,12 @@ export declare namespace Lists {
     type ListListResponse as ListListResponse,
     type ListUpdateParams as ListUpdateParams,
     type ListListParams as ListListParams,
+    type ListRestoreParams as ListRestoreParams,
   };
 
   export {
     Subscriptions as Subscriptions,
+    type NotificationPreferenceDetails as NotificationPreferenceDetails,
     type PutSubscriptionsRecipient as PutSubscriptionsRecipient,
     type RecipientPreferences as RecipientPreferences,
     type SubscriptionListResponse as SubscriptionListResponse,

package/src/resources/lists/subscriptions.ts

@@ -3,8 +3,8 @@
 import { APIResource } from '../../core/resource';
 import * as SubscriptionsAPI from './subscriptions';
 import * as AudiencesAPI from '../audiences';
+import * as Shared from '../shared';
 import * as PreferencesAPI from '../users/preferences';
-import * as ItemsAPI from '../tenants/default-preferences/items';
 import { APIPromise } from '../../core/api-promise';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
@@ -79,6 +79,14 @@ export class Subscriptions extends APIResource {
   }
 }
 
+export interface NotificationPreferenceDetails {
+  status: PreferencesAPI.PreferenceStatus;
+
+  channel_preferences?: Array<Shared.ChannelPreference> | null;
+
+  rules?: Array<Shared.Rule> | null;
+}
+
 export interface PutSubscriptionsRecipient {
   recipientId: string;
 
@@ -86,51 +94,9 @@ export interface PutSubscriptionsRecipient {
 }
 
 export interface RecipientPreferences {
-  categories?: { [key: string]: RecipientPreferences.Categories } | null;
-
-  notifications?: { [key: string]: RecipientPreferences.Notifications } | null;
-}
-
-export namespace RecipientPreferences {
-  export interface Categories {
-    status: PreferencesAPI.PreferenceStatus;
-
-    channel_preferences?: Array<Categories.ChannelPreference> | null;
-
-    rules?: Array<Categories.Rule> | null;
-  }
-
-  export namespace Categories {
-    export interface ChannelPreference {
-      channel: ItemsAPI.ChannelClassification;
-    }
+  categories?: { [key: string]: NotificationPreferenceDetails } | null;
 
-    export interface Rule {
-      until: string;
-
-      start?: string | null;
-    }
-  }
-
-  export interface Notifications {
-    status: PreferencesAPI.PreferenceStatus;
-
-    channel_preferences?: Array<Notifications.ChannelPreference> | null;
-
-    rules?: Array<Notifications.Rule> | null;
-  }
-
-  export namespace Notifications {
-    export interface ChannelPreference {
-      channel: ItemsAPI.ChannelClassification;
-    }
-
-    export interface Rule {
-      until: string;
-
-      start?: string | null;
-    }
-  }
+  notifications?: { [key: string]: NotificationPreferenceDetails } | null;
 }
 
 export interface SubscriptionListResponse {
@@ -185,6 +151,7 @@ export interface SubscriptionUnsubscribeUserParams {
 
 export declare namespace Subscriptions {
   export {
+    type NotificationPreferenceDetails as NotificationPreferenceDetails,
     type PutSubscriptionsRecipient as PutSubscriptionsRecipient,
     type RecipientPreferences as RecipientPreferences,
     type SubscriptionListResponse as SubscriptionListResponse,