@zohoim/client-sdk 1.0.0-subscription1 → 1.0.0-subscription2

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

@@ -0,0 +1,29 @@
+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({
+      schema: ActionSchema,
+      data,
+      entityName: 'Action'
+    });
+    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,30 @@
+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({
+      schema: ExternalInfoSchema,
+      data,
+      entityName: 'ExternalInfo'
+    });
+    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,48 @@
+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({
+      schema: InfoSchema,
+      data,
+      entityName: 'Info'
+    });
+    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,26 @@
+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({
+      schema: InfoTargetSchema,
+      data,
+      entityName: 'InfoTarget'
+    });
+    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,22 @@
+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({
+      schema: LocationSchema,
+      data,
+      entityName: 'Location'
+    });
+    this.data = {
+      latitude: validatedData.latitude,
+      longitude: validatedData.longitude
+    };
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

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

@@ -0,0 +1,160 @@
+import { validateSchema } from '../../../core/utils';
+import { MessageDirection, MessageStatus, MessageTypes, MessageMeta, MetaSystemMessageType, MetaMessageSourceType } 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({
+      schema: MessageSchema,
+      data,
+      entityName: 'Message'
+    });
+    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 getMessageSourceValue(meta) {
+    return Message.getMetaValue(meta, MessageMeta.MESSAGE_SOURCE);
+  }
+
+  static isHistoryMessage(meta) {
+    const messageType = Message.getMessageSourceValue(meta);
+    return messageType === MetaMessageSourceType.HISTORY_MESSAGE;
+  }
+
+  static isHistoryMessageViaMobileWBApp(meta) {
+    const messageType = Message.getMessageSourceValue(meta);
+    return messageType === MetaMessageSourceType.HISTORY_MESSAGE_VIA_MOBILE_WHATSAPP_BUSINESS_APP;
+  }
+
+  static isMessageViaMobileWBApp(meta) {
+    const messageType = Message.getMessageSourceValue(meta);
+    return messageType === MetaMessageSourceType.VIA_MOBILE_WHATSAPP_BUSINESS_APP;
+  }
+
+  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,25 @@
+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({
+      schema: MessageWithSessionSchema,
+      data,
+      entityName: 'MessageWithSession'
+    });
+    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,84 @@
+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({
+      schema: SessionSchema,
+      data,
+      entityName: 'Session'
+    });
+    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/SessionMetrics.js

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

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

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

package/es/domain/entities/Subscription/AddOn.js

@@ -0,0 +1,26 @@
+import { validateSchema } from '../../../core/utils';
+import { AddOnSchema } from '../../schema';
+import SubscriptionInfo from './SubscriptionInfo';
+export default class AddOn {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema({
+      schema: AddOnSchema,
+      data,
+      entityName: 'AddOn' // No I18N
+
+    });
+    this.data = {
+      name: validatedData.name,
+      type: validatedData.type,
+      module: validatedData.module,
+      cost: validatedData.cost,
+      subscriptionInfo: validatedData.subscriptionInfo ? new SubscriptionInfo(validatedData.subscriptionInfo).toJSON() : null
+    };
+  }
+
+  toJSON() {
+    return this.data;
+  }
+
+}

package/es/domain/entities/Subscription/LicenseDetails.js

@@ -0,0 +1,21 @@
+import { validateSchema } from '../../../core/utils';
+import { LicenseDetailsSchema } from '../../schema';
+export default class LicenseDetails {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema({
+      schema: LicenseDetailsSchema,
+      data,
+      entityName: 'LicenseDetails' // No I18N
+
+    });
+    this.data = {
+      paymentSource: validatedData.paymentSource
+    };
+  }
+
+  toJSON() {
+    return this.data;
+  }
+
+}

package/es/domain/entities/Subscription/SubscriptionInfo.js

@@ -0,0 +1,26 @@
+import { validateSchema } from '../../../core/utils';
+import { SubscriptionInfoSchema } from '../../schema';
+export default class SubscriptionInfo {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema({
+      schema: SubscriptionInfoSchema,
+      data,
+      entityName: 'SubscriptionInfo' // No I18N
+
+    });
+    this.data = {
+      count: validatedData.count,
+      available: validatedData.available,
+      renewalCount: validatedData.renewalCount,
+      renewalThreshold: validatedData.renewalThreshold,
+      status: validatedData.status,
+      reserved: validatedData.reserved
+    };
+  }
+
+  toJSON() {
+    return this.data;
+  }
+
+}

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

@@ -0,0 +1,4 @@
+import AddOn from './AddOn';
+import LicenseDetails from './LicenseDetails';
+import SubscriptionInfo from './SubscriptionInfo';
+export { AddOn, LicenseDetails, SubscriptionInfo };

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

@@ -0,0 +1,27 @@
+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({
+      schema: TemplateCreditExhaustStatusSchema,
+      data,
+      entityName: 'TemplateCreditExhaustStatus'
+    });
+    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,22 @@
+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({
+      schema: TemplateLanguageSchema,
+      data,
+      entityName: 'TemplateLanguage'
+    });
+    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/UserPreference/UserPreference.js

@@ -0,0 +1,26 @@
+import { validateSchema } from '../../../core/utils';
+import { UserPreferenceSchema } from '../../schema';
+import { CollapseSidePanel } from '../../enum';
+export default class UserPreference {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema({
+      schema: UserPreferenceSchema,
+      data,
+      entityName: 'UserPreference'
+    });
+    this.data = {
+      collapseSidePanel: validatedData.collapseSidePanel
+    };
+  }
+
+  static isCollpseView(view) {
+    return view === CollapseSidePanel.ENABLED;
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

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

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

package/es/domain/entities/WhatsAppPricing/WhatsAppPricing.js

@@ -0,0 +1,25 @@
+import { validateSchema } from '../../../core/utils';
+import { WhatsAppPricingSchema } from '../../schema';
+import WhatsAppPricingCategory from './WhatsAppPricingCategory';
+export default class WhatsAppPricing {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema({
+      schema: WhatsAppPricingSchema,
+      data,
+      entityName: 'WhatsAppPricing'
+    });
+    this.data = {
+      total: validatedData.total,
+      creditsCount: validatedData.creditsCount,
+      actutalCreditsAmount: validatedData.actutalCreditsAmount,
+      category: validatedData.category.map(item => new WhatsAppPricingCategory(item).toJSON())
+    };
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

package/es/domain/entities/WhatsAppPricing/WhatsAppPricingCategory.js

@@ -0,0 +1,22 @@
+import { validateSchema } from '../../../core/utils';
+import { WhatsAppPricingCategorySchema } from '../../schema';
+export default class WhatsAppPricingCategory {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema({
+      schema: WhatsAppPricingCategorySchema,
+      data,
+      entityName: 'WhatsAppPricingCategory'
+    });
+    this.data = {
+      type: validatedData.type,
+      value: validatedData.value
+    };
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}