Class: LoyaltyService

services/loyalty.LoyaltyService

Loyalty service can be used in the following way:

1. Import the service from our library:

import {LoyaltyService} from "@selfcommunity/api-services";

2. Create a function and put the service inside it!
The async function `getPrizes` will return the paginated list of available prizes.

async getPrizes() {
       return await LoyaltyService.getPrizes();
     }

In case of required `params`, just add them inside the brackets.

async getSpecificPrize(prizeId) {
      return await LoyaltyService.getSpecificPrize(prizeId);
    }

If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).

1. Declare it(or declare them, it is possible to add multiple params)

const headers = headers: {Authorization: `Bearer ${yourToken}`}

2. Add it inside the brackets and pass it to the function, as shown in the previous example!

Constructors

constructor

• new LoyaltyService(): LoyaltyService

Returns

LoyaltyService

Methods

createPrize

▸ createPrize(data, config?): Promise<SCPrizeType>

Parameters

Name	Type
data	LoyaltyPrizeParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPrizeType>

Defined in

services/loyalty/index.ts:148

---

createPrizeRequest

▸ createPrizeRequest(prize, config?): Promise<SCPrizeUserType>

Parameters

Name	Type
prize	number
config?	AxiosRequestConfig<any>

Returns

Promise<SCPrizeUserType>

Defined in

services/loyalty/index.ts:168

---

getAllPrizeRequests

▸ getAllPrizeRequests(config?): Promise<SCPaginatedResponse<SCPrizeUserType>>

Parameters

Name	Type
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCPrizeUserType>>

Defined in

services/loyalty/index.ts:164

---

getPrizes

▸ getPrizes(params?, config?): Promise<SCPaginatedResponse<SCPrizeType>>

Parameters

Name	Type
params?	LoyaltyGetPrizeParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCPrizeType>>

Defined in

services/loyalty/index.ts:144

---

getSpecificPrize

▸ getSpecificPrize(id, config?): Promise<SCPrizeType>

Parameters

Name	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCPrizeType>

Defined in

services/loyalty/index.ts:152

---

getSpecificPrizeRequest

▸ getSpecificPrizeRequest(id, config?): Promise<SCPrizeUserType>

Parameters

Name	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCPrizeUserType>

Defined in

services/loyalty/index.ts:172

---

patchPrize

▸ patchPrize(id, data?, config?): Promise<SCPrizeType>

Parameters

Name	Type
id	string | number
data?	LoyaltyPrizeParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPrizeType>

Defined in

services/loyalty/index.ts:160

---

patchPrizeRequest

▸ patchPrizeRequest(id, status?, config?): Promise<SCPrizeUserType>

Parameters

Name	Type
id	string | number
status?	SCPrizeUserStatusType
config?	AxiosRequestConfig<any>

Returns

Promise<SCPrizeUserType>

Defined in

services/loyalty/index.ts:175

---

updatePrize

▸ updatePrize(id, data, config?): Promise<SCPrizeType>

Parameters

Name	Type
id	string | number
data	LoyaltyPrizeParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPrizeType>

Defined in

services/loyalty/index.ts:156