@gofynd/fdk-client-javascript 0.1.35 → 0.1.36

package/documentation/application/REWARDS.md

@@ -2,16 +2,18 @@
 
 
 
+
 ##### [Back to Application docs](./README.md)
 
 ## Rewards Methods
 Earn and redeem reward points
-* [getPointsOnProduct](#getpointsonproduct)
+
 * [getOfferByName](#getofferbyname)
-* [getOrderDiscount](#getorderdiscount)
-* [getUserPoints](#getuserpoints)
+* [catalogueOrder](#catalogueorder)
 * [getUserPointsHistory](#getuserpointshistory)
+* [getUserPoints](#getuserpoints)
 * [getUserReferralDetails](#getuserreferraldetails)
+* [getOrderDiscount](#getorderdiscount)
 * [redeemReferralCode](#redeemreferralcode)
 
 
@@ -19,17 +21,19 @@ Earn and redeem reward points
 ## Methods with example and description
 
 
-### getPointsOnProduct
-Get the eligibility of reward points on a product
+
+
+### getOfferByName
+Get offer by name
 
 
 
 ```javascript
 // Promise
-const promise = rewards.getPointsOnProduct({  body : value });
+const promise = rewards.getOfferByName({  name : value });
 
 // Async/Await
-const data = await rewards.getPointsOnProduct({  body : value });
+const data = await rewards.getOfferByName({  name : value });
 ```
 
 
@@ -37,20 +41,21 @@ const data = await rewards.getPointsOnProduct({  body : value });
 
 
 | Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |
-| body | [CatalogueOrderRequest](#CatalogueOrderRequest) | yes | Request body |
+| --------- | -----  | -------- | ----------- | 
+| name | string | yes | The name given to the offer. |  
 
 
-Use this API to evaluate the amount of reward points that could be earned on any catalogue product.
+
+Use this API to get the offer details and configuration by entering the name of the offer.
 
 *Returned Response:*
 
 
 
 
-[CatalogueOrderResponse](#CatalogueOrderResponse)
+[Offer](#Offer)
 
-Success. Check example below or refer `CatalogueOrderRequest` for more details.
+Success. Check example below or refer `Offer` for more details.
 
 
 
@@ -74,17 +79,17 @@ Success. Check example below or refer `CatalogueOrderRequest` for more details.
 ---
 
 
-### getOfferByName
-Get offer by name
+### catalogueOrder
+Get all transactions of reward points
 
 
 
 ```javascript
 // Promise
-const promise = rewards.getOfferByName({  name : value });
+const promise = rewards.catalogueOrder({  body : value });
 
 // Async/Await
-const data = await rewards.getOfferByName({  name : value });
+const data = await rewards.catalogueOrder({  body : value });
 ```
 
 
@@ -92,21 +97,20 @@ const data = await rewards.getOfferByName({  name : value });
 
 
 | Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| name | string | yes | The name given to the offer. |  
-
+| --------- | -----  | -------- | ----------- |
+| body | [CatalogueOrderRequest](#CatalogueOrderRequest) | yes | Request body |
 
 
-Use this API to get the offer details and configuration by entering the name of the offer.
+Use this API to evaluate the amount of reward points that could be earned on any catalogue product.
 
 *Returned Response:*
 
 
 
 
-[Offer](#Offer)
+[CatalogueOrderResponse](#CatalogueOrderResponse)
 
-Success. Check example below or refer `Offer` for more details.
+Success. Check example below or refer `CatalogueOrderResponse` for more details.
 
 
 
@@ -130,17 +134,19 @@ Success. Check example below or refer `Offer` for more details.
 ---
 
 
-### getOrderDiscount
-Calculates the discount on order-amount
+### getUserPointsHistory
+Get all transactions of reward points
 
 
 
 ```javascript
 // Promise
-const promise = rewards.getOrderDiscount({  body : value });
+const promise = rewards.getUserPointsHistory({  pageId : value,
+ pageSize : value });
 
 // Async/Await
-const data = await rewards.getOrderDiscount({  body : value });
+const data = await rewards.getUserPointsHistory({  pageId : value,
+ pageSize : value });
 ```
 
 
@@ -148,20 +154,22 @@ const data = await rewards.getOrderDiscount({  body : value });
 
 
 | Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |
-| body | [OrderDiscountRequest](#OrderDiscountRequest) | yes | Request body |
+| --------- | -----  | -------- | ----------- |  
+| pageId | string | no | PageID is the ID of the requested page. For first request it should be kept empty. |    
+| pageSize | number | no | The number of items to retrieve in each page. |  
 
 
-Use this API to calculate the discount on order-amount based on all the amount range configured in order_discount.
+
+Use this API to get a list of points transactions.
 
 *Returned Response:*
 
 
 
 
-[OrderDiscountResponse](#OrderDiscountResponse)
+[PointsHistoryResponse](#PointsHistoryResponse)
 
-Success. Check example below or refer `OrderDiscountResponse` for more details.
+Success. Check example below or refer `PointsHistoryResponse` for more details.
 
 
 
@@ -186,7 +194,7 @@ Success. Check example below or refer `OrderDiscountResponse` for more details.
 
 
 ### getUserPoints
-Get reward points available with a user
+Get referral details of a user
 
 
 
@@ -236,42 +244,34 @@ Success. Check example below or refer `PointsResponse` for more details.
 ---
 
 
-### getUserPointsHistory
-Get all transactions of reward points
+### getUserReferralDetails
+Get referral details of a user
 
 
 
 ```javascript
 // Promise
-const promise = rewards.getUserPointsHistory({  pageId : value,
- pageSize : value });
+const promise = rewards.getUserReferralDetails();
 
 // Async/Await
-const data = await rewards.getUserPointsHistory({  pageId : value,
- pageSize : value });
+const data = await rewards.getUserReferralDetails();
 ```
 
 
 
 
 
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |  
-| pageId | string | no | PageID is the ID of the requested page. For first request it should be kept empty. |    
-| pageSize | number | no | The number of items to retrieve in each page. |  
 
-
-
-Use this API to get a list of points transactions. The list of points history is paginated.
+Use this API to retrieve the referral details a user has configured in the application.
 
 *Returned Response:*
 
 
 
 
-[PointsHistoryResponse](#PointsHistoryResponse)
+[ReferralDetailsResponse](#ReferralDetailsResponse)
 
-Success. Check example below or refer `PointsHistoryResponse` for more details.
+Success. Check example below or refer `ReferralDetailsResponse` for more details.
 
 
 
@@ -295,34 +295,38 @@ Success. Check example below or refer `PointsHistoryResponse` for more details.
 ---
 
 
-### getUserReferralDetails
-Get referral details of a user
+### getOrderDiscount
+Calculates the discount on order-amount
 
 
 
 ```javascript
 // Promise
-const promise = rewards.getUserReferralDetails();
+const promise = rewards.getOrderDiscount({  body : value });
 
 // Async/Await
-const data = await rewards.getUserReferralDetails();
+const data = await rewards.getOrderDiscount({  body : value });
 ```
 
 
 
 
 
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- |
+| body | [OrderDiscountRequest](#OrderDiscountRequest) | yes | Request body |
+
 
-Use this API to retrieve the referral details a user has configured in the application.
+Use this API to calculate the discount on order-amount based on all the amount range configured in order_discount.
 
 *Returned Response:*
 
 
 
 
-[ReferralDetailsResponse](#ReferralDetailsResponse)
+[OrderDiscountResponse](#OrderDiscountResponse)
 
-Success. Check example below or refer `ReferralDetailsResponse` for more details.
+Success. Check example below or refer `OrderDiscountResponse` for more details.
 
 
 
@@ -406,31 +410,20 @@ Success. Check example below or refer `RedeemReferralCodeResponse` for more deta
 
  
  
- #### [ActionPageParams](#ActionPageParams)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | slug | [string] |  no  |  |
-
----
-
-
- 
- 
- #### [Asset](#Asset)
+ #### [RewardsArticle](#RewardsArticle)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | aspect_ratio | string |  no  |  |
  | id | string |  no  |  |
- | secure_url | string |  no  |  |
+ | points | number |  no  |  |
+ | price | number |  no  |  |
 
 ---
 
 
  
  
- #### [CatalogueOrderRequest](#CatalogueOrderRequest)
+ #### [CatalogueOrderResponse](#CatalogueOrderResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
@@ -441,7 +434,7 @@ Success. Check example below or refer `RedeemReferralCodeResponse` for more deta
 
  
  
- #### [CatalogueOrderResponse](#CatalogueOrderResponse)
+ #### [CatalogueOrderRequest](#CatalogueOrderRequest)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
@@ -452,29 +445,25 @@ Success. Check example below or refer `RedeemReferralCodeResponse` for more deta
 
  
  
- #### [DiscountProperties](#DiscountProperties)
+ #### [PointsResponse](#PointsResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | absolute | number |  no  |  |
- | currency | string |  no  |  |
- | display_absolute | string |  no  |  |
- | display_percent | string |  no  |  |
- | percent | number |  no  |  |
+ | points | number |  no  | Total points available |
 
 ---
 
 
  
  
- #### [Error](#Error)
+ #### [ReferralDetailsUser](#ReferralDetailsUser)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | code | number |  no  |  |
- | exception | string |  no  |  |
- | info | string |  no  |  |
- | message | string |  no  |  |
+ | blocked | boolean |  no  |  |
+ | points | number |  no  |  |
+ | redeemed | boolean |  no  |  |
+ | referral_code | string |  no  |  |
 
 ---
 
@@ -505,207 +494,211 @@ Success. Check example below or refer `RedeemReferralCodeResponse` for more deta
 
  
  
- #### [OrderDiscountRequest](#OrderDiscountRequest)
+ #### [Schedule](#Schedule)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | currency | string |  no  |  |
- | order_amount | number |  yes  |  |
+ | duration | number |  no  |  |
+ | end | string |  no  |  |
+ | start | string |  no  |  |
+ | cron | string |  no  |  |
 
 ---
 
 
  
  
- #### [OrderDiscountResponse](#OrderDiscountResponse)
+ #### [Error](#Error)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | applied_rule_bucket | [OrderDiscountRuleBucket](#OrderDiscountRuleBucket) |  no  |  |
- | base_discount | [DiscountProperties](#DiscountProperties) |  no  |  |
- | discount | [DiscountProperties](#DiscountProperties) |  no  |  |
- | order_amount | number |  no  |  |
- | points | number |  no  |  |
+ | code | number |  no  |  |
+ | exception | string |  no  |  |
+ | info | string |  no  |  |
+ | message | string |  no  |  |
 
 ---
 
 
  
  
- #### [OrderDiscountRuleBucket](#OrderDiscountRuleBucket)
+ #### [Asset](#Asset)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | high | number |  no  |  |
- | low | number |  no  |  |
- | max | number |  no  |  |
- | value | number |  no  |  |
- | value_type | string |  no  |  |
+ | aspect_ratio | string |  no  |  |
+ | id | string |  no  |  |
+ | secure_url | string |  no  |  |
 
 ---
 
 
  
  
- #### [Page](#Page)
+ #### [ShareMessages](#ShareMessages)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | 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  |  |
+ | email | number |  no  |  |
+ | facebook | string |  no  |  |
+ | fallback | string |  no  |  |
+ | message | string |  no  |  |
+ | messenger | string |  no  |  |
+ | sms | string |  no  |  |
+ | text | string |  no  |  |
+ | twitter | string |  no  |  |
+ | whatsapp | string |  no  |  |
 
 ---
 
 
  
  
- #### [PointsHistory](#PointsHistory)
+ #### [ReferralDetailsResponse](#ReferralDetailsResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | _id | string |  no  |  |
- | application_id | string |  no  |  |
- | claimed | boolean |  no  |  |
- | created_at | string |  no  |  |
- | expires_on | string |  no  |  |
- | meta | string |  no  |  |
- | points | number |  no  |  |
- | remaining_points | number |  no  |  |
- | text_1 | string |  no  |  |
- | text_2 | string |  no  |  |
- | text_3 | string |  no  |  |
- | txn_name | string |  no  |  |
- | updated_at | string |  no  |  |
- | user_id | string |  no  |  |
+ | referral | [Offer](#Offer) |  no  |  |
+ | share | [ShareMessages](#ShareMessages) |  no  |  |
+ | user | [ReferralDetailsUser](#ReferralDetailsUser) |  no  |  |
+ | referrer_info | string |  no  |  |
 
 ---
 
 
  
  
- #### [PointsHistoryResponse](#PointsHistoryResponse)
+ #### [OrderDiscountRequest](#OrderDiscountRequest)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | items | [[PointsHistory](#PointsHistory)] |  no  | History is the list of points transaction. |
- | page | [Page](#Page) |  no  |  |
+ | order_amount | number |  yes  |  |
+ | currency | string |  no  |  |
 
 ---
 
 
  
  
- #### [PointsResponse](#PointsResponse)
+ #### [OrderDiscountRuleBucket](#OrderDiscountRuleBucket)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | points | number |  no  | Points is the total available |
+ | high | number |  no  |  |
+ | low | number |  no  |  |
+ | max | number |  no  |  |
+ | value | number |  no  |  |
+ | value_type | string |  no  |  |
 
 ---
 
 
  
  
- #### [RedeemReferralCodeRequest](#RedeemReferralCodeRequest)
+ #### [DiscountProperties](#DiscountProperties)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | device_id | string |  yes  |  |
- | referral_code | string |  yes  |  |
+ | absolute | number |  no  |  |
+ | currency | string |  no  |  |
+ | display_absolute | string |  no  |  |
+ | display_percent | string |  no  |  |
+ | percent | number |  no  |  |
 
 ---
 
 
  
  
- #### [RedeemReferralCodeResponse](#RedeemReferralCodeResponse)
+ #### [OrderDiscountResponse](#OrderDiscountResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | message | string |  no  |  |
+ | order_amount | number |  no  |  |
  | points | number |  no  |  |
- | redeemed | boolean |  no  |  |
- | referrer_id | string |  no  |  |
- | referrer_info | string |  no  |  |
+ | discount | [DiscountProperties](#DiscountProperties) |  no  |  |
+ | base_discount | [DiscountProperties](#DiscountProperties) |  no  |  |
+ | applied_rule_bucket | [OrderDiscountRuleBucket](#OrderDiscountRuleBucket) |  no  |  |
 
 ---
 
 
  
  
- #### [ReferralDetailsResponse](#ReferralDetailsResponse)
+ #### [RedeemReferralCodeRequest](#RedeemReferralCodeRequest)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | referral | [Offer](#Offer) |  no  |  |
- | referrer_info | string |  no  |  |
- | share | [ShareMessages](#ShareMessages) |  no  |  |
- | user | [ReferralDetailsUser](#ReferralDetailsUser) |  no  |  |
+ | device_id | string |  no  |  |
+ | referral_code | string |  no  |  |
 
 ---
 
 
  
  
- #### [ReferralDetailsUser](#ReferralDetailsUser)
+ #### [RedeemReferralCodeResponse](#RedeemReferralCodeResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | blocked | boolean |  no  |  |
- | points | number |  no  |  |
  | redeemed | boolean |  no  |  |
- | referral_code | string |  no  |  |
+ | message | string |  no  |  |
+ | referrer_info | string |  no  |  |
+ | referrer_id | string |  no  |  |
+ | points | number |  no  |  |
 
 ---
 
 
  
  
- #### [RewardsArticle](#RewardsArticle)
+ #### [PointsHistoryResponse](#PointsHistoryResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | id | string |  no  |  |
- | points | number |  no  |  |
- | price | number |  no  |  |
+ | items | [[PointsHistory](#PointsHistory)] |  no  | History is the list of points transaction. |
+ | page | [Page](#Page) |  no  |  |
 
 ---
 
 
  
  
- #### [Schedule](#Schedule)
+ #### [PointsHistory](#PointsHistory)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | cron | string |  no  |  |
- | duration | number |  no  |  |
- | end | string |  no  |  |
- | start | string |  no  |  |
+ | _id | string |  no  |  |
+ | application_id | string |  no  |  |
+ | claimed | boolean |  no  |  |
+ | created_at | string |  no  |  |
+ | expires_on | string |  no  |  |
+ | meta | string |  no  |  |
+ | points | number |  no  |  |
+ | remaining_points | number |  no  |  |
+ | text_1 | string |  no  |  |
+ | text_2 | string |  no  |  |
+ | text_3 | string |  no  |  |
+ | txn_name | string |  no  |  |
+ | updated_at | string |  no  |  |
+ | user_id | string |  no  |  |
 
 ---
 
 
  
  
- #### [ShareMessages](#ShareMessages)
+ #### [Page](#Page)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | email | string |  no  |  |
- | facebook | string |  no  |  |
- | fallback | string |  no  |  |
- | message | string |  no  |  |
- | messenger | string |  no  |  |
- | sms | string |  no  |  |
- | text | string |  no  |  |
- | twitter | string |  no  |  |
- | whatsapp | string |  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 |  no  |  |
 
 ---
 

package/documentation/application/SHARE.md

@@ -2,10 +2,12 @@
 
 
 
+
 ##### [Back to Application docs](./README.md)
 
 ## Share Methods
 Short link and QR Code
+
 * [getApplicationQRCode](#getapplicationqrcode)
 * [getProductQRCodeBySlug](#getproductqrcodebyslug)
 * [getCollectionQRCodeBySlug](#getcollectionqrcodebyslug)
@@ -19,6 +21,8 @@ Short link and QR Code
 ## Methods with example and description
 
 
+
+
 ### getApplicationQRCode
 Create QR Code of an app
 

package/documentation/application/THEME.md

@@ -2,10 +2,12 @@
 
 
 
+
 ##### [Back to Application docs](./README.md)
 
 ## Theme Methods
 Responsible for themes
+
 * [getAllPages](#getallpages)
 * [getPage](#getpage)
 * [getAppliedTheme](#getappliedtheme)
@@ -16,6 +18,8 @@ Responsible for themes
 ## Methods with example and description
 
 
+
+
 ### getAllPages
 Get all pages of a theme