@gofynd/fdk-client-javascript 1.0.2 → 1.0.3

package/documentation/platform/REWARDS.md

@@ -8,19 +8,19 @@
 ## Rewards Methods
 Earn and redeem reward points
 
-* [showGiveaways](#showgiveaways)
-* [saveGiveAway](#savegiveaway)
-* [getGiveawayById](#getgiveawaybyid)
-* [updateGiveAway](#updategiveaway)
 * [getGiveawayAudienceStatus](#getgiveawayaudiencestatus)
-* [showOffers](#showoffers)
+* [getGiveawayById](#getgiveawaybyid)
 * [getOfferByName](#getofferbyname)
+* [getRewardsConfiguration](#getrewardsconfiguration)
+* [getUserPointsHistory](#getuserpointshistory)
+* [saveGiveAway](#savegiveaway)
+* [setRewardsConfiguration](#setrewardsconfiguration)
+* [showGiveaways](#showgiveaways)
+* [showOffers](#showoffers)
+* [updateGiveAway](#updategiveaway)
 * [updateOfferByName](#updateofferbyname)
 * [updateUserStatus](#updateuserstatus)
 * [user](#user)
-* [getUserPointsHistory](#getuserpointshistory)
-* [getRewardsConfiguration](#getrewardsconfiguration)
-* [setRewardsConfiguration](#setrewardsconfiguration)
 
 
 
@@ -29,19 +29,17 @@ Earn and redeem reward points
 
 
 
-### showGiveaways
-List of giveaways of the current application.
+### getGiveawayAudienceStatus
+Get the Giveaway audience status
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.showGiveaways({  pageId : value,
- pageSize : value });
+const promise = client.application("<APPLICATION_ID>").rewards.getGiveawayAudienceStatus({  audienceId : value });
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.showGiveaways({  pageId : value,
- pageSize : value });
+const data = await client.application("<APPLICATION_ID>").rewards.getGiveawayAudienceStatus({  audienceId : value });
 ```
 
 
@@ -50,21 +48,20 @@ const data = await client.application("<APPLICATION_ID>").rewards.showGiveaways(
 
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- | 
-| pageId | string | yes | pagination page id |   
-| pageSize | number | yes | pagination page size |  
+| audienceId | string | yes | audience id |  
 
 
 
-List of giveaways of the current application.
+Get giveaway audience status
 
 *Returned Response:*
 
 
 
 
-[GiveawayResponse](#GiveawayResponse)
+[GiveawayAudience](#GiveawayAudience)
 
-ok
+Success
 
 
 
@@ -88,17 +85,17 @@ ok
 ---
 
 
-### saveGiveAway
-List of giveaways of the current application.
+### getGiveawayById
+Get giveaway by ID.
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.saveGiveAway({  body : value });
+const promise = client.application("<APPLICATION_ID>").rewards.getGiveawayById({  id : value });
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.saveGiveAway({  body : value });
+const data = await client.application("<APPLICATION_ID>").rewards.getGiveawayById({  id : value });
 ```
 
 
@@ -106,11 +103,12 @@ const data = await client.application("<APPLICATION_ID>").rewards.saveGiveAway({
 
 
 | Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |
-| body | [Giveaway](#Giveaway) | yes | Request body |
+| --------- | -----  | -------- | ----------- | 
+| id | string | yes | Giveaway ID |  
 
 
-Adds a new giveaway.
+
+Get giveaway by ID.
 
 *Returned Response:*
 
@@ -143,17 +141,19 @@ ok
 ---
 
 
-### getGiveawayById
-Get giveaway by ID.
+### getOfferByName
+Get offer by name
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.getGiveawayById({  id : value });
+const promise = client.application("<APPLICATION_ID>").rewards.getOfferByName({  name : value,
+ cookie : value });
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.getGiveawayById({  id : value });
+const data = await client.application("<APPLICATION_ID>").rewards.getOfferByName({  name : value,
+ cookie : value });
 ```
 
 
@@ -162,20 +162,21 @@ const data = await client.application("<APPLICATION_ID>").rewards.getGiveawayByI
 
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- | 
-| id | string | yes | Giveaway ID |  
+| 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 giveaway by ID.
+Use this API to get the offer details and configuration by entering the name of the offer.
 
 *Returned Response:*
 
 
 
 
-[Giveaway](#Giveaway)
+[Offer](#Offer)
 
-ok
+Success. Check example below or refer `Offer` for more details.
 
 
 
@@ -199,41 +200,34 @@ ok
 ---
 
 
-### updateGiveAway
-Updates the giveaway by it's ID.
+### getRewardsConfiguration
+Get all valid android paths
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.updateGiveAway({  id : value,
- body : value });
+const promise = client.application("<APPLICATION_ID>").rewards.getRewardsConfiguration();
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.updateGiveAway({  id : value,
- body : value });
+const data = await client.application("<APPLICATION_ID>").rewards.getRewardsConfiguration();
 ```
 
 
 
 
 
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| id | string | yes | Giveaway ID |  
-| body | [Giveaway](#Giveaway) | yes | Request body |
-
 
-Updates the giveaway by it's ID.
+Use this API to get a list of valid android paths required by the Rewards INIT API to validate a fradualent device.
 
 *Returned Response:*
 
 
 
 
-[Giveaway](#Giveaway)
+[ConfigurationRes](#ConfigurationRes)
 
-ok
+Success. Refer `ConfigurationRes` for more details.
 
 
 
@@ -257,17 +251,21 @@ ok
 ---
 
 
-### getGiveawayAudienceStatus
-Get the Giveaway audience status
+### getUserPointsHistory
+Get all transactions of reward points
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.getGiveawayAudienceStatus({  audienceId : value });
+const promise = client.application("<APPLICATION_ID>").rewards.getUserPointsHistory({  userId : value,
+ pageId : value,
+ pageSize : value });
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.getGiveawayAudienceStatus({  audienceId : value });
+const data = await client.application("<APPLICATION_ID>").rewards.getUserPointsHistory({  userId : value,
+ pageId : value,
+ pageSize : value });
 ```
 
 
@@ -276,20 +274,22 @@ const data = await client.application("<APPLICATION_ID>").rewards.getGiveawayAud
 
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- | 
-| audienceId | string | yes | audience id |  
+| userId | string | yes | user id |    
+| 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. |  
 
 
 
-Get giveaway audience status
+Use this API to get a list of points transactions.
 
 *Returned Response:*
 
 
 
 
-[GiveawayAudience](#GiveawayAudience)
+[HistoryRes](#HistoryRes)
 
-Success
+Success. Check example below or refer `HistoryRes` for more details.
 
 
 
@@ -313,32 +313,36 @@ Success
 ---
 
 
-### showOffers
-List of offers of the current application.
+### saveGiveAway
+List of giveaways of the current application.
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.showOffers();
+const promise = client.application("<APPLICATION_ID>").rewards.saveGiveAway({  body : value });
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.showOffers();
+const data = await client.application("<APPLICATION_ID>").rewards.saveGiveAway({  body : value });
 ```
 
 
 
 
 
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- |
+| body | [Giveaway](#Giveaway) | yes | Request body |
 
-List of offers of the current application.
+
+Adds a new giveaway.
 
 *Returned Response:*
 
 
 
 
-[Array<Offer>](#Array<Offer>)
+[Giveaway](#Giveaway)
 
 ok
 
@@ -364,19 +368,17 @@ ok
 ---
 
 
-### getOfferByName
-Get offer by name
+### setRewardsConfiguration
+Updates the collection with given android paths.
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.getOfferByName({  name : value,
- cookie : value });
+const promise = client.application("<APPLICATION_ID>").rewards.setRewardsConfiguration({  body : value });
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.getOfferByName({  name : value,
- cookie : value });
+const data = await client.application("<APPLICATION_ID>").rewards.setRewardsConfiguration({  body : value });
 ```
 
 
@@ -384,22 +386,20 @@ const data = await client.application("<APPLICATION_ID>").rewards.getOfferByName
 
 
 | Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| 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. |  
-
+| --------- | -----  | -------- | ----------- |
+| body | [ConfigurationRequest](#ConfigurationRequest) | yes | Request body |
 
 
-Use this API to get the offer details and configuration by entering the name of the offer.
+Updates the configuration or inserts new records.
 
 *Returned Response:*
 
 
 
 
-[Offer](#Offer)
+[SetConfigurationRes](#SetConfigurationRes)
 
-Success. Check example below or refer `Offer` for more details.
+ok
 
 
 
@@ -423,19 +423,19 @@ Success. Check example below or refer `Offer` for more details.
 ---
 
 
-### updateOfferByName
-Update offer by name
+### showGiveaways
+List of giveaways of the current application.
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.updateOfferByName({  name : value,
- body : value });
+const promise = client.application("<APPLICATION_ID>").rewards.showGiveaways({  pageId : value,
+ pageSize : value });
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.updateOfferByName({  name : value,
- body : value });
+const data = await client.application("<APPLICATION_ID>").rewards.showGiveaways({  pageId : value,
+ pageSize : value });
 ```
 
 
@@ -444,20 +444,21 @@ const data = await client.application("<APPLICATION_ID>").rewards.updateOfferByN
 
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- | 
-| name | string | yes | The name given to the offer. |  
-| body | [Offer](#Offer) | yes | Request body |
+| pageId | string | yes | pagination page id |   
+| pageSize | number | yes | pagination page size |  
 
 
-Use this API to update the offer details
+
+List of giveaways of the current application.
 
 *Returned Response:*
 
 
 
 
-[Offer](#Offer)
+[GiveawayResponse](#GiveawayResponse)
 
-Success. Check example below or refer `Offer` for more details.
+ok
 
 
 
@@ -481,41 +482,34 @@ Success. Check example below or refer `Offer` for more details.
 ---
 
 
-### updateUserStatus
-Update user status
+### showOffers
+List of offers of the current application.
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.updateUserStatus({  userId : value,
- body : value });
+const promise = client.application("<APPLICATION_ID>").rewards.showOffers();
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.updateUserStatus({  userId : value,
- body : value });
+const data = await client.application("<APPLICATION_ID>").rewards.showOffers();
 ```
 
 
 
 
 
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| userId | string | yes | user id |  
-| body | [AppUser](#AppUser) | yes | Request body |
 
-
-Use this API to update the user status active/archive
+List of offers of the current application.
 
 *Returned Response:*
 
 
 
 
-[AppUser](#AppUser)
+[Array<Offer>](#Array<Offer>)
 
-Success
+ok
 
 
 
@@ -539,17 +533,19 @@ Success
 ---
 
 
-### user
-Get user reward details
+### updateGiveAway
+Updates the giveaway by it's ID.
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.user({  userId : value });
+const promise = client.application("<APPLICATION_ID>").rewards.updateGiveAway({  id : value,
+ body : value });
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.user({  userId : value });
+const data = await client.application("<APPLICATION_ID>").rewards.updateGiveAway({  id : value,
+ body : value });
 ```
 
 
@@ -558,20 +554,20 @@ const data = await client.application("<APPLICATION_ID>").rewards.user({  userId
 
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- | 
-| userId | string | yes | user id |  
-
+| id | string | yes | Giveaway ID |  
+| body | [Giveaway](#Giveaway) | yes | Request body |
 
 
-Use this API to get the user reward details
+Updates the giveaway by it's ID.
 
 *Returned Response:*
 
 
 
 
-[UserRes](#UserRes)
+[Giveaway](#Giveaway)
 
-Success. Check example below or refer `UserRes` for more details.
+ok
 
 
 
@@ -595,21 +591,19 @@ Success. Check example below or refer `UserRes` for more details.
 ---
 
 
-### getUserPointsHistory
-Get all transactions of reward points
+### updateOfferByName
+Update offer by name
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.getUserPointsHistory({  userId : value,
- pageId : value,
- pageSize : value });
+const promise = client.application("<APPLICATION_ID>").rewards.updateOfferByName({  name : value,
+ body : value });
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.getUserPointsHistory({  userId : value,
- pageId : value,
- pageSize : value });
+const data = await client.application("<APPLICATION_ID>").rewards.updateOfferByName({  name : value,
+ body : value });
 ```
 
 
@@ -618,22 +612,20 @@ const data = await client.application("<APPLICATION_ID>").rewards.getUserPointsH
 
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- | 
-| userId | string | yes | user id |    
-| 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. |  
-
+| name | string | yes | The name given to the offer. |  
+| body | [Offer](#Offer) | yes | Request body |
 
 
-Use this API to get a list of points transactions.
+Use this API to update the offer details
 
 *Returned Response:*
 
 
 
 
-[HistoryRes](#HistoryRes)
+[Offer](#Offer)
 
-Success. Check example below or refer `HistoryRes` for more details.
+Success. Check example below or refer `Offer` for more details.
 
 
 
@@ -657,34 +649,41 @@ Success. Check example below or refer `HistoryRes` for more details.
 ---
 
 
-### getRewardsConfiguration
-Get all valid android paths
+### updateUserStatus
+Update user status
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.getRewardsConfiguration();
+const promise = client.application("<APPLICATION_ID>").rewards.updateUserStatus({  userId : value,
+ body : value });
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.getRewardsConfiguration();
+const data = await client.application("<APPLICATION_ID>").rewards.updateUserStatus({  userId : value,
+ body : value });
 ```
 
 
 
 
 
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| userId | string | yes | user id |  
+| body | [AppUser](#AppUser) | yes | Request body |
 
-Use this API to get a list of valid android paths required by the Rewards INIT API to validate a fradualent device.
+
+Use this API to update the user status active/archive
 
 *Returned Response:*
 
 
 
 
-[ConfigurationRes](#ConfigurationRes)
+[AppUser](#AppUser)
 
-Success. Refer `ConfigurationRes` for more details.
+Success
 
 
 
@@ -708,17 +707,17 @@ Success. Refer `ConfigurationRes` for more details.
 ---
 
 
-### setRewardsConfiguration
-Updates the collection with given android paths.
+### user
+Get user reward details
 
 
 
 ```javascript
 // Promise
-const promise = client.application("<APPLICATION_ID>").rewards.setRewardsConfiguration({  body : value });
+const promise = client.application("<APPLICATION_ID>").rewards.user({  userId : value });
 
 // Async/Await
-const data = await client.application("<APPLICATION_ID>").rewards.setRewardsConfiguration({  body : value });
+const data = await client.application("<APPLICATION_ID>").rewards.user({  userId : value });
 ```
 
 
@@ -726,20 +725,21 @@ const data = await client.application("<APPLICATION_ID>").rewards.setRewardsConf
 
 
 | Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |
-| body | [ConfigurationRequest](#ConfigurationRequest) | yes | Request body |
+| --------- | -----  | -------- | ----------- | 
+| userId | string | yes | user id |  
 
 
-Updates the configuration or inserts new records.
+
+Use this API to get the user reward details
 
 *Returned Response:*
 
 
 
 
-[SetConfigurationRes](#SetConfigurationRes)
+[UserRes](#UserRes)
 
-ok
+Success. Check example below or refer `UserRes` for more details.
 
 
 
@@ -766,315 +766,151 @@ ok
 
 ### Schemas
 
- 
- 
- #### [E](#E)
+
+#### [AppUser](#AppUser)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | code | number |  no  |  |
- | exception | string |  no  |  |
- | info | string |  no  |  |
- | message | string |  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  |  |
 
 ---
 
-
- 
- 
- #### [GiveawayResponse](#GiveawayResponse)
+#### [Asset](#Asset)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | items | [[Giveaway](#Giveaway)] |  no  |  |
- | page | [Page](#Page) |  no  |  |
+ | ---------- | ---- | -------- | ----------- || aspect_ratio | string |  no  |  || id | string |  no  |  || secure_url | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [Giveaway](#Giveaway)
+#### [ConfigurationRequest](#ConfigurationRequest)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | _id | string |  no  |  |
- | _schedule | [Schedule](#Schedule) |  no  |  |
- | active | boolean |  no  |  |
- | application_id | string |  no  |  |
- | audience | [RewardsAudience](#RewardsAudience) |  no  |  |
- | banner_image | [Asset](#Asset) |  no  |  |
- | created_at | string |  no  |  |
- | description | string |  no  |  |
- | name | string |  no  |  |
- | rule | [RewardsRule](#RewardsRule) |  no  |  |
- | title | string |  no  |  |
- | updated_at | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || terms_conditions_link | string |  no  |  || valid_android_packages | [string] |  no  |  |
 
 ---
 
-
- 
- 
- #### [Schedule](#Schedule)
+#### [ConfigurationRes](#ConfigurationRes)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | duration | number |  no  |  |
- | end | string |  no  |  |
- | start | string |  no  |  |
- | cron | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || application_id | string |  no  |  || success | boolean |  no  |  || terms_conditions_link | string |  no  |  || valid_android_packages | [string] |  no  |  |
 
 ---
 
-
- 
- 
- #### [RewardsAudience](#RewardsAudience)
+#### [E](#E)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | header_user_id | string |  no  |  |
- | id | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || code | number |  no  |  || exception | string |  no  |  || info | string |  no  |  || message | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [Asset](#Asset)
+#### [Giveaway](#Giveaway)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | aspect_ratio | string |  no  |  |
- | id | string |  no  |  |
- | secure_url | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || _id | string |  no  |  || _schedule | [Schedule](#Schedule) |  no  |  || active | boolean |  no  |  || application_id | string |  no  |  || audience | [RewardsAudience](#RewardsAudience) |  no  |  || banner_image | [Asset](#Asset) |  no  |  || created_at | string |  no  |  || description | string |  no  |  || name | string |  no  |  || rule | [RewardsRule](#RewardsRule) |  no  |  || title | string |  no  |  || updated_at | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [RewardsRule](#RewardsRule)
+#### [GiveawayAudience](#GiveawayAudience)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | amount | number |  no  |  |
+ | ---------- | ---- | -------- | ----------- || audience_id | string |  no  |  || current_count | number |  no  |  |
 
 ---
 
-
- 
- 
- #### [Page](#Page)
+#### [GiveawayResponse](#GiveawayResponse)
 
  | 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  |  |
+ | ---------- | ---- | -------- | ----------- || items | [[Giveaway](#Giveaway)] |  no  |  || page | [Page](#Page) |  no  |  |
 
 ---
 
-
- 
- 
- #### [Offer](#Offer)
+#### [HistoryRes](#HistoryRes)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | _schedule | [Schedule](#Schedule) |  no  |  |
- | active | boolean |  no  |  |
- | application_id | string |  no  |  |
- | banner_image | [Asset](#Asset) |  no  |  |
- | created_at | string |  no  |  |
- | name | string |  no  |  |
- | rule | string |  no  |  |
- | share | [ShareMessages](#ShareMessages) |  no  |  |
- | sub_text | string |  no  |  |
- | text | string |  no  |  |
- | type | string |  no  |  |
- | updated_at | string |  no  |  |
- | updated_by | string |  no  |  |
- | url | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || items | [[PointsHistory](#PointsHistory)] |  no  |  || page | [Page](#Page) |  no  |  || points | number |  no  |  |
 
 ---
 
-
- 
- 
- #### [ShareMessages](#ShareMessages)
+#### [Offer](#Offer)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | 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  |  |
+ | ---------- | ---- | -------- | ----------- || _schedule | [Schedule](#Schedule) |  no  |  || active | boolean |  no  |  || application_id | string |  no  |  || banner_image | [Asset](#Asset) |  no  |  || created_at | string |  no  |  || name | string |  no  |  || rule | string |  no  |  || share | [ShareMessages](#ShareMessages) |  no  |  || sub_text | string |  no  |  || text | string |  no  |  || type | string |  no  |  || updated_at | string |  no  |  || updated_by | string |  no  |  || url | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [UserRes](#UserRes)
+#### [Page](#Page)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | points | [Points](#Points) |  no  |  |
- | user | [RewardUser](#RewardUser) |  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  |  |
 
 ---
 
-
- 
- 
- #### [Points](#Points)
+#### [Points](#Points)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | available | number |  no  |  |
+ | ---------- | ---- | -------- | ----------- || available | number |  no  |  |
 
 ---
 
-
- 
- 
- #### [RewardUser](#RewardUser)
+#### [PointsHistory](#PointsHistory)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | _id | string |  no  |  |
- | active | boolean |  no  |  |
- | created_at | string |  no  |  |
- | referral | [Referral](#Referral) |  no  |  |
- | uid | number |  no  |  |
- | updated_at | string |  no  |  |
- | user_block_reason | string |  no  |  |
- | user_id | 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  |  |
 
 ---
 
-
- 
- 
- #### [Referral](#Referral)
+#### [Referral](#Referral)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | code | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || code | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [AppUser](#AppUser)
+#### [RewardsAudience](#RewardsAudience)
 
  | 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  |  |
+ | ---------- | ---- | -------- | ----------- || header_user_id | string |  no  |  || id | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [GiveawayAudience](#GiveawayAudience)
+#### [RewardsRule](#RewardsRule)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | audience_id | string |  no  |  |
- | current_count | number |  no  |  |
+ | ---------- | ---- | -------- | ----------- || amount | number |  no  |  |
 
 ---
 
-
- 
- 
- #### [HistoryRes](#HistoryRes)
+#### [RewardUser](#RewardUser)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | items | [[PointsHistory](#PointsHistory)] |  no  | History is the list of points transaction. |
- | page | [Page](#Page) |  no  |  |
- | points | number |  no  |  |
+ | ---------- | ---- | -------- | ----------- || _id | string |  no  |  || active | boolean |  no  |  || created_at | string |  no  |  || referral | [Referral](#Referral) |  no  |  || uid | number |  no  |  || updated_at | string |  no  |  || user_block_reason | string |  no  |  || user_id | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [PointsHistory](#PointsHistory)
+#### [Schedule](#Schedule)
 
  | 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  |  |
+ | ---------- | ---- | -------- | ----------- || cron | string |  no  |  || duration | number |  no  |  || end | string |  no  |  || start | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [ConfigurationRes](#ConfigurationRes)
+#### [SetConfigurationRes](#SetConfigurationRes)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | valid_android_packages | [string] |  no  | Contains array of string items, Valid android package names. |
- | terms_conditions_link | string |  no  | A URL that redirects to the referral information suport page link |
- | application_id | string |  no  |  |
- | success | boolean |  no  |  |
+ | ---------- | ---- | -------- | ----------- || success | boolean |  no  |  |
 
 ---
 
-
- 
- 
- #### [SetConfigurationRes](#SetConfigurationRes)
+#### [ShareMessages](#ShareMessages)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | success | boolean |  no  |  |
+ | ---------- | ---- | -------- | ----------- || 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  |  |
 
 ---
 
-
- 
- 
- #### [ConfigurationRequest](#ConfigurationRequest)
+#### [UserRes](#UserRes)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | valid_android_packages | [string] |  no  |  |
- | terms_conditions_link | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || points | [Points](#Points) |  no  |  || user | [RewardUser](#RewardUser) |  no  |  |
 
 ---