UnauthenticatedClient | polympics

A wrapper for the Polympics API, in TypeScript.

Hierarchy

BaseClient
- UnauthenticatedClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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

Properties

apiUrl

apiUrl: string

Optional credentials

credentials: null | Credentials

Methods

checkSignups

checkSignups(): Promise<boolean>

- Defined in polympics/endpoints.ts:180
Check if signups are open.

Returns Promise<boolean>

discordAuthenticate

discordAuthenticate(token: string): Promise<Session>

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

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

Parameters
- id: string
Returns Promise<Account>

getAward

getAward(id: number): Promise<ExtendedAward>

- Defined in polympics/endpoints.ts:172
Get an award by ID.

Parameters
- id: number
Returns Promise<ExtendedAward>

getTeam

getTeam(id: number): Promise<Team>

- Defined in polympics/endpoints.ts:74
Get a team by ID.

Parameters
- id: number
Returns Promise<Team>

listAccounts

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

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

- 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 BaseClient.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>

updateAccount

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

- Defined in polympics/endpoints.ts:140
Edit an account.

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

Generated using TypeDoc