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

package/README.md

@@ -516,6 +516,14 @@ Tells x-bees which chat or conversation should be opened (brought into focus). T
 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.
+
+```ts
+const { payload } = await client.getChannelsByEmailOrPhone({ id: 'user@example.com', type: 'email' });
+```
+
 ---
 
 ### Technical support

package/dist-cjs/package.json

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

package/dist-cjs/src/Client.js

@@ -546,6 +546,12 @@ class Client {
             payload: { chatId },
         });
     }
+    getChannelsByEmailOrPhone(payload) {
+        return this.sendAsync({
+            type: enums_1.ClientEventType.GET_CHANNELS_BY_EMAIL_OR_PHONE,
+            payload,
+        });
+    }
     onContactWeightUpdate(callback) {
         return this.addEventListener(enums_1.EventType.CONTACT_WEIGHT_UPDATE, callback);
     }

package/dist-cjs/src/enums/index.js

@@ -58,6 +58,7 @@ var ClientEventType;
     ClientEventType["DROPDOWN_VISIBILITY"] = "xBeesDropdownVisibility";
     ClientEventType["CUSTOM_EVENT"] = "xBeesCustomEvent";
     ClientEventType["SET_CHAT_TO_OPEN"] = "xBeesSetChatToOpen";
+    ClientEventType["GET_CHANNELS_BY_EMAIL_OR_PHONE"] = "xBeesGetChannelsByEmailOrPhone";
     ClientEventType["CREATE_CONTACT_IS_SUPPORTED"] = "xBeesCreateContactIsSupported";
     ClientEventType["CREATE_CONTACT_HAS_NO_PERMISSION"] = "xBeesCreateContactHasNoPermission";
     ClientEventType["INTEGRATION_PROXY_RESPONSE"] = "xBeesIntegrationProxyResponse";

package/dist-es/package.json

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

package/dist-es/src/Client.js

@@ -540,6 +540,12 @@ export class Client {
             payload: { chatId },
         });
     }
+    getChannelsByEmailOrPhone(payload) {
+        return this.sendAsync({
+            type: ClientEventType.GET_CHANNELS_BY_EMAIL_OR_PHONE,
+            payload,
+        });
+    }
     onContactWeightUpdate(callback) {
         return this.addEventListener(EventType.CONTACT_WEIGHT_UPDATE, callback);
     }

package/dist-es/src/enums/index.js

@@ -55,6 +55,7 @@ export var ClientEventType;
     ClientEventType["DROPDOWN_VISIBILITY"] = "xBeesDropdownVisibility";
     ClientEventType["CUSTOM_EVENT"] = "xBeesCustomEvent";
     ClientEventType["SET_CHAT_TO_OPEN"] = "xBeesSetChatToOpen";
+    ClientEventType["GET_CHANNELS_BY_EMAIL_OR_PHONE"] = "xBeesGetChannelsByEmailOrPhone";
     ClientEventType["CREATE_CONTACT_IS_SUPPORTED"] = "xBeesCreateContactIsSupported";
     ClientEventType["CREATE_CONTACT_HAS_NO_PERMISSION"] = "xBeesCreateContactHasNoPermission";
     ClientEventType["INTEGRATION_PROXY_RESPONSE"] = "xBeesIntegrationProxyResponse";

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

@@ -1,4 +1,4 @@
-import { Callback, ConnectClient, Contact, ContactQuery, IntegrationProxyRequest, IPayloadViewPort, LookupAndMatchContactsResolver, Message, Reject, RemoveEventListener, ResponseMessage, StorageEventCallback, SuggestContactsResolver, SupportedPlatformVariant, ToastSeverity, XBeesUser } from '../types';
+import { Callback, ConnectClient, Contact, ContactQuery, IntegrationProxyRequest, IPayloadGetChannelsByEmailOrPhone, IPayloadViewPort, LookupAndMatchContactsResolver, Message, Reject, RemoveEventListener, ResponseMessage, StorageEventCallback, SuggestContactsResolver, SupportedPlatformVariant, ToastSeverity, XBeesUser } from '../types';
 import { ReadyExtendedProps } from '../types/Event';
 import { JSONValue } from '../types/Json';
 import { IntegrationProxyRequestResolver, LookupAndMatchBatchContactsResolver } from '../types/Resolver';
@@ -120,6 +120,7 @@ export declare class Client implements ConnectClient {
      * @param chatId - Conversation or chat identifier in x-bees.
      */
     setChatToOpen(chatId: string): void;
+    getChannelsByEmailOrPhone(payload: IPayloadGetChannelsByEmailOrPhone): Promise<ResponseMessage>;
     onContactWeightUpdate(callback: Callback<EventType.CONTACT_WEIGHT_UPDATE>): RemoveEventListener;
     onContactRefresh(callback: Callback<EventType.CONTACT_REFRESH>): RemoveEventListener;
     /**

package/dist-types/src/enums/index.d.ts

@@ -53,6 +53,7 @@ export declare enum ClientEventType {
     DROPDOWN_VISIBILITY = "xBeesDropdownVisibility",
     CUSTOM_EVENT = "xBeesCustomEvent",
     SET_CHAT_TO_OPEN = "xBeesSetChatToOpen",
+    GET_CHANNELS_BY_EMAIL_OR_PHONE = "xBeesGetChannelsByEmailOrPhone",
     CREATE_CONTACT_IS_SUPPORTED = "xBeesCreateContactIsSupported",
     CREATE_CONTACT_HAS_NO_PERMISSION = "xBeesCreateContactHasNoPermission",
     INTEGRATION_PROXY_RESPONSE = "xBeesIntegrationProxyResponse",

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

@@ -6,7 +6,7 @@ import { ReadyExtendedProps } from './Event';
 import { JSONValue } from './Json';
 import { RemoveEventListener } from './Listener';
 import { ResponseMessage } from './Message';
-import { IntegrationProxyRequest, IPayloadViewPort } from './Payload';
+import { IntegrationProxyRequest, IPayloadGetChannelsByEmailOrPhone, IPayloadViewPort } from './Payload';
 import { SupportedPlatformVariant } from './Platform';
 import { IntegrationProxyRequestResolver, LookupAndMatchBatchContactsResolver, LookupAndMatchContactsResolver, Reject, SuggestContactsResolver } from './Resolver';
 import { StorageEventCallback } from './Storage';
@@ -234,6 +234,11 @@ export interface ConnectClient {
      * @param chatId - Conversation or chat identifier in x-bees.
      */
     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'`).
+     */
+    getChannelsByEmailOrPhone: (payload: IPayloadGetChannelsByEmailOrPhone) => Promise<ResponseMessage>;
     /**
      * Starts listen for the events of contact weight update and handle with the provided callback
      */

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

@@ -2,10 +2,10 @@ import { ClientEventType, EventType } from '../src/enums';
 import { AvailableContactData } from './AvailableContactData';
 import { ContactQuery } from './Contact';
 import { Message, MessageType } from './Message';
-import { IntegrationProxyRequest, IntegrationProxyResponse, IPayloadAutoSuggestResult, IPayloadBatchContactsMatchResult, IPayloadBatchContactsMatchResultError, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadCancelRedirectToEntityPage, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContactWeightUpdate, IPayloadContextResult, IPayloadConversationResult, IPayloadCustomEvent, IPayloadSetChatToOpen, IPayloadDaemonCallFinished, IPayloadDaemonCallStarted, IPayloadDropdownVisibility, IPayloadGetFromStorage, IPayloadSaveToStorage, IPayloadSendAnalytics, IPayloadStartRedirectToEntityPage, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort } from './Payload';
+import { IntegrationProxyRequest, IntegrationProxyResponse, IPayloadAutoSuggestResult, IPayloadBatchContactsMatchResult, IPayloadBatchContactsMatchResultError, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadCancelRedirectToEntityPage, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContactWeightUpdate, IPayloadContextResult, IPayloadConversationResult, IPayloadCustomEvent, IPayloadDaemonCallFinished, IPayloadDaemonCallStarted, IPayloadDropdownVisibility, IPayloadGetChannelsByEmailOrPhone, IPayloadGetFromStorage, IPayloadSaveToStorage, IPayloadSendAnalytics, IPayloadSetChatToOpen, IPayloadStartRedirectToEntityPage, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort } from './Payload';
 import { SupportedPlatformVariant } from './Platform';
 import { XBeesUser } from './XBeesUser';
-export type EventPayload<T extends MessageType> = T extends EventType.GET_CONTACTS_AUTO_SUGGEST ? string : T extends ClientEventType.CONTACTS_AUTO_SUGGEST ? IPayloadAutoSuggestResult : T extends ClientEventType.CONTACT_LOOKUP_AND_MATCH | ClientEventType.CONTACT_CREATE_OR_UPDATE | ClientEventType.CONTACT_MATCH_UPDATE ? IPayloadContactMatchResult : T extends ClientEventType.CONTACT_LOOKUP_AND_MATCH_NOT_FOUND ? IPayloadContactMatchResultNotFound : T extends ClientEventType.LOOKUP_AND_MATCH_BATCH_ERROR ? IPayloadBatchContactsMatchResultError : T extends ClientEventType.CONTEXT ? IPayloadContextResult : T extends ClientEventType.CURRENT_CONTACT ? IPayloadContactResult : T extends ClientEventType.CURRENT_CONVERSATION ? IPayloadConversationResult : T extends EventType.ADD_CALL ? IPayloadCallStartedInfo : T extends ClientEventType.START_CALL ? IPayloadCallStart : T extends ClientEventType.READY ? IPayloadVersion : T extends ClientEventType.VIEW_PORT ? IPayloadViewPort : T extends ClientEventType.THEME ? IPayloadThemeChange : T extends EventType.USE_THEME ? IPayloadThemeChange : T extends ClientEventType.TOAST ? IPayloadToast : T extends ClientEventType.SEND_ANALYTICS ? IPayloadSendAnalytics : T extends ClientEventType.SEND_TECHNICAL_SUPPORT_INFORMATION ? IPayloadTechSupport : T extends EventType.PBX_TOKEN ? string : T extends ClientEventType.TOKEN ? string : T extends ClientEventType.TO_CLIPBOARD ? string : T extends EventType.GET_LOOK_UP_AND_MATCH ? ContactQuery : T extends EventType.GET_LOOK_UP_AND_MATCH_BATCH ? ContactQuery[] : T extends EventType.VISIBILITY ? boolean : T extends ClientEventType.USER ? XBeesUser : T extends ClientEventType.SAVE_TO_STORAGE ? IPayloadSaveToStorage : T extends ClientEventType.GET_FROM_STORAGE ? IPayloadGetFromStorage : T extends ClientEventType.REMOVE_FROM_STORAGE ? IPayloadGetFromStorage : T extends ClientEventType.AVAILABLE_CONTACT_DATA ? AvailableContactData | null : T extends ClientEventType.LOOK_UP_AND_MATCH_BATCH_CONTACTS ? IPayloadBatchContactsMatchResult : T extends ClientEventType.DROPDOWN_VISIBILITY ? IPayloadDropdownVisibility : T extends ClientEventType.CUSTOM_EVENT ? IPayloadCustomEvent : T extends ClientEventType.SET_CHAT_TO_OPEN ? IPayloadSetChatToOpen : T extends EventType.START_REDIRECT_TO_ENTITY_PAGE ? IPayloadStartRedirectToEntityPage : T extends EventType.CANCEL_REDIRECT_TO_ENTITY_PAGE ? IPayloadCancelRedirectToEntityPage : T extends EventType.GET_INTEGRATION_PROXY_REQUEST ? IntegrationProxyRequest : T extends ClientEventType.INTEGRATION_PROXY_RESPONSE ? IntegrationProxyResponse : T extends ClientEventType.INTEGRATION_PROXY_REQUEST_IS_SUPPORTED ? undefined : T extends EventType.DAEMON_CALL_SESSION_STARTED ? IPayloadDaemonCallStarted : T extends EventType.DAEMON_CALL_SESSION_FINISHED ? IPayloadDaemonCallFinished : never;
+export type EventPayload<T extends MessageType> = T extends EventType.GET_CONTACTS_AUTO_SUGGEST ? string : T extends ClientEventType.CONTACTS_AUTO_SUGGEST ? IPayloadAutoSuggestResult : T extends ClientEventType.CONTACT_LOOKUP_AND_MATCH | ClientEventType.CONTACT_CREATE_OR_UPDATE | ClientEventType.CONTACT_MATCH_UPDATE ? IPayloadContactMatchResult : T extends ClientEventType.CONTACT_LOOKUP_AND_MATCH_NOT_FOUND ? IPayloadContactMatchResultNotFound : T extends ClientEventType.LOOKUP_AND_MATCH_BATCH_ERROR ? IPayloadBatchContactsMatchResultError : T extends ClientEventType.CONTEXT ? IPayloadContextResult : T extends ClientEventType.CURRENT_CONTACT ? IPayloadContactResult : T extends ClientEventType.CURRENT_CONVERSATION ? IPayloadConversationResult : T extends EventType.ADD_CALL ? IPayloadCallStartedInfo : T extends ClientEventType.START_CALL ? IPayloadCallStart : T extends ClientEventType.READY ? IPayloadVersion : T extends ClientEventType.VIEW_PORT ? IPayloadViewPort : T extends ClientEventType.THEME ? IPayloadThemeChange : T extends EventType.USE_THEME ? IPayloadThemeChange : T extends ClientEventType.TOAST ? IPayloadToast : T extends ClientEventType.SEND_ANALYTICS ? IPayloadSendAnalytics : T extends ClientEventType.SEND_TECHNICAL_SUPPORT_INFORMATION ? IPayloadTechSupport : T extends EventType.PBX_TOKEN ? string : T extends ClientEventType.TOKEN ? string : T extends ClientEventType.TO_CLIPBOARD ? string : T extends EventType.GET_LOOK_UP_AND_MATCH ? ContactQuery : T extends EventType.GET_LOOK_UP_AND_MATCH_BATCH ? ContactQuery[] : T extends EventType.VISIBILITY ? boolean : T extends ClientEventType.USER ? XBeesUser : T extends ClientEventType.SAVE_TO_STORAGE ? IPayloadSaveToStorage : T extends ClientEventType.GET_FROM_STORAGE ? IPayloadGetFromStorage : T extends ClientEventType.REMOVE_FROM_STORAGE ? IPayloadGetFromStorage : T extends ClientEventType.AVAILABLE_CONTACT_DATA ? AvailableContactData | null : T extends ClientEventType.LOOK_UP_AND_MATCH_BATCH_CONTACTS ? IPayloadBatchContactsMatchResult : T extends ClientEventType.DROPDOWN_VISIBILITY ? IPayloadDropdownVisibility : T extends ClientEventType.CUSTOM_EVENT ? IPayloadCustomEvent : T extends ClientEventType.SET_CHAT_TO_OPEN ? IPayloadSetChatToOpen : T extends ClientEventType.GET_CHANNELS_BY_EMAIL_OR_PHONE ? IPayloadGetChannelsByEmailOrPhone : T extends EventType.START_REDIRECT_TO_ENTITY_PAGE ? IPayloadStartRedirectToEntityPage : T extends EventType.CANCEL_REDIRECT_TO_ENTITY_PAGE ? IPayloadCancelRedirectToEntityPage : T extends EventType.GET_INTEGRATION_PROXY_REQUEST ? IntegrationProxyRequest : T extends ClientEventType.INTEGRATION_PROXY_RESPONSE ? IntegrationProxyResponse : T extends ClientEventType.INTEGRATION_PROXY_REQUEST_IS_SUPPORTED ? undefined : T extends EventType.DAEMON_CALL_SESSION_STARTED ? IPayloadDaemonCallStarted : T extends EventType.DAEMON_CALL_SESSION_FINISHED ? IPayloadDaemonCallFinished : never;
 export type EventPayloadMap = {
     [EventType.GET_CONTACTS_AUTO_SUGGEST]: string;
     [EventType.GET_LOOK_UP_AND_MATCH]: ContactQuery;

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

@@ -97,10 +97,13 @@ export interface IPayloadCustomEvent {
     type: string;
     payload?: JSONValue;
 }
-/** Payload for the integration → x-bees message that requests opening a chat by id (`ClientEventType.SET_CHAT_TO_OPEN`). */
 export interface IPayloadSetChatToOpen {
     chatId: string;
 }
+export interface IPayloadGetChannelsByEmailOrPhone {
+    id: string;
+    type: 'email' | 'phone';
+}
 export interface IPayloadContactWeightUpdate {
     id: string;
     query: ContactQuery;

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

@@ -7,7 +7,7 @@ export type { JSONArray, JSONObject } from './Json';
 export type { Listener, RemoveEventListener } from './Listener';
 export type { Message, MessageIFrameResponse, MessageType, ResponseMessage } from './Message';
 export type { MessageSender } from './MessageSender';
-export type { IntegrationProxyErrorCode, IntegrationProxyRequest, IntegrationProxyResponse, IPayloadAutoSuggestResult, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadCancelRedirectToEntityPage, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContextResult, IPayloadConversationResult, IPayloadDaemonCallFinished, IPayloadDaemonCallStarted, IPayloadSendAnalytics, IPayloadSetChatToOpen, IPayloadStartRedirectToEntityPage, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort, } from './Payload';
+export type { IntegrationProxyErrorCode, IntegrationProxyRequest, IntegrationProxyResponse, IPayloadAutoSuggestResult, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadCancelRedirectToEntityPage, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContextResult, IPayloadConversationResult, IPayloadDaemonCallFinished, IPayloadDaemonCallStarted, IPayloadGetChannelsByEmailOrPhone, IPayloadSendAnalytics, IPayloadSetChatToOpen, IPayloadStartRedirectToEntityPage, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort, } from './Payload';
 export { SupportedPlatformVariant } from './Platform';
 export type { IntegrationProxyRequestResolver, LookupAndMatchBatchContactsResolver, LookupAndMatchContactsResolver, Reject, SuggestContactsResolver, } from './Resolver';
 export type { StorageEventCallback } from './Storage';

package/package.json

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