@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

package/sdk/platform/Theme/ThemePlatformApplicationValidator.js

@@ -1,65 +1,236 @@
 const Joi = require("joi");
 
-const ThemeModel = require("./ThemePlatformModel");
-class ThemeValidator {
+const ThemePlatformModel = require("./ThemePlatformModel");
+
+/**
+ * @typedef AddThemeToApplicationParam
+ * @property {ThemePlatformModel.ThemeReq} body
+ */
+
+/**
+ * @typedef AddToThemeLibraryParam
+ * @property {ThemePlatformModel.AddThemeRequestSchema} body
+ */
+
+/**
+ * @typedef ApplyThemeParam
+ * @property {string} themeId - The ID of the apply
+ */
+
+/**
+ * @typedef ArchiveThemeParam
+ * @property {string} themeId - ID allotted to the theme.
+ */
+
+/**
+ * @typedef CreatePageParam
+ * @property {string} themeId - ID of the theme
+ * @property {ThemePlatformModel.AvailablePageSchema} body
+ */
+
+/**
+ * @typedef DeletePageParam
+ * @property {string} themeId - ID of the theme
+ * @property {string} pageValue - Value of the page to be updated
+ */
+
+/**
+ * @typedef DeleteThemeParam
+ * @property {string} themeId - The ID of the theme to be deleted.
+ */
+
+/**
+ * @typedef DuplicateThemeParam
+ * @property {string} themeId - The ID of the theme to be duplicated
+ */
+
+/**
+ * @typedef GetAllPagesParam
+ * @property {string} themeId - ID of the theme to be retrieved
+ */
+
+/** @typedef GetApplicationThemesParam */
+
+/** @typedef GetApplicationThemesCountParam */
+
+/** @typedef GetAppliedThemeParam */
+
+/** @typedef GetFontsParam */
+
+/**
+ * @typedef GetPageParam
+ * @property {string} themeId - ID of the theme to be retrieved
+ * @property {string} pageValue - Value of the page to be retrieved
+ */
+
+/**
+ * @typedef GetPublicThemesParam
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
+ *   Default value is 10.
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results. Default value is 1.
+ */
+
+/**
+ * @typedef GetThemeByIdParam
+ * @property {string} themeId - The ID of the theme
+ */
+
+/**
+ * @typedef GetThemeForPreviewParam
+ * @property {string} themeId - The ID of the theme
+ */
+
+/**
+ * @typedef GetThemeLastModifiedParam
+ * @property {string} themeId - ID allotted to the theme.
+ */
+
+/**
+ * @typedef GetThemeLibraryParam
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
+ *   Default value is 10.
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results. Default value is 1.
+ */
+
+/**
+ * @typedef IsUpgradableParam
+ * @property {string} themeId - The ID of the theme
+ */
+
+/**
+ * @typedef PublishThemeParam
+ * @property {string} themeId - ID allotted to the theme.
+ */
+
+/**
+ * @typedef UnarchiveThemeParam
+ * @property {string} themeId - ID allotted to the theme.
+ */
+
+/**
+ * @typedef UnpublishThemeParam
+ * @property {string} themeId - ID allotted to the theme.
+ */
+
+/**
+ * @typedef UpdateMultiplePagesParam
+ * @property {string} themeId - ID of the theme to be retrieved
+ * @property {ThemePlatformModel.AllAvailablePageSchema} body
+ */
+
+/**
+ * @typedef UpdatePageParam
+ * @property {string} themeId - ID of the theme
+ * @property {string} pageValue - Value of the page to be updated
+ * @property {ThemePlatformModel.AvailablePageSchema} body
+ */
+
+/**
+ * @typedef UpdateThemeParam
+ * @property {string} themeId - The ID of the theme.
+ * @property {ThemePlatformModel.UpdateThemeRequestBody} body
+ */
+
+/**
+ * @typedef UpdateThemeNameParam
+ * @property {string} themeId - The ID of the theme to be updated.
+ * @property {ThemePlatformModel.UpdateThemeNameRequestBody} body
+ */
+
+/**
+ * @typedef UpgradeThemeParam
+ * @property {string} themeId - The ID of the upgrade
+ */
+
+class ThemePlatformApplicationValidator {
+  /** @returns {AddThemeToApplicationParam} */
+  static addThemeToApplication() {
+    return Joi.object({
+      body: ThemePlatformModel.ThemeReq().required(),
+    }).required();
+  }
+
+  /** @returns {AddToThemeLibraryParam} */
   static addToThemeLibrary() {
     return Joi.object({
-      body: ThemeModel.AddThemeRequestSchema().required(),
+      body: ThemePlatformModel.AddThemeRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {ApplyThemeParam} */
   static applyTheme() {
     return Joi.object({
-      body: ThemeModel.AddThemeRequestSchema().required(),
+      themeId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {ArchiveThemeParam} */
   static archiveTheme() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {CreatePageParam} */
   static createPage() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
-      body: ThemeModel.AvailablePageSchema().required(),
+      body: ThemePlatformModel.AvailablePageSchema().required(),
     }).required();
   }
 
-  static createTheme() {
+  /** @returns {DeletePageParam} */
+  static deletePage() {
     return Joi.object({
-      body: ThemeModel.ThemesSchema().required(),
+      themeId: Joi.string().allow("").required(),
+      pageValue: Joi.string().allow("").required(),
     }).required();
   }
 
-  static deletePage() {
+  /** @returns {DeleteThemeParam} */
+  static deleteTheme() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
-      pageValue: Joi.string().allow("").required(),
     }).required();
   }
 
-  static deleteTheme() {
+  /** @returns {DuplicateThemeParam} */
+  static duplicateTheme() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetAllPagesParam} */
   static getAllPages() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetApplicationThemesParam} */
+  static getApplicationThemes() {
+    return Joi.object({}).required();
+  }
+
+  /** @returns {GetApplicationThemesCountParam} */
+  static getApplicationThemesCount() {
+    return Joi.object({}).required();
+  }
+
+  /** @returns {GetAppliedThemeParam} */
   static getAppliedTheme() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetFontsParam} */
   static getFonts() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetPageParam} */
   static getPage() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
@@ -67,6 +238,7 @@ class ThemeValidator {
     }).required();
   }
 
+  /** @returns {GetPublicThemesParam} */
   static getPublicThemes() {
     return Joi.object({
       pageSize: Joi.number(),
@@ -74,24 +246,28 @@ class ThemeValidator {
     }).required();
   }
 
+  /** @returns {GetThemeByIdParam} */
   static getThemeById() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetThemeForPreviewParam} */
   static getThemeForPreview() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetThemeLastModifiedParam} */
   static getThemeLastModified() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetThemeLibraryParam} */
   static getThemeLibrary() {
     return Joi.object({
       pageSize: Joi.number(),
@@ -99,52 +275,68 @@ class ThemeValidator {
     }).required();
   }
 
+  /** @returns {IsUpgradableParam} */
   static isUpgradable() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {PublishThemeParam} */
   static publishTheme() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {UnarchiveThemeParam} */
   static unarchiveTheme() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {UnpublishThemeParam} */
   static unpublishTheme() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {UpdateMultiplePagesParam} */
   static updateMultiplePages() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
-      body: ThemeModel.AllAvailablePageSchema().required(),
+      body: ThemePlatformModel.AllAvailablePageSchema().required(),
     }).required();
   }
 
+  /** @returns {UpdatePageParam} */
   static updatePage() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
       pageValue: Joi.string().allow("").required(),
-      body: ThemeModel.AvailablePageSchema().required(),
+      body: ThemePlatformModel.AvailablePageSchema().required(),
     }).required();
   }
 
+  /** @returns {UpdateThemeParam} */
   static updateTheme() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
-      body: ThemeModel.ThemesSchema().required(),
+      body: ThemePlatformModel.UpdateThemeRequestBody().required(),
+    }).required();
+  }
+
+  /** @returns {UpdateThemeNameParam} */
+  static updateThemeName() {
+    return Joi.object({
+      themeId: Joi.string().allow("").required(),
+      body: ThemePlatformModel.UpdateThemeNameRequestBody().required(),
     }).required();
   }
 
+  /** @returns {UpgradeThemeParam} */
   static upgradeTheme() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
@@ -152,4 +344,4 @@ class ThemeValidator {
   }
 }
 
-module.exports = ThemeValidator;
+module.exports = ThemePlatformApplicationValidator;

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

@@ -0,0 +1,37 @@
+export = Theme;
+declare class Theme {
+    constructor(config: any);
+    config: any;
+    /**
+     * @param {ThemePlatformValidator.AddMarketplaceThemeToCompanyParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ThemePlatformModel.CompanyThemeSchema>} - Success response
+     * @name addMarketplaceThemeToCompany
+     * @summary: Add a theme to a company
+     * @description: Add a marketplace theme to a company by providing the theme ID and company ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/addMarketplaceThemeToCompany/).
+     */
+    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.CompanyThemeSchema>} - Success response
+     * @name deleteCompanyTheme
+     * @summary: Delete a theme
+     * @description: Delete a specific theme for a company by providing the company ID and theme ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/deleteCompanyTheme/).
+     */
+    deleteCompanyTheme({ themeId, requestHeaders }?: ThemePlatformValidator.DeleteCompanyThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.CompanyThemeSchema>;
+    /**
+     * @param {ThemePlatformValidator.GetCompanyLevelThemesParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ThemePlatformModel.CompanyThemeSchema[]>} - Success response
+     * @name getCompanyLevelThemes
+     * @summary: Get themes for a company
+     * @description: Retrieve a list of themes available for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getCompanyLevelThemes/).
+     */
+    getCompanyLevelThemes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.CompanyThemeSchema[]>;
+}
+import ThemePlatformValidator = require("./ThemePlatformValidator");
+import ThemePlatformModel = require("./ThemePlatformModel");

package/sdk/platform/Theme/ThemePlatformClient.js

@@ -0,0 +1,235 @@
+const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const Paginator = require("../../common/Paginator");
+const ThemePlatformValidator = require("./ThemePlatformValidator");
+const ThemePlatformModel = require("./ThemePlatformModel");
+const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
+
+class Theme {
+  constructor(config) {
+    this.config = config;
+  }
+
+  /**
+   * @param {ThemePlatformValidator.AddMarketplaceThemeToCompanyParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<ThemePlatformModel.CompanyThemeSchema>} - Success response
+   * @name addMarketplaceThemeToCompany
+   * @summary: Add a theme to a company
+   * @description: Add a marketplace theme to a company by providing the theme ID and company ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/addMarketplaceThemeToCompany/).
+   */
+  async addMarketplaceThemeToCompany(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = ThemePlatformValidator.addMarketplaceThemeToCompany().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ThemePlatformValidator.addMarketplaceThemeToCompany().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Theme > addMarketplaceThemeToCompany \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/theme/v2.0/company/${this.config.companyId}`,
+      query_params,
+      body,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ThemePlatformModel.CompanyThemeSchema().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: `Response Validation Warnnings for platform > Theme > addMarketplaceThemeToCompany \n ${res_error}`,
+      });
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {ThemePlatformValidator.DeleteCompanyThemeParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<ThemePlatformModel.CompanyThemeSchema>} - Success response
+   * @name deleteCompanyTheme
+   * @summary: Delete a theme
+   * @description: Delete a specific theme for a company by providing the company ID and theme ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/deleteCompanyTheme/).
+   */
+  async deleteCompanyTheme(
+    { themeId, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemePlatformValidator.deleteCompanyTheme().validate(
+      {
+        themeId,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ThemePlatformValidator.deleteCompanyTheme().validate(
+      {
+        themeId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Theme > deleteCompanyTheme \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "delete",
+      `/service/platform/theme/v2.0/company/${this.config.companyId}/${themeId}`,
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ThemePlatformModel.CompanyThemeSchema().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: `Response Validation Warnnings for platform > Theme > deleteCompanyTheme \n ${res_error}`,
+      });
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {ThemePlatformValidator.GetCompanyLevelThemesParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<ThemePlatformModel.CompanyThemeSchema[]>} - Success response
+   * @name getCompanyLevelThemes
+   * @summary: Get themes for a company
+   * @description: Retrieve a list of themes available for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getCompanyLevelThemes/).
+   */
+  async getCompanyLevelThemes(
+    { requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemePlatformValidator.getCompanyLevelThemes().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.getCompanyLevelThemes().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Theme > getCompanyLevelThemes \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/theme/v2.0/company/${this.config.companyId}/themes`,
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const { error: res_error } = Joi.array()
+      .items(ThemePlatformModel.CompanyThemeSchema())
+      .validate(responseData, { abortEarly: false, allowUnknown: false });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: `Response Validation Warnnings for platform > Theme > getCompanyLevelThemes \n ${res_error}`,
+      });
+    }
+
+    return response;
+  }
+}
+
+module.exports = Theme;