@zohoim/client-sdk 1.0.0-poc88 → 1.0.0-poc89

package/es/application/services/messages/MessageService.js

@@ -12,6 +12,10 @@ export default class MessageService extends IMessageRepository {
     return this.messageRepository.getMessages(request);
   }
 
+  async getMessage(request) {
+    return this.messageRepository.getMessage(request);
+  }
+
   async getFullContent(request) {
     return this.messageRepository.getFullContent(request);
   }
@@ -43,6 +47,7 @@ export default class MessageService extends IMessageRepository {
   toJSON() {
     return {
       getMessages: this.getMessages.bind(this),
+      getMessage: this.getMessage.bind(this),
       getFullContent: this.getFullContent.bind(this),
       sendMessage: this.sendMessage.bind(this),
       sendAttachment: this.sendAttachment.bind(this),

package/es/domain/dto/messages/getMessageRequest.js

@@ -0,0 +1,14 @@
+import RequestBuilder from '../RequestBuilder';
+
+function getMessageRequest() {
+  let {
+    params = {}
+  } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  return new RequestBuilder().withParams({
+    sessionId: null,
+    messageId: null,
+    ...params
+  }).build();
+}
+
+export default getMessageRequest;

package/es/domain/dto/messages/index.js

@@ -1,4 +1,5 @@
 export { default as getMessagesRequest } from './getMessagesRequest';
+export { default as getMessageRequest } from './getMessageRequest';
 export { default as deleteMessageRequest } from './deleteMessageRequest';
 export { default as getFullContentRequest } from './getFullContentRequest';
 export { default as resendMessageRequest } from './resendMessageRequest';

package/es/domain/dto/messages/initiateSessionRequest.js

@@ -14,6 +14,7 @@ function initiateSessionRequest() {
     cannedMessageId: null,
     language: null,
     parameters: {},
+    message: null,
     ...body
   }).build();
 }

package/es/domain/dto/messages/sendAttachmentRequest.js

@@ -7,7 +7,6 @@ function sendAttachmentRequest() {
   } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
   return new RequestBuilder().withParams({
     sessionId: null,
-    messageId: null,
     ...params
   }).withBody({
     message: null,

package/es/domain/dto/messages/sendMessageRequest.js

@@ -10,6 +10,8 @@ function sendMessageRequest() {
     ...params
   }).withBody({
     message: null,
+    replyToMessageId: null,
+    meta: null,
     ...body
   }).build();
 }

package/es/domain/dto/sessions/markSessionAsReadRequest.js

@@ -2,11 +2,15 @@ import RequestBuilder from '../RequestBuilder';
 
 function markSessionAsReadRequest() {
   let {
-    body = {}
+    body = {},
+    params = {}
   } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
   return new RequestBuilder().withBody({
     lastSeenMessageId: null,
     ...body
+  }).withParams({
+    sessionId: null,
+    ...params
   }).build();
 }
 

package/es/domain/entities/Actor/Actor.js

@@ -21,10 +21,14 @@ export default class Actor {
     return type === ActorType.BOT;
   }
 
-  static isEndUser(type) {
+  static isEnduser(type) {
     return type === ActorType.ENDUSER;
   }
 
+  static isSystemMessage(type) {
+    return type === ActorType.SYSTEM;
+  }
+
   toJSON() {
     return { ...this.data
     };

package/es/domain/entities/Message/Action.js

@@ -17,6 +17,10 @@ export default class Action {
     return action && action.type === ActionType.TRANSFER;
   }
 
+  static isTransferAction(action) {
+    return action === ActionType.TRANSFER;
+  }
+
   toJSON() {
     return { ...this.data
     };

package/es/domain/entities/Message/ExternalInfo.js

@@ -1,4 +1,5 @@
 import { validateSchema } from '../../../core/utils';
+import { ExternalInfoAction } from '../../enum';
 import { ExternalInfoSchema } from '../../schema';
 export default class ExternalInfo {
   constructor() {
@@ -9,6 +10,14 @@ export default class ExternalInfo {
     };
   }
 
+  static isGCConversationEnded(action) {
+    return action === ExternalInfoAction.GC_CONVERSATION_ENDED;
+  }
+
+  static isZIAConversationEnded(action) {
+    return action === ExternalInfoAction.ZIA_CONVERSATION_ENDED;
+  }
+
   toJSON() {
     return { ...this.data
     };

package/es/domain/entities/Message/Info.js

@@ -24,6 +24,18 @@ export default class Info {
     return info && info.action === InfoAction.CHAT_TRANSFER;
   }
 
+  static isChatTransfer(action) {
+    return action === InfoAction.CHAT_TRANSFER;
+  }
+
+  static isAutoAssign(action) {
+    return action === InfoAction.CHAT_AUTO_ASSIGN;
+  }
+
+  static isEndSession(action) {
+    return action === InfoAction.END_SESSION;
+  }
+
   toJSON() {
     return { ...this.data
     };

package/es/domain/entities/Message/Message.js

@@ -34,7 +34,8 @@ export default class Message {
       template: validatedData.template,
       type: validatedData.type,
       isRead: validatedData.isRead,
-      article: validatedData.article
+      article: validatedData.article,
+      webUrl: validatedData.webUrl
     };
   }
 
@@ -58,10 +59,18 @@ export default class Message {
     return type === MessageTypes.INFO;
   }
 
+  static isExternalInfo(type) {
+    return type === MessageTypes.EXTERNAL_INFO;
+  }
+
   static isAttachment(type) {
     return type === MessageTypes.ATTACHMENT;
   }
 
+  static isTemplate(type) {
+    return type === MessageTypes.TEMPLATE;
+  }
+
   static isActionMessage(type) {
     return type === MessageTypes.ACTION;
   }
@@ -70,6 +79,30 @@ export default class Message {
     return !!systemMsgType;
   }
 
+  static isSystemMessage(message) {
+    return !!message;
+  }
+
+  static isHapinessRating(systemMessageType) {
+    return systemMessageType === MessageTypes.CX_HAPPINESS_SURVEY;
+  }
+
+  static isWelcomeMessage(systemMessageType) {
+    return systemMessageType === MessageTypes.WELCOMEMSG;
+  }
+
+  static isWorkflowMessage(systemMessageType) {
+    return systemMessageType === MessageTypes.WORKFLOW_MESSAGE;
+  }
+
+  static isWorkflowNotification(systemMessageType) {
+    return systemMessageType === MessageTypes.WORKFLOW_NOTIFICATION;
+  }
+
+  static isFailed(status) {
+    return status === MessageStatus.FAILED;
+  }
+
   static getMetaValue() {
     let meta = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
     let key = arguments.length > 1 ? arguments[1] : undefined;

package/es/domain/entities/Session/Session.js

@@ -36,18 +36,38 @@ export default class Session {
     return sessionStatus === SessionStatus.BLOCKED;
   }
 
-  static isInactiveChannel(replyStatus) {
-    return replyStatus === SessionReplyStatus.CHANNEL_INACTIVE;
+  static isOnProgress(sessionStatus) {
+    return sessionStatus === SessionStatus.ON_PROGRESS;
+  }
+
+  static isHold(sessionStatus) {
+    return sessionStatus === SessionStatus.ON_HOLD;
   }
 
   static isOpen(sessionStatus) {
     return sessionStatus === SessionStatus.OPEN;
   }
 
+  static isInactiveChannel(replyStatus) {
+    return replyStatus === SessionReplyStatus.CHANNEL_INACTIVE;
+  }
+
   static isCreated(sessionStatus) {
     return sessionStatus === SessionStatus.CREATED;
   }
 
+  static isChannelDeleted(replyStatus) {
+    return replyStatus === SessionReplyStatus.CHANNEL_DELETED;
+  }
+
+  static isReplyAccepted(replyStatus) {
+    return replyStatus === SessionReplyStatus.ACCEPTED;
+  }
+
+  static isEndUserOffline(replyStatus) {
+    return replyStatus === SessionReplyStatus.ENDUSER_OFFLINE;
+  }
+
   static isAssignedToOtherService(replyStatus) {
     return replyStatus === SessionReplyStatus.ASSIGNED_TO_OTHER_SERVICE;
   }

package/es/domain/enum/message/MessageType.js

@@ -6,6 +6,10 @@ const MessageTypes = {
   LAYOUT: 'LAYOUT',
   EXTERNAL_INFO: 'EXTERNAL_INFO',
   TEMPLATE: 'TEMPLATE',
-  ACTION: 'ACTION'
+  ACTION: 'ACTION',
+  WELCOMEMSG: 'WELCOMEMSG',
+  WORKFLOW_MESSAGE: 'WORKFLOW_MESSAGE',
+  WORKFLOW_NOTIFICATION: 'WORKFLOW_NOTIFICATION',
+  CX_HAPPINESS_SURVEY: 'CX_HAPPINESS_SURVEY'
 };
 export default MessageTypes;

package/es/domain/interfaces/repositories/messages/IMessageRepository.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-unused-vars */
 import { ModuleNames } from '../../../../core/constants';
 import BaseAPI from '../../../../infrastructure/api/BaseAPI';
-import { getMessagesRequest, deleteMessageRequest, getFullContentRequest, resendMessageRequest, sendAttachmentRequest, sendMessageRequest, initiateSessionRequest, searchMessagesRequest } from '../../../dto';
+import { getMessagesRequest, getMessageRequest, deleteMessageRequest, getFullContentRequest, resendMessageRequest, sendAttachmentRequest, sendMessageRequest, initiateSessionRequest, searchMessagesRequest } from '../../../dto';
 export default class IMessageRepository extends BaseAPI {
   constructor() {
     super({
@@ -14,6 +14,11 @@ export default class IMessageRepository extends BaseAPI {
     throw new Error('Method not implemented.');
   }
 
+  getMessage() {
+    let request = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : getMessageRequest();
+    throw new Error('Method not implemented.');
+  }
+
   getFullContent() {
     let request = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : getFullContentRequest();
     throw new Error('Method not implemented.');

package/es/domain/schema/message/MessageSchema.js

@@ -107,6 +107,10 @@ const MessageSchema = {
   article: {
     type: 'object',
     required: false
+  },
+  webUrl: {
+    type: 'string',
+    required: false
   }
 };
 export default MessageSchema;

package/es/infrastructure/api/BaseAPI.js

@@ -2,6 +2,7 @@ import { ResponseTypes } from '../../core/constants';
 import { ResponseUtils } from '../../core/utils';
 import configRegistry from '../config/configRegistry';
 import { getRegistryConfig } from './registry';
+import UrlBuilder from './UrlBuilder';
 export default class BaseAPI {
   constructor() {
     let {
@@ -9,78 +10,30 @@ export default class BaseAPI {
       configProvider = configRegistry,
       registryProvider = {
         getRegistryConfig
-      }
+      },
+      urlBuilder = new UrlBuilder()
     } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     this.configProvider = configProvider;
     this.registryProvider = registryProvider;
     this.httpClient = this.configProvider.getHttpClient();
     this.baseURL = this.configProvider.getBaseURL();
     this.module = module;
+    this.urlBuilder = urlBuilder;
   }
 
-  replacePathParams(url, params) {
-    let _url = url;
-    Object.entries(params).forEach(_ref => {
-      let [key, value] = _ref;
-      _url = url.replace(`:${key}`, value);
-    });
-    return _url;
-  }
-
-  buildUrl(_ref2) {
-    let {
-      url,
-      params,
-      query
-    } = _ref2;
-
-    const _params = params || {};
-
-    const _query = query || {};
-
-    let _url = this.replacePathParams(url, _params);
-
-    if (this.baseURL) {
-      _url = `${this.baseURL}${_url}`;
-    }
-
-    const queryString = this.buildQuery(_query);
-
-    if (queryString) {
-      return `${_url}?${queryString}`;
-    }
-
-    return _url;
-  }
-
-  buildQuery(query) {
-    const filteredQuery = Object.entries(query).filter(_ref3 => {
-      let [, value] = _ref3;
-      return value !== undefined && value !== null && value !== '';
-    }).reduce((acc, _ref4) => {
-      let [key, value] = _ref4;
-      acc[key] = value;
-      return acc;
-    }, {});
-    return Object.entries(filteredQuery).map(_ref5 => {
-      let [key, value] = _ref5;
-      return `${key}=${value}`;
-    }).join('&');
-  }
-
-  async request(_ref6) {
+  async request(_ref) {
     let {
       request,
       operation,
       header
-    } = _ref6;
+    } = _ref;
     const config = this.registryProvider.getRegistryConfig(this.module, operation);
 
     if (!config) {
       throw new Error(`Operation "${operation}" not found in registry for module "${this.module}"`);
     }
 
-    const url = this.buildUrl({
+    const url = this.urlBuilder.buildUrl({
       url: config.endpoint,
       params: request.params || {},
       query: request.query || {}
@@ -125,7 +78,7 @@ export default class BaseAPI {
     Object.prototype.hasOwnProperty.call(customPrototype, methodName);
   }
 
-  async executeAPICall(_ref7) {
+  async executeAPICall(_ref2) {
     let {
       operation,
       request,
@@ -133,7 +86,7 @@ export default class BaseAPI {
       customAPI,
       adapter,
       responseType = ResponseTypes.SINGLE
-    } = _ref7;
+    } = _ref2;
     const response = await apiProxy[operation](request);
     const isOverridden = this.isMethodOverridden(customAPI, operation);
 

package/es/infrastructure/api/UrlBuilder.js

@@ -0,0 +1,53 @@
+export default class UrlBuilder {
+  constructor(baseURL) {
+    this.baseURL = baseURL;
+  }
+
+  replacePathParams(url, params) {
+    let processedUrl = url;
+    Object.entries(params).forEach(_ref => {
+      let [key, value] = _ref;
+      processedUrl = processedUrl.replace(`:${key}`, value);
+    });
+    return processedUrl;
+  }
+
+  buildUrl(_ref2) {
+    let {
+      url,
+      params,
+      query
+    } = _ref2;
+    const paramsObj = params || {};
+    const queryObj = query || {};
+    let processedUrl = this.replacePathParams(url, paramsObj);
+
+    if (this.baseURL) {
+      processedUrl = `${this.baseURL}${processedUrl}`;
+    }
+
+    const queryString = this.buildQuery(queryObj);
+
+    if (queryString) {
+      return `${processedUrl}?${queryString}`;
+    }
+
+    return processedUrl;
+  }
+
+  buildQuery(query) {
+    const filteredQuery = Object.entries(query).filter(_ref3 => {
+      let [, value] = _ref3;
+      return value !== undefined && value !== null && value !== '';
+    }).reduce((acc, _ref4) => {
+      let [key, value] = _ref4;
+      acc[key] = value;
+      return acc;
+    }, {});
+    return Object.entries(filteredQuery).map(_ref5 => {
+      let [key, value] = _ref5;
+      return `${key}=${value}`;
+    }).join('&');
+  }
+
+}

package/es/infrastructure/api/messages/MessageAPI.js

@@ -1,4 +1,4 @@
-import { getMessagesRequest, deleteMessageRequest, getFullContentRequest, resendMessageRequest, sendAttachmentRequest, sendMessageRequest, initiateSessionRequest, searchMessagesRequest } from '../../../domain/dto';
+import { getMessagesRequest, deleteMessageRequest, getFullContentRequest, resendMessageRequest, sendAttachmentRequest, sendMessageRequest, initiateSessionRequest, searchMessagesRequest, getMessageRequest } from '../../../domain/dto';
 import { IMessageRepository } from '../../../domain/interfaces/repositories';
 export default class MessageAPI extends IMessageRepository {
   async getMessages() {
@@ -11,6 +11,16 @@ export default class MessageAPI extends IMessageRepository {
     return httpRequest;
   }
 
+  async getMessage() {
+    let request = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : getMessageRequest();
+    const operation = 'getMessage';
+    const httpRequest = await this.request({
+      operation,
+      request
+    });
+    return httpRequest;
+  }
+
   async getFullContent() {
     let request = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : getFullContentRequest();
     const operation = 'getFullContent';

package/es/infrastructure/api/registry/messages/messageAPIRegistry.js

@@ -1,5 +1,5 @@
 import { HTTP_METHODS } from '../../../../core/constants';
-import { deleteMessageRequest, getFullContentRequest, getMessagesRequest, initiateSessionRequest, resendMessageRequest, sendAttachmentRequest, sendMessageRequest, searchMessagesRequest } from '../../../../domain/dto';
+import { deleteMessageRequest, getFullContentRequest, getMessagesRequest, initiateSessionRequest, resendMessageRequest, sendAttachmentRequest, sendMessageRequest, searchMessagesRequest, getMessageRequest } from '../../../../domain/dto';
 import constructChannelEndPoint from '../channels/constructChannelEndPoint';
 import constructMessageEndPoint from './constructMessageEndPoint';
 import createAPIRegistry from '../createAPIRegistry';
@@ -17,6 +17,10 @@ function getMessages() {
   return createAPIRegistry(constructMessageEndPoint(MESSAGES_URL), HTTP_METHODS.GET, getMessagesRequest());
 }
 
+function getMessage() {
+  return createAPIRegistry(constructMessageEndPoint(SINGLE_MESSAGE_URL), HTTP_METHODS.GET, getMessageRequest());
+}
+
 function getFullContent() {
   return createAPIRegistry(constructMessageEndPoint(FULL_CONTENT_URL), HTTP_METHODS.GET, getFullContentRequest());
 }
@@ -47,6 +51,7 @@ function searchMessages() {
 
 export default {
   getMessages,
+  getMessage,
   getFullContent,
   sendMessage,
   sendAttachment,

package/es/infrastructure/repositories/messages/MessageRepository.js

@@ -43,6 +43,13 @@ export default class MessageRepository extends IMessageRepository {
     });
   }
 
+  async getMessage(request) {
+    return this.invokeAPI({
+      operation: 'getMessage',
+      request
+    });
+  }
+
   async getFullContent(request) {
     return this.invokeAPI({
       operation: 'getFullContent',
@@ -98,6 +105,7 @@ export default class MessageRepository extends IMessageRepository {
   toJSON() {
     return {
       getMessages: this.getMessages.bind(this),
+      getMessage: this.getMessage.bind(this),
       getFullContent: this.getFullContent.bind(this),
       sendMessage: this.sendMessage.bind(this),
       sendAttachment: this.sendAttachment.bind(this),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohoim/client-sdk",
-  "version": "1.0.0-poc88",
+  "version": "1.0.0-poc89",
   "description": "To have the client sdk for the IM",
   "main": "es/index.js",
   "module": "es/index.js",