@gofynd/fdk-client-javascript 0.1.37 → 1.0.0

package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js

@@ -0,0 +1,285 @@
+const Paginator = require("../../common/Paginator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const AnalyticsValidator = require("./AnalyticsPlatformApplicationValidator");
+
+class Analytics {
+  constructor(config, applicationId) {
+    this.config = config;
+    this.applicationId = applicationId;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @summary: Get statistics groups
+   * @description: Get statistics groups
+   */
+  getStatiscticsGroups({} = {}) {
+    const { error } = AnalyticsValidator.getStatiscticsGroups().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/analytics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/stats/group`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.groupName - Group name
+   * @summary: Get statistics group components
+   * @description: Get statistics group components
+   */
+  getStatiscticsGroupComponents({ groupName } = {}) {
+    const {
+      error,
+    } = AnalyticsValidator.getStatiscticsGroupComponents().validate(
+      {
+        groupName,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/analytics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/stats/group/${groupName}`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.componentName - Component name
+   * @summary: Get component statistics csv
+   * @description: Get component statistics csv
+   */
+  getComponentStatsCSV({ componentName } = {}) {
+    const { error } = AnalyticsValidator.getComponentStatsCSV().validate(
+      {
+        componentName,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/analytics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/stats/component/{component_name}.csv`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.componentName - Component name
+   * @summary: Get component statistics pdf
+   * @description: Get component statistics pdf
+   */
+  getComponentStatsPDF({ componentName } = {}) {
+    const { error } = AnalyticsValidator.getComponentStatsPDF().validate(
+      {
+        componentName,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/analytics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/stats/component/{component_name}.pdf`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.componentName - Component name
+   * @summary: Get component statistics
+   * @description: Get component statistics
+   */
+  getComponentStats({ componentName } = {}) {
+    const { error } = AnalyticsValidator.getComponentStats().validate(
+      {
+        componentName,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/analytics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/stats/component/${componentName}`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.fromDate - From date
+   * @param {string} arg.toDate - To date
+   * @param {number} [arg.pageNo] - Current page number
+   * @param {number} [arg.pageSize] - Current page size
+   * @summary: Get abandon carts list
+   * @description: Get abandon carts list
+   */
+  getAbandonCartList({ fromDate, toDate, pageNo, pageSize } = {}) {
+    const { error } = AnalyticsValidator.getAbandonCartList().validate(
+      {
+        fromDate,
+        toDate,
+        pageNo,
+        pageSize,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/analytics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/cart/from/${fromDate}/to/${toDate}/abandon-cart/`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.companyId - Company Id
+   * @param {string} arg.applicationId - Application Id
+   * @param {string} arg.fromDate - From date
+   * @param {string} arg.toDate - To date
+   * @param {number} [arg.pageSize] - Current page size
+   * @summary: Get abandon carts list
+   * @description: Get abandon carts list
+   */
+  getAbandonCartListPaginator({
+    companyId,
+    applicationId,
+    fromDate,
+    toDate,
+    pageSize,
+  } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getAbandonCartList({
+        companyId: companyId,
+        applicationId: applicationId,
+        fromDate: fromDate,
+        toDate: toDate,
+        pageNo: pageNo,
+        pageSize: pageSize,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.fromDate - From date
+   * @param {string} arg.toDate - To date
+   * @summary: Get abandon carts csv
+   * @description: Get abandon carts csv
+   */
+  getAbandonCartsCSV({ fromDate, toDate } = {}) {
+    const { error } = AnalyticsValidator.getAbandonCartsCSV().validate(
+      {
+        fromDate,
+        toDate,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/analytics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/cart/${fromDate}/to/${toDate}/abandon-cart.csv`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.cartId - Cart Id
+   * @summary: Get abandon carts details
+   * @description: Get abandon cart details
+   */
+  getAbandonCartDetail({ cartId } = {}) {
+    const { error } = AnalyticsValidator.getAbandonCartDetail().validate(
+      {
+        cartId,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/analytics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/cart/abandon-cart/${cartId}`,
+      query_params,
+      undefined
+    );
+  }
+}
+module.exports = Analytics;

package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts

@@ -0,0 +1,11 @@
+export = AnalyticsValidator;
+declare class AnalyticsValidator {
+    static getStatiscticsGroups(): any;
+    static getStatiscticsGroupComponents(): any;
+    static getComponentStatsCSV(): any;
+    static getComponentStatsPDF(): any;
+    static getComponentStats(): any;
+    static getAbandonCartList(): any;
+    static getAbandonCartsCSV(): any;
+    static getAbandonCartDetail(): any;
+}

package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js

@@ -0,0 +1,56 @@
+const Joi = require("joi");
+const AnalyticsModel = require("./AnalyticsPlatformModel");
+
+class AnalyticsValidator {
+  static getStatiscticsGroups() {
+    return Joi.object({}).required();
+  }
+
+  static getStatiscticsGroupComponents() {
+    return Joi.object({
+      groupName: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getComponentStatsCSV() {
+    return Joi.object({
+      componentName: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getComponentStatsPDF() {
+    return Joi.object({
+      componentName: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getComponentStats() {
+    return Joi.object({
+      componentName: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getAbandonCartList() {
+    return Joi.object({
+      fromDate: Joi.string().allow("").required(),
+      toDate: Joi.string().allow("").required(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+    }).required();
+  }
+
+  static getAbandonCartsCSV() {
+    return Joi.object({
+      fromDate: Joi.string().allow("").required(),
+      toDate: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getAbandonCartDetail() {
+    return Joi.object({
+      cartId: Joi.string().allow("").required(),
+    }).required();
+  }
+}
+
+module.exports = AnalyticsValidator;

package/sdk/platform/{client → Analytics}/AnalyticsPlatformClient.js

@@ -1,7 +1,7 @@
 const Paginator = require("../../common/Paginator");
-const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
-const AnalyticsValidator = require("../models/AnalyticsValidator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const AnalyticsValidator = require("./AnalyticsPlatformValidator");
 class Analytics {
   constructor(config) {
     this.config = config;

package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts

@@ -0,0 +1,23 @@
+export = AnalyticsModel;
+declare class AnalyticsModel {
+    static StatGroup(): any;
+    static ErrorRes(): any;
+    static StatsGroups(): any;
+    static StatsGroupComponent(): any;
+    static StatsGroupComponents(): any;
+    static StatsRes(): any;
+    static ReceivedAt(): any;
+    static AbandonCartsDetail(): any;
+    static Page(): any;
+    static AbandonCartsList(): any;
+    static AbandonCartDetail(): any;
+    static ExportJobReq(): any;
+    static ExportJobRes(): any;
+    static ExportJobStatusRes(): any;
+    static GetLogsListReq(): any;
+    static MkpLogsResp(): any;
+    static GetLogsListRes(): any;
+    static SearchLogReq(): any;
+    static LogInfo(): any;
+    static SearchLogRes(): any;
+}

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;

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;
+}