@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

package/sdk/platform/User/UserPlatformApplicationClient.js

@@ -2,6 +2,8 @@ const Paginator = require("../../common/Paginator");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const UserValidator = require("./UserPlatformApplicationValidator");
+const UserModel = require("./UserPlatformModel");
+const { Logger } = require("./../../common/Logger");
 
 class User {
   constructor(config, applicationId) {
@@ -17,10 +19,11 @@ class User {
    *   page. Default value is 10.
    * @param {number} [arg.pageNo] - The page number to navigate through the
    *   given set of results. Default value is 1.
+   * @returns {Promise<CustomerListResponseSchema>} - Success response
    * @summary: Get a list of customers
    * @description: Use this API to retrieve a list of customers who have registered in the application.
    */
-  getCustomers({ q, pageSize, pageNo } = {}) {
+  async getCustomers({ q, pageSize, pageNo } = {}) {
     const { error } = UserValidator.getCustomers().validate(
       {
         q,
@@ -33,28 +36,63 @@ class User {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = UserValidator.getCustomers().validate(
+      {
+        q,
+        pageSize,
+        pageNo,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getCustomers",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["q"] = q;
     query_params["page_size"] = pageSize;
     query_params["page_no"] = pageNo;
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/customers/list`,
       query_params,
       undefined
     );
+
+    const {
+      error: res_error,
+    } = UserModel.CustomerListResponseSchema().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getCustomers",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} [arg.q] - The search query. Mobile number or email ID of
    *   a customer.
+   * @returns {Promise<UserSearchResponseSchema>} - Success response
    * @summary: Search an existing user.
    * @description: Use this API to retrieve an existing user from a list.
    */
-  searchUsers({ q } = {}) {
+  async searchUsers({ q } = {}) {
     const { error } = UserValidator.searchUsers().validate(
       {
         q,
@@ -65,25 +103,58 @@ class User {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = UserValidator.searchUsers().validate(
+      {
+        q,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for searchUsers",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["q"] = q;
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/customers/search`,
       query_params,
       undefined
     );
+
+    const {
+      error: res_error,
+    } = UserModel.UserSearchResponseSchema().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for searchUsers",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {CreateUserRequestSchema} arg.body
+   * @returns {Promise<CreateUserResponseSchema>} - Success response
    * @summary: Create user
    * @description: Create user
    */
-  createUser({ body } = {}) {
+  async createUser({ body } = {}) {
     const { error } = UserValidator.createUser().validate(
       {
         body,
@@ -94,24 +165,57 @@ class User {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = UserValidator.createUser().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for createUser",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/customers`,
       query_params,
       body
     );
+
+    const {
+      error: res_error,
+    } = UserModel.CreateUserResponseSchema().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for createUser",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {BlockUserRequestSchema} arg.body
+   * @returns {Promise<BlockUserSuccess>} - Success response
    * @summary: Block/Unblock user
    * @description: Block/Unblock user
    */
-  blockOrUnblockUsers({ body } = {}) {
+  async blockOrUnblockUsers({ body } = {}) {
     const { error } = UserValidator.blockOrUnblockUsers().validate(
       {
         body,
@@ -122,24 +226,55 @@ class User {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = UserValidator.blockOrUnblockUsers().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for blockOrUnblockUsers",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "put",
       `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/customers/activation`,
       query_params,
       body
     );
+
+    const { error: res_error } = UserModel.BlockUserSuccess().validate(
+      response,
+      { abortEarly: false, allowUnknown: false }
+    );
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for blockOrUnblockUsers",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {ArchiveUserRequestSchema} arg.body
+   * @returns {Promise<ArchiveUserSuccess>} - Success response
    * @summary: archive user
    * @description: archive user
    */
-  archiveUser({ body } = {}) {
+  async archiveUser({ body } = {}) {
     const { error } = UserValidator.archiveUser().validate(
       {
         body,
@@ -150,24 +285,57 @@ class User {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = UserValidator.archiveUser().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for archiveUser",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "put",
       `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/customers/archive`,
       query_params,
       body
     );
+
+    const {
+      error: res_error,
+    } = UserModel.ArchiveUserSuccess().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for archiveUser",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {UnDeleteUserRequestSchema} arg.body
+   * @returns {Promise<UnDeleteUserSuccess>} - Success response
    * @summary: undelete user who deleted from application and have not elapsed the platform configured delete days
    * @description: undelete user who deleted from application and have not elapsed the platform configured delete days
    */
-  unDeleteUser({ body } = {}) {
+  async unDeleteUser({ body } = {}) {
     const { error } = UserValidator.unDeleteUser().validate(
       {
         body,
@@ -178,25 +346,58 @@ class User {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = UserValidator.unDeleteUser().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for unDeleteUser",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "put",
       `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/customers/undelete`,
       query_params,
       body
     );
+
+    const {
+      error: res_error,
+    } = UserModel.UnDeleteUserSuccess().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for unDeleteUser",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.userId - User ID
    * @param {UpdateUserRequestSchema} arg.body
+   * @returns {Promise<CreateUserResponseSchema>} - Success response
    * @summary: Update user
    * @description: Update user
    */
-  updateUser({ userId, body } = {}) {
+  async updateUser({ userId, body } = {}) {
     const { error } = UserValidator.updateUser().validate(
       {
         userId,
@@ -208,24 +409,58 @@ class User {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = UserValidator.updateUser().validate(
+      {
+        userId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for updateUser",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "put",
       `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/customers/${userId}`,
       query_params,
       body
     );
+
+    const {
+      error: res_error,
+    } = UserModel.CreateUserResponseSchema().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for updateUser",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {CreateUserSessionRequestSchema} arg.body
+   * @returns {Promise<CreateUserSessionResponseSchema>} - Success response
    * @summary: Create user session
    * @description: Create user session
    */
-  createUserSession({ body } = {}) {
+  async createUserSession({ body } = {}) {
     const { error } = UserValidator.createUserSession().validate(
       {
         body,
@@ -236,24 +471,57 @@ class User {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = UserValidator.createUserSession().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for createUserSession",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/customers/session`,
       query_params,
       body
     );
+
+    const {
+      error: res_error,
+    } = UserModel.CreateUserSessionResponseSchema().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for createUserSession",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.id - ID of a customer.
+   * @returns {Promise<SessionListResponseSchema>} - Success response
    * @summary: Get a list of all session for a user
    * @description: Use this API to retrieve a list of session of customers who have registered in the application.
    */
-  getActiveSessions({ id } = {}) {
+  async getActiveSessions({ id } = {}) {
     const { error } = UserValidator.getActiveSessions().validate(
       {
         id,
@@ -264,25 +532,58 @@ class User {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = UserValidator.getActiveSessions().validate(
+      {
+        id,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getActiveSessions",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["id"] = id;
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/customers/sesions`,
       query_params,
       undefined
     );
+
+    const {
+      error: res_error,
+    } = UserModel.SessionListResponseSchema().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getActiveSessions",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.id - ID of a customer.
+   * @returns {Promise<SessionDeleteResponseSchema>} - Success response
    * @summary: Delete a list of all session for a user
    * @description: Use this API to Delete a list of session of customers who have registered in the application.
    */
-  deleteActiveSessions({ id } = {}) {
+  async deleteActiveSessions({ id } = {}) {
     const { error } = UserValidator.deleteActiveSessions().validate(
       {
         id,
@@ -293,24 +594,57 @@ class User {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = UserValidator.deleteActiveSessions().validate(
+      {
+        id,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for deleteActiveSessions",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["id"] = id;
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "delete",
       `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/customers/sesions`,
       query_params,
       undefined
     );
+
+    const {
+      error: res_error,
+    } = UserModel.SessionDeleteResponseSchema().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for deleteActiveSessions",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
+   * @returns {Promise<PlatformSchema>} - Success response
    * @summary: Get platform configurations
    * @description: Use this API to get all the platform configurations such as mobile image, desktop image, social logins, and all other text.
    */
-  getPlatformConfig({} = {}) {
+  async getPlatformConfig({} = {}) {
     const { error } = UserValidator.getPlatformConfig().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -319,24 +653,53 @@ class User {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = UserValidator.getPlatformConfig().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getPlatformConfig",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/platform/config`,
       query_params,
       undefined
     );
+
+    const { error: res_error } = UserModel.PlatformSchema().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getPlatformConfig",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {PlatformSchema} arg.body
+   * @returns {Promise<PlatformSchema>} - Success response
    * @summary: Update platform configurations
    * @description: Use this API to edit the existing platform configurations such as mobile image, desktop image, social logins, and all other text.
    */
-  updatePlatformConfig({ body } = {}) {
+  async updatePlatformConfig({ body } = {}) {
     const { error } = UserValidator.updatePlatformConfig().validate(
       {
         body,
@@ -347,15 +710,45 @@ class User {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = UserValidator.updatePlatformConfig().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for updatePlatformConfig",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/platform/config`,
       query_params,
       body
     );
+
+    const { error: res_error } = UserModel.PlatformSchema().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for updatePlatformConfig",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }
 module.exports = User;