redemptionKeys | @livelike/engagementsdk - v2.21.0

API
Elements

Index

Functions

Functions

Const getRedemptionKeys

getRedemptionKeys(args: IRedemptionKeyArgs): Promise<IPaginatedResponse<IRedemptionKey>>

description
Get list of Redemption Keys

async
since
2.17.0

example
```
getRedemptionKeys()
.then(paginatedRedemptionKeys => console.log(paginatedRedemptionKeys))
```
Parameters
- args: IRedemptionKeyArgs
Returns Promise<IPaginatedResponse<IRedemptionKey>>

Const redeemKeyByCode

redeemKeyByCode(args: { code: string }): Promise<IRedemptionKey>

description
Redeem Key by passing the code

async
since
2.17.0

example
```
redeemKeyByCode({
 code: "xxxxxxxxx"
}).then(redemptionKey => console.log(redemptionKey))
```
Parameters
- args: { code: string }
  - code: string
Returns Promise<IRedemptionKey>

Const redeemKeyById

redeemKeyById(args: { redemptionKeyId: string }): Promise<IRedemptionKey>

description
Redeem Key by passing the Id of Redemption Key Object

async
since
2.17.0

example
```
redeemKeyById({
 redemptionKeyId: "xxxxxxxxx"
}).then(redemptionKey => console.log(redemptionKey))
```
Parameters
- args: { redemptionKeyId: string }
  - redemptionKeyId: string
Returns Promise<IRedemptionKey>

Generated using TypeDoc