@wildix/xbees-connect 1.3.17-alpha.1 → 1.3.17-alpha.2

package/README.md

@@ -518,10 +518,10 @@ client.setChatToOpen('chat_id');
 
 #### `getChannelsByEmailOrPhone(payload: IPayloadGetChannelsByEmailOrPhone): Promise<ResponseMessage>`
 
-Asks x-bees to look up chat channels for an email address or phone number. The integration sends `ClientEventType.GET_CHANNELS_BY_EMAIL_OR_PHONE` (`xBeesGetChannelsByEmailOrPhone`) with payload `{ id, type }`, where `type` is `'email'` or `'phone'`. Resolves with a `ResponseMessage` whose payload contains the matching channels returned by x-bees.
+Asks x-bees to look up chat channels for an email address or phone number. The integration sends `ClientEventType.GET_CHANNELS_BY_EMAIL_OR_PHONE` (`xBeesGetChannelsByEmailOrPhone`) with payload `{ value, type }`, where `type` is `'email'` or `'phone'`. Resolves with a `ResponseMessage` whose payload contains the matching channels returned by x-bees.
 
 ```ts
-const { payload } = await client.getChannelsByEmailOrPhone({ id: 'user@example.com', type: 'email' });
+const { payload } = await client.getChannelsByEmailOrPhone({ value: 'user@example.com', type: 'email' });
 ```
 
 ---

package/dist-cjs/src/Client.js

@@ -547,6 +547,12 @@ class Client {
         });
     }
     getChannelsByEmailOrPhone(payload) {
+        if (!payload?.value?.trim()) {
+            return Promise.reject(new Error('`value` is required'));
+        }
+        if (payload.type !== 'email' && payload.type !== 'phone') {
+            return Promise.reject(new Error('`type` must be "email" or "phone"'));
+        }
         return this.sendAsync({
             type: enums_1.ClientEventType.GET_CHANNELS_BY_EMAIL_OR_PHONE,
             payload,

package/dist-es/src/Client.js

@@ -541,6 +541,12 @@ export class Client {
         });
     }
     getChannelsByEmailOrPhone(payload) {
+        if (!payload?.value?.trim()) {
+            return Promise.reject(new Error('`value` is required'));
+        }
+        if (payload.type !== 'email' && payload.type !== 'phone') {
+            return Promise.reject(new Error('`type` must be "email" or "phone"'));
+        }
         return this.sendAsync({
             type: ClientEventType.GET_CHANNELS_BY_EMAIL_OR_PHONE,
             payload,

package/dist-types/types/Client.d.ts

@@ -236,7 +236,7 @@ export interface ConnectClient {
     setChatToOpen: (chatId: string) => void;
     /**
      * Asks x-bees to look up chat channels for an email address or phone number.
-     * @param payload - Contact identifier: `id` (email or phone value) and `type` (`'email'` or `'phone'`).
+     * @param payload - Contact identifier: `value` (email or phone value) and `type` (`'email'` or `'phone'`).
      */
     getChannelsByEmailOrPhone: (payload: IPayloadGetChannelsByEmailOrPhone) => Promise<ResponseMessage>;
     /**

package/dist-types/types/Payload.d.ts

@@ -101,7 +101,7 @@ export interface IPayloadSetChatToOpen {
     chatId: string;
 }
 export interface IPayloadGetChannelsByEmailOrPhone {
-    id: string;
+    value: string;
     type: 'email' | 'phone';
 }
 export interface IPayloadContactWeightUpdate {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wildix/xbees-connect",
-  "version": "1.3.17-alpha.1",
+  "version": "1.3.17-alpha.2",
   "description": "This library provides easy communication between x-bees and integrated web applications",
   "author": "dimitri.chernykh <dimitri.chernykh@wildix.com>",
   "homepage": "",