@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

package/sdk/platform/Analytics/AnalyticsPlatformModel.js

@@ -1,252 +1,169 @@
 const Joi = require("joi");
 
 class AnalyticsModel {
-  static StatGroup() {
-    return Joi.object({
-      key: Joi.string().allow(""),
-
-      url: Joi.string().allow(""),
-
-      title: Joi.string().allow(""),
-    });
-  }
-
-  static ErrorRes() {
-    return Joi.object({
-      message: Joi.string().allow(""),
-    });
-  }
-
-  static StatsGroups() {
-    return Joi.object({
-      groups: Joi.array().items(AnalyticsModel.StatGroup()),
-    });
-  }
-
-  static StatsGroupComponent() {
-    return Joi.object({
-      key: Joi.string().allow(""),
-
-      url: Joi.string().allow(""),
-
-      title: Joi.string().allow(""),
-
-      type: Joi.string().allow(""),
-
-      filters: Joi.any(),
-    });
-  }
-
-  static StatsGroupComponents() {
-    return Joi.object({
-      title: Joi.string().allow(""),
-
-      components: Joi.array().items(AnalyticsModel.StatsGroupComponent()),
-    });
-  }
-
-  static StatsRes() {
-    return Joi.object({
-      key: Joi.string().allow(""),
-
-      title: Joi.string().allow(""),
-
-      type: Joi.string().allow(""),
-
-      data: Joi.any(),
-    });
-  }
-
-  static ReceivedAt() {
+  static AbandonCartDetail() {
     return Joi.object({
-      value: Joi.string().allow(""),
+      _id: Joi.string().allow(""),
+      address: Joi.any(),
+      articles: Joi.array().items(Joi.any()),
+      breakup: Joi.any(),
+      cart_value: Joi.string().allow(""),
+      user_id: Joi.string().allow(""),
     });
   }
-
   static AbandonCartsDetail() {
     return Joi.object({
-      properties_cart_id: Joi.string().allow(""),
-
+      context_app_application_id: Joi.string().allow(""),
+      context_traits_email: Joi.string().allow(""),
       context_traits_first_name: Joi.string().allow(""),
-
       context_traits_last_name: Joi.string().allow(""),
-
       context_traits_phone_number: Joi.string().allow(""),
-
-      context_traits_email: Joi.string().allow(""),
-
-      context_app_application_id: Joi.string().allow(""),
-
       properties_breakup_values_raw_total: Joi.string().allow(""),
-
+      properties_cart_id: Joi.string().allow(""),
       received_at: AnalyticsModel.ReceivedAt(),
     });
   }
-
-  static Page() {
-    return Joi.object({
-      item_total: Joi.number(),
-
-      next_id: Joi.string().allow(""),
-
-      has_previous: Joi.boolean(),
-
-      has_next: Joi.boolean(),
-
-      current: Joi.number(),
-
-      type: Joi.string().allow("").required(),
-
-      size: Joi.number(),
-    });
-  }
-
   static AbandonCartsList() {
     return Joi.object({
-      items: Joi.array().items(AnalyticsModel.AbandonCartsDetail()),
-
       cart_total: Joi.string().allow(""),
-
+      items: Joi.array().items(AnalyticsModel.AbandonCartsDetail()),
       page: AnalyticsModel.Page(),
     });
   }
-
-  static AbandonCartDetail() {
+  static ErrorRes() {
     return Joi.object({
-      _id: Joi.string().allow(""),
-
-      user_id: Joi.string().allow(""),
-
-      cart_value: Joi.string().allow(""),
-
-      articles: Joi.array().items(Joi.any()),
-
-      breakup: Joi.any(),
-
-      address: Joi.any(),
+      message: Joi.string().allow(""),
     });
   }
-
   static ExportJobReq() {
     return Joi.object({
-      marketplace_name: Joi.string().allow(""),
-
-      start_time: Joi.string().allow(""),
-
       end_time: Joi.string().allow(""),
-
       event_type: Joi.string().allow(""),
-
+      marketplace_name: Joi.string().allow(""),
+      start_time: Joi.string().allow(""),
       trace_id: Joi.string().allow(""),
     });
   }
-
   static ExportJobRes() {
     return Joi.object({
-      status: Joi.string().allow(""),
-
       job_id: Joi.string().allow(""),
+      status: Joi.string().allow(""),
     });
   }
-
   static ExportJobStatusRes() {
     return Joi.object({
-      status: Joi.string().allow(""),
-
-      job_id: Joi.string().allow(""),
-
       download_url: Joi.string().allow(""),
+      job_id: Joi.string().allow(""),
+      status: Joi.string().allow(""),
     });
   }
-
   static GetLogsListReq() {
     return Joi.object({
-      marketplace_name: Joi.string().allow(""),
-
-      start_date: Joi.string().allow(""),
-
       company_id: Joi.string().allow(""),
-
       end_date: Joi.string().allow(""),
+      marketplace_name: Joi.string().allow(""),
+      start_date: Joi.string().allow(""),
     });
   }
-
-  static MkpLogsResp() {
+  static GetLogsListRes() {
     return Joi.object({
-      start_time_iso: Joi.string().allow(""),
-
-      end_time_iso: Joi.string().allow(""),
-
+      items: Joi.array().items(AnalyticsModel.MkpLogsResp()),
+      page: AnalyticsModel.Page(),
+    });
+  }
+  static LogInfo() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      article_id: Joi.string().allow(""),
+      brand_id: Joi.number(),
+      company_id: Joi.number(),
+      event: Joi.string().allow(""),
       event_type: Joi.string().allow(""),
-
+      item_id: Joi.number(),
+      marketplace_name: Joi.string().allow(""),
+      seller_identifier: Joi.string().allow(""),
+      status: Joi.string().allow(""),
+      store_code: Joi.string().allow(""),
+      store_id: Joi.number(),
       trace_id: Joi.string().allow(""),
-
+    });
+  }
+  static MkpLogsResp() {
+    return Joi.object({
       count: Joi.string().allow(""),
-
+      end_time_iso: Joi.string().allow(""),
+      event_type: Joi.string().allow(""),
+      start_time_iso: Joi.string().allow(""),
       status: Joi.string().allow(""),
+      trace_id: Joi.string().allow(""),
     });
   }
-
-  static GetLogsListRes() {
+  static Page() {
     return Joi.object({
-      items: Joi.array().items(AnalyticsModel.MkpLogsResp()),
-
-      page: AnalyticsModel.Page(),
+      current: Joi.number(),
+      has_next: Joi.boolean(),
+      has_previous: Joi.boolean(),
+      item_total: Joi.number(),
+      next_id: Joi.string().allow(""),
+      size: Joi.number(),
+      type: Joi.string().allow("").required(),
+    });
+  }
+  static ReceivedAt() {
+    return Joi.object({
+      value: Joi.string().allow(""),
     });
   }
-
   static SearchLogReq() {
     return Joi.object({
-      marketplace_name: Joi.string().allow(""),
-
-      start_date: Joi.string().allow(""),
-
       company_id: Joi.string().allow(""),
-
       end_date: Joi.string().allow(""),
-
       identifier: Joi.string().allow(""),
-
       identifier_value: Joi.string().allow(""),
-    });
-  }
-
-  static LogInfo() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-
-      status: Joi.string().allow(""),
-
-      event_type: Joi.string().allow(""),
-
       marketplace_name: Joi.string().allow(""),
-
-      event: Joi.string().allow(""),
-
-      trace_id: Joi.string().allow(""),
-
-      company_id: Joi.number(),
-
-      brand_id: Joi.number(),
-
-      store_code: Joi.string().allow(""),
-
-      store_id: Joi.number(),
-
-      item_id: Joi.number(),
-
-      article_id: Joi.string().allow(""),
-
-      seller_identifier: Joi.string().allow(""),
+      start_date: Joi.string().allow(""),
     });
   }
-
   static SearchLogRes() {
     return Joi.object({
       items: Joi.array().items(AnalyticsModel.LogInfo()),
-
       page: AnalyticsModel.Page(),
     });
   }
+  static StatGroup() {
+    return Joi.object({
+      key: Joi.string().allow(""),
+      title: Joi.string().allow(""),
+      url: Joi.string().allow(""),
+    });
+  }
+  static StatsGroupComponent() {
+    return Joi.object({
+      filters: Joi.any(),
+      key: Joi.string().allow(""),
+      title: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      url: Joi.string().allow(""),
+    });
+  }
+  static StatsGroupComponents() {
+    return Joi.object({
+      components: Joi.array().items(AnalyticsModel.StatsGroupComponent()),
+      title: Joi.string().allow(""),
+    });
+  }
+  static StatsGroups() {
+    return Joi.object({
+      groups: Joi.array().items(AnalyticsModel.StatGroup()),
+    });
+  }
+  static StatsRes() {
+    return Joi.object({
+      data: Joi.any(),
+      key: Joi.string().allow(""),
+      title: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+    });
+  }
 }
 module.exports = AnalyticsModel;

package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts

@@ -2,37 +2,41 @@ export = AuditTrail;
 declare class AuditTrail {
     constructor(config: any);
     config: any;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.qs - Logs Query
-     * @summary: Get paginated audit logs
-     * @description: Get a paginated set of logs that can be filtered using the available set of parameters and get the relevant group of logs
-     */
-    getAuditLogs({ qs }?: {
-        qs: string;
-    }): Promise<any>;
     /**
      * @param {Object} arg - Arg object.
      * @param {RequestBodyAuditLog} arg.body
+     * @returns {Promise<CreateLogResponse>} - Success response
      * @summary: Create logs for auditing later on
      * @description: Create a log instance that stores all the relevant info to be logged
      */
     createAuditLog({ body }?: {
         body: RequestBodyAuditLog;
-    }): Promise<any>;
+    }): Promise<CreateLogResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Log uuid
+     * @returns {Promise<LogSchemaResponse>} - Success response
      * @summary: Get audit log
      * @description: Get detailed log information by their id
      */
     getAuditLog({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<LogSchemaResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.qs - Logs Query
+     * @returns {Promise<LogSchemaResponse>} - Success response
+     * @summary: Get paginated audit logs
+     * @description: Get a paginated set of logs that can be filtered using the available set of parameters and get the relevant group of logs
+     */
+    getAuditLogs({ qs }?: {
+        qs: string;
+    }): Promise<LogSchemaResponse>;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<EntityTypesResponse>} - Success response
      * @summary: Get entity types
      * @description: Get a consolidated list of entity types from all the logs stored on the db, which further helps to filter the logs better
      */
-    getEntityTypes({}?: any): Promise<any>;
+    getEntityTypes({}?: any): Promise<EntityTypesResponse>;
 }

package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js

@@ -2,6 +2,9 @@ const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const AuditTrailValidator = require("./AuditTrailPlatformValidator");
+const AuditTrailModel = require("./AuditTrailPlatformModel");
+const { Logger } = require("./../../common/Logger");
+
 class AuditTrail {
   constructor(config) {
     this.config = config;
@@ -9,14 +12,15 @@ class AuditTrail {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.qs - Logs Query
-   * @summary: Get paginated audit logs
-   * @description: Get a paginated set of logs that can be filtered using the available set of parameters and get the relevant group of logs
+   * @param {RequestBodyAuditLog} arg.body
+   * @returns {Promise<CreateLogResponse>} - Success response
+   * @summary: Create logs for auditing later on
+   * @description: Create a log instance that stores all the relevant info to be logged
    */
-  getAuditLogs({ qs } = {}) {
-    const { error } = AuditTrailValidator.getAuditLogs().validate(
+  async createAuditLog({ body } = {}) {
+    const { error } = AuditTrailValidator.createAuditLog().validate(
       {
-        qs,
+        body,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -25,42 +29,62 @@ class AuditTrail {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = AuditTrailValidator.getAuditLogs().validate(
+    const { error: warrning } = AuditTrailValidator.createAuditLog().validate(
       {
-        qs,
+        body,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getAuditLogs");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for createAuditLog",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
-    query_params["qs"] = qs;
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
-      "get",
+      "post",
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/`,
       query_params,
-      undefined,
+      body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = AuditTrailModel.CreateLogResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for createAuditLog",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {RequestBodyAuditLog} arg.body
-   * @summary: Create logs for auditing later on
-   * @description: Create a log instance that stores all the relevant info to be logged
+   * @param {string} arg.id - Log uuid
+   * @returns {Promise<LogSchemaResponse>} - Success response
+   * @summary: Get audit log
+   * @description: Get detailed log information by their id
    */
-  createAuditLog({ body } = {}) {
-    const { error } = AuditTrailValidator.createAuditLog().validate(
+  async getAuditLog({ id } = {}) {
+    const { error } = AuditTrailValidator.getAuditLog().validate(
       {
-        body,
+        id,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -69,41 +93,62 @@ class AuditTrail {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = AuditTrailValidator.createAuditLog().validate(
+    const { error: warrning } = AuditTrailValidator.getAuditLog().validate(
       {
-        body,
+        id,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for createAuditLog");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getAuditLog",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
-      "post",
-      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/`,
+      "get",
+      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/${id}`,
       query_params,
-      body,
+      undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = AuditTrailModel.LogSchemaResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getAuditLog",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.id - Log uuid
-   * @summary: Get audit log
-   * @description: Get detailed log information by their id
+   * @param {string} arg.qs - Logs Query
+   * @returns {Promise<LogSchemaResponse>} - Success response
+   * @summary: Get paginated audit logs
+   * @description: Get a paginated set of logs that can be filtered using the available set of parameters and get the relevant group of logs
    */
-  getAuditLog({ id } = {}) {
-    const { error } = AuditTrailValidator.getAuditLog().validate(
+  async getAuditLogs({ qs } = {}) {
+    const { error } = AuditTrailValidator.getAuditLogs().validate(
       {
-        id,
+        qs,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -112,37 +157,59 @@ class AuditTrail {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = AuditTrailValidator.getAuditLog().validate(
+    const { error: warrning } = AuditTrailValidator.getAuditLogs().validate(
       {
-        id,
+        qs,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getAuditLog");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getAuditLogs",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
+    query_params["qs"] = qs;
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
-      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/${id}`,
+      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/`,
       query_params,
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = AuditTrailModel.LogSchemaResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getAuditLogs",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
+   * @returns {Promise<EntityTypesResponse>} - Success response
    * @summary: Get entity types
    * @description: Get a consolidated list of entity types from all the logs stored on the db, which further helps to filter the logs better
    */
-  getEntityTypes({} = {}) {
+  async getEntityTypes({} = {}) {
     const { error } = AuditTrailValidator.getEntityTypes().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -157,15 +224,18 @@ class AuditTrail {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getEntityTypes");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getEntityTypes",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/entity-types`,
@@ -173,6 +243,23 @@ class AuditTrail {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = AuditTrailModel.EntityTypesResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getEntityTypes",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }