Class: LoyaltyApiClient
services/loyalty.LoyaltyApiClient
Contains all the endpoints needed to manage loyalty program.
Constructors
constructor
• new LoyaltyApiClient(): LoyaltyApiClient
Returns
Methods
createPrize
▸ createPrize(data, config?): Promise<SCPrizeType>
This endpoint creates a prize.
Parameters
| Name | Type |
|---|---|
data | LoyaltyPrizeParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrizeType>
Defined in
createPrizeRequest
▸ createPrizeRequest(prize, config?): Promise<SCPrizeUserType>
This endpoint creates a request for a loyalty prize
Parameters
| Name | Type |
|---|---|
prize | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrizeUserType>
Defined in
getAllPrizeRequests
▸ getAllPrizeRequests(config?): Promise<SCPaginatedResponse<SCPrizeUserType>>
This endpoint retrieves all requests of loyalty prizes.
Parameters
| Name | Type |
|---|---|
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCPrizeUserType>>
Defined in
getPrizes
▸ getPrizes(params?, config?): Promise<SCPaginatedResponse<SCPrizeType>>
This endpoint retrieves all prizes.
Parameters
| Name | Type |
|---|---|
params? | LoyaltyGetPrizeParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCPrizeType>>
Defined in
getSpecificPrize
▸ getSpecificPrize(id, config?): Promise<SCPrizeType>
This endpoint retrieves a specific prize
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrizeType>
Defined in
getSpecificPrizeRequest
▸ getSpecificPrizeRequest(id, config?): Promise<SCPrizeUserType>
This endpoint retrieves a specific request for a loyalty prize.
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrizeUserType>
Defined in
patchPrize
▸ patchPrize(id, data?, config?): Promise<SCPrizeType>
This endpoint patches a specific prize.
Parameters
| Name | Type |
|---|---|
id | string | number |
data? | LoyaltyPrizeParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrizeType>
Defined in
patchPrizeRequest
▸ patchPrizeRequest(id, status?, config?): Promise<SCPrizeUserType>
This endpoint patches a specific request for a loyalty prize. You can use this endpoint to change status in an admin list/table interface.
Parameters
| Name | Type |
|---|---|
id | string | number |
status? | SCPrizeUserStatusType |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrizeUserType>
Defined in
updatePrize
▸ updatePrize(id, data, config?): Promise<SCPrizeType>
This endpoint updates a specific prize.
Parameters
| Name | Type |
|---|---|
id | string | number |
data | LoyaltyPrizeParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrizeType>