Interface: LoyaltyApiClientInterface

services/loyalty.LoyaltyApiClientInterface

Methods

createPrize

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

Parameters

Name	Type
data	LoyaltyPrizeParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPrizeType>

Defined in

services/loyalty/index.ts:9

---

createPrizeRequest

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

Parameters

Name	Type
prize	number
config?	AxiosRequestConfig<any>

Returns

Promise<SCPrizeUserType>

Defined in

services/loyalty/index.ts:14

---

getAllPrizeRequests

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

Parameters

Name	Type
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCPrizeUserType>>

Defined in

services/loyalty/index.ts:13

---

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:8

---

getSpecificPrize

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

Parameters

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

Returns

Promise<SCPrizeType>

Defined in

services/loyalty/index.ts:10

---

getSpecificPrizeRequest

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

Parameters

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

Returns

Promise<SCPrizeUserType>

Defined in

services/loyalty/index.ts:15

---

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:12

---

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:16

---

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:11