@gofynd/fdk-client-javascript 1.4.6 → 1.4.8-beta.2

package/sdk/platform/Webhook/WebhookPlatformValidator.js

@@ -19,18 +19,11 @@ const WebhookPlatformModel = require("./WebhookPlatformModel");
  * @property {WebhookPlatformModel.EventProcessRequest} body
  */
 
-/**
- * @typedef GetEventCountsParam
- * @property {WebhookPlatformModel.RetryEventRequest} body
- */
-
 /**
  * @typedef GetHistoricalReportsParam
  * @property {WebhookPlatformModel.HistoryPayload} body
  */
 
-/** @typedef GetManualRetryStatusParam */
-
 /**
  * @typedef GetReportFiltersParam
  * @property {WebhookPlatformModel.ReportFiltersPayload} body
@@ -55,13 +48,6 @@ const WebhookPlatformModel = require("./WebhookPlatformModel");
  * @property {string} extensionId - Extension_id
  */
 
-/** @typedef ManualRetryCancelParam */
-
-/**
- * @typedef ManualRetryOfFailedEventParam
- * @property {WebhookPlatformModel.RetryEventRequest} body
- */
-
 /**
  * @typedef PingWebhookParam
  * @property {WebhookPlatformModel.PingWebhook} body
@@ -69,12 +55,22 @@ const WebhookPlatformModel = require("./WebhookPlatformModel");
 
 /**
  * @typedef RegisterSubscriberToEventParam
- * @property {WebhookPlatformModel.SubscriberConfig} body
+ * @property {WebhookPlatformModel.SubscriberConfigPost} body
+ */
+
+/**
+ * @typedef RegisterSubscriberToEventV2Param
+ * @property {WebhookPlatformModel.SubscriberConfigPostRequestV2} body
  */
 
 /**
  * @typedef UpdateSubscriberConfigParam
- * @property {WebhookPlatformModel.SubscriberConfig} body
+ * @property {WebhookPlatformModel.SubscriberConfigUpdate} body
+ */
+
+/**
+ * @typedef UpdateSubscriberV2Param
+ * @property {WebhookPlatformModel.SubscriberConfigUpdateRequestV2} body
  */
 
 class WebhookPlatformValidator {
@@ -104,13 +100,6 @@ class WebhookPlatformValidator {
     }).required();
   }
 
-  /** @returns {GetEventCountsParam} */
-  static getEventCounts() {
-    return Joi.object({
-      body: WebhookPlatformModel.RetryEventRequest().required(),
-    }).required();
-  }
-
   /** @returns {GetHistoricalReportsParam} */
   static getHistoricalReports() {
     return Joi.object({
@@ -118,11 +107,6 @@ class WebhookPlatformValidator {
     }).required();
   }
 
-  /** @returns {GetManualRetryStatusParam} */
-  static getManualRetryStatus() {
-    return Joi.object({}).required();
-  }
-
   /** @returns {GetReportFiltersParam} */
   static getReportFilters() {
     return Joi.object({
@@ -155,18 +139,6 @@ class WebhookPlatformValidator {
     }).required();
   }
 
-  /** @returns {ManualRetryCancelParam} */
-  static manualRetryCancel() {
-    return Joi.object({}).required();
-  }
-
-  /** @returns {ManualRetryOfFailedEventParam} */
-  static manualRetryOfFailedEvent() {
-    return Joi.object({
-      body: WebhookPlatformModel.RetryEventRequest().required(),
-    }).required();
-  }
-
   /** @returns {PingWebhookParam} */
   static pingWebhook() {
     return Joi.object({
@@ -177,14 +149,28 @@ class WebhookPlatformValidator {
   /** @returns {RegisterSubscriberToEventParam} */
   static registerSubscriberToEvent() {
     return Joi.object({
-      body: WebhookPlatformModel.SubscriberConfig().required(),
+      body: WebhookPlatformModel.SubscriberConfigPost().required(),
+    }).required();
+  }
+
+  /** @returns {RegisterSubscriberToEventV2Param} */
+  static registerSubscriberToEventV2() {
+    return Joi.object({
+      body: WebhookPlatformModel.SubscriberConfigPostRequestV2().required(),
     }).required();
   }
 
   /** @returns {UpdateSubscriberConfigParam} */
   static updateSubscriberConfig() {
     return Joi.object({
-      body: WebhookPlatformModel.SubscriberConfig().required(),
+      body: WebhookPlatformModel.SubscriberConfigUpdate().required(),
+    }).required();
+  }
+
+  /** @returns {UpdateSubscriberV2Param} */
+  static updateSubscriberV2() {
+    return Joi.object({
+      body: WebhookPlatformModel.SubscriberConfigUpdateRequestV2().required(),
     }).required();
   }
 }

package/sdk/platform/index.d.ts

@@ -1,6 +1,7 @@
 export const PlatformConfig: typeof import("./PlatformConfig");
 export const PlatformClient: typeof import("./PlatformClient");
 export namespace PlatformModel {
+    const AnalyticsPlatformModel: typeof import("./Analytics/AnalyticsPlatformModel");
     const AuditTrailPlatformModel: typeof import("./AuditTrail/AuditTrailPlatformModel");
     const BillingPlatformModel: typeof import("./Billing/BillingPlatformModel");
     const CartPlatformModel: typeof import("./Cart/CartPlatformModel");

package/sdk/platform/index.js

@@ -2,6 +2,8 @@ module.exports = {
   PlatformConfig: require("./PlatformConfig"),
   PlatformClient: require("./PlatformClient"),
   PlatformModel: {
+    AnalyticsPlatformModel: require("./Analytics/AnalyticsPlatformModel"),
+
     AuditTrailPlatformModel: require("./AuditTrail/AuditTrailPlatformModel"),
 
     BillingPlatformModel: require("./Billing/BillingPlatformModel"),

package/sdk/public/Billing/BillingPublicClient.d.ts

@@ -3,10 +3,23 @@ declare class Billing {
     constructor(_conf: any);
     _conf: any;
     _relativeUrls: {
+        getPlanDetails: string;
         getStandardPlans: string;
+        planList: string;
     };
     _urls: {};
     updateUrls(urls: any): void;
+    /**
+     * @param {BillingPublicValidator.GetPlanDetailsParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<BillingPublicModel.PlanDetails>} - Success response
+     * @name getPlanDetails
+     * @summary: Get plan details
+     * @description: Get plan details.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/billing/getPlanDetails/).
+     */
+    getPlanDetails({ planId, requestHeaders }?: BillingPublicValidator.GetPlanDetailsParam, { responseHeaders }?: object): Promise<BillingPublicModel.PlanDetails>;
     /**
      * @param {BillingPublicValidator.GetStandardPlansParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -14,10 +27,19 @@ declare class Billing {
      * @returns {Promise<BillingPublicModel.DetailList>} - Success response
      * @name getStandardPlans
      * @summary: Get Standard/Public Plans
-     * @description: Get Standard/Public Plans.
-     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/billing/getStandardPlans/).
+     * @description: Get Standard/Public Plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/billing/getStandardPlans/).
      */
     getStandardPlans({ platform, requestHeaders }?: BillingPublicValidator.GetStandardPlansParam, { responseHeaders }?: object): Promise<BillingPublicModel.DetailList>;
+    /**
+     * @param {BillingPublicValidator.PlanListParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<BillingPublicModel.PlanList[]>} - Success response
+     * @name planList
+     * @summary: Get List of all plans
+     * @description: Get List of all plans - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/billing/planList/).
+     */
+    planList({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPublicModel.PlanList[]>;
 }
 import BillingPublicValidator = require("./BillingPublicValidator");
 import BillingPublicModel = require("./BillingPublicModel");

package/sdk/public/Billing/BillingPublicClient.js

@@ -14,7 +14,9 @@ class Billing {
   constructor(_conf) {
     this._conf = _conf;
     this._relativeUrls = {
-      getStandardPlans: "/service/public/billing/v1.0/plan/detailed-list",
+      getPlanDetails: "/service/public/billing/v1.0/plan/details/{plan_id}",
+      getStandardPlans: "/service/public/billing/v1.0/plan/detailed-list/",
+      planList: "/service/public/billing/v1.0/plan/list",
     };
     this._urls = Object.entries(this._relativeUrls).reduce(
       (urls, [method, relativeUrl]) => {
@@ -32,6 +34,85 @@ class Billing {
     };
   }
 
+  /**
+   * @param {BillingPublicValidator.GetPlanDetailsParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PublicAPIClient").Options} - Options
+   * @returns {Promise<BillingPublicModel.PlanDetails>} - Success response
+   * @name getPlanDetails
+   * @summary: Get plan details
+   * @description: Get plan details.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/billing/getPlanDetails/).
+   */
+  async getPlanDetails(
+    { planId, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = BillingPublicValidator.getPlanDetails().validate(
+      { planId },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = BillingPublicValidator.getPlanDetails().validate(
+      { planId },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for public > Billing > getPlanDetails \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getPlanDetails"],
+        params: { planId },
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = BillingPublicModel.PlanDetails().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this._conf.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for public > Billing > getPlanDetails \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {BillingPublicValidator.GetStandardPlansParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -39,8 +120,7 @@ class Billing {
    * @returns {Promise<BillingPublicModel.DetailList>} - Success response
    * @name getStandardPlans
    * @summary: Get Standard/Public Plans
-   * @description: Get Standard/Public Plans.
-   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/billing/getStandardPlans/).
+   * @description: Get Standard/Public Plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/billing/getStandardPlans/).
    */
   async getStandardPlans(
     { platform, requestHeaders } = { requestHeaders: {} },
@@ -111,6 +191,79 @@ class Billing {
 
     return response;
   }
+
+  /**
+   * @param {BillingPublicValidator.PlanListParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PublicAPIClient").Options} - Options
+   * @returns {Promise<BillingPublicModel.PlanList[]>} - Success response
+   * @name planList
+   * @summary: Get List of all plans
+   * @description: Get List of all plans - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/billing/planList/).
+   */
+  async planList(
+    { requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = BillingPublicValidator.planList().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = BillingPublicValidator.planList().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for public > Billing > planList \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["planList"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const { error: res_error } = Joi.array()
+      .items(BillingPublicModel.PlanList())
+      .validate(responseData, { abortEarly: false, allowUnknown: true });
+
+    if (res_error) {
+      if (this._conf.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for public > Billing > planList \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
 }
 
 module.exports = Billing;