@trycourier/courier 6.6.1-alpha0 → 6.7.0-alpha10

package/src/resources/shared.ts

@@ -0,0 +1,305 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Shared from './shared';
+
+export type Alignment = 'center' | 'left' | 'right' | 'full';
+
+export type ChannelClassification = 'direct_message' | 'email' | 'push' | 'sms' | 'webhook' | 'inbox';
+
+export interface ChannelPreference {
+  channel: ChannelClassification;
+}
+
+export interface ElementalActionNodeWithType extends ElementalBaseNode {
+  type?: 'action';
+}
+
+export interface ElementalBaseNode {
+  channels?: Array<string> | null;
+
+  if?: string | null;
+
+  loop?: string | null;
+
+  ref?: string | null;
+}
+
+/**
+ * The channel element allows a notification to be customized based on which
+ * channel it is sent through. For example, you may want to display a detailed
+ * message when the notification is sent through email, and a more concise message
+ * in a push notification. Channel elements are only valid as top-level elements;
+ * you cannot nest channel elements. If there is a channel element specified at the
+ * top-level of the document, all sibling elements must be channel elements. Note:
+ * As an alternative, most elements support a `channel` property. Which allows you
+ * to selectively display an individual element on a per channel basis. See the
+ * [control flow docs](https://www.courier.com/docs/platform/content/elemental/control-flow/)
+ * for more details.
+ */
+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;
+
+  /**
+   * Raw data to apply to the channel. If `elements` has not been specified, `raw` is
+   * `required`.
+   */
+  raw?: { [key: string]: unknown } | null;
+}
+
+/**
+ * The channel element allows a notification to be customized based on which
+ * channel it is sent through. For example, you may want to display a detailed
+ * message when the notification is sent through email, and a more concise message
+ * in a push notification. Channel elements are only valid as top-level elements;
+ * you cannot nest channel elements. If there is a channel element specified at the
+ * top-level of the document, all sibling elements must be channel elements. Note:
+ * As an alternative, most elements support a `channel` property. Which allows you
+ * to selectively display an individual element on a per channel basis. See the
+ * [control flow docs](https://www.courier.com/docs/platform/content/elemental/control-flow/)
+ * for more details.
+ */
+export interface ElementalChannelNodeWithType extends ElementalChannelNode {
+  type?: 'channel';
+}
+
+export interface ElementalContent {
+  elements: Array<ElementalNode>;
+
+  /**
+   * For example, "2022-01-01"
+   */
+  version: string;
+
+  brand?: string | null;
+}
+
+/**
+ * Syntactic sugar to provide a fast shorthand for Courier Elemental Blocks.
+ */
+export interface ElementalContentSugar {
+  /**
+   * The text content displayed in the notification.
+   */
+  body: string;
+
+  /**
+   * Title/subject displayed by supported channels.
+   */
+  title: string;
+}
+
+export interface ElementalDividerNodeWithType extends ElementalBaseNode {
+  type?: 'divider';
+}
+
+export interface ElementalImageNodeWithType extends ElementalBaseNode {
+  type?: 'image';
+}
+
+export interface ElementalMetaNodeWithType extends ElementalBaseNode {
+  type?: 'meta';
+}
+
+/**
+ * The channel element allows a notification to be customized based on which
+ * channel it is sent through. For example, you may want to display a detailed
+ * message when the notification is sent through email, and a more concise message
+ * in a push notification. Channel elements are only valid as top-level elements;
+ * you cannot nest channel elements. If there is a channel element specified at the
+ * top-level of the document, all sibling elements must be channel elements. Note:
+ * As an alternative, most elements support a `channel` property. Which allows you
+ * to selectively display an individual element on a per channel basis. See the
+ * [control flow docs](https://www.courier.com/docs/platform/content/elemental/control-flow/)
+ * for more details.
+ */
+export type ElementalNode =
+  | ElementalTextNodeWithType
+  | ElementalMetaNodeWithType
+  | ElementalChannelNodeWithType
+  | ElementalImageNodeWithType
+  | ElementalActionNodeWithType
+  | ElementalDividerNodeWithType
+  | ElementalQuoteNodeWithType;
+
+export interface ElementalQuoteNodeWithType extends ElementalBaseNode {
+  type?: 'quote';
+}
+
+export interface ElementalTextNodeWithType extends ElementalBaseNode {
+  type?: 'text';
+}
+
+export interface MessageContext {
+  /**
+   * Tenant id used to load brand/default preferences/context.
+   */
+  tenant_id?: string | null;
+}
+
+export interface MessageRouting {
+  channels: Array<MessageRoutingChannel>;
+
+  method: 'all' | 'single';
+}
+
+export type MessageRoutingChannel = string | MessageRouting;
+
+export interface NotificationPreferenceDetails {
+  status: PreferenceStatus;
+
+  channel_preferences?: Array<ChannelPreference> | null;
+
+  rules?: Array<Rule> | null;
+}
+
+export interface Paging {
+  more: boolean;
+
+  cursor?: string | null;
+}
+
+export interface Preference {
+  status: PreferenceStatus;
+
+  channel_preferences?: Array<ChannelPreference> | null;
+
+  rules?: Array<Rule> | null;
+
+  source?: 'subscription' | 'list' | 'recipient' | null;
+}
+
+export type PreferenceStatus = 'OPTED_IN' | 'OPTED_OUT' | 'REQUIRED';
+
+export interface Recipient {
+  /**
+   * Deprecated - Use `tenant_id` instead.
+   */
+  account_id?: string | null;
+
+  /**
+   * Context such as tenant_id to send the notification with.
+   */
+  context?: MessageContext | null;
+
+  data?: { [key: string]: unknown } | null;
+
+  /**
+   * The user's email address.
+   */
+  email?: string | null;
+
+  /**
+   * The user's preferred ISO 639-1 language code.
+   */
+  locale?: string | null;
+
+  /**
+   * The user's phone number.
+   */
+  phone_number?: string | null;
+
+  preferences?: Recipient.Preferences | null;
+
+  /**
+   * The id of the tenant the user is associated with.
+   */
+  tenant_id?: string | null;
+
+  /**
+   * The user's unique identifier. Typically, this will match the user id of a user
+   * in your system.
+   */
+  user_id?: string | null;
+}
+
+export namespace Recipient {
+  export interface Preferences {
+    notifications: { [key: string]: Shared.Preference };
+
+    categories?: { [key: string]: Shared.Preference } | null;
+
+    templateId?: string | null;
+  }
+}
+
+export interface RecipientPreferences {
+  categories?: { [key: string]: NotificationPreferenceDetails } | null;
+
+  notifications?: { [key: string]: NotificationPreferenceDetails } | null;
+}
+
+export interface Rule {
+  until: string;
+
+  start?: string | null;
+}
+
+export type TextStyle = 'text' | 'h1' | 'h2' | 'subtext';
+
+export interface UserRecipient {
+  /**
+   * Deprecated - Use `tenant_id` instead.
+   */
+  account_id?: string | null;
+
+  /**
+   * Context such as tenant_id to send the notification with.
+   */
+  context?: MessageContext | null;
+
+  data?: { [key: string]: unknown } | null;
+
+  /**
+   * The user's email address.
+   */
+  email?: string | null;
+
+  /**
+   * The user's preferred ISO 639-1 language code.
+   */
+  locale?: string | null;
+
+  /**
+   * The user's phone number.
+   */
+  phone_number?: string | null;
+
+  preferences?: UserRecipient.Preferences | null;
+
+  /**
+   * The id of the tenant the user is associated with.
+   */
+  tenant_id?: string | null;
+
+  /**
+   * The user's unique identifier. Typically, this will match the user id of a user
+   * in your system.
+   */
+  user_id?: string | null;
+}
+
+export namespace UserRecipient {
+  export interface Preferences {
+    notifications: { [key: string]: Shared.Preference };
+
+    categories?: { [key: string]: Shared.Preference } | null;
+
+    templateId?: string | null;
+  }
+}
+
+export interface Utm {
+  campaign?: string | null;
+
+  content?: string | null;
+
+  medium?: string | null;
+
+  source?: string | null;
+
+  term?: string | null;
+}

package/src/resources/tenants/index.ts

@@ -1,9 +1,19 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  Templates,
+  type TemplateListResponse,
+  type TemplateRetrieveParams,
+  type TemplateListParams,
+} from './templates';
+export { TenantDefaultPreferences } from './tenant-default-preferences/index';
 export {
   Tenants,
+  type BaseTemplateTenantAssociation,
   type DefaultPreferences,
+  type SubscriptionTopicNew,
   type Tenant,
+  type TenantAssociation,
   type TenantListResponse,
   type TenantListUsersResponse,
   type TenantUpdateParams,

package/src/resources/tenants/templates.ts

@@ -0,0 +1,124 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import * as TenantsAPI from './tenants';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Templates extends APIResource {
+  /**
+   * Get a Template in Tenant
+   *
+   * @example
+   * ```ts
+   * const baseTemplateTenantAssociation =
+   *   await client.tenants.templates.retrieve('template_id', {
+   *     tenant_id: 'tenant_id',
+   *   });
+   * ```
+   */
+  retrieve(
+    templateID: string,
+    params: TemplateRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<TenantsAPI.BaseTemplateTenantAssociation> {
+    const { tenant_id } = params;
+    return this._client.get(path`/tenants/${tenant_id}/templates/${templateID}`, options);
+  }
+
+  /**
+   * List Templates in Tenant
+   *
+   * @example
+   * ```ts
+   * const templates = await client.tenants.templates.list(
+   *   'tenant_id',
+   * );
+   * ```
+   */
+  list(
+    tenantID: string,
+    query: TemplateListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<TemplateListResponse> {
+    return this._client.get(path`/tenants/${tenantID}/templates`, { query, ...options });
+  }
+}
+
+export interface TemplateListResponse {
+  /**
+   * Set to true when there are more pages that can be retrieved.
+   */
+  has_more: boolean;
+
+  /**
+   * Always set to `list`. Represents the type of this object.
+   */
+  type: 'list';
+
+  /**
+   * A url that may be used to generate these results.
+   */
+  url: string;
+
+  /**
+   * A pointer to the next page of results. Defined only when `has_more` is set to
+   * true
+   */
+  cursor?: string | null;
+
+  items?: Array<TemplateListResponse.Item> | null;
+
+  /**
+   * A url that may be used to generate fetch the next set of results. Defined only
+   * when `has_more` is set to true
+   */
+  next_url?: string | null;
+}
+
+export namespace TemplateListResponse {
+  export interface Item extends TenantsAPI.BaseTemplateTenantAssociation {
+    /**
+     * The template's data containing it's routing configs
+     */
+    data: Item.Data;
+  }
+
+  export namespace Item {
+    /**
+     * The template's data containing it's routing configs
+     */
+    export interface Data {
+      routing: Shared.MessageRouting;
+    }
+  }
+}
+
+export interface TemplateRetrieveParams {
+  /**
+   * Id of the tenant for which to retrieve the template.
+   */
+  tenant_id: string;
+}
+
+export interface TemplateListParams {
+  /**
+   * Continue the pagination with the next cursor
+   */
+  cursor?: string | null;
+
+  /**
+   * The number of templates to return (defaults to 20, maximum value of 100)
+   */
+  limit?: number | null;
+}
+
+export declare namespace Templates {
+  export {
+    type TemplateListResponse as TemplateListResponse,
+    type TemplateRetrieveParams as TemplateRetrieveParams,
+    type TemplateListParams as TemplateListParams,
+  };
+}

package/src/resources/tenants/tenant-default-preferences/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Items, type ItemUpdateParams, type ItemDeleteParams } from './items';
+export { TenantDefaultPreferences } from './tenant-default-preferences';

package/src/resources/tenants/{default-preferences → tenant-default-preferences}/items.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 Shared from '../../shared';
 import { APIPromise } from '../../../core/api-promise';
 import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
@@ -12,7 +13,7 @@ export class Items extends APIResource {
    *
    * @example
    * ```ts
-   * await client.tenants.defaultPreferences.items.update(
+   * await client.tenants.tenantDefaultPreferences.items.update(
    *   'topic_id',
    *   {
    *     tenant_id: 'tenant_id',
@@ -37,7 +38,7 @@ export class Items extends APIResource {
    *
    * @example
    * ```ts
-   * await client.tenants.defaultPreferences.items.delete(
+   * await client.tenants.tenantDefaultPreferences.items.delete(
    *   'topic_id',
    *   { tenant_id: 'tenant_id' },
    * );
@@ -52,24 +53,6 @@ export class Items extends APIResource {
   }
 }
 
-export type ChannelClassification = 'direct_message' | 'email' | 'push' | 'sms' | 'webhook' | 'inbox';
-
-export interface SubscriptionTopicNew {
-  status: 'OPTED_OUT' | 'OPTED_IN' | 'REQUIRED';
-
-  /**
-   * The default channels to send to this tenant when has_custom_routing is enabled
-   */
-  custom_routing?: Array<ChannelClassification> | null;
-
-  /**
-   * Override channel routing with custom preferences. This will override any
-   * template prefernces that are set, but a user can still customize their
-   * preferences
-   */
-  has_custom_routing?: boolean | null;
-}
-
 export interface ItemUpdateParams {
   /**
    * Path param: Id of the tenant to update the default preferences for.
@@ -85,7 +68,7 @@ export interface ItemUpdateParams {
    * Body param: The default channels to send to this tenant when has_custom_routing
    * is enabled
    */
-  custom_routing?: Array<ChannelClassification> | null;
+  custom_routing?: Array<Shared.ChannelClassification> | null;
 
   /**
    * Body param: Override channel routing with custom preferences. This will override
@@ -103,10 +86,5 @@ export interface ItemDeleteParams {
 }
 
 export declare namespace Items {
-  export {
-    type ChannelClassification as ChannelClassification,
-    type SubscriptionTopicNew as SubscriptionTopicNew,
-    type ItemUpdateParams as ItemUpdateParams,
-    type ItemDeleteParams as ItemDeleteParams,
-  };
+  export { type ItemUpdateParams as ItemUpdateParams, type ItemDeleteParams as ItemDeleteParams };
 }

package/src/resources/tenants/{default-preferences/default-preferences.ts → tenant-default-preferences/tenant-default-preferences.ts}

@@ -2,25 +2,17 @@
 
 import { APIResource } from '../../../core/resource';
 import * as ItemsAPI from './items';
-import {
-  ChannelClassification,
-  ItemDeleteParams,
-  ItemUpdateParams,
-  Items,
-  SubscriptionTopicNew,
-} from './items';
+import { ItemDeleteParams, ItemUpdateParams, Items } from './items';
 
-export class DefaultPreferences extends APIResource {
+export class TenantDefaultPreferences extends APIResource {
   items: ItemsAPI.Items = new ItemsAPI.Items(this._client);
 }
 
-DefaultPreferences.Items = Items;
+TenantDefaultPreferences.Items = Items;
 
-export declare namespace DefaultPreferences {
+export declare namespace TenantDefaultPreferences {
   export {
     Items as Items,
-    type ChannelClassification as ChannelClassification,
-    type SubscriptionTopicNew as SubscriptionTopicNew,
     type ItemUpdateParams as ItemUpdateParams,
     type ItemDeleteParams as ItemDeleteParams,
   };

package/src/resources/tenants/tenant-default-preferences.ts

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