ScoreApiClient

Contains all the endpoints needed to manage user scores.

Constructors

new ScoreApiClient()

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<any>

Returns

Promise<SCUserScoreType>

Source

services/score/index.ts:43

---

getAllScores()

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

This endpoint retrieves all users scores.

Parameters

Parameter	Type	Description
params?	ScoreParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserScoreType>>

Source

services/score/index.ts:23

---

searchScore()

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

This endpoint performs search to user scores.

Parameters

Parameter	Type	Description
params?	ScoreParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserScoreType>>

Source

services/score/index.ts:33