@gofynd/fdk-client-javascript 0.1.35 → 0.1.36

package/documentation/platform/REWARDS.md

@@ -2,19 +2,22 @@
 
 
 
+
 ##### [Back to Platform docs](./README.md)
 
 ## Rewards Methods
-Rewards
-* [getGiveaways](#getgiveaways)
-* [createGiveaway](#creategiveaway)
-* [getGiveawayByID](#getgiveawaybyid)
-* [updateGiveaway](#updategiveaway)
-* [getOffers](#getoffers)
+Earn and redeem reward points
+
+* [showGiveaways](#showgiveaways)
+* [saveGiveAway](#savegiveaway)
+* [getGiveawayById](#getgiveawaybyid)
+* [updateGiveAway](#updategiveaway)
+* [getGiveawayAudienceStatus](#getgiveawayaudiencestatus)
+* [showOffers](#showoffers)
 * [getOfferByName](#getofferbyname)
 * [updateOfferByName](#updateofferbyname)
-* [getUserAvailablePoints](#getuseravailablepoints)
 * [updateUserStatus](#updateuserstatus)
+* [user](#user)
 * [getUserPointsHistory](#getuserpointshistory)
 
 
@@ -22,18 +25,20 @@ Rewards
 ## Methods with example and description
 
 
-### getGiveaways
+
+
+### showGiveaways
 List of giveaways of the current application.
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.getGiveaways({  pageId : value,
+const promise = client.application("<APPLICATION_ID>").rewards.showGiveaways({  pageId : value,
  pageSize : value });
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.getGiveaways({  pageId : value,
+const data = await client.application("<APPLICATION_ID>").rewards.showGiveaways({  pageId : value,
  pageSize : value });
 ```
 
@@ -42,9 +47,9 @@ const data = await client.application("<APPLICATION_ID>").rewards.getGiveaways({
 
 
 | Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |  
-| pageId | string | no | pagination page id |    
-| pageSize | number | no | pagination page size |  
+| --------- | -----  | -------- | ----------- | 
+| pageId | string | yes | pagination page id |   
+| pageSize | number | yes | pagination page size |  
 
 
 
@@ -81,17 +86,17 @@ ok
 ---
 
 
-### createGiveaway
-Adds a new giveaway.
+### saveGiveAway
+List of giveaways of the current application.
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.createGiveaway({  body : value });
+const promise = client.application("<APPLICATION_ID>").rewards.saveGiveAway({  body : value });
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.createGiveaway({  body : value });
+const data = await client.application("<APPLICATION_ID>").rewards.saveGiveAway({  body : value });
 ```
 
 
@@ -136,17 +141,17 @@ ok
 ---
 
 
-### getGiveawayByID
+### getGiveawayById
 Get giveaway by ID.
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.getGiveawayByID({  id : value });
+const promise = client.application("<APPLICATION_ID>").rewards.getGiveawayById({  id : value });
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.getGiveawayByID({  id : value });
+const data = await client.application("<APPLICATION_ID>").rewards.getGiveawayById({  id : value });
 ```
 
 
@@ -192,18 +197,18 @@ ok
 ---
 
 
-### updateGiveaway
+### updateGiveAway
 Updates the giveaway by it's ID.
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.updateGiveaway({  id : value,
+const promise = client.application("<APPLICATION_ID>").rewards.updateGiveAway({  id : value,
  body : value });
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.updateGiveaway({  id : value,
+const data = await client.application("<APPLICATION_ID>").rewards.updateGiveAway({  id : value,
  body : value });
 ```
 
@@ -250,17 +255,73 @@ ok
 ---
 
 
-### getOffers
-List of offer of the current application.
+### getGiveawayAudienceStatus
+Get the Giveaway audience status
+
+
+
+```javascript
+// Promise
+const promise = client.application("<APPLICATION_ID>").rewards.getGiveawayAudienceStatus({  audienceId : value });
+
+// Async/Await
+const data = await client.application("<APPLICATION_ID>").rewards.getGiveawayAudienceStatus({  audienceId : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| audienceId | string | yes | audience id |  
+
+
+
+Get giveaway audience status
+
+*Returned Response:*
+
+
+
+
+[GiveawayAudience](#GiveawayAudience)
+
+Success
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### showOffers
+List of offers of the current application.
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.getOffers();
+const promise = client.application("<APPLICATION_ID>").rewards.showOffers();
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.getOffers();
+const data = await client.application("<APPLICATION_ID>").rewards.showOffers();
 ```
 
 
@@ -268,7 +329,7 @@ const data = await client.application("<APPLICATION_ID>").rewards.getOffers();
 
 
 
-List of offer of the current application.
+List of offers of the current application.
 
 *Returned Response:*
 
@@ -302,18 +363,18 @@ ok
 
 
 ### getOfferByName
-Get offer by name.
+Get offer by name
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.getOfferByName({  cookie : value,
- name : value });
+const promise = client.application("<APPLICATION_ID>").rewards.getOfferByName({  name : value,
+ cookie : value });
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.getOfferByName({  cookie : value,
- name : value });
+const data = await client.application("<APPLICATION_ID>").rewards.getOfferByName({  name : value,
+ cookie : value });
 ```
 
 
@@ -322,12 +383,12 @@ const data = await client.application("<APPLICATION_ID>").rewards.getOfferByName
 
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- | 
-| cookie | string | yes | User's session cookie. This cookie is set in browser cookie when logged-in to fynd's authentication system i.e. `Grimlock` or by using grimlock-backend SDK for backend implementation. |   
-| name | string | yes | Offer name |  
+| name | string | yes | The name given to the offer. |   
+| cookie | string | yes | User's session cookie. This cookie is set in browser cookie when logged-in to fynd's authentication system i.e. `Grimlock` or by using grimlock-backend SDK for backend implementation. |  
 
 
 
-Get offer by name.
+Use this API to get the offer details and configuration by entering the name of the offer.
 
 *Returned Response:*
 
@@ -336,7 +397,7 @@ Get offer by name.
 
 [Offer](#Offer)
 
-ok
+Success. Check example below or refer `Offer` for more details.
 
 
 
@@ -361,7 +422,7 @@ ok
 
 
 ### updateOfferByName
-Updates the offer by name.
+Update offer by name
 
 
 
@@ -381,11 +442,11 @@ const data = await client.application("<APPLICATION_ID>").rewards.updateOfferByN
 
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- | 
-| name | string | yes | Offer name |  
+| name | string | yes | The name given to the offer. |  
 | body | [Offer](#Offer) | yes | Request body |
 
 
-Updates the offer by name.
+Use this API to update the offer details
 
 *Returned Response:*
 
@@ -394,7 +455,7 @@ Updates the offer by name.
 
 [Offer](#Offer)
 
-ok
+Success. Check example below or refer `Offer` for more details.
 
 
 
@@ -418,17 +479,19 @@ ok
 ---
 
 
-### getUserAvailablePoints
-User's reward details.
+### updateUserStatus
+Update user status
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.getUserAvailablePoints({  userId : value });
+const promise = client.application("<APPLICATION_ID>").rewards.updateUserStatus({  userId : value,
+ body : value });
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.getUserAvailablePoints({  userId : value });
+const data = await client.application("<APPLICATION_ID>").rewards.updateUserStatus({  userId : value,
+ body : value });
 ```
 
 
@@ -438,19 +501,19 @@ const data = await client.application("<APPLICATION_ID>").rewards.getUserAvailab
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- | 
 | userId | string | yes | user id |  
+| body | [AppUser](#AppUser) | yes | Request body |
 
 
-
-User's reward details.
+Use this API to update the user status active/archive
 
 *Returned Response:*
 
 
 
 
-[UserRes](#UserRes)
+[AppUser](#AppUser)
 
-ok
+Success
 
 
 
@@ -474,19 +537,17 @@ ok
 ---
 
 
-### updateUserStatus
-Update User status
+### user
+Get user reward details
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.updateUserStatus({  userId : value,
- body : value });
+const promise = client.application("<APPLICATION_ID>").rewards.user({  userId : value });
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.updateUserStatus({  userId : value,
- body : value });
+const data = await client.application("<APPLICATION_ID>").rewards.user({  userId : value });
 ```
 
 
@@ -496,19 +557,19 @@ const data = await client.application("<APPLICATION_ID>").rewards.updateUserStat
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- | 
 | userId | string | yes | user id |  
-| body | [AppUser](#AppUser) | yes | Request body |
 
 
-Update user status, active/archive
+
+Use this API to get the user reward details
 
 *Returned Response:*
 
 
 
 
-[AppUser](#AppUser)
+[UserRes](#UserRes)
 
-Success
+Success. Check example below or refer `UserRes` for more details.
 
 
 
@@ -533,7 +594,7 @@ Success
 
 
 ### getUserPointsHistory
-Get list of points transactions.
+Get all transactions of reward points
 
 
 
@@ -541,13 +602,11 @@ Get list of points transactions.
 // Promise
 const promise = client.application("<APPLICATION_ID>").rewards.getUserPointsHistory({  userId : value,
  pageId : value,
- pageLimit : value,
  pageSize : value });
 
 // Async/Await
 const data = await client.application("<APPLICATION_ID>").rewards.getUserPointsHistory({  userId : value,
  pageId : value,
- pageLimit : value,
  pageSize : value });
 ```
 
@@ -559,13 +618,11 @@ const data = await client.application("<APPLICATION_ID>").rewards.getUserPointsH
 | --------- | -----  | -------- | ----------- | 
 | userId | string | yes | user id |    
 | pageId | string | no | PageID is the ID of the requested page. For first request it should be kept empty. |    
-| pageLimit | number | no | PageLimit is the number of requested items in response. |    
-| pageSize | number | no | PageSize is the number of requested items in response. |  
+| pageSize | number | no | The number of items to retrieve in each page. |  
 
 
 
-Get list of points transactions.
-The list of points history is paginated.
+Use this API to get a list of points transactions.
 
 *Returned Response:*
 
@@ -574,7 +631,7 @@ The list of points history is paginated.
 
 [HistoryRes](#HistoryRes)
 
-ok
+Success. Check example below or refer `HistoryRes` for more details.
 
 
 
@@ -603,47 +660,26 @@ ok
 
  
  
- #### [AppUser](#AppUser)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | _id | string |  no  |  |
- | active | boolean |  no  |  |
- | application_id | string |  no  |  |
- | block_reason | string |  no  |  |
- | updated_at | string |  no  |  |
- | updated_by | string |  no  |  |
- | user_id | string |  no  |  |
-
----
-
-
- 
- 
- #### [Asset](#Asset)
+ #### [E](#E)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | aspect_ratio | string |  no  |  |
- | id | string |  no  |  |
- | secure_url | string |  no  |  |
+ | code | number |  no  |  |
+ | exception | string |  no  |  |
+ | info | string |  no  |  |
+ | message | string |  no  |  |
 
 ---
 
 
  
  
- #### [E](#E)
+ #### [GiveawayResponse](#GiveawayResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | code | string |  no  |  |
- | exception | string |  no  |  |
- | info | string |  no  |  |
- | message | string |  no  |  |
- | request_id | string |  no  |  |
- | stack_trace | string |  no  |  |
- | status | number |  no  |  |
+ | items | [[Giveaway](#Giveaway)] |  no  |  |
+ | page | [Page](#Page) |  no  |  |
 
 ---
 
@@ -672,48 +708,67 @@ ok
 
  
  
- #### [GiveawayResponse](#GiveawayResponse)
+ #### [Schedule](#Schedule)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | items | [[Giveaway](#Giveaway)] |  no  |  |
- | page | [Page](#Page) |  no  |  |
+ | duration | number |  no  |  |
+ | end | string |  no  |  |
+ | start | string |  no  |  |
+ | cron | string |  no  |  |
 
 ---
 
 
  
  
- #### [HistoryPretty](#HistoryPretty)
+ #### [RewardsAudience](#RewardsAudience)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | _id | string |  no  |  |
- | application_id | string |  no  |  |
- | claimed | boolean |  no  |  |
- | created_at | string |  no  |  |
- | expires_on | 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  |  |
+ | header_user_id | string |  no  |  |
+ | id | string |  no  |  |
 
 ---
 
 
  
  
- #### [HistoryRes](#HistoryRes)
+ #### [Asset](#Asset)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | items | [[HistoryPretty](#HistoryPretty)] |  no  |  |
- | page | [Page](#Page) |  no  |  |
- | points | number |  no  |  |
+ | aspect_ratio | string |  no  |  |
+ | id | string |  no  |  |
+ | secure_url | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [RewardsRule](#RewardsRule)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | amount | number |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [Page](#Page)
+
+ | 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  |  |
 
 ---
 
@@ -744,39 +799,42 @@ ok
 
  
  
- #### [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  |  |
 
 ---
 
 
  
  
- #### [Points](#Points)
+ #### [UserRes](#UserRes)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | available | number |  no  |  |
+ | points | [Points](#Points) |  no  |  |
+ | user | [RewardUser](#RewardUser) |  no  |  |
 
 ---
 
 
  
  
- #### [Referral](#Referral)
+ #### [Points](#Points)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | code | string |  no  |  |
+ | available | number |  no  |  |
 
 ---
 
@@ -801,68 +859,77 @@ ok
 
  
  
- #### [RewardsAudience](#RewardsAudience)
+ #### [Referral](#Referral)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | header_user_id | string |  no  |  |
- | id | string |  no  |  |
+ | code | string |  no  |  |
 
 ---
 
 
  
  
- #### [RewardsRule](#RewardsRule)
+ #### [AppUser](#AppUser)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | amount | number |  no  |  |
+ | _id | string |  no  |  |
+ | active | boolean |  no  |  |
+ | application_id | string |  no  |  |
+ | block_reason | string |  no  |  |
+ | updated_at | string |  no  |  |
+ | updated_by | string |  no  |  |
+ | user_id | string |  no  |  |
 
 ---
 
 
  
  
- #### [Schedule](#Schedule)
+ #### [GiveawayAudience](#GiveawayAudience)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | cron | string |  no  |  |
- | duration | number |  no  |  |
- | end | string |  no  |  |
- | start | string |  no  |  |
+ | audience_id | string |  no  |  |
+ | current_count | number |  no  |  |
 
 ---
 
 
  
  
- #### [ShareMessages](#ShareMessages)
+ #### [HistoryRes](#HistoryRes)
 
  | 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  |  |
+ | items | [[PointsHistory](#PointsHistory)] |  no  | History is the list of points transaction. |
+ | page | [Page](#Page) |  no  |  |
+ | points | number |  no  |  |
 
 ---
 
 
  
  
- #### [UserRes](#UserRes)
+ #### [PointsHistory](#PointsHistory)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | points | [Points](#Points) |  no  |  |
- | user | [RewardUser](#RewardUser) |  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  |  |
 
 ---