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

package/sdk/application/Share/ShareApplicationModel.d.ts

@@ -1,88 +1,104 @@
 export = ShareApplicationModel;
 /**
  * @typedef QRCodeResp
- * @property {string} [link]
- * @property {string} [svg]
+ * @property {string} [link] - Original url that was used to encoded url into a QR code.
+ * @property {string} [svg] - String representation of the QR Code in SVG format.
  */
 /**
  * @typedef RedirectDevice
- * @property {string} [link]
- * @property {string} [type]
+ * @property {string} [link] - Fallback URL to redirect users to the app store
+ *   or a web page if the app is not installed when they click the link.
+ * @property {string} [type] - Type of fallback used to redirect users to the
+ *   app store or a web page if the app is not installed when they click the link.
  */
 /**
  * @typedef WebRedirect
- * @property {string} [link]
- * @property {string} [type]
+ * @property {string} [link] - Fallback URL to redirect users to the app store
+ *   or a web page if the app is not installed when they click the link.
+ * @property {string} [type] - Type of fallback used to redirect users to the
+ *   app store or a web page if the app is not installed when they click the link.
  */
 /**
  * @typedef Redirects
  * @property {RedirectDevice} [ios]
  * @property {RedirectDevice} [android]
  * @property {WebRedirect} [web]
- * @property {boolean} [force_web]
+ * @property {boolean} [force_web] - Flag for overriding redirection traffic to
+ *   the web if the app is not installed when the link is clicked.
  */
 /**
  * @typedef CampaignShortLink
- * @property {string} [source]
- * @property {string} [medium]
+ * @property {string} [source] - Source of communication of campaign.
+ * @property {string} [medium] - Channel of communication of campaign.
  */
 /**
  * @typedef Attribution
- * @property {string} [campaign_cookie_expiry]
+ * @property {string} [campaign_cookie_expiry] - Expiration of campaign.
  */
 /**
  * @typedef SocialMediaTags
- * @property {string} [title]
- * @property {string} [description]
- * @property {string} [image]
+ * @property {string} [title] - Title to be displayed when link is shared on
+ *   social media platforms.
+ * @property {string} [description] - Description to be displayed when link is
+ *   shared on social media platforms.
+ * @property {string} [image] - Preview to be displayed when link is shared on
+ *   social media platforms.
  */
 /**
  * @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 {string} [expire_at]
- * @property {boolean} [enable_tracking]
+ * @property {string} [hash] - A string value used for converting long URL to
+ *   short URL and vice-versa.
+ * @property {boolean} [active] - Status of the shortlink.
+ * @property {string} [expire_at] - Expiry of the shortlink.
+ * @property {boolean} [enable_tracking] - Flag to enable tracking of a short link.
  * @property {boolean} [personalized] - To create personalized short links.
  * @property {CampaignShortLink} [campaign]
  * @property {Redirects} [redirects]
  * @property {Attribution} [attribution]
  * @property {SocialMediaTags} [social_media_tags]
- * @property {number} [count]
+ * @property {number} [count] - Click count of shortlink.
  */
 /**
  * @typedef UrlInfo
- * @property {string} [original]
- * @property {string} [hash]
- * @property {string} [short_url]
+ * @property {string} [original] - Original web address which will be converted
+ *   to shortlink.
+ * @property {string} [hash] - A string value used for converting long URL to
+ *   short URL and vice-versa.
+ * @property {string} [short_url] - Condensed version of a longer URL,
+ *   redirecting to the original page upon being clicked.
  */
 /**
  * @typedef ShortLinkRes
- * @property {string} [title]
+ * @property {string} [title] - Name reference of the shortlink.
  * @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} [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 {string} [created_by] - Reference of the creator of the shortlink.
+ * @property {boolean} [app_redirect] - Application redirection flag of shortlink.
+ * @property {string} [fallback] - Fallback attributes of shortlink.
+ * @property {boolean} [active] - Status of the shortlink.
+ * @property {string} [_id] - Key used to uniquely identify document that
+ *   contains shortlink details.
+ * @property {boolean} [enable_tracking] - Flag to enable tracking of a short link.
+ * @property {string} [expire_at] - Expiry of the shortlink.
+ * @property {string} [application] - The ID of the sales channel associated
+ *   with the shortlink.
+ * @property {string} [user_id] - Identifier which can uniquely identify the user.
+ * @property {string} [created_at] - The timestamp indicating when a record was
+ *   initially created.
+ * @property {Object} [meta] - Additional attributes of shortlink.
+ * @property {string} [updated_at] - The timestamp indicating when a record was
+ *   last modified or updated.
+ * @property {boolean} [personalized] - To create personalized short links.
  * @property {CampaignShortLink} [campaign]
  * @property {Redirects} [redirects]
  * @property {Attribution} [attribution]
  * @property {SocialMediaTags} [social_media_tags]
- * @property {number} [count]
+ * @property {number} [count] - Click count of shortlink.
  */
 /**
  * @typedef ErrorRes
- * @property {string} [message]
+ * @property {string} [message] - Error message providing details about the error.
  */
 declare class ShareApplicationModel {
 }
@@ -92,19 +108,41 @@ declare namespace ShareApplicationModel {
 /** @returns {QRCodeResp} */
 declare function QRCodeResp(): QRCodeResp;
 type QRCodeResp = {
+    /**
+     * - Original url that was used to encoded url into a QR code.
+     */
     link?: string;
+    /**
+     * - String representation of the QR Code in SVG format.
+     */
     svg?: string;
 };
 /** @returns {RedirectDevice} */
 declare function RedirectDevice(): RedirectDevice;
 type RedirectDevice = {
+    /**
+     * - Fallback URL to redirect users to the app store
+     * or a web page if the app is not installed when they click the link.
+     */
     link?: string;
+    /**
+     * - Type of fallback used to redirect users to the
+     * app store or a web page if the app is not installed when they click the link.
+     */
     type?: string;
 };
 /** @returns {WebRedirect} */
 declare function WebRedirect(): WebRedirect;
 type WebRedirect = {
+    /**
+     * - Fallback URL to redirect users to the app store
+     * or a web page if the app is not installed when they click the link.
+     */
     link?: string;
+    /**
+     * - Type of fallback used to redirect users to the
+     * app store or a web page if the app is not installed when they click the link.
+     */
     type?: string;
 };
 /** @returns {Redirects} */
@@ -113,24 +151,49 @@ type Redirects = {
     ios?: RedirectDevice;
     android?: RedirectDevice;
     web?: WebRedirect;
+    /**
+     * - Flag for overriding redirection traffic to
+     * the web if the app is not installed when the link is clicked.
+     */
     force_web?: boolean;
 };
 /** @returns {CampaignShortLink} */
 declare function CampaignShortLink(): CampaignShortLink;
 type CampaignShortLink = {
+    /**
+     * - Source of communication of campaign.
+     */
     source?: string;
+    /**
+     * - Channel of communication of campaign.
+     */
     medium?: string;
 };
 /** @returns {Attribution} */
 declare function Attribution(): Attribution;
 type Attribution = {
+    /**
+     * - Expiration of campaign.
+     */
     campaign_cookie_expiry?: string;
 };
 /** @returns {SocialMediaTags} */
 declare function SocialMediaTags(): SocialMediaTags;
 type SocialMediaTags = {
+    /**
+     * - Title to be displayed when link is shared on
+     * social media platforms.
+     */
     title?: string;
+    /**
+     * - Description to be displayed when link is
+     * shared on social media platforms.
+     */
     description?: string;
+    /**
+     * - Preview to be displayed when link is shared on
+     * social media platforms.
+     */
     image?: string;
 };
 /** @returns {ShortLinkReq} */
@@ -144,9 +207,22 @@ type ShortLinkReq = {
      * - The web address to shorten.
      */
     url: string;
+    /**
+     * - A string value used for converting long URL to
+     * short URL and vice-versa.
+     */
     hash?: string;
+    /**
+     * - Status of the shortlink.
+     */
     active?: boolean;
+    /**
+     * - Expiry of the shortlink.
+     */
     expire_at?: string;
+    /**
+     * - Flag to enable tracking of a short link.
+     */
     enable_tracking?: boolean;
     /**
      * - To create personalized short links.
@@ -156,44 +232,108 @@ type ShortLinkReq = {
     redirects?: Redirects;
     attribution?: Attribution;
     social_media_tags?: SocialMediaTags;
+    /**
+     * - Click count of shortlink.
+     */
     count?: number;
 };
 /** @returns {UrlInfo} */
 declare function UrlInfo(): UrlInfo;
 type UrlInfo = {
+    /**
+     * - Original web address which will be converted
+     * to shortlink.
+     */
     original?: string;
+    /**
+     * - A string value used for converting long URL to
+     * short URL and vice-versa.
+     */
     hash?: string;
+    /**
+     * - Condensed version of a longer URL,
+     * redirecting to the original page upon being clicked.
+     */
     short_url?: string;
 };
 /** @returns {ShortLinkRes} */
 declare function ShortLinkRes(): ShortLinkRes;
 type ShortLinkRes = {
+    /**
+     * - Name reference of the shortlink.
+     */
     title?: string;
     url?: UrlInfo;
+    /**
+     * - Reference of the creator of the shortlink.
+     */
     created_by?: string;
+    /**
+     * - Application redirection flag of shortlink.
+     */
     app_redirect?: boolean;
+    /**
+     * - Fallback attributes of shortlink.
+     */
     fallback?: string;
+    /**
+     * - Status of the shortlink.
+     */
     active?: boolean;
+    /**
+     * - Key used to uniquely identify document that
+     * contains shortlink details.
+     */
     _id?: string;
+    /**
+     * - Flag to enable tracking of a short link.
+     */
     enable_tracking?: boolean;
+    /**
+     * - Expiry of the shortlink.
+     */
     expire_at?: string;
+    /**
+     * - The ID of the sales channel associated
+     * with the shortlink.
+     */
     application?: string;
+    /**
+     * - Identifier which can uniquely identify the user.
+     */
     user_id?: string;
+    /**
+     * - The timestamp indicating when a record was
+     * initially created.
+     */
     created_at?: string;
+    /**
+     * - Additional attributes of shortlink.
+     */
     meta?: any;
+    /**
+     * - The timestamp indicating when a record was
+     * last modified or updated.
+     */
     updated_at?: string;
     /**
-     * - To create personalized short links
+     * - To create personalized short links.
      */
     personalized?: boolean;
     campaign?: CampaignShortLink;
     redirects?: Redirects;
     attribution?: Attribution;
     social_media_tags?: SocialMediaTags;
+    /**
+     * - Click count of shortlink.
+     */
     count?: number;
 };
 /** @returns {ErrorRes} */
 declare function ErrorRes(): ErrorRes;
 type ErrorRes = {
+    /**
+     * - Error message providing details about the error.
+     */
     message?: string;
 };

package/sdk/application/Share/ShareApplicationModel.js

@@ -2,20 +2,24 @@ const Joi = require("joi");
 
 /**
  * @typedef QRCodeResp
- * @property {string} [link]
- * @property {string} [svg]
+ * @property {string} [link] - Original url that was used to encoded url into a QR code.
+ * @property {string} [svg] - String representation of the QR Code in SVG format.
  */
 
 /**
  * @typedef RedirectDevice
- * @property {string} [link]
- * @property {string} [type]
+ * @property {string} [link] - Fallback URL to redirect users to the app store
+ *   or a web page if the app is not installed when they click the link.
+ * @property {string} [type] - Type of fallback used to redirect users to the
+ *   app store or a web page if the app is not installed when they click the link.
  */
 
 /**
  * @typedef WebRedirect
- * @property {string} [link]
- * @property {string} [type]
+ * @property {string} [link] - Fallback URL to redirect users to the app store
+ *   or a web page if the app is not installed when they click the link.
+ * @property {string} [type] - Type of fallback used to redirect users to the
+ *   app store or a web page if the app is not installed when they click the link.
  */
 
 /**
@@ -23,77 +27,89 @@ const Joi = require("joi");
  * @property {RedirectDevice} [ios]
  * @property {RedirectDevice} [android]
  * @property {WebRedirect} [web]
- * @property {boolean} [force_web]
+ * @property {boolean} [force_web] - Flag for overriding redirection traffic to
+ *   the web if the app is not installed when the link is clicked.
  */
 
 /**
  * @typedef CampaignShortLink
- * @property {string} [source]
- * @property {string} [medium]
+ * @property {string} [source] - Source of communication of campaign.
+ * @property {string} [medium] - Channel of communication of campaign.
  */
 
 /**
  * @typedef Attribution
- * @property {string} [campaign_cookie_expiry]
+ * @property {string} [campaign_cookie_expiry] - Expiration of campaign.
  */
 
 /**
  * @typedef SocialMediaTags
- * @property {string} [title]
- * @property {string} [description]
- * @property {string} [image]
+ * @property {string} [title] - Title to be displayed when link is shared on
+ *   social media platforms.
+ * @property {string} [description] - Description to be displayed when link is
+ *   shared on social media platforms.
+ * @property {string} [image] - Preview to be displayed when link is shared on
+ *   social media platforms.
  */
 
 /**
  * @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 {string} [expire_at]
- * @property {boolean} [enable_tracking]
+ * @property {string} [hash] - A string value used for converting long URL to
+ *   short URL and vice-versa.
+ * @property {boolean} [active] - Status of the shortlink.
+ * @property {string} [expire_at] - Expiry of the shortlink.
+ * @property {boolean} [enable_tracking] - Flag to enable tracking of a short link.
  * @property {boolean} [personalized] - To create personalized short links.
  * @property {CampaignShortLink} [campaign]
  * @property {Redirects} [redirects]
  * @property {Attribution} [attribution]
  * @property {SocialMediaTags} [social_media_tags]
- * @property {number} [count]
+ * @property {number} [count] - Click count of shortlink.
  */
 
 /**
  * @typedef UrlInfo
- * @property {string} [original]
- * @property {string} [hash]
- * @property {string} [short_url]
+ * @property {string} [original] - Original web address which will be converted
+ *   to shortlink.
+ * @property {string} [hash] - A string value used for converting long URL to
+ *   short URL and vice-versa.
+ * @property {string} [short_url] - Condensed version of a longer URL,
+ *   redirecting to the original page upon being clicked.
  */
 
 /**
  * @typedef ShortLinkRes
- * @property {string} [title]
+ * @property {string} [title] - Name reference of the shortlink.
  * @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} [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 {string} [created_by] - Reference of the creator of the shortlink.
+ * @property {boolean} [app_redirect] - Application redirection flag of shortlink.
+ * @property {string} [fallback] - Fallback attributes of shortlink.
+ * @property {boolean} [active] - Status of the shortlink.
+ * @property {string} [_id] - Key used to uniquely identify document that
+ *   contains shortlink details.
+ * @property {boolean} [enable_tracking] - Flag to enable tracking of a short link.
+ * @property {string} [expire_at] - Expiry of the shortlink.
+ * @property {string} [application] - The ID of the sales channel associated
+ *   with the shortlink.
+ * @property {string} [user_id] - Identifier which can uniquely identify the user.
+ * @property {string} [created_at] - The timestamp indicating when a record was
+ *   initially created.
+ * @property {Object} [meta] - Additional attributes of shortlink.
+ * @property {string} [updated_at] - The timestamp indicating when a record was
+ *   last modified or updated.
+ * @property {boolean} [personalized] - To create personalized short links.
  * @property {CampaignShortLink} [campaign]
  * @property {Redirects} [redirects]
  * @property {Attribution} [attribution]
  * @property {SocialMediaTags} [social_media_tags]
- * @property {number} [count]
+ * @property {number} [count] - Click count of shortlink.
  */
 
 /**
  * @typedef ErrorRes
- * @property {string} [message]
+ * @property {string} [message] - Error message providing details about the error.
  */
 
 class ShareApplicationModel {

package/sdk/application/Share/ShareApplicationValidator.d.ts

@@ -26,7 +26,8 @@ export = ShareApplicationValidator;
  */
 /**
  * @typedef GetUrlQRCodeParam
- * @property {string} url - A link or a web address
+ * @property {string} url - A link or a web address of a given URL transformed
+ *   into a scannable QR code.
  */
 declare class ShareApplicationValidator {
     /** @returns {CreateShortLinkParam} */
@@ -80,7 +81,8 @@ type GetShortLinkByHashParam = {
 };
 type GetUrlQRCodeParam = {
     /**
-     * - A link or a web address
+     * - A link or a web address of a given URL transformed
+     * into a scannable QR code.
      */
     url: string;
 };

package/sdk/application/Share/ShareApplicationValidator.js

@@ -35,7 +35,8 @@ const ShareApplicationModel = require("./ShareApplicationModel");
 
 /**
  * @typedef GetUrlQRCodeParam
- * @property {string} url - A link or a web address
+ * @property {string} url - A link or a web address of a given URL transformed
+ *   into a scannable QR code.
  */
 
 class ShareApplicationValidator {

package/sdk/application/Theme/ThemeApplicationClient.d.ts

@@ -17,7 +17,7 @@ declare class Theme {
      * @returns {Promise<ThemeApplicationModel.AllAvailablePageSchema>} - Success response
      * @name getAllPages
      * @summary: List pages
-     * @description: Get all page level configs, sections and SEO data of a theme - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAllPages/).
+     * @description: Get all page level configs, sections and seo data of a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAllPages/).
      */
     getAllPages({ themeId, requestHeaders }?: ThemeApplicationValidator.GetAllPagesParam, { responseHeaders }?: object): Promise<ThemeApplicationModel.AllAvailablePageSchema>;
     /**
@@ -37,9 +37,9 @@ declare class Theme {
      * @returns {Promise<ThemeApplicationModel.AvailablePageSchema>} - Success response
      * @name getPage
      * @summary: Get theme page
-     * @description: Get page level configurations, applied sections and SEO data of a page by `page_value` received from list pages API - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getPage/).
+     * @description: Get page level configurations, applied sections and seo data of a page by `page_value` received from list pages api. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getPage/).
      */
-    getPage({ themeId, pageValue, filters, company, requestHeaders }?: ThemeApplicationValidator.GetPageParam, { responseHeaders }?: object): Promise<ThemeApplicationModel.AvailablePageSchema>;
+    getPage({ themeId, pageValue, filters, sectionPreviewHash, company, requestHeaders, }?: ThemeApplicationValidator.GetPageParam, { responseHeaders }?: object): Promise<ThemeApplicationModel.AvailablePageSchema>;
     /**
      * @param {ThemeApplicationValidator.GetThemeForPreviewParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -47,7 +47,7 @@ declare class Theme {
      * @returns {Promise<ThemeApplicationModel.ThemesSchema>} - Success response
      * @name getThemeForPreview
      * @summary: Get theme for preview
-     * @description: Gets the theme configuration and template details of a theme by theme Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getThemeForPreview/).
+     * @description: Gets the theme configuration and template details of a theme by theme id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getThemeForPreview/).
      */
     getThemeForPreview({ themeId, requestHeaders }?: ThemeApplicationValidator.GetThemeForPreviewParam, { responseHeaders }?: object): Promise<ThemeApplicationModel.ThemesSchema>;
 }

package/sdk/application/Theme/ThemeApplicationClient.js

@@ -42,7 +42,7 @@ class Theme {
    * @returns {Promise<ThemeApplicationModel.AllAvailablePageSchema>} - Success response
    * @name getAllPages
    * @summary: List pages
-   * @description: Get all page level configs, sections and SEO data of a theme - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAllPages/).
+   * @description: Get all page level configs, sections and seo data of a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAllPages/).
    */
   async getAllPages(
     { themeId, requestHeaders } = { requestHeaders: {} },
@@ -198,16 +198,21 @@ class Theme {
    * @returns {Promise<ThemeApplicationModel.AvailablePageSchema>} - Success response
    * @name getPage
    * @summary: Get theme page
-   * @description: Get page level configurations, applied sections and SEO data of a page by `page_value` received from list pages API - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getPage/).
+   * @description: Get page level configurations, applied sections and seo data of a page by `page_value` received from list pages api. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getPage/).
    */
   async getPage(
-    { themeId, pageValue, filters, company, requestHeaders } = {
-      requestHeaders: {},
-    },
+    {
+      themeId,
+      pageValue,
+      filters,
+      sectionPreviewHash,
+      company,
+      requestHeaders,
+    } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const { error } = ThemeApplicationValidator.getPage().validate(
-      { themeId, pageValue, filters, company },
+      { themeId, pageValue, filters, sectionPreviewHash, company },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -216,7 +221,7 @@ class Theme {
 
     // Showing warrnings if extra unknown parameters are found
     const { error: warrning } = ThemeApplicationValidator.getPage().validate(
-      { themeId, pageValue, filters, company },
+      { themeId, pageValue, filters, sectionPreviewHash, company },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -228,6 +233,7 @@ class Theme {
 
     const query_params = {};
     query_params["filters"] = filters;
+    query_params["section_preview_hash"] = sectionPreviewHash;
     query_params["company"] = company;
 
     const xHeaders = {};
@@ -278,7 +284,7 @@ class Theme {
    * @returns {Promise<ThemeApplicationModel.ThemesSchema>} - Success response
    * @name getThemeForPreview
    * @summary: Get theme for preview
-   * @description: Gets the theme configuration and template details of a theme by theme Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getThemeForPreview/).
+   * @description: Gets the theme configuration and template details of a theme by theme id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getThemeForPreview/).
    */
   async getThemeForPreview(
     { themeId, requestHeaders } = { requestHeaders: {} },