@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

package/sdk/application/Rewards/RewardsApplicationModel.js

@@ -1,6 +1,183 @@
 const Joi = require("joi");
 
-class RewardsModel {
+/**
+ * @typedef Asset
+ * @property {string} [aspect_ratio]
+ * @property {string} [id]
+ * @property {string} [secure_url]
+ */
+
+/**
+ * @typedef CatalogueOrderRequest
+ * @property {RewardsArticle[]} [articles]
+ */
+
+/**
+ * @typedef CatalogueOrderResponse
+ * @property {RewardsArticle[]} [articles]
+ */
+
+/**
+ * @typedef DiscountProperties
+ * @property {number} [absolute]
+ * @property {string} [currency]
+ * @property {string} [display_absolute]
+ * @property {string} [display_percent]
+ * @property {number} [percent]
+ */
+
+/**
+ * @typedef Error
+ * @property {number} [code]
+ * @property {string} [exception]
+ * @property {string} [info]
+ * @property {string} [message]
+ */
+
+/**
+ * @typedef Offer
+ * @property {Schedule} [_schedule]
+ * @property {boolean} [active]
+ * @property {string} [application_id]
+ * @property {Asset} [banner_image]
+ * @property {string} [created_at]
+ * @property {string} [name]
+ * @property {Object} [rule]
+ * @property {ShareMessages} [share]
+ * @property {string} [sub_text]
+ * @property {string} [text]
+ * @property {string} [type]
+ * @property {string} [updated_at]
+ * @property {string} [updated_by]
+ * @property {string} [url]
+ */
+
+/**
+ * @typedef OrderDiscountRequest
+ * @property {string} [currency]
+ * @property {number} order_amount
+ */
+
+/**
+ * @typedef OrderDiscountResponse
+ * @property {OrderDiscountRuleBucket} [applied_rule_bucket]
+ * @property {DiscountProperties} [base_discount]
+ * @property {DiscountProperties} [discount]
+ * @property {number} [order_amount]
+ * @property {number} [points]
+ */
+
+/**
+ * @typedef OrderDiscountRuleBucket
+ * @property {number} [high]
+ * @property {number} [low]
+ * @property {number} [max]
+ * @property {number} [value]
+ * @property {string} [value_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 PointsHistory
+ * @property {string} [_id]
+ * @property {string} [application_id]
+ * @property {boolean} [claimed]
+ * @property {string} [created_at]
+ * @property {string} [expires_on]
+ * @property {Object} [meta]
+ * @property {number} [points]
+ * @property {number} [remaining_points]
+ * @property {string} [text_1]
+ * @property {string} [text_2]
+ * @property {string} [text_3]
+ * @property {string} [txn_name]
+ * @property {string} [updated_at]
+ * @property {string} [user_id]
+ */
+
+/**
+ * @typedef PointsHistoryResponse
+ * @property {PointsHistory[]} [items] - History is the list of points transaction.
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef PointsResponse
+ * @property {number} [points] - Total points available
+ */
+
+/**
+ * @typedef RedeemReferralCodeRequest
+ * @property {string} [device_id]
+ * @property {string} [referral_code]
+ */
+
+/**
+ * @typedef RedeemReferralCodeResponse
+ * @property {string} [message]
+ * @property {number} [points]
+ * @property {boolean} [redeemed]
+ * @property {string} [referrer_id]
+ * @property {string} [referrer_info]
+ */
+
+/**
+ * @typedef ReferralDetailsResponse
+ * @property {Offer} [referral]
+ * @property {string} [referrer_info]
+ * @property {ShareMessages} [share]
+ * @property {string} [terms_conditions_link]
+ * @property {ReferralDetailsUser} [user]
+ */
+
+/**
+ * @typedef ReferralDetailsUser
+ * @property {boolean} [blocked]
+ * @property {number} [points]
+ * @property {boolean} [redeemed]
+ * @property {string} [referral_code]
+ */
+
+/**
+ * @typedef RewardsArticle
+ * @property {string} [id]
+ * @property {number} [points]
+ * @property {number} [price]
+ */
+
+/**
+ * @typedef Schedule
+ * @property {string} [cron]
+ * @property {number} [duration]
+ * @property {string} [end]
+ * @property {string} [start]
+ */
+
+/**
+ * @typedef ShareMessages
+ * @property {number} [email]
+ * @property {string} [facebook]
+ * @property {string} [fallback]
+ * @property {string} [message]
+ * @property {string} [messenger]
+ * @property {string} [sms]
+ * @property {string} [text]
+ * @property {string} [twitter]
+ * @property {string} [whatsapp]
+ */
+
+class RewardsApplicationModel {
+  /** @returns {Asset} */
   static Asset() {
     return Joi.object({
       aspect_ratio: Joi.string().allow(""),
@@ -8,16 +185,22 @@ class RewardsModel {
       secure_url: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CatalogueOrderRequest} */
   static CatalogueOrderRequest() {
     return Joi.object({
-      articles: Joi.array().items(RewardsModel.RewardsArticle()),
+      articles: Joi.array().items(RewardsApplicationModel.RewardsArticle()),
     });
   }
+
+  /** @returns {CatalogueOrderResponse} */
   static CatalogueOrderResponse() {
     return Joi.object({
-      articles: Joi.array().items(RewardsModel.RewardsArticle()),
+      articles: Joi.array().items(RewardsApplicationModel.RewardsArticle()),
     });
   }
+
+  /** @returns {DiscountProperties} */
   static DiscountProperties() {
     return Joi.object({
       absolute: Joi.number(),
@@ -27,6 +210,8 @@ class RewardsModel {
       percent: Joi.number(),
     });
   }
+
+  /** @returns {Error} */
   static Error() {
     return Joi.object({
       code: Joi.number(),
@@ -35,16 +220,18 @@ class RewardsModel {
       message: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Offer} */
   static Offer() {
     return Joi.object({
-      _schedule: RewardsModel.Schedule(),
+      _schedule: RewardsApplicationModel.Schedule(),
       active: Joi.boolean(),
       application_id: Joi.string().allow(""),
-      banner_image: RewardsModel.Asset(),
+      banner_image: RewardsApplicationModel.Asset(),
       created_at: Joi.string().allow(""),
       name: Joi.string().allow(""),
       rule: Joi.any(),
-      share: RewardsModel.ShareMessages(),
+      share: RewardsApplicationModel.ShareMessages(),
       sub_text: Joi.string().allow(""),
       text: Joi.string().allow(""),
       type: Joi.string().allow(""),
@@ -53,21 +240,27 @@ class RewardsModel {
       url: Joi.string().allow(""),
     });
   }
+
+  /** @returns {OrderDiscountRequest} */
   static OrderDiscountRequest() {
     return Joi.object({
       currency: Joi.string().allow(""),
       order_amount: Joi.number().required(),
     });
   }
+
+  /** @returns {OrderDiscountResponse} */
   static OrderDiscountResponse() {
     return Joi.object({
-      applied_rule_bucket: RewardsModel.OrderDiscountRuleBucket(),
-      base_discount: RewardsModel.DiscountProperties(),
-      discount: RewardsModel.DiscountProperties(),
+      applied_rule_bucket: RewardsApplicationModel.OrderDiscountRuleBucket(),
+      base_discount: RewardsApplicationModel.DiscountProperties(),
+      discount: RewardsApplicationModel.DiscountProperties(),
       order_amount: Joi.number(),
       points: Joi.number(),
     });
   }
+
+  /** @returns {OrderDiscountRuleBucket} */
   static OrderDiscountRuleBucket() {
     return Joi.object({
       high: Joi.number(),
@@ -77,6 +270,8 @@ class RewardsModel {
       value_type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Page} */
   static Page() {
     return Joi.object({
       current: Joi.number(),
@@ -88,6 +283,8 @@ class RewardsModel {
       type: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {PointsHistory} */
   static PointsHistory() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -106,23 +303,31 @@ class RewardsModel {
       user_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {PointsHistoryResponse} */
   static PointsHistoryResponse() {
     return Joi.object({
-      items: Joi.array().items(RewardsModel.PointsHistory()),
-      page: RewardsModel.Page(),
+      items: Joi.array().items(RewardsApplicationModel.PointsHistory()),
+      page: RewardsApplicationModel.Page(),
     });
   }
+
+  /** @returns {PointsResponse} */
   static PointsResponse() {
     return Joi.object({
       points: Joi.number(),
     });
   }
+
+  /** @returns {RedeemReferralCodeRequest} */
   static RedeemReferralCodeRequest() {
     return Joi.object({
       device_id: Joi.string().allow(""),
       referral_code: Joi.string().allow(""),
     });
   }
+
+  /** @returns {RedeemReferralCodeResponse} */
   static RedeemReferralCodeResponse() {
     return Joi.object({
       message: Joi.string().allow(""),
@@ -132,15 +337,19 @@ class RewardsModel {
       referrer_info: Joi.string().allow(""),
     });
   }
+
+  /** @returns {ReferralDetailsResponse} */
   static ReferralDetailsResponse() {
     return Joi.object({
-      referral: RewardsModel.Offer(),
+      referral: RewardsApplicationModel.Offer(),
       referrer_info: Joi.string().allow(""),
-      share: RewardsModel.ShareMessages(),
+      share: RewardsApplicationModel.ShareMessages(),
       terms_conditions_link: Joi.string().allow(""),
-      user: RewardsModel.ReferralDetailsUser(),
+      user: RewardsApplicationModel.ReferralDetailsUser(),
     });
   }
+
+  /** @returns {ReferralDetailsUser} */
   static ReferralDetailsUser() {
     return Joi.object({
       blocked: Joi.boolean(),
@@ -149,6 +358,8 @@ class RewardsModel {
       referral_code: Joi.string().allow(""),
     });
   }
+
+  /** @returns {RewardsArticle} */
   static RewardsArticle() {
     return Joi.object({
       id: Joi.string().allow(""),
@@ -156,6 +367,8 @@ class RewardsModel {
       price: Joi.number(),
     });
   }
+
+  /** @returns {Schedule} */
   static Schedule() {
     return Joi.object({
       cron: Joi.string().allow(""),
@@ -164,6 +377,8 @@ class RewardsModel {
       start: Joi.string().allow(""),
     });
   }
+
+  /** @returns {ShareMessages} */
   static ShareMessages() {
     return Joi.object({
       email: Joi.number(),
@@ -178,4 +393,4 @@ class RewardsModel {
     });
   }
 }
-module.exports = RewardsModel;
+module.exports = RewardsApplicationModel;

package/sdk/application/Rewards/RewardsApplicationValidator.d.ts

@@ -1,10 +1,73 @@
-export = RewardsValidator;
-declare class RewardsValidator {
-    static catalogueOrder(): any;
-    static getOfferByName(): any;
-    static getOrderDiscount(): any;
+export = RewardsApplicationValidator;
+/**
+ * @typedef CatalogueOrderParam
+ * @property {RewardsApplicationModel.CatalogueOrderRequest} body
+ */
+/**
+ * @typedef GetOfferByNameParam
+ * @property {string} name - The name given to the offer.
+ */
+/**
+ * @typedef GetOrderDiscountParam
+ * @property {RewardsApplicationModel.OrderDiscountRequest} body
+ */
+/** @typedef GetUserPointsParam */
+/**
+ * @typedef GetUserPointsHistoryParam
+ * @property {string} [pageId] - PageID is the ID of the requested page. For
+ *   first request it should be kept empty.
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
+ */
+/** @typedef GetUserReferralDetailsParam */
+/**
+ * @typedef RedeemReferralCodeParam
+ * @property {RewardsApplicationModel.RedeemReferralCodeRequest} body
+ */
+declare class RewardsApplicationValidator {
+    /** @returns {CatalogueOrderParam} */
+    static catalogueOrder(): CatalogueOrderParam;
+    /** @returns {GetOfferByNameParam} */
+    static getOfferByName(): GetOfferByNameParam;
+    /** @returns {GetOrderDiscountParam} */
+    static getOrderDiscount(): GetOrderDiscountParam;
+    /** @returns {GetUserPointsParam} */
     static getUserPoints(): any;
-    static getUserPointsHistory(): any;
+    /** @returns {GetUserPointsHistoryParam} */
+    static getUserPointsHistory(): GetUserPointsHistoryParam;
+    /** @returns {GetUserReferralDetailsParam} */
     static getUserReferralDetails(): any;
-    static redeemReferralCode(): any;
+    /** @returns {RedeemReferralCodeParam} */
+    static redeemReferralCode(): RedeemReferralCodeParam;
 }
+declare namespace RewardsApplicationValidator {
+    export { CatalogueOrderParam, GetOfferByNameParam, GetOrderDiscountParam, GetUserPointsParam, GetUserPointsHistoryParam, GetUserReferralDetailsParam, RedeemReferralCodeParam };
+}
+type CatalogueOrderParam = {
+    body: RewardsApplicationModel.CatalogueOrderRequest;
+};
+type GetOfferByNameParam = {
+    /**
+     * - The name given to the offer.
+     */
+    name: string;
+};
+type GetOrderDiscountParam = {
+    body: RewardsApplicationModel.OrderDiscountRequest;
+};
+type GetUserPointsHistoryParam = {
+    /**
+     * - PageID is the ID of the requested page. For
+     * first request it should be kept empty.
+     */
+    pageId?: string;
+    /**
+     * - The number of items to retrieve in each page.
+     */
+    pageSize?: number;
+};
+type RedeemReferralCodeParam = {
+    body: RewardsApplicationModel.RedeemReferralCodeRequest;
+};
+type GetUserPointsParam = any;
+type GetUserReferralDetailsParam = any;
+import RewardsApplicationModel = require("./RewardsApplicationModel");

package/sdk/application/Rewards/RewardsApplicationValidator.js

@@ -1,29 +1,66 @@
 const Joi = require("joi");
 
-const RewardsModel = require("./RewardsApplicationModel");
-class RewardsValidator {
+const RewardsApplicationModel = require("./RewardsApplicationModel");
+
+/**
+ * @typedef CatalogueOrderParam
+ * @property {RewardsApplicationModel.CatalogueOrderRequest} body
+ */
+
+/**
+ * @typedef GetOfferByNameParam
+ * @property {string} name - The name given to the offer.
+ */
+
+/**
+ * @typedef GetOrderDiscountParam
+ * @property {RewardsApplicationModel.OrderDiscountRequest} body
+ */
+
+/** @typedef GetUserPointsParam */
+
+/**
+ * @typedef GetUserPointsHistoryParam
+ * @property {string} [pageId] - PageID is the ID of the requested page. For
+ *   first request it should be kept empty.
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
+ */
+
+/** @typedef GetUserReferralDetailsParam */
+
+/**
+ * @typedef RedeemReferralCodeParam
+ * @property {RewardsApplicationModel.RedeemReferralCodeRequest} body
+ */
+
+class RewardsApplicationValidator {
+  /** @returns {CatalogueOrderParam} */
   static catalogueOrder() {
     return Joi.object({
-      body: RewardsModel.CatalogueOrderRequest().required(),
+      body: RewardsApplicationModel.CatalogueOrderRequest().required(),
     }).required();
   }
 
+  /** @returns {GetOfferByNameParam} */
   static getOfferByName() {
     return Joi.object({
       name: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetOrderDiscountParam} */
   static getOrderDiscount() {
     return Joi.object({
-      body: RewardsModel.OrderDiscountRequest().required(),
+      body: RewardsApplicationModel.OrderDiscountRequest().required(),
     }).required();
   }
 
+  /** @returns {GetUserPointsParam} */
   static getUserPoints() {
     return Joi.object({});
   }
 
+  /** @returns {GetUserPointsHistoryParam} */
   static getUserPointsHistory() {
     return Joi.object({
       pageId: Joi.string().allow(""),
@@ -31,15 +68,17 @@ class RewardsValidator {
     });
   }
 
+  /** @returns {GetUserReferralDetailsParam} */
   static getUserReferralDetails() {
     return Joi.object({});
   }
 
+  /** @returns {RedeemReferralCodeParam} */
   static redeemReferralCode() {
     return Joi.object({
-      body: RewardsModel.RedeemReferralCodeRequest().required(),
+      body: RewardsApplicationModel.RedeemReferralCodeRequest().required(),
     }).required();
   }
 }
 
-module.exports = RewardsValidator;
+module.exports = RewardsApplicationValidator;

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

@@ -14,74 +14,76 @@ declare class Share {
     _urls: {};
     updateUrls(urls: any): void;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {ShortLinkReq} arg.body
-     * @returns {Promise<ShortLinkRes>} - Success response
+     * @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.
+     * @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/).
      */
-    createShortLink({ body }?: {
-        body: ShortLinkReq;
-    }): Promise<ShortLinkRes>;
+    createShortLink({ body, requestHeaders }?: ShareApplicationValidator.CreateShortLinkParam, { responseHeaders }?: object): Promise<ShareApplicationModel.ShortLinkRes>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<QRCodeResp>} - Success response
+     * @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.
+     * @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/).
      */
-    getApplicationQRCode({}?: any): Promise<QRCodeResp>;
+    getApplicationQRCode({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ShareApplicationModel.QRCodeResp>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.slug - A short, human-readable, URL-friendly
-     *   identifier of a collection. You can get slug value from the endpoint.
-     * @returns {Promise<QRCodeResp>} - Success response
+     * @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
      * @summary: Create QR Code of a collection
-     * @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.
+     * @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/).
      */
-    getCollectionQRCodeBySlug({ slug }?: {
-        slug: string;
-    }): Promise<QRCodeResp>;
+    getCollectionQRCodeBySlug({ slug, requestHeaders }?: ShareApplicationValidator.GetCollectionQRCodeBySlugParam, { responseHeaders }?: object): Promise<ShareApplicationModel.QRCodeResp>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.hash - A string value used for converting long URL to
-     *   short URL and vice-versa.
-     * @returns {Promise<ShortLinkRes>} - Success response
+     * @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
      * @summary: Get original link by hash
-     * @description: Use this API to retrieve the original link from a short-link by using a hash value.
+     * @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/).
      */
-    getOriginalShortLinkByHash({ hash }?: {
-        hash: string;
-    }): Promise<ShortLinkRes>;
+    getOriginalShortLinkByHash({ hash, requestHeaders }?: ShareApplicationValidator.GetOriginalShortLinkByHashParam, { responseHeaders }?: object): Promise<ShareApplicationModel.ShortLinkRes>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.slug - A short, human-readable, URL-friendly
-     *   identifier of a product. You can get slug value from the endpoint.
-     * @returns {Promise<QRCodeResp>} - Success response
+     * @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
      * @summary: Create QR Code of a product
-     * @description: Use this API to create a QR code of a product for sharing it with users who want to view/purchase the product.
+     * @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/).
      */
-    getProductQRCodeBySlug({ slug }?: {
-        slug: string;
-    }): Promise<QRCodeResp>;
+    getProductQRCodeBySlug({ slug, requestHeaders }?: ShareApplicationValidator.GetProductQRCodeBySlugParam, { responseHeaders }?: object): Promise<ShareApplicationModel.QRCodeResp>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.hash - A string value used for converting long URL to
-     *   short URL and vice-versa.
-     * @returns {Promise<ShortLinkRes>} - Success response
+     * @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.
+     * @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/).
      */
-    getShortLinkByHash({ hash }?: {
-        hash: string;
-    }): Promise<ShortLinkRes>;
+    getShortLinkByHash({ hash, requestHeaders }?: ShareApplicationValidator.GetShortLinkByHashParam, { responseHeaders }?: object): Promise<ShareApplicationModel.ShortLinkRes>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.url - A link or a web address
-     * @returns {Promise<QRCodeResp>} - Success response
+     * @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.
+     * @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/).
      */
-    getUrlQRCode({ url }?: {
-        url: string;
-    }): Promise<QRCodeResp>;
+    getUrlQRCode({ url, requestHeaders }?: ShareApplicationValidator.GetUrlQRCodeParam, { responseHeaders }?: object): Promise<ShareApplicationModel.QRCodeResp>;
 }
+import ShareApplicationValidator = require("./ShareApplicationValidator");
+import ShareApplicationModel = require("./ShareApplicationModel");