@sinch/conversation 0.0.4 → 1.0.0

package/README.md

@@ -2,9 +2,6 @@
 
 This package contains the Sinch Conversation SDK for Node.js for use with [Sinch APIs](https://developers.sinch.com/). To use it, you will need a Sinch account. Please [sign up](https://dashboard.sinch.com/signup) or [log in](https://dashboard.sinch.com/login) if you already have one.
 
-> <span style="color:red; font-weight:bold">Warning:</span>
-> **This SDK is currently available to selected developers for preview use only. It is being provided for the purpose of collecting feedback, and should not be used in production environments.**
-
 ## Installation
 
 We recommend to use this SDK as part of the `@sinch/sdk-core` package as it will take care about the authentication plugins to use.
@@ -41,8 +38,7 @@ import {
   ConversationService,
   SinchClient,
   UnifiedCredentials,
-  SendMessageRequestData,
-  SendMessageResponse,
+  Conversation,
 } from '@sinch/sdk-core';
 
 const credentials: UnifiedCredentials = {
@@ -56,7 +52,7 @@ const sinch = new SinchClient(credentials);
 const conversationService: ConversationService = sinch.conversation;
 
 // Build the request data
-const requestData: SendMessageRequestData = {
+const requestData: Conversation.SendMessageRequestData = {
   sendMessageRequestBody: {
     app_id: 'CONVERSATION_APP_ID',
     message: {
@@ -74,7 +70,7 @@ const requestData: SendMessageRequestData = {
 };
 
 // Use the 'conversation' service registered on the Sinch client
-const result: SendMessageResponse
+const result: Conversation.SendMessageResponse
     = await conversationService.messages.send(requestData);
 ```
 
@@ -88,8 +84,7 @@ import {
 } from '@sinch/sdk-client';
 import {
   ConversationService,
-  SendMessageRequestData,
-  SendMessageResponse,
+  Conversation,
 } from '@sinch/conversation';
 
 const credentials: UnifiedCredentials = {
@@ -102,7 +97,7 @@ const credentials: UnifiedCredentials = {
 const conversationService = new ConversationService(options);
 
 // Build the request data
-const requestData: SendMessageRequestData = {
+const requestData: Conversation.SendMessageRequestData = {
   sendMessageRequestBody: {
     app_id: 'CONVERSATION_APP_ID',
     message: {
@@ -120,7 +115,7 @@ const requestData: SendMessageRequestData = {
 };
 
 // Use the standalone declaration of the 'conversation' service
-const result: SendMessageResponse
+const result: Conversation.SendMessageResponse
     = await conversationService.messages.send(requestData);
 ```
 
@@ -130,7 +125,7 @@ All the methods that interact with the Sinch APIs use Promises. You can use `awa
 
 ```typescript
 // Method 1: Wait for the Promise to complete
-let result: SendMessageResponse;
+let result: Conversation.SendMessageResponse;
 try {
   result = await conversationService.messages.send(requestData);
   console.log(`Message sent successfully. Message Id: ${result.id}`);

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export * from './models';
+export * as Conversation from './models';
 export * from './rest';
 export * from '@sinch/sdk-client';

package/dist/index.js

@@ -10,11 +10,24 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./models"), exports);
+exports.Conversation = void 0;
+exports.Conversation = __importStar(require("./models"));
 __exportStar(require("./rest"), exports);
 __exportStar(require("@sinch/sdk-client"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,yCAAuB;AACvB,oDAAkC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yDAAyC;AACzC,yCAAuB;AACvB,oDAAkC"}

package/dist/models/v1/app-message/app-message.d.ts

@@ -10,11 +10,12 @@ import { CarouselMessage, CarouselMessageItem } from '../carousel-message';
 import { ListMessage, ListMessageItem } from '../list-message';
 import { ContactInfoMessage, ContactInfoMessageItem } from '../contact-info-message';
 import { ConversationChannel } from '../conversation-channel';
+import { ChannelSpecificMessage } from '../channel-specific-message';
 /**
  * Message originating from an app
  */
 export type AppMessage = AppCardMessage | AppChoiceMessage | AppLocationMessage | AppCarouselMessage | AppMediaMessage | AppTemplateMessage | AppTextMessage | AppListMessage | AppContactInfoMessage;
-interface AppCardMessage extends AppMessageBase {
+export interface AppCardMessage extends AppMessageBase {
     /** @see CardMessageItem */
     card_message: CardMessageItem;
     choice_message?: never;
@@ -26,7 +27,7 @@ interface AppCardMessage extends AppMessageBase {
     list_message?: never;
     contact_info_message?: never;
 }
-interface AppChoiceMessage extends AppMessageBase {
+export interface AppChoiceMessage extends AppMessageBase {
     /** @see ChoiceMessageItem */
     choice_message: ChoiceMessageItem;
     card_message?: never;
@@ -38,7 +39,7 @@ interface AppChoiceMessage extends AppMessageBase {
     list_message?: never;
     contact_info_message?: never;
 }
-interface AppLocationMessage extends AppMessageBase {
+export interface AppLocationMessage extends AppMessageBase {
     /** @see LocationMessageItem */
     location_message: LocationMessageItem;
     card_message?: never;
@@ -50,7 +51,7 @@ interface AppLocationMessage extends AppMessageBase {
     list_message?: never;
     contact_info_message?: never;
 }
-interface AppCarouselMessage extends AppMessageBase {
+export interface AppCarouselMessage extends AppMessageBase {
     /** @see CarouselMessageItem */
     carousel_message: CarouselMessageItem;
     card_message?: never;
@@ -62,7 +63,7 @@ interface AppCarouselMessage extends AppMessageBase {
     list_message?: never;
     contact_info_message?: never;
 }
-interface AppMediaMessage extends AppMessageBase {
+export interface AppMediaMessage extends AppMessageBase {
     /** @see MediaMessageItem */
     media_message: MediaMessageItem;
     card_message?: never;
@@ -74,7 +75,7 @@ interface AppMediaMessage extends AppMessageBase {
     list_message?: never;
     contact_info_message?: never;
 }
-interface AppTemplateMessage extends AppMessageBase {
+export interface AppTemplateMessage extends AppMessageBase {
     /** @see TemplateMessageItem */
     template_message: TemplateMessageItem;
     card_message?: never;
@@ -86,7 +87,7 @@ interface AppTemplateMessage extends AppMessageBase {
     list_message?: never;
     contact_info_message?: never;
 }
-interface AppTextMessage extends AppMessageBase {
+export interface AppTextMessage extends AppMessageBase {
     /** @see TextMessageItem */
     text_message: TextMessageItem;
     card_message?: never;
@@ -98,7 +99,7 @@ interface AppTextMessage extends AppMessageBase {
     list_message?: never;
     contact_info_message?: never;
 }
-interface AppListMessage extends AppMessageBase {
+export interface AppListMessage extends AppMessageBase {
     /** @see ListMessageItem */
     list_message: ListMessageItem;
     card_message?: never;
@@ -110,7 +111,7 @@ interface AppListMessage extends AppMessageBase {
     text_message?: never;
     contact_info_message?: never;
 }
-interface AppContactInfoMessage extends AppMessageBase {
+export interface AppContactInfoMessage extends AppMessageBase {
     /** @see ContactInfoMessageItem */
     contact_info_message: ContactInfoMessageItem;
     card_message?: never;
@@ -124,7 +125,7 @@ interface AppContactInfoMessage extends AppMessageBase {
 }
 interface AppMessageBase {
     /**
-     * Optional. Channel specific messages, overriding any transcoding.
+     * Channel specific messages, overriding any transcoding.
      * The key in the map must point to a valid conversation channel as defined by the enum ConversationChannel.
      */
     explicit_channel_message?: {
@@ -135,14 +136,21 @@ interface AppMessageBase {
      * (for channels on which channel-specific templates can be created. For more information, see [Channel Specific Templates](https://developers.sinch.com/docs/conversation/templates/#channel-specific-templates)).
      */
     explicit_channel_omni_message?: {
-        [key in ChannelSpecificTemplate]?: OmniMessage;
+        [key in ChannelSpecificTemplate]?: OmniMessageOverride;
+    };
+    /**
+     * Channel specific messages, overriding any transcoding. The structure of this property is more well-defined than the open structure of the `explicit_channel_message` property, and may be easier to use.
+     * The key in the map must point to a valid conversation channel as defined in the enum `ConversationChannel`.
+     */
+    channel_specific_message?: {
+        [key in ConversationChannel]?: ChannelSpecificMessage;
     };
     /** Identity of a sender */
     agent?: Agent | null;
 }
 type ChannelSpecificTemplate = 'WHATSAPP' | 'KAKAOTALK' | 'WECHAT';
-export type OmniMessage = OmniCardMessage | OmniCarouselMessage | OmniChoiceMessage | OmniLocationMessage | OmniMediaMessage | OmniTemplateMessage | OmniTextMessage | OmniListMessage | OmniContactInfoMessage;
-interface OmniCardMessage extends CardMessage {
+export type OmniMessageOverride = OmniMessageOverrideCardMessage | OmniMessageOverrideCarouselMessage | OmniMessageOverrideChoiceMessage | OmniMessageOverrideLocationMessage | OmniMessageOverrideMediaMessage | OmniMessageOverrideTemplateReference | OmniMessageOverrideTextMessage | OmniMessageOverrideListMessage | OmniMessageOverrideContactInfoMessage;
+export interface OmniMessageOverrideCardMessage extends CardMessage {
     carousel_message?: never;
     choice_message?: never;
     location_message?: never;
@@ -152,7 +160,7 @@ interface OmniCardMessage extends CardMessage {
     list_message?: never;
     contact_info_message?: never;
 }
-interface OmniCarouselMessage extends CarouselMessage {
+export interface OmniMessageOverrideCarouselMessage extends CarouselMessage {
     card_message?: never;
     choice_message?: never;
     location_message?: never;
@@ -162,7 +170,7 @@ interface OmniCarouselMessage extends CarouselMessage {
     list_message?: never;
     contact_info_message?: never;
 }
-interface OmniChoiceMessage extends ChoiceMessage {
+export interface OmniMessageOverrideChoiceMessage extends ChoiceMessage {
     card_message?: never;
     carousel_message?: never;
     location_message?: never;
@@ -172,7 +180,7 @@ interface OmniChoiceMessage extends ChoiceMessage {
     list_message?: never;
     contact_info_message?: never;
 }
-interface OmniLocationMessage extends LocationMessage {
+export interface OmniMessageOverrideLocationMessage extends LocationMessage {
     card_message?: never;
     carousel_message?: never;
     choice_message?: never;
@@ -182,7 +190,7 @@ interface OmniLocationMessage extends LocationMessage {
     list_message?: never;
     contact_info_message?: never;
 }
-interface OmniMediaMessage extends MediaMessage {
+export interface OmniMessageOverrideMediaMessage extends MediaMessage {
     card_message?: never;
     carousel_message?: never;
     choice_message?: never;
@@ -192,7 +200,7 @@ interface OmniMediaMessage extends MediaMessage {
     list_message?: never;
     contact_info_message?: never;
 }
-interface OmniTemplateMessage {
+export interface OmniMessageOverrideTemplateReference {
     /** @see TemplateReference */
     template_reference: TemplateReference;
     card_message?: never;
@@ -204,7 +212,7 @@ interface OmniTemplateMessage {
     list_message?: never;
     contact_info_message?: never;
 }
-interface OmniTextMessage extends TextMessage {
+export interface OmniMessageOverrideTextMessage extends TextMessage {
     card_message?: never;
     carousel_message?: never;
     choice_message?: never;
@@ -214,7 +222,7 @@ interface OmniTextMessage extends TextMessage {
     list_message?: never;
     contact_info_message?: never;
 }
-interface OmniListMessage extends ListMessage {
+export interface OmniMessageOverrideListMessage extends ListMessage {
     card_message?: never;
     carousel_message?: never;
     choice_message?: never;
@@ -224,7 +232,7 @@ interface OmniListMessage extends ListMessage {
     text_message?: never;
     contact_info_message?: never;
 }
-interface OmniContactInfoMessage extends ContactInfoMessage {
+export interface OmniMessageOverrideContactInfoMessage extends ContactInfoMessage {
     card_message?: never;
     carousel_message?: never;
     choice_message?: never;

package/dist/models/v1/app-message/index.d.ts

@@ -1 +1 @@
-export type { AppMessage } from './app-message';
+export type { AppMessage, AppCardMessage, AppCarouselMessage, AppChoiceMessage, AppContactInfoMessage, AppListMessage, AppLocationMessage, AppMediaMessage, AppTemplateMessage, AppTextMessage, OmniMessageOverride, OmniMessageOverrideCardMessage, OmniMessageOverrideCarouselMessage, OmniMessageOverrideChoiceMessage, OmniMessageOverrideContactInfoMessage, OmniMessageOverrideListMessage, OmniMessageOverrideLocationMessage, OmniMessageOverrideMediaMessage, OmniMessageOverrideTemplateReference, OmniMessageOverrideTextMessage, } from './app-message';

package/dist/models/v1/channel-specific-contact-message/channel-specific-contact-message.d.ts

@@ -0,0 +1,21 @@
+import { WhatsAppInteractiveNfmReply } from '../whatsapp-interactive-nfm-reply';
+/**
+ * A contact message containing a channel specific message (not supported by OMNI types).
+ */
+export type ChannelSpecificContactMessage = WhatsAppSpecificContactMessage;
+export interface WhatsAppSpecificContactMessage {
+    /** The message type. */
+    message_type: 'nfm_reply';
+    /** @see WhatsAppInteractiveNfmReplyMessage */
+    message: WhatsAppInteractiveNfmReplyMessage;
+}
+/**
+ * A WhatsApp interactive contact message containing the nfm_reply.
+ */
+interface WhatsAppInteractiveNfmReplyMessage {
+    /** The interactive message type. */
+    type: string;
+    /** @see WhatsAppInteractiveNfmReply */
+    nfm_reply: WhatsAppInteractiveNfmReply;
+}
+export {};

package/dist/models/v1/channel-specific-contact-message/channel-specific-contact-message.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=channel-specific-contact-message.js.map

package/dist/models/v1/channel-specific-contact-message/channel-specific-contact-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"channel-specific-contact-message.js","sourceRoot":"","sources":["../../../../src/models/v1/channel-specific-contact-message/channel-specific-contact-message.ts"],"names":[],"mappings":""}

package/dist/models/v1/channel-specific-contact-message/index.d.ts

@@ -0,0 +1 @@
+export type { ChannelSpecificContactMessage, WhatsAppSpecificContactMessage } from './channel-specific-contact-message';

package/dist/models/v1/channel-specific-contact-message/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/channel-specific-contact-message/index.ts"],"names":[],"mappings":""}

package/dist/models/v1/channel-specific-message/channel-specific-message.d.ts

@@ -0,0 +1,11 @@
+import { FlowChannelSpecificMessage } from '../flow-channel-specific-message';
+/**
+ * A message containing a channel specific message (not supported by OMNI types).
+ */
+export type ChannelSpecificMessage = WhatsAppFlowMessage;
+export interface WhatsAppFlowMessage {
+    /** @see MessageTypeEnum */
+    message_type: 'FLOWS';
+    /** @see FlowChannelSpecificMessage */
+    message: FlowChannelSpecificMessage;
+}

package/dist/models/v1/channel-specific-message/channel-specific-message.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=channel-specific-message.js.map

package/dist/models/v1/channel-specific-message/channel-specific-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"channel-specific-message.js","sourceRoot":"","sources":["../../../../src/models/v1/channel-specific-message/channel-specific-message.ts"],"names":[],"mappings":""}

package/dist/models/v1/channel-specific-message/index.d.ts

@@ -0,0 +1 @@
+export type { ChannelSpecificMessage, WhatsAppFlowMessage } from './channel-specific-message';

package/dist/models/v1/channel-specific-message/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/channel-specific-message/index.ts"],"names":[],"mappings":""}

package/dist/models/v1/choice-item/choice-item.d.ts

@@ -1,8 +1,9 @@
 import { MediaMessageItem } from '../media-message';
-export interface ChoiceItem {
-    choice: ChoiceItemItem;
+export interface ChoiceItemWrapper {
+    /** A message component for interactive messages, containing a choice. */
+    choice: ChoiceItem;
 }
-export interface ChoiceItemItem {
+export interface ChoiceItem {
     /** Required parameter. Title for the choice item. */
     title: string;
     /** Optional parameter. The description (or subtitle) of this choice item. */

package/dist/models/v1/choice-item/index.d.ts

@@ -1 +1 @@
-export type { ChoiceItem, ChoiceItemItem } from './choice-item';
+export type { ChoiceItemWrapper, ChoiceItem } from './choice-item';

package/dist/models/v1/contact-info-message/contact-info-message.d.ts

@@ -3,7 +3,7 @@
  */
 export interface ContactInfoMessage {
     /** @see ContactInfoMessageItem */
-    contact_info_message?: ContactInfoMessageItem;
+    contact_info_message: ContactInfoMessageItem;
 }
 export interface ContactInfoMessageItem {
     /** @see NameInfo */

package/dist/models/v1/contact-message/contact-message.d.ts

@@ -5,62 +5,98 @@ import { MediaCardMessage } from '../media-card-message';
 import { MediaMessageItem } from '../media-message';
 import { ReplyTo } from '../reply-to';
 import { TextMessageItem } from '../text-message';
+import { ProductResponseMessage } from '../product-response-message';
+import { ChannelSpecificContactMessage } from '../channel-specific-contact-message';
 /**
  * Message originating from a contact
  */
-export type ContactMessage = ContactMessageChoiceResponseMessage | ContactMessageFallbackMessage | ContactMessageLocationMessage | ContactMessageMediaCardMessage | ContactMessageMediaMessage | ContactMessageTextMessage;
+export type ContactMessage = ContactMessageChoiceResponseMessage | ContactMessageFallbackMessage | ContactMessageLocationMessage | ContactMessageMediaCardMessage | ContactMessageMediaMessage | ContactMessageTextMessage | ContactMessageProductResponseMessage | ContactMessageChannelSpecificContactMessage;
+interface ContactMessageChannelSpecificContactMessage extends ContactMessageBase {
+    /** @see ChannelSpecificContactMessage */
+    channel_specific_message: ChannelSpecificContactMessage;
+    choice_response_message?: never;
+    fallback_message?: never;
+    location_message?: never;
+    media_card_message?: never;
+    media_message?: never;
+    product_response_message?: never;
+    text_message?: never;
+}
 interface ContactMessageChoiceResponseMessage extends ContactMessageBase {
     /** @see ChoiceResponseMessage */
     choice_response_message: ChoiceResponseMessage;
+    channel_specific_message?: never;
     fallback_message?: never;
     location_message?: never;
     media_card_message?: never;
     media_message?: never;
+    product_response_message?: never;
     text_message?: never;
 }
 interface ContactMessageFallbackMessage extends ContactMessageBase {
     /** @see FallbackMessage */
     fallback_message: FallbackMessage;
+    channel_specific_message?: never;
     choice_response_message?: never;
     location_message?: never;
     media_card_message?: never;
     media_message?: never;
+    product_response_message?: never;
     text_message?: never;
 }
 interface ContactMessageLocationMessage extends ContactMessageBase {
     /** @see LocationMessageItem */
     location_message: LocationMessageItem;
+    channel_specific_message?: never;
     choice_response_message?: never;
     fallback_message?: never;
     media_card_message?: never;
     media_message?: never;
+    product_response_message?: never;
     text_message?: never;
 }
 interface ContactMessageMediaCardMessage extends ContactMessageBase {
     /** @see MediaCardMessage */
     media_card_message: MediaCardMessage;
+    channel_specific_message?: never;
     choice_response_message?: never;
     fallback_message?: never;
     location_message?: never;
     media_message?: never;
+    product_response_message?: never;
     text_message?: never;
 }
 interface ContactMessageMediaMessage extends ContactMessageBase {
     /** @see MediaMessageItem */
     media_message: MediaMessageItem;
+    channel_specific_message?: never;
     choice_response_message?: never;
     fallback_message?: never;
     location_message?: never;
     media_card_message?: never;
+    product_response_message?: never;
+    text_message?: never;
+}
+interface ContactMessageProductResponseMessage extends ContactMessageBase {
+    /** @see ProductResponseMessage */
+    product_response_message: ProductResponseMessage;
+    channel_specific_message?: never;
+    choice_response_message?: never;
+    fallback_message?: never;
+    location_message?: never;
+    media_card_message?: never;
+    media_message?: never;
     text_message?: never;
 }
 interface ContactMessageTextMessage extends ContactMessageBase {
     /** @see TextMessageItem */
     text_message: TextMessageItem;
+    channel_specific_message?: never;
     choice_response_message?: never;
     fallback_message?: never;
     location_message?: never;
     media_card_message?: never;
+    product_response_message?: never;
     media_message?: never;
 }
 interface ContactMessageBase {

package/dist/models/v1/delivery-report-based-fallback/delivery-report-based-fallback.d.ts

@@ -2,8 +2,14 @@
  * This object contains additional settings related to [delivery report based fallback](../../../../../conversation/keyconcepts/#delivery-report-base-message-fallback). Note that this **paid** functionality is available for open beta testing.
  */
 export interface DeliveryReportBasedFallback {
-    /** Optional. A flag specifying whether this app has enabled fallback message delivery upon no positive delivery report. This feature is applicable only to messages which are sent to a recipient with more than one channel identity. Identities must be defined on channels which support at least the \'DELIVERED\' message state. **Please note that this functionality requires payment.** */
+    /**
+     * Optional. A flag specifying whether this app has enabled fallback message delivery upon no positive delivery report.
+     * This feature is applicable only to messages which are sent to a recipient with more than one channel identity.
+     * Identities must be defined on channels which support at least the 'DELIVERED' message state.
+     * **Please note that this functionality requires payment.** */
     enabled?: boolean;
-    /** Optional. The time, in seconds, after which a message without a positive delivery report will fallback to the next channel. The valid values for this field are [60 - 259200]. */
+    /**
+     * Optional. The time, in seconds, after which a message without a positive delivery report will fallback to the next channel.
+     * The valid values for this field are [60 - 259200]. */
     delivery_report_waiting_time?: number;
 }

package/dist/models/v1/enums.d.ts

@@ -1,4 +1,7 @@
-export type { SentimentResult as MachineLearningSentimentEnum, EvaluationEnum as OffensiveAnalysisEvaluationEnum, } from './mod-callback-events/smart-conversations-event/smart-conversations-event';
+/**
+ * NONE - Omit metadata.
+ * FULL - Include all metadata assigned to the conversation.
+ */
 export type ConversationMetadataReportView = 'NONE' | 'FULL';
 export type ConversationMetadataUpdateStrategy = 'REPLACE' | 'MERGE_PATCH';
 /**
@@ -21,3 +24,4 @@ export type MessageQueue = 'NORMAL_PRIORITY' | 'HIGH_PRIORITY';
 export type ProcessingMode = 'CONVERSATION' | 'DISPATCH';
 export type ProcessingStrategy = 'DEFAULT' | 'DISPATCH_ONLY';
 export type WebhookTargetType = 'DISMISS' | 'HTTP';
+export type MessageSource = 'CONVERSATION_SOURCE' | 'DISPATCH_SOURCE';

package/dist/models/v1/flow-channel-specific-message/flow-channel-specific-message.d.ts

@@ -0,0 +1,37 @@
+import { WhatsAppInteractiveBody } from '../whatsapp-interactive-body';
+import { WhatsAppInteractiveFooter } from '../whatsapp-interactive-footer';
+import { WhatsAppInteractiveTextHeader } from '../whatsapp-interactive-text-header';
+import { WhatsAppInteractiveImageHeader } from '../whatsapp-interactive-image-header';
+import { WhatsAppInteractiveDocumentHeader } from '../whatsapp-interactive-document-header';
+import { WhatsAppInteractiveVideoHeader } from '../whatsapp-interactive-video-header';
+/**
+ * A message type for sending WhatsApp Flows.
+ */
+export interface FlowChannelSpecificMessage {
+    /** @see FlowChannelSpecificMessageHeader */
+    header?: FlowChannelSpecificMessageHeader;
+    /** @see WhatsAppInteractiveBody */
+    body?: WhatsAppInteractiveBody;
+    /** @see WhatsAppInteractiveFooter */
+    footer?: WhatsAppInteractiveFooter;
+    /** ID of the Flow. */
+    flow_id: string;
+    /** Generated token which is an identifier. */
+    flow_token?: string;
+    /** The mode in which the flow is. */
+    flow_mode?: 'draft' | 'published';
+    /** Text which is displayed on the Call To Action button (20 characters maximum, emoji not supported). */
+    flow_cta: string;
+    /** */
+    flow_action?: 'navigate' | 'data_exchange';
+    /** @see FlowChannelSpecificMessageFlowActionPayload */
+    flow_action_payload?: FlowChannelSpecificMessageFlowActionPayload;
+}
+type FlowChannelSpecificMessageHeader = WhatsAppInteractiveTextHeader | WhatsAppInteractiveImageHeader | WhatsAppInteractiveDocumentHeader | WhatsAppInteractiveVideoHeader;
+interface FlowChannelSpecificMessageFlowActionPayload {
+    /** The ID of the screen displayed first. This must be an entry screen. */
+    screen?: string;
+    /** Data for the first screen. */
+    data?: object;
+}
+export {};

package/dist/models/v1/flow-channel-specific-message/flow-channel-specific-message.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=flow-channel-specific-message.js.map

package/dist/models/v1/flow-channel-specific-message/flow-channel-specific-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow-channel-specific-message.js","sourceRoot":"","sources":["../../../../src/models/v1/flow-channel-specific-message/flow-channel-specific-message.ts"],"names":[],"mappings":""}

package/dist/models/v1/flow-channel-specific-message/index.d.ts

@@ -0,0 +1 @@
+export type { FlowChannelSpecificMessage } from './flow-channel-specific-message';

package/dist/{rest/v1/enums.js → models/v1/flow-channel-specific-message/index.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=enums.js.map
+//# sourceMappingURL=index.js.map

package/dist/models/v1/flow-channel-specific-message/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/flow-channel-specific-message/index.ts"],"names":[],"mappings":""}

package/dist/models/v1/helper.d.ts

@@ -8,6 +8,8 @@ import { MediaMessage, MediaMessageItem } from './media-message';
 import { TemplateMessage, TemplateMessageItem } from './template-message';
 import { ListMessage, ListMessageItem } from './list-message';
 import { V2TemplateTranslation } from './v2-template-translation';
+import { ChoiceItem, ChoiceItemWrapper } from './choice-item';
+import { ProductItem, ProductItemWrapper } from './product-item';
 export declare const messageBuilder: {
     card: (cardMessageItem: CardMessageItem) => CardMessage;
     carousel: (carouselMessageItem: CarouselMessageItem) => CarouselMessage;
@@ -66,13 +68,17 @@ export declare const templateV2Helper: {
         content: TemplateMessageItem | undefined;
     } | {
         type: MessageType;
-        content: TextMessageItem | undefined;
+        content: TextMessageItem;
     } | {
         type: MessageType;
         content: string;
     };
     getPreviousTranslations: (translations: V2TemplateTranslation[] | undefined) => V2TemplateTranslation[];
 };
+export declare const listSectionHelper: {
+    buildChoiceItem: (choiceItem: ChoiceItem) => ChoiceItemWrapper;
+    buildProductItem: (productItem: ProductItem) => ProductItemWrapper;
+};
 export declare const enum MessageType {
     CARD = "CardMessage",
     CAROUSEL = "CarouselMessage",

package/dist/models/v1/helper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.templateV2Helper = exports.templateV1Helper = exports.messageBuilder = void 0;
+exports.listSectionHelper = exports.templateV2Helper = exports.templateV1Helper = exports.messageBuilder = void 0;
 exports.messageBuilder = {
     card: (cardMessageItem) => {
         return {
@@ -177,4 +177,16 @@ exports.templateV2Helper = {
         }
     },
 };
+exports.listSectionHelper = {
+    buildChoiceItem: (choiceItem) => {
+        return {
+            choice: choiceItem,
+        };
+    },
+    buildProductItem: (productItem) => {
+        return {
+            product: productItem,
+        };
+    },
+};
 //# sourceMappingURL=helper.js.map