@zohoim/client-sdk 1.0.0-poc2 → 1.0.0-poc20

package/es/config/urls/bots/bots-api-url.js

@@ -0,0 +1,11 @@
+import { HTTP_METHODS, IM_API_PREFIX } from '../../../core/constants';
+import { GetBotsRequest } from '../../../infrastructure/interfaces/api';
+const BASE_URL = `${IM_API_PREFIX}/bots`;
+const BOTS_API_URLS = {
+  LIST: {
+    url: BASE_URL,
+    method: HTTP_METHODS.GET,
+    ...GetBotsRequest
+  }
+};
+export default BOTS_API_URLS;

package/es/config/urls/bots/index.js

@@ -0,0 +1,2 @@
+import BOTS_API_URLS from './bots-api-url';
+export { BOTS_API_URLS };

package/es/config/urls/channels/channel-agents-api-url.js

@@ -0,0 +1,11 @@
+import { HTTP_METHODS, IM_API_PREFIX } from '../../../core/constants';
+import { GetChannelAgentsRequest } from '../../../infrastructure/interfaces/api';
+const BASE_URL = `${IM_API_PREFIX}/channels/:channelId/agents`;
+const CHANNEL_AGENTS_API_URLS = {
+  LIST: {
+    url: BASE_URL,
+    method: HTTP_METHODS.GET,
+    ...GetChannelAgentsRequest
+  }
+};
+export default CHANNEL_AGENTS_API_URLS;

package/es/config/urls/channels/index.js

@@ -0,0 +1,2 @@
+import CHANNEL_AGENTS_API_URLS from './channel-agents-api-url';
+export { CHANNEL_AGENTS_API_URLS };

package/es/config/urls/sessions/index.js

@@ -0,0 +1,2 @@
+import SESSIONS_API_URLS from './sessions-api-url';
+export { SESSIONS_API_URLS };

package/es/config/urls/sessions/sessions-api-url.js

@@ -0,0 +1,12 @@
+import { UpdateSessionAssigneeRequest } from '../../../infrastructure/interfaces/api';
+import { HTTP_METHODS, IM_API_PREFIX } from '../../../core/constants';
+const BASE_URL = `${IM_API_PREFIX}/sessions`;
+const SINGLE_SESSION_URL = `${BASE_URL}/:sessionId`;
+const SESSIONS_API_URLS = {
+  UPDATE_SESSION_ASSIGNEE: {
+    url: SINGLE_SESSION_URL,
+    method: HTTP_METHODS.PATCH,
+    ...UpdateSessionAssigneeRequest
+  }
+};
+export default SESSIONS_API_URLS;

package/es/core/constants/HttpMethods.js

@@ -0,0 +1,8 @@
+const HTTP_METHODS = {
+  GET: 'GET',
+  POST: 'POST',
+  PUT: 'PUT',
+  PATCH: 'PATCH',
+  DELETE: 'DELETE'
+};
+export default HTTP_METHODS;

package/es/core/constants/ModuleNames.js

@@ -0,0 +1,6 @@
+const ModuleNames = {
+  CHANNELS: 'channels',
+  SESSIONS: 'sessions',
+  BOTS: 'bots'
+};
+export default ModuleNames;

package/es/core/constants/index.js

@@ -0,0 +1,4 @@
+import HTTP_METHODS from './HttpMethods';
+import ModuleNames from './ModuleNames';
+const IM_API_PREFIX = '/api/v1';
+export { ModuleNames, IM_API_PREFIX, HTTP_METHODS };

package/es/core/errors/AdapterError.js

@@ -0,0 +1,7 @@
+export default class AdapterError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = 'AdapterError';
+  }
+
+}

package/es/core/errors/index.js

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

package/es/core/utils/index.js

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

package/es/core/utils/validateSchema.js

@@ -0,0 +1,68 @@
+import { ValidationError } from '../errors';
+
+function validateSchemaKeys(schema, data) {
+  Object.keys(schema).forEach(key => {
+    if (!(key in data)) {
+      throw new ValidationError(`Key '${key}' is missing in the data`);
+    }
+  });
+}
+
+function validateRequiredCheck(_ref) {
+  let {
+    value,
+    rules,
+    path
+  } = _ref;
+
+  if (rules.required && !value) {
+    throw new ValidationError(rules.message || `${path} is required`);
+  }
+}
+
+function validateEnumCheck(_ref2) {
+  let {
+    value,
+    rules,
+    path
+  } = _ref2;
+
+  if (rules.enum && !rules.enum.includes(value)) {
+    throw new ValidationError(`${path} must be one of: ${rules.enum.join(', ')}`);
+  }
+}
+
+export const validateSchema = (schema, data) => {
+  const validate = function (schemaObj, dataObj) {
+    let path = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '';
+    // Check if all schema keys exist in data
+    validateSchemaKeys(schemaObj, dataObj); // Validate each field
+
+    Object.entries(schemaObj).forEach(_ref3 => {
+      let [field, rules] = _ref3;
+      const value = dataObj[field];
+      const fieldPath = path ? `${path}.${field}` : field;
+      validateRequiredCheck({
+        value,
+        rules,
+        path: fieldPath
+      });
+
+      if (value !== null && value !== undefined) {
+        // Enum validation
+        validateEnumCheck({
+          value,
+          rules,
+          path: fieldPath
+        }); // Nested object validation
+
+        if (rules.type === 'object' && rules.schema) {
+          validate(rules.schema, value, fieldPath);
+        }
+      }
+    });
+    return dataObj;
+  };
+
+  return validate(schema, data);
+};

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

@@ -0,0 +1,23 @@
+import { validateSchema } from '../../../core/utils';
+import { ActorSchema } from '../../schema';
+export default class Actor {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema(ActorSchema, data);
+    this.data = {
+      name: validatedData.name,
+      type: validatedData.type,
+      photoURL: validatedData.photoURL,
+      extId: validatedData.extId,
+      id: validatedData.id,
+      email: validatedData.email,
+      botType: validatedData.botType
+    };
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

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

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

package/es/domain/entities/Agent/Agent.js

@@ -1,110 +1,21 @@
-import ValidationError from '../../errors/ValidationError';
-import ActorType from '../Actor/ActorType';
+import { validateSchema } from '../../../core/utils';
+import { AgentSchema } from '../../schema';
 export default class Agent {
   constructor() {
-    let {
-      id = '',
-      name = '',
-      email = '',
-      photoURL = '',
-      zuid = '',
-      type = ''
-    } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    this.validateFields({
-      id,
-      email,
-      name,
-      zuid
-    });
-    this._id = id;
-    this._name = name;
-    this._email = email;
-    this._photoURL = photoURL;
-    this._zuid = zuid;
-    this.setType(type);
-  }
-
-  validateFields(_ref) {
-    let {
-      id,
-      email,
-      name,
-      zuid
-    } = _ref;
-    this.validateId(id);
-    this.validateEmail(email);
-    this.validateName(name);
-    this.validateZuid(zuid);
-  }
-
-  static validateId(id) {
-    if (!id) {
-      throw new ValidationError('Agent ID is required');
-    }
-  }
-
-  static validateEmail(email) {
-    if (!email) {
-      throw new ValidationError('Agent email is required');
-    }
-  }
-
-  static validateName(name) {
-    if (!name) {
-      throw new ValidationError('Agent name is required');
-    }
-  }
-
-  static validateZuid(zuid) {
-    if (!zuid) {
-      throw new ValidationError('Agent zuid is required');
-    }
-  }
-
-  static validateType(type) {
-    return type === ActorType.AGENT;
-  }
-
-  setType(type) {
-    if (!Agent.validateType(type)) {
-      throw new Error('Invalid actor type. Must be AGENT');
-    }
-
-    this._type = type;
-  }
-
-  get id() {
-    return this._id;
-  }
-
-  get name() {
-    return this._name;
-  }
-
-  get email() {
-    return this._email;
-  }
-
-  get photoURL() {
-    return this._photoURL;
-  }
-
-  get zuid() {
-    return this._zuid;
-  }
-
-  get type() {
-    return this._type;
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema(AgentSchema, data);
+    this.data = {
+      id: validatedData.id,
+      name: validatedData.name,
+      email: validatedData.email,
+      photoURL: validatedData.photoURL || '',
+      zuid: validatedData.zuid,
+      type: validatedData.type
+    };
   }
 
   toJSON() {
-    return {
-      id: this._id,
-      name: this._name,
-      email: this._email,
-      photoURL: this._photoURL,
-      zuid: this._zuid,
-      type: this._type
+    return { ...this.data
     };
   }
 

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

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

package/es/domain/entities/Bot/Bot.js

@@ -0,0 +1,23 @@
+import { validateSchema } from '../../../core/utils';
+import { BotSchema } from '../../schema';
+export default class Bot {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema(BotSchema, data);
+    this.data = {
+      id: validatedData.id,
+      botServiceType: validatedData.botService,
+      name: validatedData.name,
+      isActive: validatedData.isActive,
+      createdTime: validatedData.createdTime,
+      logoURL: validatedData.logoURL,
+      createdBy: validatedData.createdBy
+    };
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

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

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

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

@@ -0,0 +1,36 @@
+import { validateSchema } from '../../../core/utils';
+import { SessionSchema } from '../../schema';
+import { Actor } from '../Actor';
+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,
+      channel: validatedData.channel
+    };
+  }
+
+  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/index.js

@@ -1,2 +1,4 @@
 export * from './Actor';
-export * from './Agent';
+export * from './Agent';
+export * from './Session';
+export * from './Bot';

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

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

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

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

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

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

package/es/domain/enum/index.js

@@ -0,0 +1,4 @@
+export * from './integrationServices';
+export * from './session';
+export * from './actor';
+export * from './bot';

package/es/domain/enum/integrationServices/IntegrationServices.js

@@ -0,0 +1,11 @@
+const IntegrationServices = {
+  TWILIO: 'TWILIO',
+  WHATSAPP: 'WHATSAPP',
+  TELEGRAM: 'TELEGRAM',
+  WECHAT: 'WECHAT',
+  LINE: 'LINE',
+  IM_TALK: 'IM_TALK',
+  FACEBOOKMESSENGER: 'FACEBOOKMESSENGER',
+  INSTAGRAM: 'INSTAGRAM'
+};
+export default IntegrationServices;

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

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

package/es/domain/enum/session/SessionReplyStatus.js

@@ -0,0 +1,20 @@
+const SessionReplyStatus = {
+  ACCEPTED: 'ACCEPTED',
+  CHANNEL_INACTIVE: 'CHANNEL_INACTIVE',
+  CHANNEL_REVOKED: 'CHANNEL_REVOKED',
+  SESSION_ENDED: 'SESSION_ENDED',
+  SESSION_BLOCKED: 'SESSION_BLOCKED',
+  SESSION_EXPIRED: 'SESSION_EXPIRED',
+  UNASSIGNED: 'UNASSIGNED',
+  NOT_AN_ASSIGNEE: 'NOT_AN_ASSIGNEE',
+  CREDIT_EXHAUSTED: 'CREDIT_EXHAUSTED',
+  ACCESSTOKEN_EXPIRED: 'ACCESSTOKEN_EXPIRED',
+  PERMISSION_REVOKED: 'PERMISSION_REVOKED',
+  UNEXPECTED_ERROR: 'UNEXPECTED_ERROR',
+  PAGE_REMOVED: 'PAGE_REMOVED',
+  SANDBOX_LIMIT_REACHED: 'SANDBOX_LIMIT_REACHED',
+  CHANNEL_DELETED: 'CHANNEL_DELETED',
+  ENDUSER_OFFLINE: 'ENDUSER_OFFLINE',
+  CONFIG_SKIPPED_CHANNEL: 'CONFIG_SKIPPED_CHANNEL'
+};
+export default SessionReplyStatus;

package/es/domain/enum/session/SessionStatus.js

@@ -0,0 +1,9 @@
+const SessionStatus = {
+  CREATED: 'CREATED',
+  OPEN: 'OPEN',
+  ON_PROGRESS: 'ON_PROGRESS',
+  ON_HOLD: 'ON_HOLD',
+  ENDED: 'ENDED',
+  BLOCKED: 'BLOCKED'
+};
+export default SessionStatus;

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

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

package/es/domain/interfaces/BaseAPI.js

@@ -0,0 +1,63 @@
+import { configRegistry } from '../../infrastructure/sdk/config';
+export default class BaseAPI {
+  constructor() {
+    this.httpClient = configRegistry.getHttpClient();
+    this.baseURL = configRegistry.getBaseURL();
+  }
+
+  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 _url = `${this.baseURL}${this.replacePathParams(url, params)}`;
+    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 new URLSearchParams(filteredQuery).toString();
+  }
+
+  async request(_ref5) {
+    let {
+      urlConfig,
+      request
+    } = _ref5;
+    const url = this.buildUrl({
+      url: urlConfig.url,
+      params: request.params,
+      query: request.query
+    });
+    const httpRequest = await this.httpClient.request({
+      url,
+      method: urlConfig.method,
+      header: urlConfig.header
+    });
+    return httpRequest;
+  }
+
+}

package/es/domain/interfaces/bots/IBot.js

@@ -0,0 +1,10 @@
+import { GetBotsRequest } from '../../../infrastructure/interfaces/api';
+import BaseAPI from '../BaseAPI';
+export default class IBot extends BaseAPI {
+  // eslint-disable-next-line no-unused-vars
+  async getBots() {
+    let request = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : GetBotsRequest;
+    throw new Error('Method not implemented');
+  }
+
+}

package/es/domain/interfaces/bots/index.js

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

package/es/domain/interfaces/channels/IChannelAgent.js

@@ -1,5 +1,9 @@
-export default class IChannelAgent {
-  static getChannelAgents() {
+import { GetChannelAgentsRequest } from '../../../infrastructure/interfaces/api';
+import BaseAPI from '../BaseAPI';
+export default class IChannelAgent extends BaseAPI {
+  // eslint-disable-next-line no-unused-vars
+  getAgents() {
+    let request = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : GetChannelAgentsRequest;
     throw new Error('Method not implemented.');
   }
 

package/es/domain/interfaces/index.js

@@ -1 +1,3 @@
-export * from './channels';
+export * from './channels';
+export * from './sessions';
+export * from './bots';

package/es/domain/interfaces/sessions/ISession.js

@@ -0,0 +1,10 @@
+import { UpdateSessionAssigneeRequest } from '../../../infrastructure/interfaces/api';
+import BaseAPI from '../BaseAPI';
+export default class ISession extends BaseAPI {
+  // eslint-disable-next-line no-unused-vars
+  updateAssignee() {
+    let request = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : UpdateSessionAssigneeRequest;
+    throw new Error('Method not implemented.');
+  }
+
+}

package/es/domain/interfaces/sessions/index.js

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

package/es/domain/schema/actor/ActorSchema.js

@@ -0,0 +1,33 @@
+import { ActorType } from '../../enum';
+const ActorSchema = {
+  name: {
+    type: 'string',
+    required: true
+  },
+  type: {
+    type: 'string',
+    required: true,
+    enum: Object.values(ActorType)
+  },
+  photoURL: {
+    type: 'string',
+    required: false
+  },
+  extId: {
+    type: 'string',
+    required: false
+  },
+  id: {
+    type: 'string',
+    required: true
+  },
+  email: {
+    type: 'string',
+    required: false
+  },
+  botType: {
+    type: 'string',
+    required: false
+  }
+};
+export default ActorSchema;

package/es/domain/schema/actor/AgentSchema.js

@@ -0,0 +1,29 @@
+import { ActorType } from '../../enum';
+const AgentSchema = {
+  id: {
+    type: 'string',
+    required: true
+  },
+  name: {
+    type: 'string',
+    required: true
+  },
+  email: {
+    type: 'string',
+    required: true
+  },
+  photoURL: {
+    type: 'string',
+    required: false
+  },
+  zuid: {
+    type: 'string',
+    required: true
+  },
+  type: {
+    type: 'string',
+    required: true,
+    enum: [ActorType.AGENT]
+  }
+};
+export default AgentSchema;

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

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