@gofynd/fdk-client-javascript 0.1.37 → 1.0.1

package/sdk/platform/Analytics/AnalyticsPlatformModel.js

@@ -0,0 +1,252 @@
+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() {
+    return Joi.object({
+      value: Joi.string().allow(""),
+    });
+  }
+
+  static AbandonCartsDetail() {
+    return Joi.object({
+      properties_cart_id: 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(""),
+
+      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(""),
+
+      page: AnalyticsModel.Page(),
+    });
+  }
+
+  static AbandonCartDetail() {
+    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(),
+    });
+  }
+
+  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(""),
+
+      trace_id: Joi.string().allow(""),
+    });
+  }
+
+  static ExportJobRes() {
+    return Joi.object({
+      status: Joi.string().allow(""),
+
+      job_id: Joi.string().allow(""),
+    });
+  }
+
+  static ExportJobStatusRes() {
+    return Joi.object({
+      status: Joi.string().allow(""),
+
+      job_id: Joi.string().allow(""),
+
+      download_url: 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(""),
+    });
+  }
+
+  static MkpLogsResp() {
+    return Joi.object({
+      start_time_iso: Joi.string().allow(""),
+
+      end_time_iso: Joi.string().allow(""),
+
+      event_type: Joi.string().allow(""),
+
+      trace_id: Joi.string().allow(""),
+
+      count: Joi.string().allow(""),
+
+      status: Joi.string().allow(""),
+    });
+  }
+
+  static GetLogsListRes() {
+    return Joi.object({
+      items: Joi.array().items(AnalyticsModel.MkpLogsResp()),
+
+      page: AnalyticsModel.Page(),
+    });
+  }
+
+  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(""),
+    });
+  }
+
+  static SearchLogRes() {
+    return Joi.object({
+      items: Joi.array().items(AnalyticsModel.LogInfo()),
+
+      page: AnalyticsModel.Page(),
+    });
+  }
+}
+module.exports = AnalyticsModel;

package/sdk/platform/{models/AnalyticsValidator.js → Analytics/AnalyticsPlatformValidator.js}

@@ -1,10 +1,11 @@
 const Joi = require("joi");
-const Validator = require("../PlatformModels");
+
+const AnalyticsModel = require("./AnalyticsPlatformModel");
 class AnalyticsValidator {
   static createExportJob() {
     return Joi.object({
       exportType: Joi.string().allow("").required(),
-      body: Validator.ExportJobReq().required(),
+      body: AnalyticsModel.ExportJobReq().required(),
     }).required();
   }
 
@@ -20,7 +21,7 @@ class AnalyticsValidator {
       logType: Joi.string().allow("").required(),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      body: Validator.GetLogsListReq().required(),
+      body: AnalyticsModel.GetLogsListReq().required(),
     }).required();
   }
 
@@ -29,7 +30,7 @@ class AnalyticsValidator {
       pageNo: Joi.number(),
       pageSize: Joi.number(),
       logType: Joi.string().allow("").required(),
-      body: Validator.SearchLogReq().required(),
+      body: AnalyticsModel.SearchLogReq().required(),
     }).required();
   }
 }

package/sdk/platform/{client → AuditTrail}/AuditTrailPlatformClient.js

@@ -1,7 +1,7 @@
 const Paginator = require("../../common/Paginator");
-const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
-const AuditTrailValidator = require("../models/AuditTrailValidator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const AuditTrailValidator = require("./AuditTrailPlatformValidator");
 class AuditTrail {
   constructor(config) {
     this.config = config;
@@ -24,6 +24,18 @@ class AuditTrail {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = AuditTrailValidator.getAuditLogs().validate(
+      {
+        qs,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for getAuditLogs");
+      console.log(warrning);
+    }
+
     const query_params = {};
     query_params["qs"] = qs;
 
@@ -56,6 +68,18 @@ class AuditTrail {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = AuditTrailValidator.createAuditLog().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for createAuditLog");
+      console.log(warrning);
+    }
+
     const query_params = {};
 
     const xHeaders = {};
@@ -87,6 +111,18 @@ class AuditTrail {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = AuditTrailValidator.getAuditLog().validate(
+      {
+        id,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for getAuditLog");
+      console.log(warrning);
+    }
+
     const query_params = {};
 
     const xHeaders = {};
@@ -115,6 +151,16 @@ class AuditTrail {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = AuditTrailValidator.getEntityTypes().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for getEntityTypes");
+      console.log(warrning);
+    }
+
     const query_params = {};
 
     const xHeaders = {};

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

@@ -0,0 +1,18 @@
+export = AuditTrailModel;
+declare class AuditTrailModel {
+    static RequestBodyAuditLog(): any;
+    static CreateLogResponse(): any;
+    static LogMetaObj(): any;
+    static EntityObject(): any;
+    static LogSchemaResponse(): any;
+    static LogDocs(): any;
+    static EntityObj(): any;
+    static Modifier(): any;
+    static DeviceInfo(): any;
+    static Location(): any;
+    static BadRequest(): any;
+    static ResourceNotFound(): any;
+    static InternalServerError(): any;
+    static EntityTypesResponse(): any;
+    static EntityTypeObj(): any;
+}

package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js

@@ -0,0 +1,144 @@
+const Joi = require("joi");
+
+class AuditTrailModel {
+  static RequestBodyAuditLog() {
+    return Joi.object({
+      log_meta: AuditTrailModel.LogMetaObj().required(),
+
+      log_payload: Joi.any().required(),
+    });
+  }
+
+  static CreateLogResponse() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+
+      internal_message: Joi.string().allow(""),
+    });
+  }
+
+  static LogMetaObj() {
+    return Joi.object({
+      modifier: Joi.any(),
+
+      application: Joi.string().allow(""),
+
+      entity: AuditTrailModel.EntityObject(),
+
+      device_info: Joi.any(),
+
+      location: Joi.any(),
+    });
+  }
+
+  static EntityObject() {
+    return Joi.object({
+      id: Joi.string().allow(""),
+
+      type: Joi.string().allow(""),
+
+      action: Joi.string().allow(""),
+    });
+  }
+
+  static LogSchemaResponse() {
+    return Joi.object({
+      docs: Joi.array().items(AuditTrailModel.LogDocs()),
+    });
+  }
+
+  static LogDocs() {
+    return Joi.object({
+      entity: AuditTrailModel.EntityObj(),
+
+      modifier: AuditTrailModel.Modifier(),
+
+      device_info: AuditTrailModel.DeviceInfo(),
+
+      location: AuditTrailModel.Location(),
+
+      _id: Joi.string().allow(""),
+
+      company: Joi.string().allow(""),
+
+      application: Joi.string().allow(""),
+
+      sessions: Joi.string().allow(""),
+
+      date: Joi.string().allow(""),
+
+      logs: Joi.any(),
+    });
+  }
+
+  static EntityObj() {
+    return Joi.object({
+      id: Joi.string().allow(""),
+
+      type: Joi.string().allow(""),
+
+      action: Joi.string().allow(""),
+
+      entity_details: Joi.any(),
+    });
+  }
+
+  static Modifier() {
+    return Joi.object({
+      user_id: Joi.string().allow(""),
+
+      as_administrator: Joi.boolean(),
+
+      user_details: Joi.any(),
+    });
+  }
+
+  static DeviceInfo() {
+    return Joi.object({
+      user_agent: Joi.string().allow(""),
+
+      extra_meta: Joi.any(),
+    });
+  }
+
+  static Location() {
+    return Joi.object({
+      extra_meta: Joi.any(),
+    });
+  }
+
+  static BadRequest() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+    });
+  }
+
+  static ResourceNotFound() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+    });
+  }
+
+  static InternalServerError() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+
+      code: Joi.string().allow(""),
+    });
+  }
+
+  static EntityTypesResponse() {
+    return Joi.object({
+      items: Joi.array().items(AuditTrailModel.EntityTypeObj()),
+    });
+  }
+
+  static EntityTypeObj() {
+    return Joi.object({
+      entity_value: Joi.string().allow(""),
+
+      display_name: Joi.string().allow(""),
+    });
+  }
+}
+module.exports = AuditTrailModel;

package/sdk/platform/{models/AuditTrailValidator.js → AuditTrail/AuditTrailPlatformValidator.js}

@@ -1,5 +1,6 @@
 const Joi = require("joi");
-const Validator = require("../PlatformModels");
+
+const AuditTrailModel = require("./AuditTrailPlatformModel");
 class AuditTrailValidator {
   static getAuditLogs() {
     return Joi.object({
@@ -9,7 +10,7 @@ class AuditTrailValidator {
 
   static createAuditLog() {
     return Joi.object({
-      body: Validator.RequestBodyAuditLog().required(),
+      body: AuditTrailModel.RequestBodyAuditLog().required(),
     }).required();
   }