@zohoim/client-sdk 1.0.0-canned05 → 1.0.0-canned08

package/es/application/services/cannedMessages/CannedMessageService.js

@@ -48,6 +48,10 @@ export default class CannedMessageService extends ICannedMessageRepository {
     return this.cannedMessageRepository.deleteTranslation(request);
   }
 
+  async getCannedPlaceholders(request) {
+    return this.cannedMessageRepository.getCannedPlaceholders(request);
+  }
+
   toJSON() {
     return {
       getCannedMessages: this.getCannedMessages.bind(this),
@@ -59,7 +63,8 @@ export default class CannedMessageService extends ICannedMessageRepository {
       disableCannedMessage: this.disableCannedMessage.bind(this),
       addTranslation: this.addTranslation.bind(this),
       updateTranslation: this.updateTranslation.bind(this),
-      deleteTranslation: this.deleteTranslation.bind(this)
+      deleteTranslation: this.deleteTranslation.bind(this),
+      getCannedPlaceholders: this.getCannedPlaceholders.bind(this)
     };
   }
 

package/es/domain/dto/cannedMessages/getCannedPlaceholdersRequest.js

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

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

@@ -7,4 +7,5 @@ export { default as disableCannedMessageRequest } from './disableCannedMessageRe
 export { default as updateCannedMessageRequest } from './updateCannedMessageRequest';
 export { default as addTranslationRequest } from './addTranslationRequest';
 export { default as updateTranslationRequest } from './updateTranslationRequest';
-export { default as deleteTranslationRequest } from './deleteTranslationRequest';
+export { default as deleteTranslationRequest } from './deleteTranslationRequest';
+export { default as getCannedPlaceholdersRequest } from './getCannedPlaceholdersRequest';

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

@@ -9,7 +9,7 @@ export default class CannedMessage {
     const validatedData = validateSchema({
       schema: CannedMessageSchema,
       data,
-      entityName: 'CannedMessage'
+      entityName: `CannedMessage${data?.id ? `_${data.id}` : ''}`
     });
     let {
       createdBy,

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

@@ -1,13 +1,32 @@
 import { validateSchema } from '../../../core/utils';
 import TranslationsSchema from '../../schema/cannedMessage/TranslationsSchema';
+import { TemplateItemButton, TemplateItemHeader, TemplateItemFooter } from '../TemplateMessage';
 export default class Translation {
   constructor() {
     let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     const validatedData = validateSchema({
       schema: TranslationsSchema,
       data,
-      entityName: 'Translation'
+      entityName: `Translation${data?.id ? `_${data.id}` : ''}`
     });
+    const {
+      templateItems
+    } = validatedData;
+    let adaptedTemplateItems = null;
+
+    if (templateItems) {
+      const {
+        header,
+        footer,
+        buttons
+      } = templateItems;
+      adaptedTemplateItems = {
+        header: header ? new TemplateItemHeader(header).toJSON() : null,
+        footer: footer ? new TemplateItemFooter(footer).toJSON() : null,
+        buttons: Array.isArray(buttons) ? buttons.map(btn => new TemplateItemButton(btn).toJSON()) : null
+      };
+    }
+
     this.data = {
       id: validatedData.id,
       language: validatedData.language,
@@ -17,7 +36,7 @@ export default class Translation {
       status: validatedData.status,
       modifiedTime: validatedData.modifiedTime,
       failedReason: validatedData.failedReason,
-      templateItems: validatedData.templateItems
+      templateItems: adaptedTemplateItems
     };
   }
 

package/es/domain/entities/Placeholder/Placeholder.js

@@ -0,0 +1,24 @@
+import { validateSchema } from '../../../core/utils';
+import { PlaceholderSchema } from '../../schema/placeholder';
+export default class Placeholder {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema({
+      schema: PlaceholderSchema,
+      data,
+      entityName: 'Placeholder'
+    });
+    this.data = {
+      apiName: validatedData.apiName,
+      i18nFieldLabel: validatedData.i18nFieldLabel,
+      fieldLabel: validatedData.fieldLabel,
+      placeHolder: validatedData.placeHolder
+    };
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

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

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

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

@@ -0,0 +1,48 @@
+import { validateSchema } from '../../../core/utils';
+import { TemplateItemButtonType } from '../../enum';
+import { TemplateItemButtonsSchema } from '../../schema';
+export default class TemplateItemButton {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema({
+      schema: TemplateItemButtonsSchema,
+      data,
+      entityName: 'TemplateItemButton'
+    });
+    this.data = {
+      type: validatedData.type,
+      message: validatedData.message,
+      action: validatedData.action
+    };
+  }
+
+  static isPhoneNumber(type) {
+    return type === TemplateItemButtonType.PHONE_NUMBER;
+  }
+
+  static isURL(type) {
+    return type === TemplateItemButtonType.URL;
+  }
+
+  static isCallToAction(type) {
+    return TemplateItemButton.isPhoneNumber(type) || TemplateItemButton.isURL(type);
+  }
+
+  static isQuickReply(type) {
+    return type === TemplateItemButtonType.QUICK_REPLY;
+  }
+
+  static isOTP(type) {
+    return type === TemplateItemButtonType.OTP;
+  }
+
+  static isCatalog(type) {
+    return type === TemplateItemButtonType.CATALOG;
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

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

@@ -0,0 +1,27 @@
+import { validateSchema } from '../../../core/utils';
+import { TemplateItemFooterType } from '../../enum';
+import { TemplateItemFooterSchema } from '../../schema';
+export default class TemplateItemFooter {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema({
+      schema: TemplateItemFooterSchema,
+      data,
+      entityName: 'TemplateItemFooter'
+    });
+    this.data = {
+      type: validatedData.type,
+      message: validatedData.message
+    };
+  }
+
+  static isText(type) {
+    return type === TemplateItemFooterType.TEXT;
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

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

@@ -0,0 +1,48 @@
+import { validateSchema } from '../../../core/utils';
+import { TemplateItemHeaderType } from '../../enum';
+import { TemplateItemHeaderSchema } from '../../schema';
+export default class TemplateItemHeader {
+  constructor() {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const validatedData = validateSchema({
+      schema: TemplateItemHeaderSchema,
+      data,
+      entityName: 'TemplateItemHeader'
+    });
+    this.data = {
+      type: validatedData.type,
+      message: validatedData.message,
+      attachment: validatedData.attachment
+    };
+  }
+
+  static isNone(type) {
+    return type === TemplateItemHeaderType.NONE;
+  }
+
+  static isText(type) {
+    return type === TemplateItemHeaderType.TEXT;
+  }
+
+  static isImage(type) {
+    return type === TemplateItemHeaderType.IMAGE;
+  }
+
+  static isVideo(type) {
+    return type === TemplateItemHeaderType.VIDEO;
+  }
+
+  static isDocument(type) {
+    return type === TemplateItemHeaderType.DOCUMENT;
+  }
+
+  static isMedia(type) {
+    return TemplateItemHeader.isImage(type) || TemplateItemHeader.isVideo(type) || TemplateItemHeader.isDocument(type);
+  }
+
+  toJSON() {
+    return { ...this.data
+    };
+  }
+
+}

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

@@ -1,3 +1,6 @@
 import TemplateLanguage from './TemplateLanguage';
 import TemplateCreditExhaustStatus from './TemplateCreditExhaustStatus';
-export { TemplateLanguage, TemplateCreditExhaustStatus };
+import TemplateItemButton from './TemplateItemButton';
+import TemplateItemHeader from './TemplateItemHeader';
+import TemplateItemFooter from './TemplateItemFooter';
+export { TemplateLanguage, TemplateCreditExhaustStatus, TemplateItemButton, TemplateItemHeader, TemplateItemFooter };

package/es/domain/entities/index.js

@@ -9,4 +9,5 @@ export * from './Contact';
 export * from './IntegrationService';
 export * from './CannedMessage';
 export * from './TemplateMessage';
-export * from './CustomReplyExtension';
+export * from './CustomReplyExtension';
+export * from './Placeholder';

package/es/domain/enum/cannedMessage/TemplateItemButtonType.js

@@ -6,6 +6,7 @@ const TemplateItemButtonType = {
   CATALOG: 'CATALOG',
   MPM: 'MPM',
   CALL_PERMISSION_REQUEST: 'CALL_PERMISSION_REQUEST',
-  VOICE_CALL: 'VOICE_CALL'
+  VOICE_CALL: 'VOICE_CALL',
+  NONE: 'NONE'
 };
 export default TemplateItemButtonType;

package/es/domain/enum/cannedMessage/TemplateItemHeaderType.js

@@ -1,6 +1,8 @@
 const TemplateItemHeaderType = {
-  IMAGE: 'IMAGE',
+  NONE: 'NONE',
   TEXT: 'TEXT',
+  MEDIA: 'MEDIA',
+  IMAGE: 'IMAGE',
   VIDEO: 'VIDEO',
   DOCUMENT: 'DOCUMENT'
 };

package/es/domain/interfaces/repositories/cannedMessages/ICannedMessageRepository.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-unused-vars */
 import { ModuleNames } from '../../../../core/constants';
 import BaseAPI from '../../../../infrastructure/api/BaseAPI';
-import { getCannedMessageRequest, getCannedMessagesRequest, createCannedMessageRequest, updateCannedMessageRequest, deleteCannedMessageRequest, disableCannedMessageRequest, enableCannedMessageRequest, addTranslationRequest, updateTranslationRequest, deleteTranslationRequest } from '../../../dto';
+import { getCannedMessageRequest, getCannedMessagesRequest, createCannedMessageRequest, updateCannedMessageRequest, deleteCannedMessageRequest, disableCannedMessageRequest, enableCannedMessageRequest, addTranslationRequest, updateTranslationRequest, deleteTranslationRequest, getCannedPlaceholdersRequest } from '../../../dto';
 export default class ICannedMessageRepository extends BaseAPI {
   constructor() {
     super({
@@ -59,4 +59,9 @@ export default class ICannedMessageRepository extends BaseAPI {
     throw new Error('Method not implemented.');
   }
 
+  getCannedPlaceholders() {
+    let request = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : getCannedPlaceholdersRequest();
+    throw new Error('Method not implemented.');
+  }
+
 }

package/es/domain/schema/cannedMessage/TemplateItem/TemplateItemButtonsSchema.js

@@ -11,7 +11,7 @@ const TemplateItemButtonsSchema = {
   },
   action: {
     type: 'string',
-    required: true
+    required: false
   }
 };
 export default TemplateItemButtonsSchema;

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

@@ -1,3 +1,4 @@
 import CannedMessageSchema from './CannedMessageSchema';
 import TranslationsSchema from './TranslationsSchema';
+export * from './TemplateItem';
 export { CannedMessageSchema, TranslationsSchema };

package/es/domain/schema/index.js

@@ -8,4 +8,5 @@ export * from './integrationService';
 export * from './contact';
 export * from './cannedMessage';
 export * from './templateMessage';
-export * from './customReplyExtension';
+export * from './customReplyExtension';
+export * from './placeholder';

package/es/domain/schema/placeholder/PlaceholderSchema.js

@@ -0,0 +1,19 @@
+const PlaceholderSchema = {
+  apiName: {
+    type: 'string',
+    required: false
+  },
+  i18nFieldLabel: {
+    type: 'string',
+    required: true
+  },
+  fieldLabel: {
+    type: 'string',
+    required: true
+  },
+  placeHolder: {
+    type: 'string',
+    required: true
+  }
+};
+export default PlaceholderSchema;

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

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

package/es/infrastructure/adapters/cannedMessages/CannedMessageAdapter.js

@@ -1,5 +1,5 @@
 import { AdapterError } from '../../../core/errors';
-import { CannedMessage } from '../../../domain/entities';
+import { CannedMessage, Translation } from '../../../domain/entities';
 import { IAdapter } from '../../../domain/interfaces';
 export default class CannedMessageAdapter extends IAdapter {
   adapt(cannedMessageData) {
@@ -8,6 +8,7 @@ export default class CannedMessageAdapter extends IAdapter {
     }
 
     try {
+      const translations = Array.isArray(cannedMessageData.translations) ? cannedMessageData.translations.map(translation => new Translation(translation).toJSON()) : cannedMessageData.translations;
       return new CannedMessage({
         id: cannedMessageData.id,
         title: cannedMessageData.title,
@@ -19,7 +20,7 @@ export default class CannedMessageAdapter extends IAdapter {
         createdBy: cannedMessageData.createdBy,
         isActive: cannedMessageData.isActive,
         isPrivate: cannedMessageData.isPrivate,
-        translations: cannedMessageData.translations,
+        translations,
         uuid: cannedMessageData.uuid,
         meta: cannedMessageData.meta,
         rejectedReason: cannedMessageData.rejectedReason,

package/es/infrastructure/adapters/cannedMessages/TranslationAdapter.js

@@ -0,0 +1,27 @@
+import { AdapterError } from '../../../core/errors';
+import { Translation } from '../../../domain/entities';
+import { IAdapter } from '../../../domain/interfaces';
+export default class TranslationAdapter extends IAdapter {
+  adapt(translationData) {
+    if (!translationData) {
+      throw new AdapterError('Translation data is required');
+    }
+
+    try {
+      return new Translation({
+        id: translationData.id,
+        language: translationData.language,
+        message: translationData.message,
+        displayMessage: translationData.displayMessage,
+        uuid: translationData.uuid,
+        status: translationData.status,
+        modifiedTime: translationData.modifiedTime,
+        failedReason: translationData.failedReason,
+        templateItems: translationData.templateItems
+      }).toJSON();
+    } catch (error) {
+      throw new AdapterError(`Failed to adapt translation: ${error.message}`);
+    }
+  }
+
+}

package/es/infrastructure/adapters/cannedMessages/index.js

@@ -1,2 +1,3 @@
 import CannedMessageAdapter from './CannedMessageAdapter';
-export { CannedMessageAdapter };
+import TranslationAdapter from './TranslationAdapter';
+export { CannedMessageAdapter, TranslationAdapter };

package/es/infrastructure/adapters/index.js

@@ -7,4 +7,5 @@ export * from './agents';
 export * from './contacts';
 export * from './cannedMessages';
 export * from './templateMessages';
-export * from './customReplyExtension';
+export * from './customReplyExtension';
+export * from './placeholders';

package/es/infrastructure/adapters/placeholders/PlaceholderAdapter.js

@@ -0,0 +1,22 @@
+import { AdapterError } from '../../../core/errors';
+import { Placeholder } from '../../../domain/entities/Placeholder';
+import { IAdapter } from '../../../domain/interfaces';
+export default class PlaceholderAdapter extends IAdapter {
+  adapt(placeholderData) {
+    if (!placeholderData) {
+      throw new AdapterError('Placeholder data is required');
+    }
+
+    try {
+      return new Placeholder({
+        apiName: placeholderData.apiName,
+        i18nFieldLabel: placeholderData.i18nFieldLabel,
+        fieldLabel: placeholderData.fieldLabel,
+        placeHolder: placeholderData.placeHolder
+      }).toJSON();
+    } catch (error) {
+      throw new AdapterError(`Failed to adapt placeholder: ${error.message}`);
+    }
+  }
+
+}

package/es/infrastructure/adapters/placeholders/index.js

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

package/es/infrastructure/api/cannedMessages/CannedMessageAPI.js

@@ -1,4 +1,4 @@
-import { getCannedMessageRequest, getCannedMessagesRequest, createCannedMessageRequest, updateCannedMessageRequest, deleteCannedMessageRequest, enableCannedMessageRequest, disableCannedMessageRequest, addTranslationRequest, updateTranslationRequest, deleteTranslationRequest } from '../../../domain/dto';
+import { getCannedMessageRequest, getCannedMessagesRequest, createCannedMessageRequest, updateCannedMessageRequest, deleteCannedMessageRequest, enableCannedMessageRequest, disableCannedMessageRequest, addTranslationRequest, updateTranslationRequest, deleteTranslationRequest, getCannedPlaceholdersRequest } from '../../../domain/dto';
 import { ICannedMessageRepository } from '../../../domain/interfaces/repositories';
 export default class CannedMessageAPI extends ICannedMessageRepository {
   async getCannedMessages() {
@@ -101,4 +101,14 @@ export default class CannedMessageAPI extends ICannedMessageRepository {
     return httpRequest;
   }
 
+  async getCannedPlaceholders() {
+    let request = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : getCannedPlaceholdersRequest();
+    const operation = 'getCannedPlaceholders';
+    const httpRequest = await this.request({
+      operation,
+      request
+    });
+    return httpRequest;
+  }
+
 }

package/es/infrastructure/api/registry/cannedMessages/cannedMessageAPIRegistry.js

@@ -1,5 +1,5 @@
 import { HTTP_METHODS } from '../../../../core/constants';
-import { getCannedMessageRequest, getCannedMessagesRequest, createCannedMessageRequest, updateCannedMessageRequest, deleteCannedMessageRequest, enableCannedMessageRequest, disableCannedMessageRequest, addTranslationRequest, updateTranslationRequest, deleteTranslationRequest } from '../../../../domain/dto';
+import { getCannedMessageRequest, getCannedMessagesRequest, createCannedMessageRequest, updateCannedMessageRequest, deleteCannedMessageRequest, enableCannedMessageRequest, disableCannedMessageRequest, addTranslationRequest, updateTranslationRequest, deleteTranslationRequest, getCannedPlaceholdersRequest } from '../../../../domain/dto';
 import constructCannedMessageEndPoint from './constructCannedMessageEndPoint';
 import createAPIRegistry from '../createAPIRegistry';
 
@@ -43,6 +43,10 @@ function deleteTranslation() {
   return createAPIRegistry(constructCannedMessageEndPoint('/:cannedMessageId/translations/:translationId'), HTTP_METHODS.DELETE, deleteTranslationRequest());
 }
 
+function getCannedPlaceholders() {
+  return createAPIRegistry(constructCannedMessageEndPoint('/placeholders'), HTTP_METHODS.GET, getCannedPlaceholdersRequest());
+}
+
 export default {
   getCannedMessage,
   getCannedMessages,
@@ -53,5 +57,6 @@ export default {
   disableCannedMessage,
   addTranslation,
   updateTranslation,
-  deleteTranslation
+  deleteTranslation,
+  getCannedPlaceholders
 };

package/es/infrastructure/repositories/cannedMessages/CannedMessageRepository.js

@@ -1,4 +1,4 @@
-import { CannedMessageAdapter } from '../../adapters';
+import { CannedMessageAdapter, PlaceholderAdapter, TranslationAdapter } from '../../adapters';
 import { CannedMessageAPI } from '../../api';
 import { ICannedMessageRepository } from '../../../domain/interfaces/repositories/cannedMessages';
 import { ResponseTypes } from '../../../core/constants';
@@ -6,13 +6,16 @@ export default class CannedMessageRepository extends ICannedMessageRepository {
   constructor(_ref) {
     let {
       cannedMessageAPI,
-      cannedMessageAdapter
+      cannedMessageAdapter,
+      placeholderAdapter
     } = _ref;
     super();
     this.defaultAPI = new CannedMessageAPI();
     this.customAPI = cannedMessageAPI;
     this.cannedMessageAPI = this.createAPIProxy(this.customAPI, this.defaultAPI);
     this.cannedMessageAdapter = cannedMessageAdapter || new CannedMessageAdapter();
+    this.translationAdapter = new TranslationAdapter();
+    this.placeholderAdapter = placeholderAdapter || new PlaceholderAdapter();
   }
 
   async invokeAPI(_ref2) {
@@ -88,14 +91,16 @@ export default class CannedMessageRepository extends ICannedMessageRepository {
   async addTranslation(request) {
     return this.invokeAPI({
       operation: 'addTranslation',
-      request
+      request,
+      adapter: this.translationAdapter
     });
   }
 
   async updateTranslation(request) {
     return this.invokeAPI({
       operation: 'updateTranslation',
-      request
+      request,
+      adapter: this.translationAdapter
     });
   }
 
@@ -107,6 +112,15 @@ export default class CannedMessageRepository extends ICannedMessageRepository {
     });
   }
 
+  async getCannedPlaceholders(request) {
+    return this.invokeAPI({
+      operation: 'getCannedPlaceholders',
+      request,
+      adapter: this.placeholderAdapter,
+      responseType: ResponseTypes.LIST
+    });
+  }
+
   toJSON() {
     return {
       getCannedMessages: this.getCannedMessages.bind(this),
@@ -118,7 +132,8 @@ export default class CannedMessageRepository extends ICannedMessageRepository {
       disableCannedMessage: this.disableCannedMessage.bind(this),
       addTranslation: this.addTranslation.bind(this),
       updateTranslation: this.updateTranslation.bind(this),
-      deleteTranslation: this.deleteTranslation.bind(this)
+      deleteTranslation: this.deleteTranslation.bind(this),
+      getCannedPlaceholders: this.getCannedPlaceholders.bind(this)
     };
   }
 

package/package.json

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