@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

package/documentation/application/SHARE.md

@@ -8,13 +8,13 @@
 ## Share Methods
 Short link and QR Code
 
+* [createShortLink](#createshortlink)
 * [getApplicationQRCode](#getapplicationqrcode)
-* [getProductQRCodeBySlug](#getproductqrcodebyslug)
 * [getCollectionQRCodeBySlug](#getcollectionqrcodebyslug)
-* [getUrlQRCode](#geturlqrcode)
-* [createShortLink](#createshortlink)
-* [getShortLinkByHash](#getshortlinkbyhash)
 * [getOriginalShortLinkByHash](#getoriginalshortlinkbyhash)
+* [getProductQRCodeBySlug](#getproductqrcodebyslug)
+* [getShortLinkByHash](#getshortlinkbyhash)
+* [getUrlQRCode](#geturlqrcode)
 
 
 
@@ -23,34 +23,38 @@ Short link and QR Code
 
 
 
-### getApplicationQRCode
-Create QR Code of an app
+### createShortLink
+Create a short link
 
 
 
 ```javascript
 // Promise
-const promise = share.getApplicationQRCode();
+const promise = share.createShortLink({  body : value });
 
 // Async/Await
-const data = await share.getApplicationQRCode();
+const data = await share.createShortLink({  body : value });
 ```
 
 
 
 
 
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- |
+| body | [ShortLinkReq](#ShortLinkReq) | yes | Request body |
 
-Use this API to create a QR code of an app for sharing it with users who want to use the app.
+
+Use this API to create a short link that is easy to write/share/read as compared to long URLs.
 
 *Returned Response:*
 
 
 
 
-[QRCodeResp](#QRCodeResp)
+[ShortLinkRes](#ShortLinkRes)
 
-Success. Check the example shown below or refer `QRCodeResp` for more details.
+Success. Check the example shown below or refer `ShortLinkRes` for more details.
 
 
 
@@ -60,8 +64,43 @@ Success. Check the example shown below or refer `QRCodeResp` for more details.
 
 ```json
 {
-  "link": "https://fynd.com",
-  "svg": "<svg xmlns=\\\"http://www.w3.org/2000/svg\\\" viewBox=\\\"0 0 29 29\\\" shape-rendering=\\\"crispEdges\\\"></svg>"
+  "url": {
+    "original": "https://0icof6vvsf.hostx0.de/products/?brand=ruosh",
+    "short": "https://0icof6vvsf.hostx0.de/l/3qKlnsq-x",
+    "hash": "3qKlnsq-x"
+  },
+  "redirects": {
+    "ios": {
+      "type": "web",
+      "link": "https://0icof6vvsf.hostx0.de/products/?brand=ruosh"
+    },
+    "android": {
+      "type": "web",
+      "link": "https://0icof6vvsf.hostx0.de/products/?brand=ruosh"
+    },
+    "web": {
+      "type": "web",
+      "link": "https://0icof6vvsf.hostx0.de/products/?brand=ruosh"
+    },
+    "force_web": false
+  },
+  "created_by": "team",
+  "personalized": false,
+  "app_redirect": false,
+  "fallback": "web",
+  "enable_tracking": false,
+  "active": true,
+  "count": 0,
+  "_id": "601a54054c0349592e76c8f3",
+  "title": "new ",
+  "meta": {
+    "type": "brand"
+  },
+  "expire_at": null,
+  "application": "5eda528b97457fe43a733ace",
+  "user_id": "5e4d01e2c39837ab66144f6d",
+  "created_at": "2021-02-03T07:43:01.342Z",
+  "updated_at": "2021-02-03T07:43:01.342Z"
 }
 ```
 </details>
@@ -77,30 +116,25 @@ Success. Check the example shown below or refer `QRCodeResp` for more details.
 ---
 
 
-### getProductQRCodeBySlug
-Create QR Code of a product
+### getApplicationQRCode
+Create QR Code of an app
 
 
 
 ```javascript
 // Promise
-const promise = share.getProductQRCodeBySlug({  slug : value });
+const promise = share.getApplicationQRCode();
 
 // Async/Await
-const data = await share.getProductQRCodeBySlug({  slug : value });
+const data = await share.getApplicationQRCode();
 ```
 
 
 
 
 
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| slug | string | yes | A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint. |  
-
 
-
-Use this API to create a QR code of a product for sharing it with users who want to view/purchase the product.
+Use this API to create a QR code of an app for sharing it with users who want to use the app.
 
 *Returned Response:*
 
@@ -119,7 +153,7 @@ Success. Check the example shown below or refer `QRCodeResp` for more details.
 
 ```json
 {
-  "link": "https://fynd.com/products/shirt-small-blue",
+  "link": "https://fynd.com",
   "svg": "<svg xmlns=\\\"http://www.w3.org/2000/svg\\\" viewBox=\\\"0 0 29 29\\\" shape-rendering=\\\"crispEdges\\\"></svg>"
 }
 ```
@@ -195,17 +229,17 @@ Success. Check the example shown below or refer `QRCodeResp` for more details.
 ---
 
 
-### getUrlQRCode
-Create QR Code of a URL
+### getOriginalShortLinkByHash
+Get original link by hash
 
 
 
 ```javascript
 // Promise
-const promise = share.getUrlQRCode({  url : value });
+const promise = share.getOriginalShortLinkByHash({  hash : value });
 
 // Async/Await
-const data = await share.getUrlQRCode({  url : value });
+const data = await share.getOriginalShortLinkByHash({  hash : value });
 ```
 
 
@@ -214,20 +248,20 @@ const data = await share.getUrlQRCode({  url : value });
 
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- | 
-| url | string | yes | A link or a web address |  
+| hash | string | yes | A string value used for converting long URL to short URL and vice-versa. |  
 
 
 
-Use this API to create a QR code of a URL for sharing it with users who want to visit the link.
+Use this API to retrieve the original link from a short-link by using a hash value.
 
 *Returned Response:*
 
 
 
 
-[QRCodeResp](#QRCodeResp)
+[ShortLinkRes](#ShortLinkRes)
 
-Success. Check the example shown below or refer `QRCodeResp` for more details.
+Success. Check the example shown below or refer `ShortLinkRes` for more details.
 
 
 
@@ -237,8 +271,43 @@ Success. Check the example shown below or refer `QRCodeResp` for more details.
 
 ```json
 {
-  "link": "https://fynd.com",
-  "svg": "<svg xmlns=\\\"http://www.w3.org/2000/svg\\\" viewBox=\\\"0 0 29 29\\\" shape-rendering=\\\"crispEdges\\\"></svg>"
+  "url": {
+    "original": "https://0icof6vvsf.hostx0.de/products/?brand=ruosh",
+    "short": "https://0icof6vvsf.hostx0.de/l/3qKlnsq-x",
+    "hash": "3qKlnsq-x"
+  },
+  "redirects": {
+    "ios": {
+      "type": "web",
+      "link": "https://0icof6vvsf.hostx0.de/products/?brand=ruosh"
+    },
+    "android": {
+      "type": "web",
+      "link": "https://0icof6vvsf.hostx0.de/products/?brand=ruosh"
+    },
+    "web": {
+      "type": "web",
+      "link": "https://0icof6vvsf.hostx0.de/products/?brand=ruosh"
+    },
+    "force_web": false
+  },
+  "created_by": "team",
+  "personalized": false,
+  "app_redirect": false,
+  "fallback": "web",
+  "enable_tracking": false,
+  "active": true,
+  "count": 0,
+  "_id": "601a54054c0349592e76c8f3",
+  "title": "new ",
+  "meta": {
+    "type": "brand"
+  },
+  "expire_at": null,
+  "application": "5eda528b97457fe43a733ace",
+  "user_id": "5e4d01e2c39837ab66144f6d",
+  "created_at": "2021-02-03T07:43:01.342Z",
+  "updated_at": "2021-02-03T07:43:01.342Z"
 }
 ```
 </details>
@@ -254,17 +323,17 @@ Success. Check the example shown below or refer `QRCodeResp` for more details.
 ---
 
 
-### createShortLink
-Create a short link
+### getProductQRCodeBySlug
+Create QR Code of a product
 
 
 
 ```javascript
 // Promise
-const promise = share.createShortLink({  body : value });
+const promise = share.getProductQRCodeBySlug({  slug : value });
 
 // Async/Await
-const data = await share.createShortLink({  body : value });
+const data = await share.getProductQRCodeBySlug({  slug : value });
 ```
 
 
@@ -272,20 +341,21 @@ const data = await share.createShortLink({  body : value });
 
 
 | Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |
-| body | [ShortLinkReq](#ShortLinkReq) | yes | Request body |
+| --------- | -----  | -------- | ----------- | 
+| slug | string | yes | A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint. |  
 
 
-Use this API to create a short link that is easy to write/share/read as compared to long URLs.
+
+Use this API to create a QR code of a product for sharing it with users who want to view/purchase the product.
 
 *Returned Response:*
 
 
 
 
-[ShortLinkRes](#ShortLinkRes)
+[QRCodeResp](#QRCodeResp)
 
-Success. Check the example shown below or refer `ShortLinkRes` for more details.
+Success. Check the example shown below or refer `QRCodeResp` for more details.
 
 
 
@@ -295,43 +365,8 @@ Success. Check the example shown below or refer `ShortLinkRes` for more details.
 
 ```json
 {
-  "url": {
-    "original": "https://0icof6vvsf.hostx0.de/products/?brand=ruosh",
-    "short": "https://0icof6vvsf.hostx0.de/l/3qKlnsq-x",
-    "hash": "3qKlnsq-x"
-  },
-  "redirects": {
-    "ios": {
-      "type": "web",
-      "link": "https://0icof6vvsf.hostx0.de/products/?brand=ruosh"
-    },
-    "android": {
-      "type": "web",
-      "link": "https://0icof6vvsf.hostx0.de/products/?brand=ruosh"
-    },
-    "web": {
-      "type": "web",
-      "link": "https://0icof6vvsf.hostx0.de/products/?brand=ruosh"
-    },
-    "force_web": false
-  },
-  "created_by": "team",
-  "personalized": false,
-  "app_redirect": false,
-  "fallback": "web",
-  "enable_tracking": false,
-  "active": true,
-  "count": 0,
-  "_id": "601a54054c0349592e76c8f3",
-  "title": "new ",
-  "meta": {
-    "type": "brand"
-  },
-  "expire_at": null,
-  "application": "5eda528b97457fe43a733ace",
-  "user_id": "5e4d01e2c39837ab66144f6d",
-  "created_at": "2021-02-03T07:43:01.342Z",
-  "updated_at": "2021-02-03T07:43:01.342Z"
+  "link": "https://fynd.com/products/shirt-small-blue",
+  "svg": "<svg xmlns=\\\"http://www.w3.org/2000/svg\\\" viewBox=\\\"0 0 29 29\\\" shape-rendering=\\\"crispEdges\\\"></svg>"
 }
 ```
 </details>
@@ -441,17 +476,17 @@ Success. Check the example shown below or refer `ShortLinkRes` for more details.
 ---
 
 
-### getOriginalShortLinkByHash
-Get original link by hash
+### getUrlQRCode
+Create QR Code of a URL
 
 
 
 ```javascript
 // Promise
-const promise = share.getOriginalShortLinkByHash({  hash : value });
+const promise = share.getUrlQRCode({  url : value });
 
 // Async/Await
-const data = await share.getOriginalShortLinkByHash({  hash : value });
+const data = await share.getUrlQRCode({  url : value });
 ```
 
 
@@ -460,20 +495,20 @@ const data = await share.getOriginalShortLinkByHash({  hash : value });
 
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- | 
-| hash | string | yes | A string value used for converting long URL to short URL and vice-versa. |  
+| url | string | yes | A link or a web address |  
 
 
 
-Use this API to retrieve the original link from a short-link by using a hash value.
+Use this API to create a QR code of a URL for sharing it with users who want to visit the link.
 
 *Returned Response:*
 
 
 
 
-[ShortLinkRes](#ShortLinkRes)
+[QRCodeResp](#QRCodeResp)
 
-Success. Check the example shown below or refer `ShortLinkRes` for more details.
+Success. Check the example shown below or refer `QRCodeResp` for more details.
 
 
 
@@ -483,43 +518,8 @@ Success. Check the example shown below or refer `ShortLinkRes` for more details.
 
 ```json
 {
-  "url": {
-    "original": "https://0icof6vvsf.hostx0.de/products/?brand=ruosh",
-    "short": "https://0icof6vvsf.hostx0.de/l/3qKlnsq-x",
-    "hash": "3qKlnsq-x"
-  },
-  "redirects": {
-    "ios": {
-      "type": "web",
-      "link": "https://0icof6vvsf.hostx0.de/products/?brand=ruosh"
-    },
-    "android": {
-      "type": "web",
-      "link": "https://0icof6vvsf.hostx0.de/products/?brand=ruosh"
-    },
-    "web": {
-      "type": "web",
-      "link": "https://0icof6vvsf.hostx0.de/products/?brand=ruosh"
-    },
-    "force_web": false
-  },
-  "created_by": "team",
-  "personalized": false,
-  "app_redirect": false,
-  "fallback": "web",
-  "enable_tracking": false,
-  "active": true,
-  "count": 0,
-  "_id": "601a54054c0349592e76c8f3",
-  "title": "new ",
-  "meta": {
-    "type": "brand"
-  },
-  "expire_at": null,
-  "application": "5eda528b97457fe43a733ace",
-  "user_id": "5e4d01e2c39837ab66144f6d",
-  "created_at": "2021-02-03T07:43:01.342Z",
-  "updated_at": "2021-02-03T07:43:01.342Z"
+  "link": "https://fynd.com",
+  "svg": "<svg xmlns=\\\"http://www.w3.org/2000/svg\\\" viewBox=\\\"0 0 29 29\\\" shape-rendering=\\\"crispEdges\\\"></svg>"
 }
 ```
 </details>
@@ -538,193 +538,95 @@ Success. Check the example shown below or refer `ShortLinkRes` for more details.
 
 ### Schemas
 
- 
- 
- #### [QRCodeResp](#QRCodeResp)
+
+#### [Attribution](#Attribution)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | link | string |  no  |  |
- | svg | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || campaign_cookie_expiry | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [RedirectDevice](#RedirectDevice)
+#### [CampaignShortLink](#CampaignShortLink)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | link | string |  no  |  |
- | type | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || medium | string |  no  |  || source | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [WebRedirect](#WebRedirect)
+#### [ErrorRes](#ErrorRes)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | link | string |  no  |  |
- | type | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || message | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [Redirects](#Redirects)
+#### [Page](#Page)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | ios | [RedirectDevice](#RedirectDevice) |  no  |  |
- | android | [RedirectDevice](#RedirectDevice) |  no  |  |
- | web | [WebRedirect](#WebRedirect) |  no  |  |
- | force_web | boolean |  no  |  |
+ | ---------- | ---- | -------- | ----------- || current | number |  no  |  || has_next | boolean |  no  |  || has_previous | boolean |  no  |  || item_total | number |  no  |  || next_id | string |  no  |  || size | number |  no  |  || type | string |  yes  |  |
 
 ---
 
-
- 
- 
- #### [CampaignShortLink](#CampaignShortLink)
+#### [QRCodeResp](#QRCodeResp)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | source | string |  no  |  |
- | medium | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || link | string |  no  |  || svg | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [Attribution](#Attribution)
+#### [RedirectDevice](#RedirectDevice)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | campaign_cookie_expiry | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || link | string |  no  |  || type | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [SocialMediaTags](#SocialMediaTags)
+#### [Redirects](#Redirects)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | title | string |  no  |  |
- | description | string |  no  |  |
- | image | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || android | [RedirectDevice](#RedirectDevice) |  no  |  || force_web | boolean |  no  |  || ios | [RedirectDevice](#RedirectDevice) |  no  |  || web | [WebRedirect](#WebRedirect) |  no  |  |
 
 ---
 
-
- 
- 
- #### [ShortLinkReq](#ShortLinkReq)
+#### [ShortLinkList](#ShortLinkList)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | title | string |  yes  | Give a name to the link. |
- | url | string |  yes  | The web address to shorten. |
- | hash | string |  no  |  |
- | active | boolean |  no  |  |
- | expire_at | string |  no  |  |
- | enable_tracking | boolean |  no  |  |
- | personalized | boolean |  no  | To create personalized short links. |
- | campaign | [CampaignShortLink](#CampaignShortLink) |  no  |  |
- | redirects | [Redirects](#Redirects) |  no  |  |
- | attribution | [Attribution](#Attribution) |  no  |  |
- | social_media_tags | [SocialMediaTags](#SocialMediaTags) |  no  |  |
- | count | number |  no  |  |
+ | ---------- | ---- | -------- | ----------- || items | [[ShortLinkRes](#ShortLinkRes)] |  no  |  || page | [Page](#Page) |  no  |  |
 
 ---
 
-
- 
- 
- #### [UrlInfo](#UrlInfo)
+#### [ShortLinkReq](#ShortLinkReq)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | original | string |  no  |  |
- | short | string |  no  |  |
- | hash | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || active | boolean |  no  |  || attribution | [Attribution](#Attribution) |  no  |  || campaign | [CampaignShortLink](#CampaignShortLink) |  no  |  || count | number |  no  |  || enable_tracking | boolean |  no  |  || expire_at | string |  no  |  || hash | string |  no  |  || personalized | boolean |  no  |  || redirects | [Redirects](#Redirects) |  no  |  || social_media_tags | [SocialMediaTags](#SocialMediaTags) |  no  |  || title | string |  yes  |  || url | string |  yes  |  |
 
 ---
 
-
- 
- 
- #### [ShortLinkRes](#ShortLinkRes)
+#### [ShortLinkRes](#ShortLinkRes)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | title | string |  no  |  |
- | url | [UrlInfo](#UrlInfo) |  no  |  |
- | created_by | string |  no  |  |
- | app_redirect | boolean |  no  |  |
- | fallback | string |  no  |  |
- | active | boolean |  no  |  |
- | _id | string |  no  |  |
- | enable_tracking | boolean |  no  |  |
- | expire_at | string |  no  |  |
- | application | string |  no  |  |
- | user_id | string |  no  |  |
- | created_at | string |  no  |  |
- | meta | string |  no  |  |
- | updated_at | string |  no  |  |
- | personalized | boolean |  no  | To create personalized short links |
- | campaign | [CampaignShortLink](#CampaignShortLink) |  no  |  |
- | redirects | [Redirects](#Redirects) |  no  |  |
- | attribution | [Attribution](#Attribution) |  no  |  |
- | social_media_tags | [SocialMediaTags](#SocialMediaTags) |  no  |  |
- | count | number |  no  |  |
+ | ---------- | ---- | -------- | ----------- || _id | string |  no  |  || active | boolean |  no  |  || app_redirect | boolean |  no  |  || application | string |  no  |  || attribution | [Attribution](#Attribution) |  no  |  || campaign | [CampaignShortLink](#CampaignShortLink) |  no  |  || count | number |  no  |  || created_at | string |  no  |  || created_by | string |  no  |  || enable_tracking | boolean |  no  |  || expire_at | string |  no  |  || fallback | string |  no  |  || meta | string |  no  |  || personalized | boolean |  no  |  || redirects | [Redirects](#Redirects) |  no  |  || social_media_tags | [SocialMediaTags](#SocialMediaTags) |  no  |  || title | string |  no  |  || updated_at | string |  no  |  || url | [UrlInfo](#UrlInfo) |  no  |  || user_id | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [Page](#Page)
+#### [SocialMediaTags](#SocialMediaTags)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | item_total | number |  no  |  |
- | next_id | string |  no  |  |
- | has_previous | boolean |  no  |  |
- | has_next | boolean |  no  |  |
- | current | number |  no  |  |
- | type | string |  yes  |  |
- | size | number |  no  |  |
+ | ---------- | ---- | -------- | ----------- || description | string |  no  |  || image | string |  no  |  || title | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [ShortLinkList](#ShortLinkList)
+#### [UrlInfo](#UrlInfo)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | items | [[ShortLinkRes](#ShortLinkRes)] |  no  |  |
- | page | [Page](#Page) |  no  |  |
+ | ---------- | ---- | -------- | ----------- || hash | string |  no  |  || original | string |  no  |  || short | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [ErrorRes](#ErrorRes)
+#### [WebRedirect](#WebRedirect)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | message | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || link | string |  no  |  || type | string |  no  |  |
 
 ---