@gofynd/fdk-client-javascript 1.4.1 → 1.4.2-beta.10

package/sdk/platform/Share/SharePlatformModel.js

@@ -1,14 +1,9 @@
 const Joi = require("joi");
 
 /**
- * @typedef Attribution
- * @property {string} [campaign_cookie_expiry]
- */
-
-/**
- * @typedef CampaignShortLink
- * @property {string} [medium]
- * @property {string} [source]
+ * @typedef ClickStatsResponse
+ * @property {ClickStatsItem[]} click_stats - An array of click statistics for
+ *   the short link.
  */
 
 /**
@@ -18,120 +13,119 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef ClickStatsResponse
- * @property {ClickStatsItem[]} click_stats - An array of click statistics for
- *   the short link.
+ * @typedef RedirectDevice
+ * @property {string} [link]
+ * @property {string} [type]
  */
 
 /**
- * @typedef ErrorRes
- * @property {string} [message]
+ * @typedef WebRedirect
+ * @property {string} [link]
+ * @property {string} [type]
  */
 
 /**
- * @typedef Page
- * @property {number} [current]
- * @property {boolean} [has_next]
- * @property {boolean} [has_previous]
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {number} [size]
- * @property {string} type
+ * @typedef Redirects
+ * @property {RedirectDevice} [ios]
+ * @property {RedirectDevice} [android]
+ * @property {WebRedirect} [web]
+ * @property {boolean} [force_web]
  */
 
 /**
- * @typedef RedirectDevice
- * @property {string} [link]
- * @property {string} [type]
+ * @typedef CampaignShortLink
+ * @property {string} [source]
+ * @property {string} [medium]
  */
 
 /**
- * @typedef Redirects
- * @property {RedirectDevice} [android]
- * @property {boolean} [force_web]
- * @property {RedirectDevice} [ios]
- * @property {WebRedirect} [web]
+ * @typedef Attribution
+ * @property {string} [campaign_cookie_expiry]
  */
 
 /**
- * @typedef ShortLinkList
- * @property {ShortLinkRes[]} [items]
- * @property {Page} [page]
+ * @typedef SocialMediaTags
+ * @property {string} [title]
+ * @property {string} [description]
+ * @property {string} [image]
  */
 
 /**
  * @typedef ShortLinkReq
+ * @property {string} title - Give a name to the link.
+ * @property {string} url - The web address to shorten.
+ * @property {string} [hash]
  * @property {boolean} [active]
- * @property {Attribution} [attribution]
- * @property {CampaignShortLink} [campaign]
- * @property {number} [count]
- * @property {boolean} [enable_tracking]
  * @property {string} [expire_at]
- * @property {string} [hash]
+ * @property {boolean} [enable_tracking]
  * @property {boolean} [personalized] - To create personalized short links.
+ * @property {CampaignShortLink} [campaign]
  * @property {Redirects} [redirects]
+ * @property {Attribution} [attribution]
  * @property {SocialMediaTags} [social_media_tags]
- * @property {string} title - Give a name to the link.
- * @property {string} url - The web address to shorten.
+ * @property {number} [count]
+ */
+
+/**
+ * @typedef UrlInfo
+ * @property {string} [original]
+ * @property {string} [short]
+ * @property {string} [hash]
  */
 
 /**
  * @typedef ShortLinkRes
- * @property {string} [_id]
- * @property {boolean} [active]
- * @property {boolean} [app_redirect]
- * @property {string} [application]
- * @property {Attribution} [attribution]
- * @property {CampaignShortLink} [campaign]
- * @property {number} [count]
- * @property {string} [created_at]
+ * @property {string} [title]
+ * @property {UrlInfo} [url]
  * @property {string} [created_by]
+ * @property {boolean} [app_redirect]
+ * @property {string} [fallback]
+ * @property {boolean} [active]
+ * @property {string} [_id]
  * @property {boolean} [enable_tracking]
  * @property {string} [expire_at]
- * @property {string} [fallback]
+ * @property {string} [application]
+ * @property {string} [user_id]
+ * @property {string} [created_at]
  * @property {Object} [meta]
+ * @property {string} [updated_at]
  * @property {boolean} [personalized] - To create personalized short links
+ * @property {CampaignShortLink} [campaign]
  * @property {Redirects} [redirects]
+ * @property {Attribution} [attribution]
  * @property {SocialMediaTags} [social_media_tags]
- * @property {string} [title]
- * @property {string} [updated_at]
- * @property {UrlInfo} [url]
- * @property {string} [user_id]
+ * @property {number} [count]
  */
 
 /**
- * @typedef SocialMediaTags
- * @property {string} [description]
- * @property {string} [image]
- * @property {string} [title]
+ * @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]
  */
 
 /**
- * @typedef UrlInfo
- * @property {string} [hash]
- * @property {string} [original]
- * @property {string} [short]
+ * @typedef ShortLinkList
+ * @property {ShortLinkRes[]} [items]
+ * @property {Page} [page]
  */
 
 /**
- * @typedef WebRedirect
- * @property {string} [link]
- * @property {string} [type]
+ * @typedef ErrorRes
+ * @property {string} [message]
  */
 
 class SharePlatformModel {
-  /** @returns {Attribution} */
-  static Attribution() {
-    return Joi.object({
-      campaign_cookie_expiry: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {CampaignShortLink} */
-  static CampaignShortLink() {
+  /** @returns {ClickStatsResponse} */
+  static ClickStatsResponse() {
     return Joi.object({
-      medium: Joi.string().allow(""),
-      source: Joi.string().allow(""),
+      click_stats: Joi.array()
+        .items(SharePlatformModel.ClickStatsItem())
+        .required(),
     });
   }
 
@@ -143,128 +137,134 @@ class SharePlatformModel {
     });
   }
 
-  /** @returns {ClickStatsResponse} */
-  static ClickStatsResponse() {
+  /** @returns {RedirectDevice} */
+  static RedirectDevice() {
     return Joi.object({
-      click_stats: Joi.array()
-        .items(SharePlatformModel.ClickStatsItem())
-        .required(),
+      link: Joi.string().allow(""),
+      type: Joi.string().allow(""),
     });
   }
 
-  /** @returns {ErrorRes} */
-  static ErrorRes() {
+  /** @returns {WebRedirect} */
+  static WebRedirect() {
     return Joi.object({
-      message: Joi.string().allow(""),
+      link: Joi.string().allow(""),
+      type: Joi.string().allow(""),
     });
   }
 
-  /** @returns {Page} */
-  static Page() {
+  /** @returns {Redirects} */
+  static Redirects() {
     return Joi.object({
-      current: Joi.number(),
-      has_next: Joi.boolean(),
-      has_previous: Joi.boolean(),
-      item_total: Joi.number(),
-      next_id: Joi.string().allow(""),
-      size: Joi.number(),
-      type: Joi.string().allow("").required(),
+      ios: SharePlatformModel.RedirectDevice(),
+      android: SharePlatformModel.RedirectDevice(),
+      web: SharePlatformModel.WebRedirect(),
+      force_web: Joi.boolean(),
     });
   }
 
-  /** @returns {RedirectDevice} */
-  static RedirectDevice() {
+  /** @returns {CampaignShortLink} */
+  static CampaignShortLink() {
     return Joi.object({
-      link: Joi.string().allow(""),
-      type: Joi.string().allow(""),
+      source: Joi.string().allow(""),
+      medium: Joi.string().allow(""),
     });
   }
 
-  /** @returns {Redirects} */
-  static Redirects() {
+  /** @returns {Attribution} */
+  static Attribution() {
     return Joi.object({
-      android: SharePlatformModel.RedirectDevice(),
-      force_web: Joi.boolean(),
-      ios: SharePlatformModel.RedirectDevice(),
-      web: SharePlatformModel.WebRedirect(),
+      campaign_cookie_expiry: Joi.string().allow(""),
     });
   }
 
-  /** @returns {ShortLinkList} */
-  static ShortLinkList() {
+  /** @returns {SocialMediaTags} */
+  static SocialMediaTags() {
     return Joi.object({
-      items: Joi.array().items(SharePlatformModel.ShortLinkRes()),
-      page: SharePlatformModel.Page(),
+      title: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+      image: Joi.string().allow(""),
     });
   }
 
   /** @returns {ShortLinkReq} */
   static ShortLinkReq() {
     return Joi.object({
+      title: Joi.string().allow("").required(),
+      url: Joi.string().allow("").required(),
+      hash: Joi.string().allow(""),
       active: Joi.boolean(),
-      attribution: SharePlatformModel.Attribution(),
-      campaign: SharePlatformModel.CampaignShortLink(),
-      count: Joi.number(),
-      enable_tracking: Joi.boolean(),
       expire_at: Joi.string().allow(""),
-      hash: Joi.string().allow(""),
+      enable_tracking: Joi.boolean(),
       personalized: Joi.boolean(),
+      campaign: SharePlatformModel.CampaignShortLink(),
       redirects: SharePlatformModel.Redirects(),
+      attribution: SharePlatformModel.Attribution(),
       social_media_tags: SharePlatformModel.SocialMediaTags(),
-      title: Joi.string().allow("").required(),
-      url: Joi.string().allow("").required(),
+      count: Joi.number(),
+    });
+  }
+
+  /** @returns {UrlInfo} */
+  static UrlInfo() {
+    return Joi.object({
+      original: Joi.string().allow(""),
+      short: Joi.string().allow(""),
+      hash: Joi.string().allow(""),
     });
   }
 
   /** @returns {ShortLinkRes} */
   static ShortLinkRes() {
     return Joi.object({
-      _id: Joi.string().allow(""),
-      active: Joi.boolean(),
-      app_redirect: Joi.boolean(),
-      application: Joi.string().allow(""),
-      attribution: SharePlatformModel.Attribution(),
-      campaign: SharePlatformModel.CampaignShortLink(),
-      count: Joi.number(),
-      created_at: Joi.string().allow(""),
+      title: Joi.string().allow(""),
+      url: SharePlatformModel.UrlInfo(),
       created_by: Joi.string().allow(""),
+      app_redirect: Joi.boolean(),
+      fallback: Joi.string().allow(""),
+      active: Joi.boolean(),
+      _id: Joi.string().allow(""),
       enable_tracking: Joi.boolean(),
       expire_at: Joi.string().allow(""),
-      fallback: Joi.string().allow(""),
+      application: Joi.string().allow(""),
+      user_id: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
       meta: Joi.any(),
+      updated_at: Joi.string().allow(""),
       personalized: Joi.boolean(),
+      campaign: SharePlatformModel.CampaignShortLink(),
       redirects: SharePlatformModel.Redirects(),
+      attribution: SharePlatformModel.Attribution(),
       social_media_tags: SharePlatformModel.SocialMediaTags(),
-      title: Joi.string().allow(""),
-      updated_at: Joi.string().allow(""),
-      url: SharePlatformModel.UrlInfo(),
-      user_id: Joi.string().allow(""),
+      count: Joi.number(),
     });
   }
 
-  /** @returns {SocialMediaTags} */
-  static SocialMediaTags() {
+  /** @returns {Page} */
+  static Page() {
     return Joi.object({
-      description: Joi.string().allow(""),
-      image: Joi.string().allow(""),
-      title: Joi.string().allow(""),
+      item_total: Joi.number(),
+      next_id: Joi.string().allow(""),
+      has_previous: Joi.boolean(),
+      has_next: Joi.boolean(),
+      current: Joi.number(),
+      type: Joi.string().allow("").required(),
+      size: Joi.number(),
     });
   }
 
-  /** @returns {UrlInfo} */
-  static UrlInfo() {
+  /** @returns {ShortLinkList} */
+  static ShortLinkList() {
     return Joi.object({
-      hash: Joi.string().allow(""),
-      original: Joi.string().allow(""),
-      short: Joi.string().allow(""),
+      items: Joi.array().items(SharePlatformModel.ShortLinkRes()),
+      page: SharePlatformModel.Page(),
     });
   }
 
-  /** @returns {WebRedirect} */
-  static WebRedirect() {
+  /** @returns {ErrorRes} */
+  static ErrorRes() {
     return Joi.object({
-      link: Joi.string().allow(""),
-      type: Joi.string().allow(""),
+      message: Joi.string().allow(""),
     });
   }
 }

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

@@ -22,16 +22,6 @@ declare class 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.GetCompanyLevelPrivateThemesParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ThemePlatformModel.CompanyPrivateTheme[]>} - Success response
-     * @name getCompanyLevelPrivateThemes
-     * @summary: Get private themes for a company
-     * @description: Retrieve a list of private themes available for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getCompanyLevelPrivateThemes/).
-     */
-    getCompanyLevelPrivateThemes({ searchText, requestHeaders }?: ThemePlatformValidator.GetCompanyLevelPrivateThemesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.CompanyPrivateTheme[]>;
     /**
      * @param {ThemePlatformValidator.GetCompanyLevelThemesParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -41,7 +31,7 @@ declare class Theme {
      * @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({ searchText, requestHeaders }?: ThemePlatformValidator.GetCompanyLevelThemesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.CompanyThemeSchema[]>;
+    getCompanyLevelThemes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.CompanyThemeSchema[]>;
 }
 import ThemePlatformValidator = require("./ThemePlatformValidator");
 import ThemePlatformModel = require("./ThemePlatformModel");

package/sdk/platform/Theme/ThemePlatformClient.js

@@ -174,85 +174,6 @@ class Theme {
     return response;
   }
 
-  /**
-   * @param {ThemePlatformValidator.GetCompanyLevelPrivateThemesParam} arg - Arg object
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ThemePlatformModel.CompanyPrivateTheme[]>} - Success response
-   * @name getCompanyLevelPrivateThemes
-   * @summary: Get private themes for a company
-   * @description: Retrieve a list of private themes available for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getCompanyLevelPrivateThemes/).
-   */
-  async getCompanyLevelPrivateThemes(
-    { searchText, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const {
-      error,
-    } = ThemePlatformValidator.getCompanyLevelPrivateThemes().validate(
-      {
-        searchText,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = ThemePlatformValidator.getCompanyLevelPrivateThemes().validate(
-      {
-        searchText,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Theme > getCompanyLevelPrivateThemes \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-    query_params["search_text"] = searchText;
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/theme/v2.0/company/${this.config.companyId}/private_themes`,
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const { error: res_error } = Joi.array()
-      .items(ThemePlatformModel.CompanyPrivateTheme())
-      .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 > getCompanyLevelPrivateThemes \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
   /**
    * @param {ThemePlatformValidator.GetCompanyLevelThemesParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -263,13 +184,11 @@ class Theme {
    * @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(
-    { searchText, requestHeaders } = { requestHeaders: {} },
+    { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const { error } = ThemePlatformValidator.getCompanyLevelThemes().validate(
-      {
-        searchText,
-      },
+      {},
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -280,9 +199,7 @@ class Theme {
     const {
       error: warrning,
     } = ThemePlatformValidator.getCompanyLevelThemes().validate(
-      {
-        searchText,
-      },
+      {},
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -293,7 +210,6 @@ class Theme {
     }
 
     const query_params = {};
-    query_params["search_text"] = searchText;
 
     const xHeaders = {};