feat: added RCS channel and changes to other channels (#941)

Co-authored-by: Karl Lingiah <karl@superchilled.co.uk>
Vonage · Jul 1, 2024 · 4342a92 · 4342a92
1 parent 2ffee8e
commit 4342a92
Show file tree

Hide file tree

Showing 33 changed files with 1,058 additions and 234 deletions.
diff --git a/packages/messages/README.md b/packages/messages/README.md
@@ -13,6 +13,7 @@ If you are updating from V2 to V3, please check the migration guide found [here]
 * [Installation](#installation)
 * [Usage](#usage)
 * [Promises](#promises)
+* [Channels](#channels)
 
 ## Installation
 
@@ -109,6 +110,25 @@ Run:
 npm run test
 ```
 
+## Channels
+
+The Vonage Messages API supports several different communication channels, and
+from time to time will add new channels. Each channel follows our normal product
+development cycle and therefore different channels within the overall API may
+have different release statuses at a certain point in time. Channels available
+for general use will be listed as having 'General Availability'. Channels which
+are currently part of a Beta program will be listed as 'Beta'. This table
+details the current release status of each channel implemented in this SDK:
+
+| Channel            |  API Release Status  |
+|--------------------|:--------------------:|
+| SMS                | General Availability |
+| MMS                | General Availability |
+| RCS                | Beta                 |
+| Facebook Messenger | General Availability |
+| WhatsApp           | General Availability |
+| Viber              | General Availability |
+
 [signup]: https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=node-server-sdk
 
 [license]: ../../LICENSE.txt
diff --git a/packages/messages/__tests__/__dataSets__/index.ts b/packages/messages/__tests__/__dataSets__/index.ts
@@ -3,26 +3,31 @@ import mmsTests from './mms';
 import messengerTests from './messenger';
 import viberTests from './viber';
 import whatsAppTests from './whatsApp';
+import RCSTests from './rcs';
 
 export default [
   {
-    label: 'SMS Messages',
+    label: 'SMS',
     tests: smsTests,
   },
   {
-    label: 'MMS Messages',
+    label: 'MMS',
     tests: mmsTests,
   },
   {
-    label: 'Messenger Messages',
+    label: 'Messenger',
     tests: messengerTests,
   },
   {
-    label: 'Viber Messages',
+    label: 'Viber',
     tests: viberTests,
   },
   {
-    label: 'WhatsApp Messages',
+    label: 'WhatsApp',
     tests: whatsAppTests,
   },
+  {
+    label: 'RCS',
+    tests: RCSTests,
+  },
 ];
diff --git a/packages/messages/__tests__/__dataSets__/messenger.ts b/packages/messages/__tests__/__dataSets__/messenger.ts
@@ -29,7 +29,7 @@ import { MessageCategory } from '../../lib/enums/Messenger/MessageCategory';
 
 export default [
   {
-    label: 'send Messenger text',
+    label: 'send text',
     request: [
       '/v1/messages',
       'POST',
@@ -61,7 +61,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send Messenger text with ref and messenger properties',
+    label: 'send text with ref and messenger properties',
     request: [
       '/v1/messages',
       'POST',
@@ -107,7 +107,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send Messenger text with old class',
+    label: 'send text with old class',
     request: [
       '/v1/messages',
       'POST',
@@ -149,7 +149,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send Messenger image',
+    label: 'send image',
     request: [
       '/v1/messages',
       'POST',
@@ -185,7 +185,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send Messenger image with messenger properties and ref',
+    label: 'send image with messenger properties and ref',
     request: [
       '/v1/messages',
       'POST',
@@ -231,7 +231,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send Messenger image with old class',
+    label: 'send image with old class',
     request: [
       '/v1/messages',
       'POST',
@@ -277,7 +277,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send Messenger audio',
+    label: 'send audio',
     request: [
       '/v1/messages',
       'POST',
@@ -313,7 +313,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send Messenger audio with caption and ref',
+    label: 'send audio with caption and ref',
     request: [
       '/v1/messages',
       'POST',
@@ -359,7 +359,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send Messenger audio with old class',
+    label: 'send audio with old class',
     request: [
       '/v1/messages',
       'POST',
@@ -405,7 +405,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send Messenger video',
+    label: 'send video',
     request: [
       '/v1/messages',
       'POST',
@@ -441,7 +441,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send Messenger video with messenger and ref',
+    label: 'send video with messenger and ref',
     request: [
       '/v1/messages',
       'POST',
@@ -487,7 +487,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send Messenger video with old class',
+    label: 'send video with old class',
     request: [
       '/v1/messages',
       'POST',
@@ -533,7 +533,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send Messenger file',
+    label: 'send file',
     request: [
       '/v1/messages',
       'POST',
@@ -569,7 +569,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send Messenger file with messenger and ref',
+    label: 'send file with messenger and ref',
     request: [
       '/v1/messages',
       'POST',
@@ -615,7 +615,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send Messenger file with old class',
+    label: 'send file with old class',
     request: [
       '/v1/messages',
       'POST',

diff --git a/packages/messages/__tests__/__dataSets__/mms.ts b/packages/messages/__tests__/__dataSets__/mms.ts
@@ -22,7 +22,7 @@ import { Vcard } from '../../lib/classes/MMS/Vcard';
 
 export default [
   {
-    label: 'send MMS image',
+    label: 'send image',
     request: [
       '/v1/messages',
       'POST',
@@ -58,7 +58,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send MMS image with caption and ref',
+    label: 'send image with caption and ref',
     request: [
       '/v1/messages',
       'POST',
@@ -102,7 +102,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send MMS image with old class ',
+    label: 'send image with old class ',
     request: [
       '/v1/messages',
       'POST',
@@ -142,7 +142,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send MMS audio',
+    label: 'send audio',
     request: [
       '/v1/messages',
       'POST',
@@ -178,7 +178,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send MMS audio with caption and ref',
+    label: 'send audio with caption and ref',
     request: [
       '/v1/messages',
       'POST',
@@ -218,7 +218,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send MMS audio using old class ',
+    label: 'send audio using old class ',
     request: [
       '/v1/messages',
       'POST',
@@ -258,7 +258,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send MMS video',
+    label: 'send video',
     request: [
       '/v1/messages',
       'POST',
@@ -294,7 +294,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send MMS video with caption and ref',
+    label: 'send video with caption and ref',
     request: [
       '/v1/messages',
       'POST',
@@ -334,7 +334,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send MMS video with old class ',
+    label: 'send video with old class ',
     request: [
       '/v1/messages',
       'POST',
@@ -374,7 +374,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send MMS vcard',
+    label: 'send vcard',
     request: [
       '/v1/messages',
       'POST',
@@ -410,7 +410,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send MMS vcard with client ref',
+    label: 'send vcard with client ref',
     request: [
       '/v1/messages',
       'POST',
@@ -450,7 +450,7 @@ export default [
     } as MessageSuccess,
   },
   {
-    label: 'send MMS vcard with old class',
+    label: 'send vcard with old class',
     request: [
       '/v1/messages',
       'POST',