Skip to main content

LoyaltyApiClientInterface

Methods

createPrize()

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

Parameters

ParameterType
dataLoyaltyPrizeParams
config?AxiosRequestConfig

Returns

Promise<SCPrizeType>


createPrizeRequest()

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

Parameters

ParameterType
prizenumber
config?AxiosRequestConfig

Returns

Promise<SCPrizeUserType>


getAllPrizeRequests()

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

Parameters

ParameterType
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCPrizeUserType>>


getPrizes()

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

Parameters

ParameterType
params?LoyaltyGetPrizeParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCPrizeType>>


getSpecificPrize()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCPrizeType>


getSpecificPrizeRequest()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCPrizeUserType>


patchPrize()

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

Parameters

ParameterType
idstring | number
data?LoyaltyPrizeParams
config?AxiosRequestConfig

Returns

Promise<SCPrizeType>


patchPrizeRequest()

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

Parameters

ParameterType
idstring | number
status?SCPrizeUserStatusType
config?AxiosRequestConfig

Returns

Promise<SCPrizeUserType>


updatePrize()

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

Parameters

ParameterType
idstring | number
dataLoyaltyPrizeParams
config?AxiosRequestConfig

Returns

Promise<SCPrizeType>