Namespace ParticipantAdapter

Namespace for all of the Participant routes

Index

Functions

Functions

bulkAdd

bulkAdd(api_key: string, tournament_url: string, params: bulkAddParticipantsRequest): Promise<bulkAddParticipantsResposne>

- Defined in adapter/participants.ts:32
Bulk add participants to a tournament (up until it is started). If an invalid participant is detected, bulk participant creation will halt and any previously added participants (from this API request) will be rolled back.

Parameters
- api_key: string
- tournament_url: string
- params: bulkAddParticipantsRequest
Returns Promise<bulkAddParticipantsResposne>

checkIn

checkIn(api_key: string, tournament_url: string, participant_id: number): Promise<checkInParticipantResponse>

- Defined in adapter/participants.ts:64
Checks a participant in, setting checked_in_at to the current time.

Parameters
- api_key: string
- tournament_url: string
- participant_id: number
Returns Promise<checkInParticipantResponse>

clear

clear(api_key: string, tournament_url: string): Promise<clearParticipantsResponse>

- Defined in adapter/participants.ts:100
Deletes all participants in a tournament. (Only allowed if tournament hasn't started yet)

Parameters
- api_key: string
- tournament_url: string
Returns Promise<clearParticipantsResponse>

create

create(api_key: string, tournament_url: string, params: createParticipantRequest): Promise<createParticipantResponse>

- Defined in adapter/participants.ts:18
Add a participant to a tournament (up until it is started).

Parameters
- api_key: string
- tournament_url: string
- params: createParticipantRequest
Returns Promise<createParticipantResponse>

destroy

destroy(api_key: string, tournament_url: string, participant_id: number): Promise<destroyParticipantResponse>

- Defined in adapter/participants.ts:88
If the tournament has not started, delete a participant, automatically filling in the abandoned seed number. If tournament is underway, mark a participant inactive, automatically forfeiting his/her remaining matches.

Parameters
- api_key: string
- tournament_url: string
- participant_id: number
Returns Promise<destroyParticipantResponse>

index

index(api_key: string, tournament_url: string): Promise<indexParticipantsResponse>

- Defined in adapter/participants.ts:7
Retrieve a tournament's participant list.

Parameters
- api_key: string
- tournament_url: string
Returns Promise<indexParticipantsResponse>

randomize

randomize(api_key: string, tournament_url: string): Promise<randomizeParticipantsResponse>

- Defined in adapter/participants.ts:111
Randomize seeds among participants. Only applicable before a tournament has started.

Parameters
- api_key: string
- tournament_url: string
Returns Promise<randomizeParticipantsResponse>

show

show(api_key: string, tournament_url: string, participant_id: number): Promise<showParticipantResponse>

- Defined in adapter/participants.ts:42
Retrieve a single participant record for a tournament.

Parameters
- api_key: string
- tournament_url: string
- participant_id: number
Returns Promise<showParticipantResponse>

undoCheckIn

undoCheckIn(api_key: string, tournament_url: string, participant_id: number): Promise<checkInParticipantResponse>

- Defined in adapter/participants.ts:75
Marks a participant as having not checked in, setting checked_in_at to nil.

Parameters
- api_key: string
- tournament_url: string
- participant_id: number
Returns Promise<checkInParticipantResponse>

update

update(api_key: string, tournament_url: string, participant_id: number, params: updateParticipantRequest): Promise<updateParticipantResponse>

- Defined in adapter/participants.ts:53
Update the attributes of a tournament participant.

Parameters
- api_key: string
- tournament_url: string
- participant_id: number
- params: updateParticipantRequest
Returns Promise<updateParticipantResponse>

Generated using TypeDoc