ScoreApiClient

Contains all the endpoints needed to manage user scores.

Constructors

Constructor

new ScoreApiClient(): ScoreApiClient

Returns

ScoreApiClient

Methods

addScore()

static addScore(data, config?): Promise<SCUserScoreType>

This endpoint adds/removes score to a user.

Parameters

Parameter	Type	Description
data	UserScoreParams
config?	AxiosRequestConfig

Returns

Promise<SCUserScoreType>

---

getAllScores()

static getAllScores(params?, config?): Promise<SCPaginatedResponse<SCUserScoreType>>

This endpoint retrieves all users scores.

Parameters

Parameter	Type	Description
params?	ScoreParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserScoreType>>

---

searchScore()

static searchScore(params?, config?): Promise<SCPaginatedResponse<SCUserScoreType>>

This endpoint performs search to user scores.

Parameters

Parameter	Type	Description
params?	ScoreParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserScoreType>>