@twilio/conversations 2.2.2 → 2.3.0-rc.1

package/builds/lib.d.ts

@@ -122,8 +122,8 @@ declare class CommandExecutor {
     constructor(_serviceUrl: string, _services: CommandExecutorServices, _productId?: string);
     private _preProcessUrl;
     private _makeRequest;
-    fetchResource<REQ = void, RESP = void>(url: string, requestBody?: REQ): Promise<RESP>;
-    mutateResource<REQ = void, RESP = void>(method: "post" | "delete", url: string, requestBody?: REQ): Promise<RESP>;
+    fetchResource<Request = void, Response = void>(url: string, requestBody?: Request): Promise<Response>;
+    mutateResource<Request = void, Response = void>(method: "post" | "delete", url: string, requestBody?: Request): Promise<Response>;
 }
 /**
  * Represents a JSON value.
@@ -714,6 +714,472 @@ declare class DetailedDeliveryReceipt {
      */
     constructor(descriptor: DetailedDeliveryReceiptDescriptor);
 }
+type ContentDataActionResponse = Readonly<{
+    type: string;
+    title: string;
+    id?: string;
+    url?: string;
+    phone?: string;
+    index?: number;
+}>;
+type ContentDataTextResponse = Readonly<{
+    body: string;
+}>;
+type ContentDataMediaResponse = Readonly<{
+    body?: string;
+    media: string[];
+}>;
+type ContentDataLocationResponse = Readonly<{
+    longitude: number;
+    latitude: number;
+    label?: string;
+}>;
+type ContentDataQuickReplyResponse = Readonly<{
+    body: string;
+    actions: Readonly<{
+        title: string;
+        id?: string;
+    }>[];
+}>;
+type ContentDataCallToActionResponse = Readonly<{
+    body: string;
+    actions: ContentDataActionResponse[];
+}>;
+type ContentDataListPickerResponse = Readonly<{
+    body: string;
+    button: string;
+    items: Readonly<{
+        id: string;
+        item: string;
+        description?: string;
+    }>[];
+}>;
+type ContentDataCardResponse = Readonly<{
+    title: string;
+    subtitle?: string;
+    media?: string[];
+    actions?: ContentDataActionResponse[];
+}>;
+type ContentDataResponse = Readonly<{
+    "twilio/text"?: ContentDataTextResponse;
+    "twilio/media"?: ContentDataMediaResponse;
+    "twilio/location"?: ContentDataLocationResponse;
+    "twilio/quick-reply"?: ContentDataQuickReplyResponse;
+    "twilio/call-to-action"?: ContentDataCallToActionResponse;
+    "twilio/list-picker"?: ContentDataListPickerResponse;
+    "twilio/card"?: ContentDataCardResponse;
+}>;
+type ContentTemplateResponse = Readonly<{
+    sid: string;
+    account_sid: string;
+    friendly_name: string;
+    variables: string;
+    variants: ContentDataResponse;
+    date_created: string;
+    date_updated: string;
+}>;
+/**
+ * Shows a button that sends back a predefined text. Used in
+ * {@link ContentDataQuickReply}.
+ */
+type ContentDataReply = {
+    /**
+     * Display value of the action. This is the message that will be sent back
+     * when the user taps on the button.
+     */
+    readonly title: string;
+    /**
+     * Postback payload. This field is not visible to the end user.
+     */
+    readonly id?: string;
+};
+/**
+ * Shows a button that redirects recipient to a predefined URL.
+ */
+type ContentDataActionUrl = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "url";
+    /**
+     * Display value for the action.
+     */
+    readonly title: string;
+    /**
+     * URL to direct to when the recipient taps the button.
+     */
+    readonly url: string;
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Shows a button that calls a phone number.
+ */
+type ContentDataActionPhone = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "phone";
+    /**
+     * Display value for the action.
+     */
+    readonly title: string;
+    /**
+     * Phone number to call when the recipient taps the button.
+     */
+    readonly phone: string;
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Shows a button that sends back a predefined text.
+ */
+type ContentDataActionReply = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "reply";
+    /**
+     * Display value for the action. This is the message that will be sent back
+     * when the user taps on the button.
+     */
+    readonly title: string;
+    /**
+     * Postback payload. This field is not visible to the end user.
+     */
+    readonly id?: string;
+    /**
+     * Index for the action.
+     */
+    readonly index: number;
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Used for unknown action types which aren't present in the current version of
+ * the Conversations SDK.
+ */
+type ContentDataActionOther = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "other";
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * A union of possible actions used in {@link ContentDataCallToAction} and
+ * {@link ContentDataCard}.
+ */
+type ContentDataAction = ContentDataActionUrl | ContentDataActionPhone | ContentDataActionReply | ContentDataActionOther;
+/**
+ * Represents an item in the {@link ContentDataListPicker}.
+ */
+type ContentDataListItem = {
+    /**
+     * Unique item identifier. Not visible to the recipient.
+     */
+    readonly id: string;
+    /**
+     * Display value of the item.
+     */
+    readonly item: string;
+    /**
+     * Description of the item.
+     */
+    readonly description?: string;
+};
+/**
+ * Contains only the plain text-based content. Represents the twilio/text
+ * content type.
+ */
+type ContentDataText = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "text";
+    /**
+     * The text of the message you want to send.
+     */
+    readonly body: string;
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Used to send file attachments, or to send long texts via MMS in the US and
+ * Canada. Represents the twilio/media content type.
+ */
+type ContentDataMedia = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "media";
+    /**
+     * The text of the message you want to send.
+     */
+    readonly body?: string;
+    /**
+     * URLs of the media you want to send.
+     */
+    readonly media: string[];
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Contains a location pin and an optional label, which can be used to enhance
+ * delivery notifications or connect recipients to physical experiences you
+ * offer. Represents the twilio/location content type.
+ */
+type ContentDataLocation = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "location";
+    /**
+     * The longitude value of the location pin you want to send.
+     */
+    readonly longitude: number;
+    /**
+     * The latitude value of the location pin you want to send.
+     */
+    readonly latitude: number;
+    /**
+     * The label to be displayed to the end user alongside the location pin.
+     */
+    readonly label?: string;
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Let recipients tap, rather than type, to respond to the message. Represents
+ * the twilio/quick-reply content type.
+ */
+type ContentDataQuickReply = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "quickReply";
+    /**
+     * The text of the message you want to send. This is included as a regular
+     * text message.
+     */
+    readonly body: string;
+    /**
+     * Up to 3 buttons can be created for quick reply. See
+     * {@link ContentDataReply}.
+     */
+    readonly replies: ContentDataReply[];
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Buttons that let recipients tap to trigger actions such as launching a
+ * website or making a phone call. Represents the twilio/call-to-action content
+ * type.
+ */
+type ContentDataCallToAction = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "callToAction";
+    /**
+     * The text of the message you want to send. This is included as a regular
+     * text message.
+     */
+    readonly body: string;
+    /**
+     * Buttons that recipients can tap on to act on the message.
+     */
+    readonly actions: ContentDataAction[];
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Shows a menu of up to 10 options, which offers a simple way for users to make
+ * a selection. Represents the twilio/list-picker content type.
+ */
+type ContentDataListPicker = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "listPicker";
+    /**
+     * The text of the message you want to send. This is rendered as the body of
+     * the message.
+     */
+    readonly body: string;
+    /**
+     * Display value of the primary button.
+     */
+    readonly button: string;
+    /**
+     * List item objects displayed in the list. See {@link ContentDataListItem}.
+     */
+    readonly items: ContentDataListItem[];
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Shows a menu of up to 10 options, which offers a simple way for users to make
+ * a selection. Represents the twilio/card content type.
+ */
+type ContentDataCard = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "card";
+    /**
+     * Title of the card.
+     */
+    readonly title: string;
+    /**
+     * Subtitle of the card.
+     */
+    readonly subtitle?: string;
+    /**
+     * URLs of the media to send with the message.
+     */
+    readonly media: string[];
+    /**
+     * Buttons that the recipients can tap on to act on the message.
+     */
+    readonly actions: ContentDataAction[];
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Used for unknown content types which aren't present in the current version of
+ * the Conversations SDK.
+ */
+type ContentDataOther = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "other";
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * A union of possible data types in rich content templates.
+ */
+type ContentData = ContentDataText | ContentDataMedia | ContentDataLocation | ContentDataQuickReply | ContentDataCallToAction | ContentDataListPicker | ContentDataCard | ContentDataOther;
+/**
+ * Represents a variable for a content template. See
+ * {@link ContentTemplate.variables}.
+ */
+declare class ContentTemplateVariable {
+    readonly name: string;
+    readonly value: string;
+    constructor(/**
+     * Name of the variable.
+     */
+    name: string, /**
+     * Key of the variable
+     */
+    value: string);
+    /**
+     * Copies the variable with a new value.
+     *
+     * @param value The new value for the variable.
+     */
+    copyWithValue(value: string): ContentTemplateVariable;
+}
+/**
+ * A rich content template.
+ *
+ * Use {@Link Client.getContentTemplates} to request all the templates available
+ * for the current account.
+ */
+declare class ContentTemplate {
+    /**
+     * The server-assigned unique identifier for the template.
+     */
+    readonly sid: string;
+    /**
+     * Friendly name used to describe the content. Not visible to the recipient.
+     */
+    readonly friendlyName: string;
+    /**
+     * Variables used by this template.
+     */
+    readonly variables: ContentTemplateVariable[];
+    /**
+     * Variants of the content. See @{link ContentData}.
+     */
+    readonly variants: Map<string, ContentData>;
+    /**
+     * Date of creation.
+     */
+    readonly dateCreated: Date;
+    /**
+     * Date of the last update.
+     */
+    readonly dateUpdated: Date;
+    /**
+     * @internal
+     */
+    constructor(contentTemplateResponse: ContentTemplateResponse);
+}
 type MessageEvents = {
     updated: (data: {
         message: Message;
@@ -748,6 +1214,7 @@ interface MessageData {
     type?: MessageType;
     author: string | null;
     subject: string | null;
+    contentSid: string | null;
     lastUpdatedBy?: string | null;
     attributes?: JSONValue;
     dateUpdated: string;
@@ -794,6 +1261,10 @@ declare class Message extends ReplayEventEmitter<MessageEvents> {
      * Message subject. Used only in email conversations.
      */
     get subject(): string | null;
+    /**
+     * Unique identifier of {@link ContentTemplate} for this message.
+     */
+    get contentSid(): string | null;
     /**
      * Body of the message.
      */
@@ -919,6 +1390,11 @@ declare class Message extends ReplayEventEmitter<MessageEvents> {
      */
     getTemporaryContentUrlsForAttachedMedia(): CancellablePromise<Map<string, string>>;
     private _getDetailedDeliveryReceiptsPaginator;
+    /**
+     * Get the {@link ContentData} for this message. Resolves to `null` when
+     * {@link Message.contentSid} is null.
+     */
+    getContentData(): CancellablePromise<ContentData | null>;
 }
 /**
  * Pagination helper interface.
@@ -1152,6 +1628,8 @@ declare class UnsentMessage {
         FormData | SendMediaOptions
     ][];
     emailOptions: SendEmailOptions;
+    contentSid?: string;
+    contentVariables?: ContentTemplateVariable[];
     /**
      * @internal
      */
@@ -1213,6 +1691,21 @@ declare class MessageBuilder {
      * @param history History payload in the selected format.
      */
     setEmailHistory(contentType: string, history: FormData | SendMediaOptions): MessageBuilder;
+    /**
+     * Adds {@link ContentTemplate} SID for the message alongside optional
+     * variables. When no variables provided, the default values will be used.
+     *
+     * Adding the content SID converts the message to a rich message. In this
+     * case, other fields are ignored and the message is sent using the content
+     * from the the {@link ContentTemplate}.
+     *
+     * Use {@link Client.getContentTemplates} to request all available
+     * {@link ContentTemplate}s.
+     *
+     * @param contentSid SID of the {@link ContentTemplate}
+     * @param variables Custom variables to resolve the template.
+     */
+    setContentTemplate(contentSid: string, contentVariables?: ContentTemplateVariable[]): MessageBuilder;
     /**
      * Adds media to the message.
      * @param payload Media to add.
@@ -2503,6 +2996,11 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      * @param contentSet Set of media attachments to query content URLs.
      */
     getTemporaryContentUrlsForMedia(contentSet: Media[]): CancellablePromise<Map<string, string>>;
+    /**
+     * Returns rich content templates belonging to the account. Rich content
+     * templates can be created via the Twilio console or the REST API.
+     */
+    getContentTemplates(): Promise<Readonly<ContentTemplate[]>>;
     /**
      * Initialize the client.
      */
@@ -2526,4 +3024,4 @@ declare class NotificationTypes {
     static readonly REMOVED_FROM_CONVERSATION = "twilio.conversations.removed_from_conversation";
     static readonly CONSUMPTION_UPDATE = "twilio.channel.consumption_update";
 }
-export { Conversation, ConversationBindings, ConversationEmailBinding, ConversationUpdateReason, ConversationStatus, NotificationLevel, ConversationState, ConversationUpdatedEventArgs, SendMediaOptions, SendEmailOptions, LastMessage, Participant, ParticipantUpdateReason, ParticipantType, ParticipantUpdatedEventArgs, ParticipantBindings, ParticipantEmailBinding, ParticipantEmailLevel, Message, MessageUpdateReason, MessageType, MessageUpdatedEventArgs, Media, MediaCategory$0 as MediaCategory, AggregatedDeliveryReceipt, DeliveryAmount, DetailedDeliveryReceipt, DeliveryStatus, RestPaginator, MessageBuilder, UnsentMessage, Paginator, ParticipantBindingOptions, User, UserUpdateReason, UserUpdatedEventArgs, PushNotification, PushNotificationType, PushNotificationDescriptor, PushNotificationData, NotificationTypes, Client, State, ConnectionState, NotificationsChannelType, ClientOptions, CreateConversationOptions, ConversationLimits, JSONValue, JSONObject, JSONArray, CancellablePromise };
+export { Conversation, ConversationBindings, ConversationEmailBinding, ConversationUpdateReason, ConversationStatus, NotificationLevel, ConversationState, ConversationUpdatedEventArgs, SendMediaOptions, SendEmailOptions, LastMessage, Participant, ParticipantUpdateReason, ParticipantType, ParticipantUpdatedEventArgs, ParticipantBindings, ParticipantEmailBinding, ParticipantEmailLevel, Message, MessageUpdateReason, MessageType, MessageUpdatedEventArgs, Media, MediaCategory$0 as MediaCategory, AggregatedDeliveryReceipt, DeliveryAmount, DetailedDeliveryReceipt, DeliveryStatus, RestPaginator, MessageBuilder, UnsentMessage, Paginator, ParticipantBindingOptions, User, UserUpdateReason, UserUpdatedEventArgs, PushNotification, PushNotificationType, PushNotificationDescriptor, PushNotificationData, NotificationTypes, Client, State, ConnectionState, NotificationsChannelType, ClientOptions, CreateConversationOptions, ConversationLimits, JSONValue, JSONObject, JSONArray, CancellablePromise, ContentDataActionUrl, ContentDataActionPhone, ContentDataActionReply, ContentDataActionOther, ContentDataAction, ContentDataText, ContentDataMedia, ContentDataLocation, ContentDataReply, ContentDataQuickReply, ContentDataCallToAction, ContentDataListPicker, ContentDataListItem, ContentDataCard, ContentDataOther, ContentData, ContentTemplate, ContentTemplateVariable };