UserClient | polympics

A wrapper for the Polympics API, in TypeScript.

Hierarchy

AuthenticatedClient
- UserClient

Index

Constructors

constructor

Properties

Constructors

constructor

new UserClient(__namedParameters?: { apiUrl?: string; credentials?: null | Credentials }): UserClient

Inherited from AuthenticatedClient.constructor
- Defined in polympics/client.ts:26
Parameters
- __namedParameters: { apiUrl?: string; credentials?: null | Credentials } = ...
  - Optional apiUrl?: string
  - Optional credentials?: null | Credentials
Returns UserClient

Properties

apiUrl

apiUrl: string

Optional credentials

credentials: null | Credentials

Methods

checkSignups

checkSignups(): Promise<boolean>

Inherited from AuthenticatedClient.checkSignups
- Defined in polympics/endpoints.ts:180
Check if signups are open.

Returns Promise<boolean>

createAccount

createAccount(account: NewAccount): Promise<Account>

Inherited from AuthenticatedClient.createAccount
- Defined in polympics/endpoints.ts:195
Create a new account.

Note that although it accepts an Account object, the createdAt attribute will be ignored if set.

Parameters
- account: NewAccount
Returns Promise<Account>

createAward

createAward(award: NewAward): Promise<Award>

Inherited from AuthenticatedClient.createAward
- Defined in polympics/endpoints.ts:240
Create an award.

Parameters
- award: NewAward
Returns Promise<Award>

createTeam

createTeam(name: string): Promise<Team>

Inherited from AuthenticatedClient.createTeam
- Defined in polympics/endpoints.ts:218
Create a new team.

Parameters
- name: string
Returns Promise<Team>

deleteAccount

deleteAccount(account: Account): Promise<void>

Inherited from AuthenticatedClient.deleteAccount
- Defined in polympics/endpoints.ts:210
Delete an account.

Parameters
- account: Account
Returns Promise<void>

deleteAward

deleteAward(award: Award): Promise<void>

Inherited from AuthenticatedClient.deleteAward
- Defined in polympics/endpoints.ts:268
Delete an award.

Parameters
- award: Award
Returns Promise<void>

deleteTeam

deleteTeam(team: Team): Promise<void>

Inherited from AuthenticatedClient.deleteTeam
- Defined in polympics/endpoints.ts:233
Delete a team.

Parameters
- team: Team
Returns Promise<void>

discordAuthenticate

discordAuthenticate(token: string): Promise<Session>

Inherited from AuthenticatedClient.discordAuthenticate
- Defined in polympics/endpoints.ts:133
Create a session from a Discord user token

Parameters
- token: string
Returns Promise<Session>

getAccount

getAccount(id: string): Promise<Account>

Inherited from AuthenticatedClient.getAccount
- Defined in polympics/endpoints.ts:66
Get an account by Discord ID.

Parameters
- id: string
Returns Promise<Account>

getAward

getAward(id: number): Promise<ExtendedAward>

Inherited from AuthenticatedClient.getAward
- Defined in polympics/endpoints.ts:172
Get an award by ID.

Parameters
- id: number
Returns Promise<ExtendedAward>

getSelf

getSelf(): Promise<Account>

- Defined in polympics/endpoints.ts:331
Get the account for the authenticated user.

Returns Promise<Account>

getTeam

getTeam(id: number): Promise<Team>

Inherited from AuthenticatedClient.getTeam
- Defined in polympics/endpoints.ts:74
Get a team by ID.

Parameters
- id: number
Returns Promise<Team>

giveAward

giveAward(award: Award, account: Account): Promise<void>

Inherited from AuthenticatedClient.giveAward
- Defined in polympics/endpoints.ts:275
Give an existing award to a user.

Parameters
- award: Award
- account: Account
Returns Promise<void>

listAccounts

listAccounts(__namedParameters?: AccountSearchOptions): Paginator<Account>

Inherited from AuthenticatedClient.listAccounts
- Defined in polympics/endpoints.ts:80
Get a paginated list of accounts matching a query.

Parameters
- __namedParameters: AccountSearchOptions = ...
Returns Paginator<Account>

listTeams

listTeams(__namedParameters?: SearchOptions): Paginator<Team>

Inherited from AuthenticatedClient.listTeams
- Defined in polympics/endpoints.ts:108
Get a paginated list of teams matching a query.

Parameters
- __namedParameters: SearchOptions = ...
Returns Paginator<Team>

Protected request

request<Type>(method: HttpMethod, endpoint: string, data?: Record<string, any>, __namedParameters?: { emptyResponse?: boolean }): Promise<Type>

Inherited from AuthenticatedClient.request
- Defined in polympics/client.ts:57
Make a request to an API endpoint.

Type parameters
- Type
Parameters
- method: HttpMethod
- endpoint: string
- data: Record<string, any> = ...
- __namedParameters: { emptyResponse?: boolean } = ...
  - Optional emptyResponse?: boolean
Returns Promise<Type>

resetToken

resetToken(): Promise<Session>

- Defined in polympics/endpoints.ts:321
Reset the session's token.

Returns Promise<Session>

takeAward

takeAward(award: Award, account: Account): Promise<void>

Inherited from AuthenticatedClient.takeAward
- Defined in polympics/endpoints.ts:283
Take an award from a user.

Parameters
- award: Award
- account: Account
Returns Promise<void>

updateAccount

updateAccount(account: Account, options: AccountUpdate): Promise<Account>

Inherited from AuthenticatedClient.updateAccount
- Defined in polympics/endpoints.ts:140
Edit an account.

Parameters
- account: Account
- options: AccountUpdate
Returns Promise<Account>

updateAward

updateAward(award: Award, options: AwardUpdate): Promise<Award>

Inherited from AuthenticatedClient.updateAward
- Defined in polympics/endpoints.ts:256
Edit an award.

Parameters
- award: Award
- options: AwardUpdate
Returns Promise<Award>

updateTeam

updateTeam(team: Team, options: TeamUpdate): Promise<Team>

Inherited from AuthenticatedClient.updateTeam
- Defined in polympics/endpoints.ts:225
Edit a team's name.

Parameters
- team: Team
- options: TeamUpdate
Returns Promise<Team>

Generated using TypeDoc