@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0

package/sdk/platform/Theme/ThemePlatformApplicationValidator.js

@@ -2,6 +2,11 @@ const Joi = require("joi");
 
 const ThemePlatformModel = require("./ThemePlatformModel");
 
+/**
+ * @typedef AddThemeToApplicationParam
+ * @property {ThemePlatformModel.ThemeReq} body
+ */
+
 /**
  * @typedef ApplyThemeParam
  * @property {string} themeId - The ID of the apply
@@ -13,11 +18,6 @@ const ThemePlatformModel = require("./ThemePlatformModel");
  * @property {ThemePlatformModel.AvailablePageSchema} body
  */
 
-/**
- * @typedef CreateThemeParam
- * @property {ThemePlatformModel.CompanyThemeReqSchema} body
- */
-
 /**
  * @typedef DeletePageParam
  * @property {string} themeId - ID of the theme
@@ -51,13 +51,10 @@ const ThemePlatformModel = require("./ThemePlatformModel");
  * @property {string} [companyMode] - The mode of the company
  */
 
-/** @typedef GetFontsParam */
-
-/** @typedef GetFontsV2Param */
-
 /**
- * @typedef GetLatestVersionOfThemeBySlugParam
- * @property {string} slugName - Slug of theme
+ * @typedef GetFontsParam
+ * @property {string} [capability] - Filter fonts based on supported
+ *   capabilities (e.g., "WOFF2").
  */
 
 /**
@@ -96,13 +93,14 @@ const ThemePlatformModel = require("./ThemePlatformModel");
  * @typedef UpdatePageParam
  * @property {string} themeId - ID of the theme
  * @property {string} pageValue - Value of the page to be updated
+ * @property {string} socketId - Unique socket id for websocket
  * @property {ThemePlatformModel.AvailablePageSchema} body
  */
 
 /**
  * @typedef UpdateThemeParam
  * @property {string} themeId - The ID of the theme.
- * @property {ThemePlatformModel.ThemesSchema} body
+ * @property {ThemePlatformModel.UpdateThemeRequestBody} body
  */
 
 /**
@@ -117,6 +115,13 @@ const ThemePlatformModel = require("./ThemePlatformModel");
  */
 
 class ThemePlatformApplicationValidator {
+  /** @returns {AddThemeToApplicationParam} */
+  static addThemeToApplication() {
+    return Joi.object({
+      body: ThemePlatformModel.ThemeReq().required(),
+    }).required();
+  }
+
   /** @returns {ApplyThemeParam} */
   static applyTheme() {
     return Joi.object({
@@ -132,13 +137,6 @@ class ThemePlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {CreateThemeParam} */
-  static createTheme() {
-    return Joi.object({
-      body: ThemePlatformModel.CompanyThemeReqSchema().required(),
-    }).required();
-  }
-
   /** @returns {DeletePageParam} */
   static deletePage() {
     return Joi.object({
@@ -193,18 +191,8 @@ class ThemePlatformApplicationValidator {
 
   /** @returns {GetFontsParam} */
   static getFonts() {
-    return Joi.object({}).required();
-  }
-
-  /** @returns {GetFontsV2Param} */
-  static getFontsV2() {
-    return Joi.object({}).required();
-  }
-
-  /** @returns {GetLatestVersionOfThemeBySlugParam} */
-  static getLatestVersionOfThemeBySlug() {
     return Joi.object({
-      slugName: Joi.string().allow("").required(),
+      capability: Joi.string().allow(""),
     }).required();
   }
 
@@ -257,6 +245,7 @@ class ThemePlatformApplicationValidator {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
       pageValue: Joi.string().allow("").required(),
+      socketId: Joi.string().allow("").required(),
       body: ThemePlatformModel.AvailablePageSchema().required(),
     }).required();
   }
@@ -265,7 +254,7 @@ class ThemePlatformApplicationValidator {
   static updateTheme() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
-      body: ThemePlatformModel.ThemesSchema().required(),
+      body: ThemePlatformModel.UpdateThemeRequestBody().required(),
     }).required();
   }
 

package/sdk/platform/Theme/ThemePlatformClient.d.ts

@@ -6,52 +6,42 @@ declare class Theme {
      * @param {ThemePlatformValidator.AddMarketplaceThemeToCompanyParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
+     * @returns {Promise<ThemePlatformModel.CompanyThemeSchema>} - Success response
      * @name addMarketplaceThemeToCompany
      * @summary: Create a company theme
      * @description: Incorporate a marketplace theme into a company's profile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/addMarketplaceThemeToCompany/).
      */
-    addMarketplaceThemeToCompany({ body, requestHeaders }?: ThemePlatformValidator.AddMarketplaceThemeToCompanyParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
+    addMarketplaceThemeToCompany({ body, requestHeaders }?: ThemePlatformValidator.AddMarketplaceThemeToCompanyParam, { responseHeaders }?: object): Promise<ThemePlatformModel.CompanyThemeSchema>;
     /**
      * @param {ThemePlatformValidator.DeleteCompanyThemeParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
+     * @returns {Promise<ThemePlatformModel.CompanyThemeSchema>} - Success response
      * @name deleteCompanyTheme
      * @summary: Delete a company theme
      * @description: Remove a theme associated with a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/deleteCompanyTheme/).
      */
-    deleteCompanyTheme({ themeId, requestHeaders }?: ThemePlatformValidator.DeleteCompanyThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
+    deleteCompanyTheme({ themeId, requestHeaders }?: ThemePlatformValidator.DeleteCompanyThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.CompanyThemeSchema>;
     /**
      * @param {ThemePlatformValidator.GetCompanyLevelPrivateThemesParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ThemePlatformModel.ThemesSchema[]>} - Success response
+     * @returns {Promise<ThemePlatformModel.CompanyPrivateTheme[]>} - Success response
      * @name getCompanyLevelPrivateThemes
      * @summary: List private company themes
      * @description: Retrieve a list of private themes added to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getCompanyLevelPrivateThemes/).
      */
-    getCompanyLevelPrivateThemes({ searchText, requestHeaders }?: ThemePlatformValidator.GetCompanyLevelPrivateThemesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema[]>;
+    getCompanyLevelPrivateThemes({ searchText, requestHeaders }?: ThemePlatformValidator.GetCompanyLevelPrivateThemesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.CompanyPrivateTheme[]>;
     /**
      * @param {ThemePlatformValidator.GetCompanyLevelThemesParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ThemePlatformModel.ThemesSchema[]>} - Success response
+     * @returns {Promise<ThemePlatformModel.CompanyThemeSchema[]>} - Success response
      * @name getCompanyLevelThemes
      * @summary: List company themes
      * @description: Retrieve themes added to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getCompanyLevelThemes/).
      */
-    getCompanyLevelThemes({ searchText, requestHeaders }?: ThemePlatformValidator.GetCompanyLevelThemesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema[]>;
-    /**
-     * @param {ThemePlatformValidator.GetDefaultMarketplaceThemeParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ThemePlatformModel.MarketplaceTheme>} - Success response
-     * @name getDefaultMarketplaceTheme
-     * @summary: Get default marketplace theme.
-     * @description: Retrieve the most recent version of a theme using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getDefaultMarketplaceTheme/).
-     */
-    getDefaultMarketplaceTheme({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.MarketplaceTheme>;
+    getCompanyLevelThemes({ searchText, requestHeaders }?: ThemePlatformValidator.GetCompanyLevelThemesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.CompanyThemeSchema[]>;
 }
 import ThemePlatformValidator = require("./ThemePlatformValidator");
 import ThemePlatformModel = require("./ThemePlatformModel");

package/sdk/platform/Theme/ThemePlatformClient.js

@@ -18,7 +18,7 @@ class Theme {
    * @param {ThemePlatformValidator.AddMarketplaceThemeToCompanyParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
+   * @returns {Promise<ThemePlatformModel.CompanyThemeSchema>} - Success response
    * @name addMarketplaceThemeToCompany
    * @summary: Create a company theme
    * @description: Incorporate a marketplace theme into a company's profile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/addMarketplaceThemeToCompany/).
@@ -76,7 +76,7 @@ class Theme {
 
     const {
       error: res_error,
-    } = ThemePlatformModel.ThemesSchema().validate(responseData, {
+    } = ThemePlatformModel.CompanyThemeSchema().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -99,7 +99,7 @@ class Theme {
    * @param {ThemePlatformValidator.DeleteCompanyThemeParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
+   * @returns {Promise<ThemePlatformModel.CompanyThemeSchema>} - Success response
    * @name deleteCompanyTheme
    * @summary: Delete a company theme
    * @description: Remove a theme associated with a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/deleteCompanyTheme/).
@@ -155,7 +155,7 @@ class Theme {
 
     const {
       error: res_error,
-    } = ThemePlatformModel.ThemesSchema().validate(responseData, {
+    } = ThemePlatformModel.CompanyThemeSchema().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -178,7 +178,7 @@ class Theme {
    * @param {ThemePlatformValidator.GetCompanyLevelPrivateThemesParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ThemePlatformModel.ThemesSchema[]>} - Success response
+   * @returns {Promise<ThemePlatformModel.CompanyPrivateTheme[]>} - Success response
    * @name getCompanyLevelPrivateThemes
    * @summary: List private company themes
    * @description: Retrieve a list of private themes added to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getCompanyLevelPrivateThemes/).
@@ -236,7 +236,7 @@ class Theme {
     }
 
     const { error: res_error } = Joi.array()
-      .items(ThemePlatformModel.ThemesSchema())
+      .items(ThemePlatformModel.CompanyPrivateTheme())
       .validate(responseData, { abortEarly: false, allowUnknown: true });
 
     if (res_error) {
@@ -257,7 +257,7 @@ class Theme {
    * @param {ThemePlatformValidator.GetCompanyLevelThemesParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ThemePlatformModel.ThemesSchema[]>} - Success response
+   * @returns {Promise<ThemePlatformModel.CompanyThemeSchema[]>} - Success response
    * @name getCompanyLevelThemes
    * @summary: List company themes
    * @description: Retrieve themes added to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getCompanyLevelThemes/).
@@ -313,7 +313,7 @@ class Theme {
     }
 
     const { error: res_error } = Joi.array()
-      .items(ThemePlatformModel.ThemesSchema())
+      .items(ThemePlatformModel.CompanyThemeSchema())
       .validate(responseData, { abortEarly: false, allowUnknown: true });
 
     if (res_error) {
@@ -329,83 +329,6 @@ class Theme {
 
     return response;
   }
-
-  /**
-   * @param {ThemePlatformValidator.GetDefaultMarketplaceThemeParam} arg - Arg object
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ThemePlatformModel.MarketplaceTheme>} - Success response
-   * @name getDefaultMarketplaceTheme
-   * @summary: Get default marketplace theme.
-   * @description: Retrieve the most recent version of a theme using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getDefaultMarketplaceTheme/).
-   */
-  async getDefaultMarketplaceTheme(
-    { requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const {
-      error,
-    } = ThemePlatformValidator.getDefaultMarketplaceTheme().validate(
-      {},
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = ThemePlatformValidator.getDefaultMarketplaceTheme().validate(
-      {},
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Theme > getDefaultMarketplaceTheme \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/theme/v2.0/company/${this.config.companyId}/default`,
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = ThemePlatformModel.MarketplaceTheme().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 > Theme > getDefaultMarketplaceTheme \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
 }
 
 module.exports = Theme;