@gofynd/fdk-client-javascript 1.2.0 → 1.3.0

package/sdk/application/Share/ShareApplicationClient.js

@@ -41,13 +41,17 @@ class Share {
 
   /**
    * @param {ShareApplicationValidator.CreateShortLinkParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
    * @name createShortLink
    * @summary: Create a short link
    * @description: Use this API to create a short link that is easy to write/share/read as compared to long URLs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/createShortLink/).
    */
-  async createShortLink({ body } = {}, { headers } = { headers: false }) {
+  async createShortLink(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = ShareApplicationValidator.createShortLink().validate(
       { body },
       { abortEarly: false, allowUnknown: true }
@@ -83,12 +87,12 @@ class Share {
       }),
       query_params,
       body,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -110,13 +114,18 @@ class Share {
   }
 
   /**
+   * @param {ShareApplicationValidator.GetApplicationQRCodeParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
    * @name getApplicationQRCode
    * @summary: Create QR Code of an app
    * @description: Use this API to create a QR code of an app for sharing it with users who want to use the app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getApplicationQRCode/).
    */
-  async getApplicationQRCode({ headers } = { headers: false }) {
+  async getApplicationQRCode(
+    { requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = ShareApplicationValidator.getApplicationQRCode().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -152,12 +161,12 @@ class Share {
       }),
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -180,6 +189,7 @@ class Share {
 
   /**
    * @param {ShareApplicationValidator.GetCollectionQRCodeBySlugParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
    * @name getCollectionQRCodeBySlug
@@ -187,8 +197,8 @@ class Share {
    * @description: Use this API to create a QR code of a collection of products for sharing it with users who want to view/purchase the collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getCollectionQRCodeBySlug/).
    */
   async getCollectionQRCodeBySlug(
-    { slug } = {},
-    { headers } = { headers: false }
+    { slug, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
   ) {
     const {
       error,
@@ -227,12 +237,12 @@ class Share {
       }),
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -256,6 +266,7 @@ class Share {
   /**
    * @param {ShareApplicationValidator.GetOriginalShortLinkByHashParam} arg -
    *   Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
    * @name getOriginalShortLinkByHash
@@ -263,8 +274,8 @@ class Share {
    * @description: Use this API to retrieve the original link from a short-link by using a hash value. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getOriginalShortLinkByHash/).
    */
   async getOriginalShortLinkByHash(
-    { hash } = {},
-    { headers } = { headers: false }
+    { hash, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
   ) {
     const {
       error,
@@ -303,12 +314,12 @@ class Share {
       }),
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -331,6 +342,7 @@ class Share {
 
   /**
    * @param {ShareApplicationValidator.GetProductQRCodeBySlugParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
    * @name getProductQRCodeBySlug
@@ -338,8 +350,8 @@ class Share {
    * @description: Use this API to create a QR code of a product for sharing it with users who want to view/purchase the product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getProductQRCodeBySlug/).
    */
   async getProductQRCodeBySlug(
-    { slug } = {},
-    { headers } = { headers: false }
+    { slug, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
   ) {
     const {
       error,
@@ -378,12 +390,12 @@ class Share {
       }),
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -406,13 +418,17 @@ class Share {
 
   /**
    * @param {ShareApplicationValidator.GetShortLinkByHashParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
    * @name getShortLinkByHash
    * @summary: Get short link by hash
    * @description: Use this API to get a short link by using a hash value. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getShortLinkByHash/).
    */
-  async getShortLinkByHash({ hash } = {}, { headers } = { headers: false }) {
+  async getShortLinkByHash(
+    { hash, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = ShareApplicationValidator.getShortLinkByHash().validate(
       { hash },
       { abortEarly: false, allowUnknown: true }
@@ -448,12 +464,12 @@ class Share {
       }),
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -476,13 +492,17 @@ class Share {
 
   /**
    * @param {ShareApplicationValidator.GetUrlQRCodeParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
    * @name getUrlQRCode
    * @summary: Create QR Code of a URL
    * @description: Use this API to create a QR code of a URL for sharing it with users who want to visit the link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getUrlQRCode/).
    */
-  async getUrlQRCode({ url } = {}, { headers } = { headers: false }) {
+  async getUrlQRCode(
+    { url, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = ShareApplicationValidator.getUrlQRCode().validate(
       { url },
       { abortEarly: false, allowUnknown: true }
@@ -519,12 +539,12 @@ class Share {
       }),
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 

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

@@ -12,16 +12,6 @@ export = ShareApplicationModel;
  * @typedef ErrorRes
  * @property {string} [message]
  */
-/**
- * @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 QRCodeResp
  * @property {string} [link]
@@ -39,11 +29,6 @@ export = ShareApplicationModel;
  * @property {RedirectDevice} [ios]
  * @property {WebRedirect} [web]
  */
-/**
- * @typedef ShortLinkList
- * @property {ShortLinkRes[]} [items]
- * @property {Page} [page]
- */
 /**
  * @typedef ShortLinkReq
  * @property {boolean} [active]
@@ -102,7 +87,7 @@ export = ShareApplicationModel;
 declare class ShareApplicationModel {
 }
 declare namespace ShareApplicationModel {
-    export { Attribution, CampaignShortLink, ErrorRes, Page, QRCodeResp, RedirectDevice, Redirects, ShortLinkList, ShortLinkReq, ShortLinkRes, SocialMediaTags, UrlInfo, WebRedirect };
+    export { Attribution, CampaignShortLink, ErrorRes, QRCodeResp, RedirectDevice, Redirects, ShortLinkReq, ShortLinkRes, SocialMediaTags, UrlInfo, WebRedirect };
 }
 /** @returns {Attribution} */
 declare function Attribution(): Attribution;
@@ -120,17 +105,6 @@ declare function ErrorRes(): ErrorRes;
 type ErrorRes = {
     message?: string;
 };
-/** @returns {Page} */
-declare function Page(): Page;
-type Page = {
-    current?: number;
-    has_next?: boolean;
-    has_previous?: boolean;
-    item_total?: number;
-    next_id?: string;
-    size?: number;
-    type: string;
-};
 /** @returns {QRCodeResp} */
 declare function QRCodeResp(): QRCodeResp;
 type QRCodeResp = {
@@ -151,12 +125,6 @@ type Redirects = {
     ios?: RedirectDevice;
     web?: WebRedirect;
 };
-/** @returns {ShortLinkList} */
-declare function ShortLinkList(): ShortLinkList;
-type ShortLinkList = {
-    items?: ShortLinkRes[];
-    page?: Page;
-};
 /** @returns {ShortLinkReq} */
 declare function ShortLinkReq(): ShortLinkReq;
 type ShortLinkReq = {

package/sdk/application/Share/ShareApplicationModel.js

@@ -16,17 +16,6 @@ const Joi = require("joi");
  * @property {string} [message]
  */
 
-/**
- * @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 QRCodeResp
  * @property {string} [link]
@@ -47,12 +36,6 @@ const Joi = require("joi");
  * @property {WebRedirect} [web]
  */
 
-/**
- * @typedef ShortLinkList
- * @property {ShortLinkRes[]} [items]
- * @property {Page} [page]
- */
-
 /**
  * @typedef ShortLinkReq
  * @property {boolean} [active]
@@ -136,19 +119,6 @@ class ShareApplicationModel {
     });
   }
 
-  /** @returns {Page} */
-  static Page() {
-    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(),
-    });
-  }
-
   /** @returns {QRCodeResp} */
   static QRCodeResp() {
     return Joi.object({
@@ -175,14 +145,6 @@ class ShareApplicationModel {
     });
   }
 
-  /** @returns {ShortLinkList} */
-  static ShortLinkList() {
-    return Joi.object({
-      items: Joi.array().items(ShareApplicationModel.ShortLinkRes()),
-      page: ShareApplicationModel.Page(),
-    });
-  }
-
   /** @returns {ShortLinkReq} */
   static ShortLinkReq() {
     return Joi.object({

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

@@ -12,39 +12,44 @@ declare class Theme {
     updateUrls(urls: any): void;
     /**
      * @param {ThemeApplicationValidator.GetAllPagesParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<ThemeApplicationModel.AllAvailablePageSchema>} - Success response
      * @name getAllPages
      * @summary: Get all pages of a theme
      * @description: Use this API to retrieve all the available pages of a theme by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAllPages/).
      */
-    getAllPages({ themeId }?: ThemeApplicationValidator.GetAllPagesParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ThemeApplicationModel.AllAvailablePageSchema>;
+    getAllPages({ themeId, requestHeaders }?: ThemeApplicationValidator.GetAllPagesParam, { responseHeaders }?: object): Promise<ThemeApplicationModel.AllAvailablePageSchema>;
     /**
+     * @param {ThemeApplicationValidator.GetAppliedThemeParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<ThemeApplicationModel.ThemesSchema>} - Success response
      * @name getAppliedTheme
      * @summary: Get the theme currently applied to an application
      * @description: An application has multiple themes, but only one theme can be applied at a time. Use this API to retrieve the theme currently applied to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAppliedTheme/).
      */
-    getAppliedTheme({ headers }?: import("../ApplicationAPIClient").Options): Promise<ThemeApplicationModel.ThemesSchema>;
+    getAppliedTheme({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemeApplicationModel.ThemesSchema>;
     /**
      * @param {ThemeApplicationValidator.GetPageParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<ThemeApplicationModel.AvailablePageSchema>} - Success response
      * @name getPage
      * @summary: Get page of a theme
      * @description: Use this API to retrieve a page of a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getPage/).
      */
-    getPage({ themeId, pageValue }?: ThemeApplicationValidator.GetPageParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ThemeApplicationModel.AvailablePageSchema>;
+    getPage({ themeId, pageValue, requestHeaders }?: ThemeApplicationValidator.GetPageParam, { responseHeaders }?: object): Promise<ThemeApplicationModel.AvailablePageSchema>;
     /**
      * @param {ThemeApplicationValidator.GetThemeForPreviewParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<ThemeApplicationModel.ThemesSchema>} - Success response
      * @name getThemeForPreview
      * @summary: Get a theme for a preview
      * @description: A theme can be previewed before applying it. Use this API to retrieve the preview of a theme by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getThemeForPreview/).
      */
-    getThemeForPreview({ themeId }?: ThemeApplicationValidator.GetThemeForPreviewParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ThemeApplicationModel.ThemesSchema>;
+    getThemeForPreview({ themeId, requestHeaders }?: ThemeApplicationValidator.GetThemeForPreviewParam, { responseHeaders }?: object): Promise<ThemeApplicationModel.ThemesSchema>;
 }
 import ThemeApplicationValidator = require("./ThemeApplicationValidator");
 import ThemeApplicationModel = require("./ThemeApplicationModel");

package/sdk/application/Theme/ThemeApplicationClient.js

@@ -12,9 +12,9 @@ class Theme {
     this._conf = _conf;
     this._relativeUrls = {
       getAllPages: "/service/application/theme/v1.0/{theme_id}/page",
-      getAppliedTheme: "/service/application/theme/v1.0/applied-theme",
+      getAppliedTheme: "/service/application/theme/v2.0/applied-theme",
       getPage: "/service/application/theme/v1.0/{theme_id}/{page_value}",
-      getThemeForPreview: "/service/application/theme/v1.0/{theme_id}/preview",
+      getThemeForPreview: "/service/application/theme/v2.0/{theme_id}/preview",
     };
     this._urls = Object.entries(this._relativeUrls).reduce(
       (urls, [method, relativeUrl]) => {
@@ -34,13 +34,17 @@ class Theme {
 
   /**
    * @param {ThemeApplicationValidator.GetAllPagesParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ThemeApplicationModel.AllAvailablePageSchema>} - Success response
    * @name getAllPages
    * @summary: Get all pages of a theme
    * @description: Use this API to retrieve all the available pages of a theme by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAllPages/).
    */
-  async getAllPages({ themeId } = {}, { headers } = { headers: false }) {
+  async getAllPages(
+    { themeId, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = ThemeApplicationValidator.getAllPages().validate(
       { themeId },
       { abortEarly: false, allowUnknown: true }
@@ -76,12 +80,12 @@ class Theme {
       }),
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -103,13 +107,18 @@ class Theme {
   }
 
   /**
+   * @param {ThemeApplicationValidator.GetAppliedThemeParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ThemeApplicationModel.ThemesSchema>} - Success response
    * @name getAppliedTheme
    * @summary: Get the theme currently applied to an application
    * @description: An application has multiple themes, but only one theme can be applied at a time. Use this API to retrieve the theme currently applied to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAppliedTheme/).
    */
-  async getAppliedTheme({ headers } = { headers: false }) {
+  async getAppliedTheme(
+    { requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = ThemeApplicationValidator.getAppliedTheme().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -145,12 +154,12 @@ class Theme {
       }),
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -173,13 +182,17 @@ class Theme {
 
   /**
    * @param {ThemeApplicationValidator.GetPageParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ThemeApplicationModel.AvailablePageSchema>} - Success response
    * @name getPage
    * @summary: Get page of a theme
    * @description: Use this API to retrieve a page of a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getPage/).
    */
-  async getPage({ themeId, pageValue } = {}, { headers } = { headers: false }) {
+  async getPage(
+    { themeId, pageValue, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = ThemeApplicationValidator.getPage().validate(
       { themeId, pageValue },
       { abortEarly: false, allowUnknown: true }
@@ -213,12 +226,12 @@ class Theme {
       }),
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -241,13 +254,17 @@ class Theme {
 
   /**
    * @param {ThemeApplicationValidator.GetThemeForPreviewParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ThemeApplicationModel.ThemesSchema>} - Success response
    * @name getThemeForPreview
    * @summary: Get a theme for a preview
    * @description: A theme can be previewed before applying it. Use this API to retrieve the preview of a theme by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getThemeForPreview/).
    */
-  async getThemeForPreview({ themeId } = {}, { headers } = { headers: false }) {
+  async getThemeForPreview(
+    { themeId, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = ThemeApplicationValidator.getThemeForPreview().validate(
       { themeId },
       { abortEarly: false, allowUnknown: true }
@@ -283,12 +300,12 @@ class Theme {
       }),
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }