@trycourier/courier 6.6.0 → 6.7.0-alpha10

package/src/resources/send.ts

@@ -0,0 +1,230 @@
+// 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 { RequestOptions } from '../internal/request-options';
+
+export class Send extends APIResource {
+  /**
+   * Use the send API to send a message to one or more recipients.
+   *
+   * @example
+   * ```ts
+   * const response = await client.send.message({
+   *   message: {
+   *     to: { user_id: 'example_user' },
+   *     template: 'template_id',
+   *     data: { foo: 'bar' },
+   *   },
+   * });
+   * ```
+   */
+  message(body: SendMessageParams, options?: RequestOptions): APIPromise<SendMessageResponse> {
+    return this._client.post('/send', { body, ...options });
+  }
+}
+
+export interface SendMessageResponse {
+  /**
+   * A successful call to `POST /send` returns a `202` status code along with a
+   * `requestId` in the response body. For single-recipient requests, the `requestId`
+   * is the derived message_id. For multiple recipients, Courier assigns a unique
+   * message_id to each derived message.
+   */
+  requestId: string;
+}
+
+export interface SendMessageParams {
+  /**
+   * The message property has the following primary top-level properties. They define
+   * the destination and content of the message.
+   */
+  message: SendMessageParams.Message;
+}
+
+export namespace SendMessageParams {
+  /**
+   * The message property has the following primary top-level properties. They define
+   * the destination and content of the message.
+   */
+  export interface Message {
+    brand_id?: string | null;
+
+    /**
+     * Define run-time configuration for channels. Valid ChannelId's: email, sms, push,
+     * inbox, direct_message, banner, webhook.
+     */
+    channels?: { [key: string]: Message.Channels } | null;
+
+    /**
+     * Describes content that will work for email, inbox, push, chat, or any channel
+     * id.
+     */
+    content?: Shared.ElementalContentSugar | Shared.ElementalContent;
+
+    context?: Shared.MessageContext | null;
+
+    data?: { [key: string]: unknown } | null;
+
+    delay?: Message.Delay | null;
+
+    expiry?: Message.Expiry | null;
+
+    metadata?: Message.Metadata | null;
+
+    preferences?: Message.Preferences | null;
+
+    providers?: { [key: string]: Message.Providers } | null;
+
+    /**
+     * Customize which channels/providers Courier may deliver the message through.
+     */
+    routing?: Message.Routing | null;
+
+    template?: string | null;
+
+    timeout?: Message.Timeout | null;
+
+    /**
+     * The recipient or a list of recipients of the message
+     */
+    to?: Shared.UserRecipient | Array<Shared.Recipient> | null;
+  }
+
+  export namespace Message {
+    export interface Channels {
+      /**
+       * Brand id used for rendering.
+       */
+      brand_id?: string | null;
+
+      /**
+       * JS conditional with access to data/profile.
+       */
+      if?: string | null;
+
+      metadata?: Channels.Metadata | null;
+
+      /**
+       * Channel specific overrides.
+       */
+      override?: { [key: string]: unknown } | null;
+
+      /**
+       * Providers enabled for this channel.
+       */
+      providers?: Array<string> | null;
+
+      /**
+       * Defaults to `single`.
+       */
+      routing_method?: 'all' | 'single' | null;
+
+      timeouts?: Channels.Timeouts | null;
+    }
+
+    export namespace Channels {
+      export interface Metadata {
+        utm?: Shared.Utm | null;
+      }
+
+      export interface Timeouts {
+        channel?: number | null;
+
+        provider?: number | null;
+      }
+    }
+
+    export interface Delay {
+      /**
+       * The duration of the delay in milliseconds.
+       */
+      duration?: number | null;
+
+      /**
+       * ISO 8601 timestamp or opening_hours-like format.
+       */
+      until?: string | null;
+    }
+
+    export interface Expiry {
+      /**
+       * Duration in ms or ISO8601 duration (e.g. P1DT4H).
+       */
+      expires_in: string | number;
+
+      /**
+       * Epoch or ISO8601 timestamp with timezone.
+       */
+      expires_at?: string | null;
+    }
+
+    export interface Metadata {
+      event?: string | null;
+
+      tags?: Array<string> | null;
+
+      trace_id?: string | null;
+
+      utm?: Shared.Utm | null;
+    }
+
+    export interface Preferences {
+      /**
+       * The subscription topic to apply to the message.
+       */
+      subscription_topic_id: string;
+    }
+
+    export interface Providers {
+      /**
+       * JS conditional with access to data/profile.
+       */
+      if?: string | null;
+
+      metadata?: Providers.Metadata | null;
+
+      /**
+       * Provider-specific overrides.
+       */
+      override?: { [key: string]: unknown } | null;
+
+      timeouts?: number | null;
+    }
+
+    export namespace Providers {
+      export interface Metadata {
+        utm?: Shared.Utm | null;
+      }
+    }
+
+    /**
+     * Customize which channels/providers Courier may deliver the message through.
+     */
+    export interface Routing {
+      /**
+       * A list of channels or providers (or nested routing rules).
+       */
+      channels: Array<Shared.MessageRoutingChannel>;
+
+      method: 'all' | 'single';
+    }
+
+    export interface Timeout {
+      channel?: { [key: string]: number } | null;
+
+      criteria?: 'no-escalation' | 'delivered' | 'viewed' | 'engaged' | null;
+
+      escalation?: number | null;
+
+      message?: number | null;
+
+      provider?: { [key: string]: number } | null;
+    }
+  }
+}
+
+export declare namespace Send {
+  export { type SendMessageResponse as SendMessageResponse, type SendMessageParams as SendMessageParams };
+}

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

@@ -0,0 +1,22 @@
+// 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,
+  type TenantListParams,
+  type TenantListUsersParams,
+} from './tenants';

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';