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

package/sdk/partner/Theme/ThemePartnerModel.js

@@ -74,6 +74,17 @@ const Joi = require("joi");
  * @property {string} [status]
  */
 
+/**
+ * @typedef ExtensionPreviewRequest
+ * @property {string} [application_id] - Application ID
+ * @property {string} [section_preview_hash] - Hash for the section preview
+ */
+
+/**
+ * @typedef ExtensionPreviewResponse
+ * @property {string} [message]
+ */
+
 /**
  * @typedef PublishExtensionSectionResponse
  * @property {SectionsResponse} [sections]
@@ -120,7 +131,7 @@ const Joi = require("joi");
 
 /**
  * @typedef Action
- * @property {string} [type]
+ * @property {string} [type] - Type of action to be taken e.g, page.
  * @property {ActionPage} [page]
  * @property {ActionPage} [popup]
  */
@@ -675,9 +686,9 @@ const Joi = require("joi");
 
 /**
  * @typedef ActionPage
- * @property {Object} [params]
- * @property {Object} [query]
- * @property {string} [url]
+ * @property {Object} [params] - Parameters that should be considered in path.
+ * @property {Object} [query] - Query parameter if any to be added to the action.
+ * @property {string} [url] - The URL for the action.
  * @property {PageType} type
  */
 
@@ -693,6 +704,7 @@ const Joi = require("joi");
  *   | "category"
  *   | "collection"
  *   | "collections"
+ *   | "custom"
  *   | "contact-us"
  *   | "external"
  *   | "faq"
@@ -825,6 +837,21 @@ class ThemePartnerModel {
     });
   }
 
+  /** @returns {ExtensionPreviewRequest} */
+  static ExtensionPreviewRequest() {
+    return Joi.object({
+      application_id: Joi.string().allow(""),
+      section_preview_hash: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {ExtensionPreviewResponse} */
+  static ExtensionPreviewResponse() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {PublishExtensionSectionResponse} */
   static PublishExtensionSectionResponse() {
     return Joi.object({
@@ -1620,6 +1647,8 @@ class ThemePartnerModel {
 
       "collections",
 
+      "custom",
+
       "contact-us",
 
       "external",

package/sdk/partner/Theme/ThemePartnerValidator.d.ts

@@ -19,6 +19,8 @@ declare class ThemeValidator {
     static createNewThemeInOrganization(): any;
     static createExtensionSectionDraft(): any;
     static publishExtensionSections(): any;
+    static applyExtensionPreview(): any;
+    static removeExtensionPreview(): any;
     static getThemeRejectionReasons(): any;
     static getThemeVersions(): any;
     static createTheme(): any;

package/sdk/partner/Theme/ThemePartnerValidator.js

@@ -153,6 +153,20 @@ class ThemeValidator {
     }).required();
   }
 
+  static applyExtensionPreview() {
+    return Joi.object({
+      extensionSectionId: Joi.string().allow("").required(),
+      body: ThemeModel.ExtensionPreviewRequest().required(),
+    }).required();
+  }
+
+  static removeExtensionPreview() {
+    return Joi.object({
+      extensionSectionId: Joi.string().allow("").required(),
+      body: ThemeModel.ExtensionPreviewRequest().required(),
+    }).required();
+  }
+
   static getThemeRejectionReasons() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),

package/sdk/partner/Webhook/WebhookPartnerModel.d.ts

@@ -179,13 +179,13 @@ export = WebhookPartnerModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 /**
  * @typedef DeliveryEventLevelSchema
@@ -516,12 +516,33 @@ type EventProcessReportObject = {
 /** @returns {Page} */
 declare function Page(): Page;
 type Page = {
+    /**
+     * - The total number of items on the page.
+     */
     item_total?: number;
+    /**
+     * - The identifier for the next page.
+     */
     next_id?: string;
+    /**
+     * - Indicates whether there is a previous page.
+     */
     has_previous?: boolean;
+    /**
+     * - Indicates whether there is a next page.
+     */
     has_next?: boolean;
+    /**
+     * - The current page number.
+     */
     current?: number;
+    /**
+     * - The type of the page, such as 'PageType'.
+     */
     type: string;
+    /**
+     * - The number of items per page.
+     */
     size?: number;
 };
 /** @returns {DeliveryEventLevelSchema} */

package/sdk/partner/Webhook/WebhookPartnerModel.js

@@ -205,13 +205,13 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 
 /**

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

@@ -1,13 +1,13 @@
 export = AnalyticsPlatformModel;
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 /**
  * @typedef FileDownloadRequestBody
@@ -28,12 +28,33 @@ declare namespace AnalyticsPlatformModel {
 /** @returns {Page} */
 declare function Page(): Page;
 type Page = {
+    /**
+     * - The total number of items on the page.
+     */
     item_total?: number;
+    /**
+     * - The identifier for the next page.
+     */
     next_id?: string;
+    /**
+     * - Indicates whether there is a previous page.
+     */
     has_previous?: boolean;
+    /**
+     * - Indicates whether there is a next page.
+     */
     has_next?: boolean;
+    /**
+     * - The current page number.
+     */
     current?: number;
+    /**
+     * - The type of the page, such as 'PageType'.
+     */
     type: string;
+    /**
+     * - The number of items per page.
+     */
     size?: number;
 };
 /** @returns {FileDownloadRequestBody} */

package/sdk/platform/Analytics/AnalyticsPlatformModel.js

@@ -2,13 +2,13 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 
 /**

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

@@ -63,6 +63,17 @@ declare class Billing {
      * @description: Generate a one-time charge for specific services or products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createOneTimeCharge/).
      */
     createOneTimeCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateOneTimeChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateOneTimeChargeResponse>;
+    /**
+     * @param {BillingPlatformValidator.CreateSubscriptionChargeParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<BillingPlatformModel.CreateSubscriptionResponse>} -
+     *   Success response
+     * @name createSubscriptionCharge
+     * @summary: Initiate subscription billing
+     * @description: Register a subscription charge for a seller using your extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createSubscriptionCharge/).
+     */
+    createSubscriptionCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateSubscriptionResponse>;
     /**
      * @param {BillingPlatformValidator.CreditTransactionParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -84,6 +95,16 @@ declare class Billing {
      * @description: Retrieve configuration settings for feature limits in subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/currentAppLimit/).
      */
     currentAppLimit({ productSuite, type, requestHeaders }?: BillingPlatformValidator.CurrentAppLimitParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionLimit>;
+    /**
+     * @param {BillingPlatformValidator.CurrentLimitParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<BillingPlatformModel.SubscriptionLimit>} - Success response
+     * @name currentLimit
+     * @summary: Obtain feature limit configurations.
+     * @description: Retrieve configuration settings for feature limits in subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/currentLimit/).
+     */
+    currentLimit({ productSuite, type, requestHeaders }?: BillingPlatformValidator.CurrentLimitParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionLimit>;
     /**
      * @param {BillingPlatformValidator.GetBankListParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -124,16 +145,6 @@ declare class Billing {
      * @description: Retrieve available enterprise-level subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getEnterprisePlans/).
      */
     getEnterprisePlans({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.Plan[]>;
-    /**
-     * @param {BillingPlatformValidator.GetFeatureLimitConfigParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<BillingPlatformModel.SubscriptionLimit>} - Success response
-     * @name getFeatureLimitConfig
-     * @summary: Obtain feature limit configurations.
-     * @description: Retrieve configuration settings for feature limits in subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getFeatureLimitConfig/).
-     */
-    getFeatureLimitConfig({ productSuite, type, requestHeaders }?: BillingPlatformValidator.GetFeatureLimitConfigParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionLimit>;
     /**
      * @param {BillingPlatformValidator.GetInvoiceByIdParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/platform/Billing/BillingPlatformClient.js

@@ -501,6 +501,90 @@ class Billing {
     return response;
   }
 
+  /**
+   * @param {BillingPlatformValidator.CreateSubscriptionChargeParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<BillingPlatformModel.CreateSubscriptionResponse>} -
+   *   Success response
+   * @name createSubscriptionCharge
+   * @summary: Initiate subscription billing
+   * @description: Register a subscription charge for a seller using your extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createSubscriptionCharge/).
+   */
+  async createSubscriptionCharge(
+    { extensionId, body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = BillingPlatformValidator.createSubscriptionCharge().validate(
+      {
+        extensionId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = BillingPlatformValidator.createSubscriptionCharge().validate(
+      {
+        extensionId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Billing > createSubscriptionCharge \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/billing/v1.0/company/${this.config.companyId}/extension/${extensionId}/subscription`,
+      query_params,
+      body,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = BillingPlatformModel.CreateSubscriptionResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > Billing > createSubscriptionCharge \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {BillingPlatformValidator.CreditTransactionParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -700,6 +784,89 @@ class Billing {
     return response;
   }
 
+  /**
+   * @param {BillingPlatformValidator.CurrentLimitParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<BillingPlatformModel.SubscriptionLimit>} - Success response
+   * @name currentLimit
+   * @summary: Obtain feature limit configurations.
+   * @description: Retrieve configuration settings for feature limits in subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/currentLimit/).
+   */
+  async currentLimit(
+    { productSuite, type, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = BillingPlatformValidator.currentLimit().validate(
+      {
+        productSuite,
+        type,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = BillingPlatformValidator.currentLimit().validate(
+      {
+        productSuite,
+        type,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Billing > currentLimit \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+    query_params["product_suite"] = productSuite;
+    query_params["type"] = type;
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/billing/v1.0/company/${this.config.companyId}/subscription/current-limit`,
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = BillingPlatformModel.SubscriptionLimit().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > Billing > currentLimit \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {BillingPlatformValidator.GetBankListParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -998,89 +1165,6 @@ class Billing {
     return response;
   }
 
-  /**
-   * @param {BillingPlatformValidator.GetFeatureLimitConfigParam} arg - Arg object
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<BillingPlatformModel.SubscriptionLimit>} - Success response
-   * @name getFeatureLimitConfig
-   * @summary: Obtain feature limit configurations.
-   * @description: Retrieve configuration settings for feature limits in subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getFeatureLimitConfig/).
-   */
-  async getFeatureLimitConfig(
-    { productSuite, type, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const { error } = BillingPlatformValidator.getFeatureLimitConfig().validate(
-      {
-        productSuite,
-        type,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = BillingPlatformValidator.getFeatureLimitConfig().validate(
-      {
-        productSuite,
-        type,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Billing > getFeatureLimitConfig \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-    query_params["product_suite"] = productSuite;
-    query_params["type"] = type;
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/billing/v1.0/company/${this.config.companyId}/subscription/current-limit`,
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = BillingPlatformModel.SubscriptionLimit().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for platform > Billing > getFeatureLimitConfig \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
   /**
    * @param {BillingPlatformValidator.GetInvoiceByIdParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`