@zohoim/client-sdk 1.0.0-poc9 → 1.0.0-poc90

package/es/domain/interfaces/repositories/sessions/ISessionRepository.js

@@ -0,0 +1,52 @@
+/* eslint-disable no-unused-vars */
+import { ModuleNames } from "../../../../core/constants";
+import BaseAPI from "../../../../infrastructure/api/BaseAPI";
+import { updateSessionAssigneeRequest, getSessionsRequest, getSessionRequest, getSessionAttachmentsRequest, getSessionLastMessagesRequest, markSessionAsReadRequest, updateSessionStatusRequest, pickupSessionRequest } from "../../../dto";
+export default class ISessionRepository extends BaseAPI {
+  constructor() {
+    super({
+      module: ModuleNames.SESSIONS
+    });
+  }
+
+  pickupSession() {
+    let request = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : pickupSessionRequest();
+    throw new Error('Method not implemented.');
+  }
+
+  updateAssignee() {
+    let request = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : updateSessionAssigneeRequest();
+    throw new Error('Method not implemented.');
+  }
+
+  getSessions() {
+    let request = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : getSessionsRequest();
+    throw new Error('Method not implemented.');
+  }
+
+  getSession() {
+    let request = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : getSessionRequest();
+    throw new Error('Method not implemented.');
+  }
+
+  getSessionAttachments() {
+    let request = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : getSessionAttachmentsRequest();
+    throw new Error('Method not implemented.');
+  }
+
+  getSessionLastMessages() {
+    let request = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : getSessionLastMessagesRequest();
+    throw new Error('Method not implemented.');
+  }
+
+  markSessionAsRead() {
+    let request = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : markSessionAsReadRequest();
+    throw new Error('Method not implemented.');
+  }
+
+  updateSessionStatus() {
+    let request = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : updateSessionStatusRequest();
+    throw new Error('Method not implemented.');
+  }
+
+}

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

@@ -0,0 +1,2 @@
+import ISessionRepository from "./ISessionRepository";
+export { ISessionRepository };

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

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

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

@@ -0,0 +1,45 @@
+import { ActorType } from "../../enum";
+const AgentSchema = {
+  id: {
+    type: 'string',
+    required: true
+  },
+  firstName: {
+    type: 'string',
+    required: false
+  },
+  lastName: {
+    type: 'string',
+    required: false
+  },
+  name: {
+    type: 'string',
+    required: false
+  },
+  email: {
+    type: 'string',
+    required: true
+  },
+  photoURL: {
+    type: 'string',
+    required: false
+  },
+  zuid: {
+    type: 'string',
+    required: true
+  },
+  role: {
+    type: 'string',
+    required: false
+  },
+  status: {
+    type: 'string',
+    required: false
+  },
+  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 };

package/es/domain/schema/attachment/AttachmentSchema.js

@@ -0,0 +1,33 @@
+import { AttachmentStatus } from "../../enum";
+const AttachmentSchema = {
+  id: {
+    type: 'string',
+    required: true
+  },
+  name: {
+    type: 'string',
+    required: true
+  },
+  type: {
+    type: 'string',
+    required: true
+  },
+  createdTime: {
+    type: 'string',
+    required: false
+  },
+  size: {
+    type: 'number',
+    required: true
+  },
+  url: {
+    type: 'string',
+    required: false
+  },
+  status: {
+    type: 'string',
+    required: false,
+    enum: Object.values(AttachmentStatus)
+  }
+};
+export default AttachmentSchema;

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

@@ -0,0 +1,2 @@
+import AttachmentSchema from "./AttachmentSchema";
+export { AttachmentSchema };

package/es/domain/schema/bot/BotSchema.js

@@ -0,0 +1,33 @@
+import { BotServiceType } from "../../enum";
+const BotSchema = {
+  id: {
+    type: 'string',
+    required: true
+  },
+  botServiceType: {
+    type: 'string',
+    required: true,
+    enum: [BotServiceType.DESK_GC_BOT, BotServiceType.DESK_ZIA_BOT, BotServiceType.ZOHO_GC_BOT, BotServiceType.ZOHO_ZIA_BOT]
+  },
+  name: {
+    type: 'string',
+    required: true
+  },
+  isActive: {
+    type: 'boolean',
+    required: true
+  },
+  createdTime: {
+    type: 'string',
+    required: true
+  },
+  photoURL: {
+    type: 'string',
+    required: false
+  },
+  createdBy: {
+    type: 'string',
+    required: true
+  }
+};
+export default BotSchema;

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

@@ -0,0 +1,2 @@
+import BotSchema from "./BotSchema";
+export { BotSchema };

package/es/domain/schema/channel/ChannelSchema.js

@@ -0,0 +1,49 @@
+import { IntegrationServiceSchema } from "../integrationService";
+const ChannelSchema = {
+  id: {
+    type: 'string',
+    required: true
+  },
+  integrationService: {
+    type: 'object',
+    required: true,
+    schema: IntegrationServiceSchema
+  },
+  name: {
+    type: 'string',
+    required: true
+  },
+  defaultBotId: {
+    type: 'string',
+    required: false
+  },
+  isActive: {
+    type: 'boolean',
+    required: true
+  },
+  createdTime: {
+    type: 'string',
+    required: true
+  },
+  accountName: {
+    type: 'string',
+    required: false
+  },
+  isSubscribed: {
+    type: 'boolean',
+    required: false
+  },
+  createdBy: {
+    type: 'string',
+    required: false
+  },
+  isOwner: {
+    type: 'boolean',
+    required: false
+  },
+  photoURL: {
+    type: 'string',
+    required: false
+  }
+};
+export default ChannelSchema;

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

@@ -0,0 +1,2 @@
+import ChannelSchema from "./ChannelSchema";
+export { ChannelSchema };

package/es/domain/schema/contact/ContactSchema.js

@@ -0,0 +1,27 @@
+const ContactSchema = {
+  id: {
+    type: 'string',
+    required: true
+  },
+  name: {
+    type: 'string',
+    required: true
+  },
+  email: {
+    type: 'string',
+    required: false
+  },
+  photoURL: {
+    type: 'string',
+    required: false
+  },
+  phone: {
+    type: 'string',
+    required: false
+  },
+  mobile: {
+    type: 'string',
+    required: false
+  }
+};
+export default ContactSchema;

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

@@ -0,0 +1,2 @@
+import ContactSchema from "./ContactSchema";
+export { ContactSchema };

package/es/domain/schema/index.js

@@ -0,0 +1,8 @@
+export * from "./actor";
+export * from "./session";
+export * from "./bot";
+export * from "./attachment";
+export * from "./message";
+export * from "./channel";
+export * from "./integrationService";
+export * from "./contact";

package/es/domain/schema/integrationService/IntegrationServiceSchema.js

@@ -0,0 +1,31 @@
+import { IntegrationServices } from "../../enum";
+const IntegrationServiceSchema = {
+  label: {
+    type: 'string',
+    required: true
+  },
+  id: {
+    type: 'string',
+    required: true,
+    enum: Object.values(IntegrationServices)
+  },
+  provider: {
+    type: 'object',
+    required: true,
+    schema: {
+      name: {
+        type: 'string',
+        required: true
+      },
+      domain: {
+        type: 'string',
+        required: true
+      }
+    }
+  },
+  logoURL: {
+    type: 'string',
+    required: false
+  }
+};
+export default IntegrationServiceSchema;

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

@@ -0,0 +1,2 @@
+import IntegrationServiceSchema from "./IntegrationServiceSchema";
+export { IntegrationServiceSchema };

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

@@ -0,0 +1,18 @@
+import { ActionType, ActionSubType } from "../../enum";
+const ActionSchema = {
+  type: {
+    type: 'string',
+    required: true,
+    enum: Object.values(ActionType)
+  },
+  subType: {
+    type: 'string',
+    required: true,
+    enum: Object.values(ActionSubType)
+  },
+  value: {
+    type: 'string',
+    required: false
+  }
+};
+export default ActionSchema;

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

@@ -0,0 +1,9 @@
+import { ExternalInfoAction } from "../../enum";
+const ExternalInfoSchema = {
+  action: {
+    type: 'string',
+    required: true,
+    enum: Object.values(ExternalInfoAction)
+  }
+};
+export default ExternalInfoSchema;

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

@@ -0,0 +1,24 @@
+import { InfoSessionStatus, InfoAction } from "../../enum";
+import { ActorSchema } from "../actor";
+const InfoSchema = {
+  actor: {
+    type: 'object',
+    required: false,
+    schema: ActorSchema
+  },
+  action: {
+    type: 'string',
+    required: true,
+    enum: Object.values(InfoAction)
+  },
+  sessionStatus: {
+    type: 'string',
+    required: false,
+    enum: Object.values(InfoSessionStatus)
+  },
+  targets: {
+    type: 'array',
+    required: false
+  }
+};
+export default InfoSchema;

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

@@ -0,0 +1,29 @@
+import { InfoTargetType } from "../../enum";
+const InfoTargetSchema = {
+  id: {
+    type: 'string',
+    required: true
+  },
+  email: {
+    type: 'string',
+    required: false
+  },
+  photoURL: {
+    type: 'string',
+    required: false
+  },
+  name: {
+    type: 'string',
+    required: false
+  },
+  isReplyAllowed: {
+    type: 'boolean',
+    required: false
+  },
+  type: {
+    type: 'string',
+    required: true,
+    enum: Object.values(InfoTargetType)
+  }
+};
+export default InfoTargetSchema;

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

@@ -0,0 +1,11 @@
+const LocationSchema = {
+  latitude: {
+    type: 'string',
+    required: false
+  },
+  longitude: {
+    type: 'string',
+    required: false
+  }
+};
+export default LocationSchema;

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

@@ -0,0 +1,112 @@
+import { MessageStatus, MessageTypes, MessageDirection, MessageContentType } from "../../enum/message";
+import { ActorSchema } from "../actor";
+import { AttachmentSchema } from "../attachment";
+import LocationSchema from "./LocationSchema";
+import ActionSchema from "./ActionSchema";
+import ExternalInfoSchema from "./ExternalInfoSchema";
+import InfoSchema from "./InfoSchema";
+const MessageSchema = {
+  id: {
+    type: 'string',
+    required: true
+  },
+  sessionId: {
+    type: 'string',
+    required: true
+  },
+  displayMessage: {
+    type: 'string',
+    required: false
+  },
+  statusUpdatedTime: {
+    type: 'string',
+    required: true
+  },
+  actor: {
+    type: 'object',
+    required: true,
+    schema: ActorSchema
+  },
+  direction: {
+    type: 'string',
+    required: true,
+    enum: Object.values(MessageDirection)
+  },
+  createdTime: {
+    type: 'string',
+    required: true
+  },
+  index: {
+    type: 'string',
+    required: true
+  },
+  replyToMessage: {
+    type: 'object',
+    required: false
+  },
+  status: {
+    type: 'string',
+    required: true,
+    enum: Object.values(MessageStatus)
+  },
+  info: {
+    type: 'object',
+    required: false,
+    schema: InfoSchema
+  },
+  location: {
+    type: 'object',
+    required: false,
+    schema: LocationSchema
+  },
+  externalInfo: {
+    type: 'object',
+    required: false,
+    schema: ExternalInfoSchema
+  },
+  layout: {
+    type: 'object',
+    required: false
+  },
+  action: {
+    type: 'object',
+    required: false,
+    action: ActionSchema
+  },
+  meta: {
+    type: 'array',
+    required: false
+  },
+  contentType: {
+    type: 'string',
+    required: true,
+    enum: Object.values(MessageContentType)
+  },
+  fullContentURL: {
+    type: 'string',
+    required: false
+  },
+  attachment: {
+    type: 'object',
+    required: false,
+    schema: AttachmentSchema
+  },
+  template: {
+    type: 'object',
+    required: false
+  },
+  type: {
+    type: 'string',
+    required: true,
+    enum: Object.values(MessageTypes)
+  },
+  isRead: {
+    type: 'boolean',
+    required: true
+  },
+  article: {
+    type: 'object',
+    required: false
+  }
+};
+export default MessageSchema;

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

@@ -0,0 +1,10 @@
+import { SessionSchema } from "../session";
+import MessageSchema from "./MessageSchema";
+const MessageWithSessionSchema = { ...MessageSchema,
+  session: {
+    type: 'object',
+    required: true,
+    schema: SessionSchema
+  }
+};
+export default MessageWithSessionSchema;

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

@@ -0,0 +1,8 @@
+import MessageSchema from "./MessageSchema";
+import ActionSchema from "./ActionSchema";
+import ExternalInfoSchema from "./ExternalInfoSchema";
+import InfoSchema from "./InfoSchema";
+import LocationSchema from "./LocationSchema";
+import MessageWithSessionSchema from "./MessageWithSessionSchema";
+import InfoTargetSchema from "./InfoTargetSchema";
+export { MessageSchema, ActionSchema, ExternalInfoSchema, InfoSchema, LocationSchema, MessageWithSessionSchema, InfoTargetSchema };

package/es/domain/schema/session/SessionSchema.js

@@ -0,0 +1,82 @@
+import { IntegrationServices, SessionReplyStatus, SessionStatus } from "../../enum";
+import { ActorSchema } from "../actor";
+const SessionSchema = {
+  channelId: {
+    type: 'string',
+    required: true
+  },
+  status: {
+    type: 'string',
+    required: true,
+    enum: Object.values(SessionStatus)
+  },
+  createdTime: {
+    type: 'string',
+    required: true
+  },
+  agentId: {
+    type: 'string',
+    required: false
+  },
+  botId: {
+    type: 'string',
+    required: false
+  },
+  actor: {
+    type: 'object',
+    required: true,
+    schema: ActorSchema
+  },
+  subject: {
+    type: 'string',
+    required: false
+  },
+  messagesCount: {
+    type: 'string',
+    required: true
+  },
+  agentLastActiveTime: {
+    type: 'string',
+    required: true
+  },
+  contactLastActiveTime: {
+    type: 'string',
+    required: true
+  },
+  lastActiveTime: {
+    type: 'string',
+    required: true
+  },
+  unreadMessagesCount: {
+    type: 'string',
+    required: true
+  },
+  integrationServiceId: {
+    type: 'string',
+    required: true,
+    enum: Object.values(IntegrationServices)
+  },
+  replyStatus: {
+    type: 'string',
+    required: true,
+    enum: Object.values(SessionReplyStatus)
+  },
+  id: {
+    type: 'string',
+    required: true
+  },
+  contactId: {
+    type: 'string',
+    required: false
+  },
+  meta: {
+    type: 'array',
+    required: false
+  },
+  assignee: {
+    type: 'object',
+    required: false,
+    schema: ActorSchema
+  }
+};
+export default SessionSchema;

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

@@ -0,0 +1,2 @@
+import SessionSchema from "./SessionSchema";
+export { SessionSchema };