DEVEXP-321: Add sub methods for messages and events (#35)

sinch · Mar 22, 2024 · c77ac00 · c77ac00
1 parent 1c465f4
commit c77ac00
Show file tree

Hide file tree

Showing 58 changed files with 2,526 additions and 490 deletions.
diff --git a/examples/simple-examples/README.md b/examples/simple-examples/README.md
diff --git a/examples/simple-examples/package.json b/examples/simple-examples/package.json
@@ -21,6 +21,15 @@
     "conversation:contact:getChannelProfile": "ts-node src/conversation/contact/getChannelProfile.ts",
     "conversation:contact:delete": "ts-node src/conversation/contact/delete.ts",
     "conversation:messages:send": "ts-node src/conversation/messages/send.ts",
+    "conversation:messages:sendCardMessage": "ts-node src/conversation/messages/sendCardMessage.ts",
+    "conversation:messages:sendCarouselMessage": "ts-node src/conversation/messages/sendCarouselMessage.ts",
+    "conversation:messages:sendChoiceMessage": "ts-node src/conversation/messages/sendChoiceMessage.ts",
+    "conversation:messages:sendContactInfoMessage": "ts-node src/conversation/messages/sendContactInfoMessage.ts",
+    "conversation:messages:sendListMessage": "ts-node src/conversation/messages/sendListMessage.ts",
+    "conversation:messages:sendLocationMessage": "ts-node src/conversation/messages/sendLocationMessage.ts",
+    "conversation:messages:sendMediaMessage": "ts-node src/conversation/messages/sendMediaMessage.ts",
+    "conversation:messages:sendTemplateMessage": "ts-node src/conversation/messages/sendTemplateMessage.ts",
+    "conversation:messages:sendTextMessage": "ts-node src/conversation/messages/sendTextMessage.ts",
     "conversation:messages:get": "ts-node src/conversation/messages/get.ts",
     "conversation:messages:list": "ts-node src/conversation/messages/list.ts",
     "conversation:messages:update": "ts-node src/conversation/messages/update.ts",
@@ -35,6 +44,12 @@
     "conversation:conversation:stop": "ts-node src/conversation/conversation/stop.ts",
     "conversation:conversation:delete": "ts-node src/conversation/conversation/delete.ts",
     "conversation:events:send": "ts-node src/conversation/events/send.ts",
+    "conversation:events:sendComposingEvent": "ts-node src/conversation/events/sendComposingEvent.ts",
+    "conversation:events:sendComposingEndEvent": "ts-node src/conversation/events/sendComposingEndEvent.ts",
+    "conversation:events:sendCommentReplyEvent": "ts-node src/conversation/events/sendCommentReplyEvent.ts",
+    "conversation:events:sendAgentJoinedEvent": "ts-node src/conversation/events/sendAgentJoinedEvent.ts",
+    "conversation:events:sendAgentLeftEvent": "ts-node src/conversation/events/sendAgentLeftEvent.ts",
+    "conversation:events:sendGenericEvent": "ts-node src/conversation/events/sendGenericEvent.ts",
     "conversation:events:get": "ts-node src/conversation/events/get.ts",
     "conversation:events:list": "ts-node src/conversation/events/list.ts",
     "conversation:events:delete": "ts-node src/conversation/events/delete.ts",

diff --git a/examples/simple-examples/src/conversation/capability/lookup.ts b/examples/simple-examples/src/conversation/capability/lookup.ts
@@ -1,4 +1,4 @@
-import { LookupCapabilityRequestData } from '@sinch/sdk-core';
+import { ContactId, LookupCapabilityRequestData } from '@sinch/sdk-core';
 import { getAppIdFromConfig, getContactIdFromConfig, initClient, printFullResponse } from '../../config';
 
 (async () => {
@@ -9,7 +9,7 @@ import { getAppIdFromConfig, getContactIdFromConfig, initClient, printFullRespon
   const appId = getAppIdFromConfig();
   const contactId = getContactIdFromConfig();
 
-  const requestData: LookupCapabilityRequestData = {
+  const requestData: LookupCapabilityRequestData<ContactId> = {
     lookupCapabilityRequestBody: {
       app_id: appId,
       recipient: {

diff --git a/examples/simple-examples/src/conversation/contact/getChannelProfile.ts b/examples/simple-examples/src/conversation/contact/getChannelProfile.ts
@@ -1,4 +1,4 @@
-import { GetChannelProfileRequestData } from '@sinch/sdk-core';
+import { GetChannelProfileRequestData, IdentifiedBy } from '@sinch/sdk-core';
 import {
   getAppIdFromConfig,
   getMessengerUserIdFromConfig,
@@ -14,7 +14,7 @@ import {
   const appId = getAppIdFromConfig();
   const messengerUserId = getMessengerUserIdFromConfig();
 
-  const requestData: GetChannelProfileRequestData = {
+  const requestData: GetChannelProfileRequestData<IdentifiedBy> = {
     getChannelProfileRequestBody: {
       app_id: appId,
       channel: 'MESSENGER',

diff --git a/examples/simple-examples/src/conversation/events/send.ts b/examples/simple-examples/src/conversation/events/send.ts
@@ -1,4 +1,4 @@
-import { SendEventRequestData } from '@sinch/sdk-core';
+import { ContactId, SendEventRequestData } from '@sinch/sdk-core';
 import { getAppIdFromConfig, getContactIdFromConfig, initClient, printFullResponse } from '../../config';
 
 (async () => {
@@ -9,7 +9,7 @@ import { getAppIdFromConfig, getContactIdFromConfig, initClient, printFullRespon
   const appId = getAppIdFromConfig();
   const contactId = getContactIdFromConfig();
 
-  const requestData: SendEventRequestData = {
+  const requestData: SendEventRequestData<ContactId> = {
     sendEventRequestBody: {
       app_id: appId,
       recipient: {

diff --git a/examples/simple-examples/src/conversation/events/sendAgentJoinedEvent.ts b/examples/simple-examples/src/conversation/events/sendAgentJoinedEvent.ts
@@ -0,0 +1,34 @@
+import { ContactId, SendAgentJoinedEventRequestData } from '@sinch/sdk-core';
+import { getAppIdFromConfig, getContactIdFromConfig, initClient, printFullResponse } from '../../config';
+
+(async () => {
+  console.log('********************');
+  console.log('* Events_SendEvent *');
+  console.log('********************');
+
+  const appId = getAppIdFromConfig();
+  const contactId = getContactIdFromConfig();
+
+  const requestData: SendAgentJoinedEventRequestData<ContactId> = {
+    sendEventRequestBody: {
+      app_id: appId,
+      recipient: {
+        contact_id: contactId,
+      },
+      event: {
+        agent_joined_event: {
+          agent: {
+            display_name: 'Agent bot name',
+            type: 'BOT',
+          },
+        },
+      },
+    },
+  };
+
+  const sinchClient = initClient();
+  const response = await sinchClient.conversation.events.sendAgentJoinedEvent(requestData);
+
+  printFullResponse(response);
+
+})();
diff --git a/examples/simple-examples/src/conversation/events/sendAgentLeftEvent.ts b/examples/simple-examples/src/conversation/events/sendAgentLeftEvent.ts
@@ -0,0 +1,34 @@
+import { ContactId, SendAgentLeftEventRequestData } from '@sinch/sdk-core';
+import { getAppIdFromConfig, getContactIdFromConfig, initClient, printFullResponse } from '../../config';
+
+(async () => {
+  console.log('********************');
+  console.log('* Events_SendEvent *');
+  console.log('********************');
+
+  const appId = getAppIdFromConfig();
+  const contactId = getContactIdFromConfig();
+
+  const requestData: SendAgentLeftEventRequestData<ContactId> = {
+    sendEventRequestBody: {
+      app_id: appId,
+      recipient: {
+        contact_id: contactId,
+      },
+      event: {
+        agent_left_event: {
+          agent: {
+            display_name: 'Agent bot name',
+            type: 'BOT',
+          },
+        },
+      },
+    },
+  };
+
+  const sinchClient = initClient();
+  const response = await sinchClient.conversation.events.sendAgentLeftEvent(requestData);
+
+  printFullResponse(response);
+
+})();
diff --git a/examples/simple-examples/src/conversation/events/sendCommentReplyEvent.ts b/examples/simple-examples/src/conversation/events/sendCommentReplyEvent.ts
@@ -0,0 +1,31 @@
+import { ContactId, SendCommentReplyEventRequestData } from '@sinch/sdk-core';
+import { getAppIdFromConfig, getContactIdFromConfig, initClient, printFullResponse } from '../../config';
+
+(async () => {
+  console.log('********************');
+  console.log('* Events_SendEvent *');
+  console.log('********************');
+
+  const appId = getAppIdFromConfig();
+  const contactId = getContactIdFromConfig();
+
+  const requestData: SendCommentReplyEventRequestData<ContactId> = {
+    sendEventRequestBody: {
+      app_id: appId,
+      recipient: {
+        contact_id: contactId,
+      },
+      event: {
+        comment_reply_event: {
+          text: 'Comment data',
+        },
+      },
+    },
+  };
+
+  const sinchClient = initClient();
+  const response = await sinchClient.conversation.events.sendCommentReplyEvent(requestData);
+
+  printFullResponse(response);
+
+})();
diff --git a/examples/simple-examples/src/conversation/events/sendComposingEndEvent.ts b/examples/simple-examples/src/conversation/events/sendComposingEndEvent.ts
@@ -0,0 +1,29 @@
+import { ContactId, SendComposingEndEventRequestData } from '@sinch/sdk-core';
+import { getAppIdFromConfig, getContactIdFromConfig, initClient, printFullResponse } from '../../config';
+
+(async () => {
+  console.log('********************');
+  console.log('* Events_SendEvent *');
+  console.log('********************');
+
+  const appId = getAppIdFromConfig();
+  const contactId = getContactIdFromConfig();
+
+  const requestData: SendComposingEndEventRequestData<ContactId> = {
+    sendEventRequestBody: {
+      app_id: appId,
+      recipient: {
+        contact_id: contactId,
+      },
+      event: {
+        composing_end_event: {},
+      },
+    },
+  };
+
+  const sinchClient = initClient();
+  const response = await sinchClient.conversation.events.sendComposingEndEvent(requestData);
+
+  printFullResponse(response);
+
+})();
diff --git a/examples/simple-examples/src/conversation/events/sendComposingEvent.ts b/examples/simple-examples/src/conversation/events/sendComposingEvent.ts
@@ -0,0 +1,29 @@
+import { ContactId, SendComposingEventRequestData } from '@sinch/sdk-core';
+import { getAppIdFromConfig, getContactIdFromConfig, initClient, printFullResponse } from '../../config';
+
+(async () => {
+  console.log('********************');
+  console.log('* Events_SendEvent *');
+  console.log('********************');
+
+  const appId = getAppIdFromConfig();
+  const contactId = getContactIdFromConfig();
+
+  const requestData: SendComposingEventRequestData<ContactId> = {
+    sendEventRequestBody: {
+      app_id: appId,
+      recipient: {
+        contact_id: contactId,
+      },
+      event: {
+        composing_event: {},
+      },
+    },
+  };
+
+  const sinchClient = initClient();
+  const response = await sinchClient.conversation.events.sendComposingEvent(requestData);
+
+  printFullResponse(response);
+
+})();
diff --git a/examples/simple-examples/src/conversation/events/sendGenericEvent.ts b/examples/simple-examples/src/conversation/events/sendGenericEvent.ts
@@ -0,0 +1,33 @@
+import { ContactId, SendGenericEventRequestData } from '@sinch/sdk-core';
+import { getAppIdFromConfig, getContactIdFromConfig, initClient, printFullResponse } from '../../config';
+
+(async () => {
+  console.log('********************');
+  console.log('* Events_SendEvent *');
+  console.log('********************');
+
+  const appId = getAppIdFromConfig();
+  const contactId = getContactIdFromConfig();
+
+  const requestData: SendGenericEventRequestData<ContactId> = {
+    sendEventRequestBody: {
+      app_id: appId,
+      recipient: {
+        contact_id: contactId,
+      },
+      event: {
+        generic_event: {
+          payload: {
+            key: 'value for the generic event',
+          },
+        },
+      },
+    },
+  };
+
+  const sinchClient = initClient();
+  const response = await sinchClient.conversation.events.sendGenericEvent(requestData);
+
+  printFullResponse(response);
+
+})();
diff --git a/examples/simple-examples/src/conversation/messages/send.ts b/examples/simple-examples/src/conversation/messages/send.ts
@@ -1,4 +1,4 @@
-import { SendMessageRequestData } from '@sinch/sdk-core';
+import { ContactId, SendMessageRequestData } from '@sinch/sdk-core';
 import { getAppIdFromConfig, getContactIdFromConfig, initClient, printFullResponse } from '../../config';
 
 (async () => {
@@ -9,7 +9,7 @@ import { getAppIdFromConfig, getContactIdFromConfig, initClient, printFullRespon
   const appId = getAppIdFromConfig();
   const contactId = getContactIdFromConfig();
 
-  const requestData: SendMessageRequestData = {
+  const requestData: SendMessageRequestData<ContactId> = {
     sendMessageRequestBody: {
       app_id: appId,
       message: {
@@ -20,7 +20,7 @@ import { getAppIdFromConfig, getContactIdFromConfig, initClient, printFullRespon
       recipient: {
         contact_id: contactId,
       },
-      correlation_id: 'correlator',
+      correlation_id: 'correlatorId',
       queue: 'HIGH_PRIORITY',
       processing_strategy: 'DEFAULT',
       channel_priority_order: ['MESSENGER'],

diff --git a/examples/simple-examples/src/conversation/messages/sendCardMessage.ts b/examples/simple-examples/src/conversation/messages/sendCardMessage.ts
@@ -0,0 +1,37 @@
+import { ContactId, SendCardMessageRequestData } from '@sinch/sdk-core';
+import { getAppIdFromConfig, getContactIdFromConfig, initClient, printFullResponse } from '../../config';
+
+(async () => {
+  console.log('****************************');
+  console.log('* Messages_SendCardMessage *');
+  console.log('****************************');
+
+  const appId = getAppIdFromConfig();
+  const contactId = getContactIdFromConfig();
+
+  const requestData: SendCardMessageRequestData<ContactId> = {
+    sendMessageRequestBody: {
+      app_id: appId,
+      message: {
+        card_message: {
+          title: 'Card message title',
+          description: 'Card message description',
+          height: 'MEDIUM',
+        },
+      },
+      recipient: {
+        contact_id: contactId,
+      },
+      correlation_id: 'correlatorId',
+      queue: 'HIGH_PRIORITY',
+      processing_strategy: 'DEFAULT',
+      channel_priority_order: ['MESSENGER'],
+    },
+  };
+
+  const sinchClient = initClient();
+  const response = await sinchClient.conversation.messages.sendCardMessage(requestData);
+
+  printFullResponse(response);
+
+})();
diff --git a/examples/simple-examples/src/conversation/messages/sendCarouselMessage.ts b/examples/simple-examples/src/conversation/messages/sendCarouselMessage.ts
@@ -0,0 +1,46 @@
+import { ContactId, SendCarouselMessageRequestData } from '@sinch/sdk-core';
+import { getAppIdFromConfig, getContactIdFromConfig, initClient, printFullResponse } from '../../config';
+
+(async () => {
+  console.log('********************************');
+  console.log('* Messages_SendCarouselMessage *');
+  console.log('********************************');
+
+  const appId = getAppIdFromConfig();
+  const contactId = getContactIdFromConfig();
+
+  const requestData: SendCarouselMessageRequestData<ContactId> = {
+    sendMessageRequestBody: {
+      app_id: appId,
+      message: {
+        carousel_message: {
+          cards: [
+            {
+              title: 'Card #1 title',
+              description: 'Card #1 description',
+              height: 'TALL',
+            },
+            {
+              title: 'Card #2 title',
+              description: 'Card #2 description',
+              height: 'TALL',
+            },
+          ],
+        },
+      },
+      recipient: {
+        contact_id: contactId,
+      },
+      correlation_id: 'correlatorId',
+      queue: 'HIGH_PRIORITY',
+      processing_strategy: 'DEFAULT',
+      channel_priority_order: ['MESSENGER'],
+    },
+  };
+
+  const sinchClient = initClient();
+  const response = await sinchClient.conversation.messages.sendCarouselMessage(requestData);
+
+  printFullResponse(response);
+
+})();