@gofynd/fdk-client-javascript 0.1.35

package/sdk/platform/client/AnalyticsPlatformClient.d.ts

@@ -0,0 +1,84 @@
+export = Analytics;
+declare class Analytics {
+    constructor(config: any);
+    config: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.exportType - Export type / format
+     * @param {ExportJobReq} arg.body
+     * @summary: Create data export job in required format
+     * @description: Create data export job in required format
+     */
+    createExportJob({ exportType, body }?: {
+        exportType: string;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.exportType - Export type / format
+     * @param {string} arg.jobId - Export job id
+     * @summary: Get data export job status
+     * @description: Get data export job status
+     */
+    getExportJobStatus({ exportType, jobId }?: {
+        exportType: string;
+        jobId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.logType - Log type
+     * @param {number} [arg.pageNo] - Current page number
+     * @param {number} [arg.pageSize] - Current page size
+     * @param {GetLogsListReq} arg.body
+     * @summary: Get logs list
+     * @description: Get logs list
+     */
+    getLogsList({ logType, body, pageNo, pageSize }?: {
+        logType: string;
+        pageNo?: number;
+        pageSize?: number;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.logType - Log type
+     * @param {number} [arg.pageSize] - Current page size
+     * @param {GetLogsListReq} arg.body
+     * @summary: Get logs list
+     * @description: Get logs list
+     */
+    getLogsListPaginator({ logType, pageSize, body }?: {
+        logType: string;
+        pageSize?: number;
+        body: any;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - Current page number
+     * @param {number} [arg.pageSize] - Current page size
+     * @param {string} arg.logType - Log type
+     * @param {SearchLogReq} arg.body
+     * @summary: Search logs
+     * @description: Search logs
+     */
+    searchLogs({ logType, body, pageNo, pageSize }?: {
+        pageNo?: number;
+        pageSize?: number;
+        logType: string;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageSize] - Current page size
+     * @param {string} arg.logType - Log type
+     * @param {SearchLogReq} arg.body
+     * @summary: Search logs
+     * @description: Search logs
+     */
+    searchLogsPaginator({ pageSize, logType, body }?: {
+        pageSize?: number;
+        logType: string;
+        body: any;
+    }): Paginator;
+}
+import Paginator = require("../../common/Paginator");

package/sdk/platform/client/AnalyticsPlatformClient.js

@@ -0,0 +1,215 @@
+const Paginator = require("../../common/Paginator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const AnalyticsValidator = require("../models/AnalyticsValidator");
+class Analytics {
+  constructor(config) {
+    this.config = config;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.exportType - Export type / format
+   * @param {ExportJobReq} arg.body
+   * @summary: Create data export job in required format
+   * @description: Create data export job in required format
+   */
+  createExportJob({ exportType, body } = {}) {
+    const { error } = AnalyticsValidator.createExportJob().validate(
+      {
+        exportType,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/analytics/v1.0/company/${this.config.companyId}/export/${exportType}`,
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.exportType - Export type / format
+   * @param {string} arg.jobId - Export job id
+   * @summary: Get data export job status
+   * @description: Get data export job status
+   */
+  getExportJobStatus({ exportType, jobId } = {}) {
+    const { error } = AnalyticsValidator.getExportJobStatus().validate(
+      {
+        exportType,
+        jobId,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/analytics/v1.0/company/${this.config.companyId}/export/${exportType}/job/${jobId}`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.logType - Log type
+   * @param {number} [arg.pageNo] - Current page number
+   * @param {number} [arg.pageSize] - Current page size
+   * @param {GetLogsListReq} arg.body
+   * @summary: Get logs list
+   * @description: Get logs list
+   */
+  getLogsList({ logType, body, pageNo, pageSize } = {}) {
+    const { error } = AnalyticsValidator.getLogsList().validate(
+      {
+        logType,
+        body,
+        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;
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/analytics/v1.0/company/${this.config.companyId}/logs/${logType}`,
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.logType - Log type
+   * @param {number} [arg.pageSize] - Current page size
+   * @param {GetLogsListReq} arg.body
+   * @summary: Get logs list
+   * @description: Get logs list
+   */
+  getLogsListPaginator({ logType, pageSize, body } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getLogsList({
+        logType: logType,
+        body: body,
+        pageNo: pageNo,
+        pageSize: pageSize,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback);
+    return paginator;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {number} [arg.pageNo] - Current page number
+   * @param {number} [arg.pageSize] - Current page size
+   * @param {string} arg.logType - Log type
+   * @param {SearchLogReq} arg.body
+   * @summary: Search logs
+   * @description: Search logs
+   */
+  searchLogs({ logType, body, pageNo, pageSize } = {}) {
+    const { error } = AnalyticsValidator.searchLogs().validate(
+      {
+        logType,
+        body,
+        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;
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/analytics/v1.0/company/${this.config.companyId}/logs/${logType}/search`,
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {number} [arg.pageSize] - Current page size
+   * @param {string} arg.logType - Log type
+   * @param {SearchLogReq} arg.body
+   * @summary: Search logs
+   * @description: Search logs
+   */
+  searchLogsPaginator({ pageSize, logType, body } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.searchLogs({
+        logType: logType,
+        body: body,
+        pageNo: pageNo,
+        pageSize: pageSize,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback);
+    return paginator;
+  }
+}
+
+module.exports = Analytics;

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

@@ -0,0 +1,38 @@
+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
+     * @summary: Create logs for auditing later on
+     * @description: Create a log instance that stores all the relevant info to be logged
+     */
+    createAuditLog({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Log uuid
+     * @summary: Get audit log
+     * @description: Get detailed log information by their id
+     */
+    getAuditLog({ id }?: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @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>;
+}

package/sdk/platform/client/AuditTrailPlatformClient.js

@@ -0,0 +1,133 @@
+const Paginator = require("../../common/Paginator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const AuditTrailValidator = require("../models/AuditTrailValidator");
+class AuditTrail {
+  constructor(config) {
+    this.config = config;
+  }
+
+  /**
+   * @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 } = {}) {
+    const { error } = AuditTrailValidator.getAuditLogs().validate(
+      {
+        qs,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["qs"] = qs;
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @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
+   */
+  createAuditLog({ body } = {}) {
+    const { error } = AuditTrailValidator.createAuditLog().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/`,
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.id - Log uuid
+   * @summary: Get audit log
+   * @description: Get detailed log information by their id
+   */
+  getAuditLog({ id } = {}) {
+    const { error } = AuditTrailValidator.getAuditLog().validate(
+      {
+        id,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/${id}`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @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({} = {}) {
+    const { error } = AuditTrailValidator.getEntityTypes().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/entity-types`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+}
+
+module.exports = AuditTrail;

package/sdk/platform/client/BillingPlatformClient.d.ts

@@ -0,0 +1,109 @@
+export = Billing;
+declare class Billing {
+    constructor(config: any);
+    config: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.plan - ID of the plan.
+     * @param {string} arg.couponCode - Coupon code.
+     * @summary: Check coupon validity
+     * @description: Check coupon validity.
+     */
+    checkCouponValidity({ plan, couponCode }?: {
+        plan: string;
+        couponCode: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.extensionId - Extension _id
+     * @param {CreateSubscriptionCharge} arg.body
+     * @summary: Create subscription charge
+     * @description: Register subscription charge for a seller of your extension.
+     */
+    createSubscriptionCharge({ extensionId, body }?: {
+        extensionId: string;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.extensionId - Extension _id
+     * @param {string} arg.subscriptionId - Subscription charge _id
+     * @summary: Get subscription charge details
+     * @description: Get created subscription charge details
+     */
+    getSubscriptionCharge({ extensionId, subscriptionId }?: {
+        extensionId: string;
+        subscriptionId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.extensionId - Extension _id
+     * @param {string} arg.subscriptionId - Subscription charge _id
+     * @summary: Cancel subscription charge
+     * @description: Cancel subscription and attached charges.
+     */
+    cancelSubscriptionCharge({ extensionId, subscriptionId }?: {
+        extensionId: string;
+        subscriptionId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @summary: Get invoices
+     * @description: Get invoices.
+     */
+    getInvoices({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.invoiceId - Invoice id
+     * @summary: Get invoice by id
+     * @description: Get invoice by id.
+     */
+    getInvoiceById({ invoiceId }?: {
+        invoiceId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @summary: Get subscription customer detail
+     * @description: Get subscription customer detail.
+     */
+    getCustomerDetail({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {SubscriptionCustomerCreate} arg.body
+     * @summary: Upsert subscription customer detail
+     * @description: Upsert subscription customer detail.
+     */
+    upsertCustomerDetail({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @summary: Get current subscription detail
+     * @description: If subscription is active then it will return is_enabled true and return subscription object. If subscription is not active then is_enabled false and message.
+     */
+    getSubscription({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @summary: Get subscription subscription limits
+     * @description: Get subscription subscription limits.
+     */
+    getFeatureLimitConfig({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {SubscriptionActivateReq} arg.body
+     * @summary: Activate subscription
+     * @description: It will activate subscription plan for customer
+     */
+    activateSubscriptionPlan({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {CancelSubscriptionReq} arg.body
+     * @summary: Cancel subscription
+     * @description: It will cancel current active subscription.
+     */
+    cancelSubscriptionPlan({ body }?: {
+        body: any;
+    }): Promise<any>;
+}