Class: ScoreApiClient
services/score.ScoreApiClient
Contains all the endpoints needed to manage user scores.
Constructors
constructor
• new ScoreApiClient(): ScoreApiClient
Returns
Methods
addScore
▸ addScore(data, config?): Promise<SCUserScoreType>
This endpoint adds/removes score to a user.
Parameters
| Name | Type |
|---|---|
data | UserScoreParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCUserScoreType>
Defined in
getAllScores
▸ getAllScores(params?, config?): Promise<SCPaginatedResponse<SCUserScoreType>>
This endpoint retrieves all users scores.
Parameters
| Name | Type |
|---|---|
params? | ScoreParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCUserScoreType>>
Defined in
searchScore
▸ searchScore(params?, config?): Promise<SCPaginatedResponse<SCUserScoreType>>
This endpoint performs search to user scores.
Parameters
| Name | Type |
|---|---|
params? | ScoreParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCUserScoreType>>