@zohoim/client-sdk 1.0.0-replyAreaPoc4 → 1.0.0-replyAreaPoc5

package/es/domain/entities/CannedMessage/CannedMessage.js

@@ -0,0 +1,46 @@
+import { validateSchema } from '../../../core/utils';
+import { CannedMessageStatus } from '../../enum';
+import { CannedMessageSchema } from '../../schema';
+import { Actor } from '../Actor';
+export default class CannedMessage {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema(CannedMessageSchema, data);
+    this.data = {
+      id: validatedData.id,
+      title: validatedData.title,
+      message: validatedData.message,
+      tags: validatedData.tags,
+      status: validatedData.status,
+      uuid: validatedData.uuid,
+      createdBy: new Actor(validatedData.createdBy),
+      displayMessage: validatedData.displayMessage,
+      type: validatedData.type,
+      kind: validatedData.kind,
+      isActive: validatedData.isActive,
+      meta: validatedData.meta,
+      isPrivate: validatedData.isPrivate,
+      rejectionReason: validatedData.rejectionReason,
+      modifiedTime: validatedData.modifiedTime,
+      translations: validatedData.translations
+    };
+  }
+
+  static isApproved(status) {
+    return status === CannedMessageStatus.APPROVED;
+  }
+
+  static isRejected(status) {
+    return status === CannedMessageStatus.REJECTED;
+  }
+
+  static isPending(status) {
+    return status === CannedMessageStatus.PENDING;
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

package/es/domain/entities/CannedMessage/index.js

@@ -0,0 +1,2 @@
+import CannedMessage from './CannedMessage';
+export { CannedMessage };

package/es/domain/entities/Channel/Channel.js

@@ -0,0 +1,38 @@
+import { validateSchema } from '../../../core/utils';
+import { ChannelSchema } from '../../schema';
+export default class Channel {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema(ChannelSchema, data); // Set required properties from schema
+
+    this.id = validatedData.id;
+    this.integrationService = validatedData.integrationService;
+    this.name = validatedData.name;
+    this.isActive = validatedData.isActive;
+    this.createdTime = validatedData.createdTime; // Set optional properties from schema
+
+    this.defaultBotId = validatedData.defaultBotId || null;
+    this.accountName = validatedData.accountName || null;
+    this.isSubscribed = validatedData.isSubscribed || false;
+    this.createdBy = validatedData.createdBy || null;
+    this.isOwner = validatedData.isOwner || false;
+    this.photoURL = validatedData.photoURL || null;
+  }
+
+  toJSON() {
+    return {
+      id: this.id,
+      integrationService: this.integrationService,
+      name: this.name,
+      defaultBotId: this.defaultBotId,
+      isActive: this.isActive,
+      createdTime: this.createdTime,
+      accountName: this.accountName,
+      isSubscribed: this.isSubscribed,
+      createdBy: this.createdBy,
+      isOwner: this.isOwner,
+      photoURL: this.photoURL
+    };
+  }
+
+}

package/es/domain/entities/Channel/index.js

@@ -0,0 +1,2 @@
+import Channel from './Channel';
+export { Channel };

package/es/domain/entities/Contact/Contact.js

@@ -0,0 +1,22 @@
+import { validateSchema } from '../../../core/utils';
+import { ContactSchema } from '../../schema';
+export default class Contact {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema(ContactSchema, data);
+    this.data = {
+      id: validatedData.id,
+      name: validatedData.name,
+      email: validatedData.email,
+      photoURL: validatedData.photoURL || null,
+      mobile: validatedData.mobile,
+      phone: validatedData.phone
+    };
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

package/es/domain/entities/Contact/index.js

@@ -0,0 +1,2 @@
+import Contact from './Contact';
+export { Contact };

package/es/domain/entities/CustomReplyExtension/CustomReplyExtension.js

@@ -0,0 +1,22 @@
+import { validateSchema } from '../../../core/utils';
+import { CustomReplyExtensionSchema } from '../../schema';
+export default class CustomReplyExtension {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema(CustomReplyExtensionSchema, data);
+    this.data = {
+      id: validatedData.id,
+      title: validatedData.title,
+      message: validatedData.message,
+      displayMessage: validatedData.displayMessage,
+      webUrl: validatedData.webUrl || null,
+      categoryName: validatedData.categoryName
+    };
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

package/es/domain/entities/CustomReplyExtension/index.js

@@ -0,0 +1,2 @@
+import CustomReplyExtension from './CustomReplyExtension';
+export { CustomReplyExtension };

package/es/domain/entities/IntegrationService/IntegrationService.js

@@ -0,0 +1,33 @@
+import { validateSchema } from '../../../core/utils';
+import { IntegrationServices } from '../../enum';
+import { IntegrationServiceSchema } from '../../schema';
+export default class IntegrationService {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema(IntegrationServiceSchema, data);
+    this.data = {
+      label: validatedData.label || '',
+      id: validatedData.id || '',
+      provider: validatedData.provider || {},
+      logoURL: validatedData.logoURL || null
+    };
+  }
+
+  static isWhatsApp(integrationServiceId) {
+    return integrationServiceId === IntegrationServices.WHATSAPP;
+  }
+
+  static isTwilio(integrationServiceId) {
+    return integrationServiceId === IntegrationServices.TWILIO;
+  }
+
+  static isBusinessMessaging(integrationServiceId) {
+    return integrationServiceId === IntegrationServices.IM_TALK;
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

package/es/domain/entities/IntegrationService/index.js

@@ -0,0 +1,2 @@
+import IntegrationService from './IntegrationService';
+export { IntegrationService };

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

@@ -0,0 +1,25 @@
+import { validateSchema } from '../../../core/utils';
+import { ActionType } from '../../enum';
+import { ActionSchema } from '../../schema';
+export default class Action {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema(ActionSchema, data);
+    this.data = {
+      type: validatedData.type,
+      subType: validatedData.subType,
+      value: validatedData.value
+    };
+  }
+
+  static isTransferAction() {
+    let action = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    return action && action.type === ActionType.TRANSFER;
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

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

@@ -0,0 +1,26 @@
+import { validateSchema } from '../../../core/utils';
+import { ExternalInfoAction } from '../../enum';
+import { ExternalInfoSchema } from '../../schema';
+export default class ExternalInfo {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema(ExternalInfoSchema, data);
+    this.data = {
+      action: validatedData.action
+    };
+  }
+
+  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

@@ -0,0 +1,44 @@
+import { validateSchema } from '../../../core/utils';
+import { Actor } from '../Actor';
+import { InfoSchema } from '../../schema/message';
+import { InfoAction } from '../../enum';
+import InfoTarget from './InfoTarget';
+
+function adaptTargets() {
+  let targets = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+  return targets.map(target => new InfoTarget(target).toJSON());
+}
+
+export default class Info {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema(InfoSchema, data);
+    this.data = {
+      actor: new Actor(validatedData.actor).toJSON(),
+      action: validatedData.action,
+      sessionStatus: validatedData.sessionStatus,
+      targets: adaptTargets(validatedData.targets)
+    };
+  }
+
+  static isEndSessionMessage() {
+    let info = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    return info && info.action === InfoAction.END_SESSION;
+  }
+
+  static isAutoAssignMessage() {
+    let info = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    return info && info.action === InfoAction.CHAT_AUTO_ASSIGN;
+  }
+
+  static isTransferMessage() {
+    let info = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    return info && info.action === InfoAction.CHAT_TRANSFER;
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

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

@@ -0,0 +1,22 @@
+import { validateSchema } from '../../../core/utils';
+import { InfoTargetSchema } from '../../schema/message';
+export default class InfoTarget {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema(InfoTargetSchema, data);
+    this.data = {
+      id: validatedData.id,
+      name: validatedData.name || null,
+      photoURL: validatedData.photoURL || null,
+      email: validatedData.email || null,
+      isReplyAllowed: validatedData.isReplyAllowed,
+      type: validatedData.type
+    };
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

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

@@ -0,0 +1,18 @@
+import { validateSchema } from '../../../core/utils';
+import { LocationSchema } from '../../schema';
+export default class Location {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema(LocationSchema, data);
+    this.data = {
+      latitude: validatedData.latitude,
+      longitude: validatedData.longitude
+    };
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

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

@@ -0,0 +1,137 @@
+import { validateSchema } from '../../../core/utils';
+import { MessageDirection, MessageStatus, MessageTypes, MessageMeta, MetaSystemMessageType } from '../../enum';
+import { MessageSchema } from '../../schema';
+import { Actor } from '../Actor';
+import { Attachment } from '../Attachment';
+import Action from './Action';
+import ExternalInfo from './ExternalInfo';
+import Info from './Info';
+import Location from './Location';
+export default class Message {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema(MessageSchema, data);
+    this.data = {
+      id: validatedData.id,
+      sessionId: validatedData.sessionId,
+      displayMessage: validatedData.displayMessage,
+      statusUpdatedTime: validatedData.statusUpdatedTime,
+      actor: new Actor(validatedData.actor).toJSON(),
+      direction: validatedData.direction,
+      createdTime: validatedData.createdTime,
+      index: validatedData.index,
+      replyToMessage: validatedData.replyToMessage ? new Message(validatedData.replyToMessage).toJSON() : null,
+      status: validatedData.status,
+      info: validatedData.info ? new Info(validatedData.info).toJSON() : null,
+      location: validatedData.location ? new Location(validatedData.location).toJSON() : null,
+      externalInfo: validatedData.externalInfo ? new ExternalInfo(validatedData.externalInfo).toJSON() : null,
+      layout: validatedData.layout,
+      action: validatedData.action ? new Action(validatedData.action).toJSON() : null,
+      meta: validatedData.meta,
+      contentType: validatedData.contentType,
+      fullContentURL: validatedData.fullContentURL,
+      attachment: validatedData.attachment ? new Attachment(validatedData.attachment).toJSON() : null,
+      template: validatedData.template,
+      type: validatedData.type,
+      isRead: validatedData.isRead,
+      article: validatedData.article,
+      webUrl: validatedData.webUrl
+    };
+  }
+
+  static isLocation(type) {
+    return type === MessageTypes.LOCATION;
+  }
+
+  static isDeleted(status) {
+    return status === MessageStatus.DELETED;
+  }
+
+  static isOutgoing(direction) {
+    return direction === MessageDirection.OUT;
+  }
+
+  static isIncoming(direction) {
+    return direction === MessageDirection.IN;
+  }
+
+  static isInfo(type) {
+    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;
+  }
+
+  static getMetaValue() {
+    let meta = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+    let key = arguments.length > 1 ? arguments[1] : undefined;
+
+    if (Array.isArray(meta) && meta.length > 0) {
+      const item = meta.find(item => item.name === key);
+      return item ? item.value : '';
+    }
+
+    return '';
+  }
+
+  static getSystemMessageValue(meta) {
+    return Message.getMetaValue(meta, MessageMeta.SYSTEM_MESSAGE_TYPE);
+  }
+
+  static isSystemMessage(meta) {
+    const systemMessageType = Message.getSystemMessageValue(meta);
+    return !!systemMessageType;
+  }
+
+  static isHapinessRating(meta) {
+    const messageType = Message.getSystemMessageValue(meta);
+    return messageType === MetaSystemMessageType.CX_HAPPINESS_SURVEY;
+  }
+
+  static isWelcomeMessage(meta) {
+    const messageType = Message.getSystemMessageValue(meta);
+    return messageType === MetaSystemMessageType.WELCOMEMSG;
+  }
+
+  static isWorkflowMessage(meta) {
+    const messageType = Message.getSystemMessageValue(meta);
+    return messageType === MetaSystemMessageType.WORKFLOW_MESSAGE;
+  }
+
+  static isWorkflowNotification(meta) {
+    const messageType = Message.getSystemMessageValue(meta);
+    return messageType === MetaSystemMessageType.WORKFLOW_NOTIFICATION;
+  }
+
+  static isUnsupportedFile(meta) {
+    const messageType = Message.getSystemMessageValue(meta);
+    return messageType === MetaSystemMessageType.UN_SUPPORTED_FILE;
+  }
+
+  static isFailed(status) {
+    return status === MessageStatus.FAILED;
+  }
+
+  static isAutoSent(systemMsgType) {
+    return !!systemMsgType;
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

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

@@ -0,0 +1,21 @@
+import { validateSchema } from '../../../core/utils';
+import { MessageWithSessionSchema } from '../../schema';
+import { Session } from '../Session';
+import Message from './Message';
+export default class MessageWithSession {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema(MessageWithSessionSchema, data);
+    const messageData = new Message(validatedData).toJSON();
+    const sessionData = new Session(validatedData.session).toJSON();
+    this.data = { ...messageData,
+      session: sessionData
+    };
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

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

@@ -0,0 +1,7 @@
+export { default as Message } from './Message';
+export { default as Info } from './Info';
+export { default as Action } from './Action';
+export { default as ExternalInfo } from './ExternalInfo';
+export { default as Location } from './Location';
+export { default as MessageWithSession } from './MessageWithSession';
+export { default as InfoTarget } from './InfoTarget';

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

@@ -0,0 +1,80 @@
+import { validateSchema } from '../../../core/utils';
+import { SessionSchema } from '../../schema';
+import { Actor } from '../Actor';
+import { SessionReplyStatus, SessionStatus } from '../../enum';
+export default class Session {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema(SessionSchema, data);
+    this.data = {
+      channelId: validatedData.channelId,
+      status: validatedData.status,
+      createdTime: validatedData.createdTime,
+      agentId: validatedData.agentId,
+      botId: validatedData.botId,
+      actor: new Actor(validatedData.actor).toJSON(),
+      subject: validatedData.subject,
+      messagesCount: validatedData.messagesCount,
+      agentLastActiveTime: validatedData.agentLastActiveTime,
+      contactLastActiveTime: validatedData.contactLastActiveTime,
+      lastActiveTime: validatedData.lastActiveTime,
+      unreadMessagesCount: validatedData.unreadMessagesCount,
+      integrationServiceId: validatedData.integrationServiceId,
+      replyStatus: validatedData.replyStatus,
+      id: validatedData.id,
+      contactId: validatedData.contactId,
+      meta: validatedData.meta,
+      assignee: validatedData.assignee ? new Actor(validatedData.assignee).toJSON() : null
+    };
+  }
+
+  static isEnded(sessionStatus) {
+    return sessionStatus === SessionStatus.ENDED;
+  }
+
+  static isBlocked(sessionStatus) {
+    return sessionStatus === SessionStatus.BLOCKED;
+  }
+
+  static isOnProgress(sessionStatus) {
+    return sessionStatus === SessionStatus.ON_PROGRESS;
+  }
+
+  static isOnHold(sessionStatus) {
+    return sessionStatus === SessionStatus.ON_HOLD;
+  }
+
+  static isOpen(sessionStatus) {
+    return sessionStatus === SessionStatus.OPEN;
+  }
+
+  static isInactiveChannel(replyStatus) {
+    return replyStatus === SessionReplyStatus.CHANNEL_INACTIVE;
+  }
+
+  static isChannelDeleted(replyStatus) {
+    return replyStatus === SessionReplyStatus.CHANNEL_DELETED;
+  }
+
+  static isReplyAccepted(replyStatus) {
+    return replyStatus === SessionReplyStatus.ACCEPTED;
+  }
+
+  static isEndUserOffline(replyStatus) {
+    return replyStatus === SessionReplyStatus.ENDUSER_OFFLINE;
+  }
+
+  static isCreated(sessionStatus) {
+    return sessionStatus === SessionStatus.CREATED;
+  }
+
+  static isAssignedToOtherService(replyStatus) {
+    return replyStatus === SessionReplyStatus.ASSIGNED_TO_OTHER_SERVICE;
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

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

@@ -0,0 +1,2 @@
+import Session from './Session';
+export { Session };

package/es/domain/entities/TemplateMessage/TemplateCreditExhaustStatus.js

@@ -0,0 +1,23 @@
+import { validateSchema } from '../../../core/utils';
+import { TemplateCreditExhaustStatusCode } from '../../enum';
+import { TemplateCreditExhaustStatusSchema } from '../../schema';
+export default class TemplateCreditExhaustStatus {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema(TemplateCreditExhaustStatusSchema, data);
+    this.data = {
+      code: validatedData.code,
+      message: validatedData.message
+    };
+  }
+
+  static isInSufficientCredits(code) {
+    return code === TemplateCreditExhaustStatusCode.INSUFFICIENT_CREDITS;
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

package/es/domain/entities/TemplateMessage/TemplateLanguage.js

@@ -0,0 +1,18 @@
+import { validateSchema } from '../../../core/utils';
+import { TemplateLanguageSchema } from '../../schema';
+export default class TemplateLanguage {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema(TemplateLanguageSchema, data);
+    this.data = {
+      code: validatedData.code,
+      language: validatedData.language
+    };
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

package/es/domain/entities/TemplateMessage/index.js

@@ -0,0 +1,3 @@
+import TemplateLanguage from './TemplateLanguage';
+import TemplateCreditExhaustStatus from './TemplateCreditExhaustStatus';
+export { TemplateLanguage, TemplateCreditExhaustStatus };

package/es/domain/entities/index.js

@@ -0,0 +1,12 @@
+export * from './Actor';
+export * from './Agent';
+export * from './Session';
+export * from './Bot';
+export * from './Attachment';
+export * from './Message';
+export * from './Channel';
+export * from './Contact';
+export * from './IntegrationService';
+export * from './CannedMessage';
+export * from './TemplateMessage';
+export * from './CustomReplyExtension';

package/es/domain/enum/actor/ActorType.js

@@ -0,0 +1,7 @@
+const ActorType = {
+  AGENT: 'AGENT',
+  BOT: 'BOT',
+  ENDUSER: 'END_USER',
+  SYSTEM: 'SYSTEM'
+};
+export default ActorType;

package/es/domain/enum/actor/index.js

@@ -0,0 +1,2 @@
+import ActorType from './ActorType';
+export { ActorType };

package/es/domain/enum/attachment/AttachmentStatus.js

@@ -0,0 +1,7 @@
+const AttachmentStatus = {
+  VALID: 'VALID',
+  // NO I18N
+  INVALID: 'INVALID' // NO I18N
+
+};
+export default AttachmentStatus;

package/es/domain/enum/attachment/index.js

@@ -0,0 +1,2 @@
+import AttachmentStatus from './AttachmentStatus';
+export { AttachmentStatus };

package/es/domain/enum/bot/BotServiceType.js

@@ -0,0 +1,7 @@
+const BotServiceType = {
+  DESK_GC_BOT: 'DESK_GC_BOT',
+  DESK_ZIA_BOT: 'DESK_ZIA_BOT',
+  ZOHO_GC_BOT: 'ZOHO_GC_BOT',
+  ZOHO_ZIA_BOT: 'ZOHO_ZIA_BOT'
+};
+export default BotServiceType;