@sinch/conversation 0.0.2 → 0.0.4

package/README.md

@@ -38,18 +38,24 @@ If you are using this SDK as part of the Sinch SDK (`@sinch/sdk-core`) you can a
 
 ```typescript
 import {
+  ConversationService,
   SinchClient,
-  SinchClientParameters,
+  UnifiedCredentials,
+  SendMessageRequestData,
+  SendMessageResponse,
 } from '@sinch/sdk-core';
 
-const credentials: SinchClientParameters = {
+const credentials: UnifiedCredentials = {
   projectId: 'PROJECT_ID',
   keyId: 'KEY_ID',
   keySecret: 'KEY_SECRET',
 };
 
+// Access the 'conversation' service registered on the Sinch Client
 const sinch = new SinchClient(credentials);
+const conversationService: ConversationService = sinch.conversation;
 
+// Build the request data
 const requestData: SendMessageRequestData = {
   sendMessageRequestBody: {
     app_id: 'CONVERSATION_APP_ID',
@@ -61,12 +67,15 @@ const requestData: SendMessageRequestData = {
     recipient: {
       contact_id: 'CONTACT_ID',
     },
+    channel_priority_order: [
+      'WHASAPP',
+    ],
   },
 };
 
-// Access the 'conversation' domain registered on the Sinch Client
+// Use the 'conversation' service registered on the Sinch client
 const result: SendMessageResponse
-    = await sinch.conversation.messages.send(requestData);
+    = await conversationService.messages.send(requestData);
 ```
 
 ### Standalone
@@ -75,21 +84,24 @@ The SDK can be used standalone if you need to use only the Conversation APIs.
 
 ```typescript
 import {
-  SinchClientParameters,
+  UnifiedCredentials,
 } from '@sinch/sdk-client';
 import {
-
+  ConversationService,
+  SendMessageRequestData,
+  SendMessageResponse,
 } from '@sinch/conversation';
 
-const credentials: SinchClientParameters = {
+const credentials: UnifiedCredentials = {
   projectId: 'PROJECT_ID',
   keyId: 'KEY_ID',
   keySecret: 'KEY_SECRET',
 };
 
 // Declare the 'conversation' service in a standalone way
-const conversation = new Conversation(options);
+const conversationService = new ConversationService(options);
 
+// Build the request data
 const requestData: SendMessageRequestData = {
   sendMessageRequestBody: {
     app_id: 'CONVERSATION_APP_ID',
@@ -101,30 +113,33 @@ const requestData: SendMessageRequestData = {
     recipient: {
       contact_id: 'CONTACT_ID',
     },
+    channel_priority_order: [
+      'WHASAPP',
+    ],
   },
 };
 
-// Use the standalone declaration of the 'conversation' domain
+// Use the standalone declaration of the 'conversation' service
 const result: SendMessageResponse
-    = await conversation.messages.send(requestData);
+    = await conversationService.messages.send(requestData);
 ```
 
 ## Promises
 
-All the methods that interact with the Sinch APIs use Promises. You can use `await` in an `async` method to wait for the response or you can resolve them yourself with `then()` / `catch()`.
+All the methods that interact with the Sinch APIs use Promises. You can use `await` in an `async` method to wait for the response, or you can resolve them yourself with `then()` / `catch()`.
 
 ```typescript
 // Method 1: Wait for the Promise to complete
 let result: SendMessageResponse;
 try {
-  result = await sinch.conversation.messages.send(requestData);
+  result = await conversationService.messages.send(requestData);
   console.log(`Message sent successfully. Message Id: ${result.id}`);
 } catch (error: any) {
   console.error(`ERROR ${error.statusCode}: `);
 }
 
 // Method 2: Resolve the promise
-sinch.conversation.messages.send(requestData)
+conversationService.messages.send(requestData)
   .then(response => console.log(`Message sent successfully. Message Id: ${result.id}`))
   .catch(error => console.error(`ERROR ${error.statusCode}: `));
 ```

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

@@ -2,10 +2,10 @@
  * Represents an agent that is involved in a conversation.
  */
 export interface Agent {
-    /** Agent\'s display name */
+    /** Agent's display name */
     display_name: string;
-    /** Agent\'s classification. It can be UNKNOWN_AGENT_TYPE, HUMAN or BOT. */
+    /** Agent's classification. It can be UNKNOWN_AGENT_TYPE, HUMAN or BOT. */
     type: 'UNKNOWN_AGENT_TYPE' | 'HUMAN' | 'BOT';
-    /** The Agent\'s picture url. */
+    /** The Agent's picture url. */
     picture_url?: string;
 }

package/dist/models/v1/agent-joined-event/agent-joined-event.d.ts

@@ -1,7 +1,7 @@
 import { Agent } from '../agent';
 export interface AgentJoinedEvent {
     /** @see AgentJoinedEventType */
-    agent_joined_event?: AgentJoinedEventType;
+    agent_joined_event: AgentJoinedEventType;
 }
 export interface AgentJoinedEventType {
     /** Represents an agent that is involved in a conversation. */

package/dist/models/v1/agent-left-event/agent-left-event.d.ts

@@ -1,7 +1,7 @@
 import { Agent } from '../agent';
 export interface AgentLeftEvent {
     /** @see AgentLeftEventType */
-    agent_left_event?: AgentLeftEventType;
+    agent_left_event: AgentLeftEventType;
 }
 export interface AgentLeftEventType {
     /** Represents an agent that is involved in a conversation. */

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

@@ -7,4 +7,47 @@ import { GenericEvent } from '../generic-event';
 /**
  * Event originating from an app
  */
-export type AppEvent = ComposingEvent | ComposingEndEvent | CommentReplyEvent | AgentJoinedEvent | AgentLeftEvent | GenericEvent;
+export type AppEvent = AppComposingEvent | AppComposingEndEvent | AppCommentReplyEvent | AppAgentJoinedEvent | AppAgentLeftEvent | AppGenericEvent;
+interface AppComposingEvent extends ComposingEvent {
+    composing_end_event?: never;
+    comment_reply_event?: never;
+    agent_joined_event?: never;
+    agent_left_event?: never;
+    generic_event?: never;
+}
+interface AppComposingEndEvent extends ComposingEndEvent {
+    composing_event?: never;
+    comment_reply_event?: never;
+    agent_joined_event?: never;
+    agent_left_event?: never;
+    generic_event?: never;
+}
+interface AppCommentReplyEvent extends CommentReplyEvent {
+    composing_event?: never;
+    composing_end_event?: never;
+    agent_joined_event?: never;
+    agent_left_event?: never;
+    generic_event?: never;
+}
+interface AppAgentJoinedEvent extends AgentJoinedEvent {
+    composing_event?: never;
+    composing_end_event?: never;
+    comment_reply_event?: never;
+    agent_left_event?: never;
+    generic_event?: never;
+}
+interface AppAgentLeftEvent extends AgentLeftEvent {
+    composing_event?: never;
+    composing_end_event?: never;
+    comment_reply_event?: never;
+    agent_joined_event?: never;
+    generic_event?: never;
+}
+interface AppGenericEvent extends GenericEvent {
+    composing_event?: never;
+    composing_end_event?: never;
+    comment_reply_event?: never;
+    agent_joined_event?: never;
+    agent_left_event?: never;
+}
+export {};

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

@@ -2,50 +2,125 @@ import { Agent } from '../agent';
 import { LocationMessage, LocationMessageItem } from '../location-message';
 import { MediaMessage, MediaMessageItem } from '../media-message';
 import { TextMessage, TextMessageItem } from '../text-message';
-import { TemplateMessage } from '../template-message';
+import { TemplateMessageItem } from '../template-message';
+import { TemplateReference } from '../template-reference';
 import { CardMessage, CardMessageItem } from '../card-message';
-import { ChoiceMessage } from '../choice-message';
-import { CarouselMessage } from '../carousel-message';
-import { ListMessage } from '../list-message';
+import { ChoiceMessage, ChoiceMessageItem } from '../choice-message';
+import { CarouselMessage, CarouselMessageItem } from '../carousel-message';
+import { ListMessage, ListMessageItem } from '../list-message';
 import { ContactInfoMessage, ContactInfoMessageItem } from '../contact-info-message';
+import { ConversationChannel } from '../conversation-channel';
 /**
  * Message originating from an app
  */
-export type AppMessage = AppMessageCardMessage | AppMessageChoiceMessage | AppMessageLocationMessage | AppMessageCarouselMessage | AppMessageMediaMessage | AppMessageTemplateMessage | AppMessageTextMessage | AppMessageListMessage | AppMessageContactInfoMessage;
-interface AppMessageCardMessage extends AppMessageBase {
+export type AppMessage = AppCardMessage | AppChoiceMessage | AppLocationMessage | AppCarouselMessage | AppMediaMessage | AppTemplateMessage | AppTextMessage | AppListMessage | AppContactInfoMessage;
+interface AppCardMessage extends AppMessageBase {
     /** @see CardMessageItem */
-    card_message?: CardMessageItem;
+    card_message: CardMessageItem;
+    choice_message?: never;
+    location_message?: never;
+    carousel_message?: never;
+    media_message?: never;
+    template_message?: never;
+    text_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
 }
-interface AppMessageChoiceMessage extends AppMessageBase {
-    /** @see ChoiceResponseMessage */
-    choice_message?: ChoiceMessage;
+interface AppChoiceMessage extends AppMessageBase {
+    /** @see ChoiceMessageItem */
+    choice_message: ChoiceMessageItem;
+    card_message?: never;
+    location_message?: never;
+    carousel_message?: never;
+    media_message?: never;
+    template_message?: never;
+    text_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
 }
-interface AppMessageLocationMessage extends AppMessageBase {
+interface AppLocationMessage extends AppMessageBase {
     /** @see LocationMessageItem */
-    location_message?: LocationMessageItem;
+    location_message: LocationMessageItem;
+    card_message?: never;
+    choice_message?: never;
+    carousel_message?: never;
+    media_message?: never;
+    template_message?: never;
+    text_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
 }
-interface AppMessageCarouselMessage extends AppMessageBase {
-    /** @see CarouselMessage */
-    carousel_message?: CarouselMessage;
+interface AppCarouselMessage extends AppMessageBase {
+    /** @see CarouselMessageItem */
+    carousel_message: CarouselMessageItem;
+    card_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    media_message?: never;
+    template_message?: never;
+    text_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
 }
-interface AppMessageMediaMessage extends AppMessageBase {
+interface AppMediaMessage extends AppMessageBase {
     /** @see MediaMessageItem */
-    media_message?: MediaMessageItem;
+    media_message: MediaMessageItem;
+    card_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    carousel_message?: never;
+    template_message?: never;
+    text_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
 }
-interface AppMessageTemplateMessage extends AppMessageBase {
-    /** @see TemplateMessage */
-    template_message?: TemplateMessage;
+interface AppTemplateMessage extends AppMessageBase {
+    /** @see TemplateMessageItem */
+    template_message: TemplateMessageItem;
+    card_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    carousel_message?: never;
+    media_message?: never;
+    text_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
 }
-interface AppMessageTextMessage extends AppMessageBase {
+interface AppTextMessage extends AppMessageBase {
     /** @see TextMessageItem */
-    text_message?: TextMessageItem;
+    text_message: TextMessageItem;
+    card_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    carousel_message?: never;
+    media_message?: never;
+    template_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
 }
-interface AppMessageListMessage extends AppMessageBase {
-    /** @see ListMessage */
-    list_message?: ListMessage;
+interface AppListMessage extends AppMessageBase {
+    /** @see ListMessageItem */
+    list_message: ListMessageItem;
+    card_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    carousel_message?: never;
+    media_message?: never;
+    template_message?: never;
+    text_message?: never;
+    contact_info_message?: never;
 }
-interface AppMessageContactInfoMessage extends AppMessageBase {
-    contact_info_message?: ContactInfoMessageItem;
+interface AppContactInfoMessage extends AppMessageBase {
+    /** @see ContactInfoMessageItem */
+    contact_info_message: ContactInfoMessageItem;
+    card_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    carousel_message?: never;
+    media_message?: never;
+    template_message?: never;
+    text_message?: never;
+    list_message?: never;
 }
 interface AppMessageBase {
     /**
@@ -53,17 +128,110 @@ interface AppMessageBase {
      * The key in the map must point to a valid conversation channel as defined by the enum ConversationChannel.
      */
     explicit_channel_message?: {
-        [key: string]: string;
+        [key in ConversationChannel]?: string;
     };
     /**
      * The option to override the omni-channel template configuration with a channel-specific template
      * (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: string]: OmniMessageOverride;
+        [key in ChannelSpecificTemplate]?: OmniMessage;
     };
     /** Identity of a sender */
     agent?: Agent | null;
 }
-type OmniMessageOverride = CardMessage | CarouselMessage | ChoiceMessage | LocationMessage | MediaMessage | TemplateMessage | TextMessage | ListMessage | ContactInfoMessage;
+type ChannelSpecificTemplate = 'WHATSAPP' | 'KAKAOTALK' | 'WECHAT';
+export type OmniMessage = OmniCardMessage | OmniCarouselMessage | OmniChoiceMessage | OmniLocationMessage | OmniMediaMessage | OmniTemplateMessage | OmniTextMessage | OmniListMessage | OmniContactInfoMessage;
+interface OmniCardMessage extends CardMessage {
+    carousel_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    media_message?: never;
+    template_reference?: never;
+    text_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
+}
+interface OmniCarouselMessage extends CarouselMessage {
+    card_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    media_message?: never;
+    template_reference?: never;
+    text_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
+}
+interface OmniChoiceMessage extends ChoiceMessage {
+    card_message?: never;
+    carousel_message?: never;
+    location_message?: never;
+    media_message?: never;
+    template_reference?: never;
+    text_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
+}
+interface OmniLocationMessage extends LocationMessage {
+    card_message?: never;
+    carousel_message?: never;
+    choice_message?: never;
+    media_message?: never;
+    template_reference?: never;
+    text_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
+}
+interface OmniMediaMessage extends MediaMessage {
+    card_message?: never;
+    carousel_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    template_reference?: never;
+    text_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
+}
+interface OmniTemplateMessage {
+    /** @see TemplateReference */
+    template_reference: TemplateReference;
+    card_message?: never;
+    carousel_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    media_message?: never;
+    text_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
+}
+interface OmniTextMessage extends TextMessage {
+    card_message?: never;
+    carousel_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    media_message?: never;
+    template_reference?: never;
+    list_message?: never;
+    contact_info_message?: never;
+}
+interface OmniListMessage extends ListMessage {
+    card_message?: never;
+    carousel_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    media_message?: never;
+    template_reference?: never;
+    text_message?: never;
+    contact_info_message?: never;
+}
+interface OmniContactInfoMessage extends ContactInfoMessage {
+    card_message?: never;
+    carousel_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    media_message?: never;
+    template_reference?: never;
+    text_message?: never;
+    list_message?: never;
+}
 export {};

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

@@ -8,4 +8,95 @@ import { ListMessage } from '../list-message';
 import { TemplateMessage } from '../template-message';
 import { ContactInfoMessage } from '../contact-info-message';
 /** The content of the message */
-export type AppMessageMessage = CardMessage | CarouselMessage | ChoiceMessage | LocationMessage | MediaMessage | TemplateMessage | TextMessage | ListMessage | ContactInfoMessage;
+export type AppMessageMessage = AppMessageCardMessage | AppMessageCarouselMessage | AppMessageChoiceMessage | AppMessageLocationMessage | AppMessageMediaMessage | AppMessageTemplateMessage | AppMessageTextMessage | AppMessageListMessage | AppMessageContactInfoMessage;
+interface AppMessageCardMessage extends CardMessage {
+    carousel_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    media_message?: never;
+    template_message?: never;
+    text_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
+}
+interface AppMessageCarouselMessage extends CarouselMessage {
+    card_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    media_message?: never;
+    template_message?: never;
+    text_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
+}
+interface AppMessageChoiceMessage extends ChoiceMessage {
+    card_message?: never;
+    carousel_message?: never;
+    location_message?: never;
+    media_message?: never;
+    template_message?: never;
+    text_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
+}
+interface AppMessageLocationMessage extends LocationMessage {
+    card_message?: never;
+    carousel_message?: never;
+    choice_message?: never;
+    media_message?: never;
+    template_message?: never;
+    text_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
+}
+interface AppMessageMediaMessage extends MediaMessage {
+    card_message?: never;
+    carousel_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    template_message?: never;
+    text_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
+}
+interface AppMessageTemplateMessage extends TemplateMessage {
+    card_message?: never;
+    carousel_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    media_message?: never;
+    text_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
+}
+interface AppMessageTextMessage extends TextMessage {
+    card_message?: never;
+    carousel_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    media_message?: never;
+    template_message?: never;
+    list_message?: never;
+    contact_info_message?: never;
+}
+interface AppMessageListMessage extends ListMessage {
+    card_message?: never;
+    carousel_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    media_message?: never;
+    template_message?: never;
+    text_message?: never;
+    contact_info_message?: never;
+}
+interface AppMessageContactInfoMessage extends ContactInfoMessage {
+    card_message?: never;
+    carousel_message?: never;
+    choice_message?: never;
+    location_message?: never;
+    media_message?: never;
+    template_message?: never;
+    text_message?: never;
+    list_message?: never;
+}
+export {};

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

@@ -12,17 +12,29 @@ export interface ChoiceBase {
 }
 export interface CallMessageChoice extends ChoiceBase {
     /** @see CallMessage */
-    call_message?: CallMessage;
+    call_message: CallMessage;
+    location_message?: never;
+    text_message?: never;
+    url_message?: never;
 }
 export interface LocationMessageChoice extends ChoiceBase {
-    /** @see LocationMessage */
-    location_message?: LocationMessageItem;
+    /** @see LocationMessageItem */
+    location_message: LocationMessageItem;
+    call_message?: never;
+    text_message?: never;
+    url_message?: never;
 }
 export interface TextMessageChoice extends ChoiceBase {
     /** @see TextMessageItem */
-    text_message?: TextMessageItem;
+    text_message: TextMessageItem;
+    call_message?: never;
+    location_message?: never;
+    url_message?: never;
 }
 export interface UrlMessageChoice extends ChoiceBase {
     /** @see UrlMessage */
-    url_message?: UrlMessage;
+    url_message: UrlMessage;
+    call_message?: never;
+    location_message?: never;
+    text_message?: never;
 }

package/dist/models/v1/comment-reply-event/comment-reply-event.d.ts

@@ -1,6 +1,6 @@
 export interface CommentReplyEvent {
     /** @see CommentReplyEvent */
-    comment_reply_event?: CommentReplyEventItem;
+    comment_reply_event: CommentReplyEventItem;
 }
 export interface CommentReplyEventItem {
     /** The text of the comment reply. */

package/dist/models/v1/composing-end-event/composing-end-event.d.ts

@@ -1,4 +1,4 @@
 export interface ComposingEndEvent {
     /** An empty object. Represents a typing end indicator. */
-    composing_end_event?: Record<string, never>;
+    composing_end_event: Record<string, never>;
 }

package/dist/models/v1/composing-event/composing-event.d.ts

@@ -1,4 +1,4 @@
 export interface ComposingEvent {
     /** An empty object. Represents a typing indicator. */
-    composing_event?: Record<string, never>;
+    composing_event: Record<string, never>;
 }

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

@@ -4,4 +4,35 @@ import { CommentEvent } from '../comment-event';
 import { GenericEvent } from '../generic-event';
 import { ConversationDeletedEvent } from '../conversation-deleted-event';
 /** Message originating from a contact */
-export type ContactEvent = ComposingEvent | ComposingEndEvent | ConversationDeletedEvent | CommentEvent | GenericEvent;
+export type ContactEvent = ContactComposingEvent | ContactComposingEndEvent | ContactConversationDeletedEvent | ContactCommentEvent | ContactGenericEvent;
+interface ContactComposingEvent extends ComposingEvent {
+    composing_end_event?: never;
+    conversation_deleted_event?: never;
+    comment_event?: never;
+    generic_event?: never;
+}
+interface ContactComposingEndEvent extends ComposingEndEvent {
+    composing_event?: never;
+    conversation_deleted_event?: never;
+    comment_event?: never;
+    generic_event?: never;
+}
+interface ContactConversationDeletedEvent extends ConversationDeletedEvent {
+    composing_event?: never;
+    composing_end_event?: never;
+    comment_event?: never;
+    generic_event?: never;
+}
+interface ContactCommentEvent extends CommentEvent {
+    composing_event?: never;
+    composing_end_event?: never;
+    conversation_deleted_event?: never;
+    generic_event?: never;
+}
+interface ContactGenericEvent extends GenericEvent {
+    composing_event?: never;
+    composing_end_event?: never;
+    conversation_deleted_event?: never;
+    comment_event?: never;
+}
+export {};

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

@@ -1,4 +1,5 @@
 export interface ContactId {
     /** The ID of the contact. */
-    contact_id?: string;
+    contact_id: string;
+    identified_by?: never;
 }

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

@@ -2,7 +2,7 @@
  * Message containing contact information.
  */
 export interface ContactInfoMessage {
-    /** @see ContactInfoMessageContactInfoMessage */
+    /** @see ContactInfoMessageItem */
     contact_info_message?: ContactInfoMessageItem;
 }
 export interface ContactInfoMessageItem {