Class default

Index

Constructors

Methods

acceptInvite approveRequest cancelRequest declineRequest invitePlayTester list mine rejectInvite requestPlayTest show submitAnswers updateQuestions

Constructors

constructor

new default(): default
Returns default

Methods

`Static` acceptInvite

acceptInvite<T>(title_id, playtest_id, params?): AxiosPromise<default<T>>
User accepts an invite to a play test.
Type Parameters
- T
Parameters
- title_id: string
  The ID of the title.
- playtest_id: string
  The ID of the play test.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/PlayTests.ts:71

`Static` approveRequest

approveRequest<T>(title_id, playtest_id, params?): AxiosPromise<default<T>>
Title admin approves a user's play test request.
Type Parameters
- T
Parameters
- title_id: string
  The ID of the title.
- playtest_id: string
  The ID of the play test.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/PlayTests.ts:93

`Static` cancelRequest

cancelRequest<T>(title_id, playtest_id, params?): AxiosPromise<default<T>>
User cancels their own play test request.
Type Parameters
- T
Parameters
- title_id: string
  The ID of the title.
- playtest_id: string
  The ID of the play test.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/PlayTests.ts:115

`Static` declineRequest

declineRequest<T>(title_id, playtest_id, params?): AxiosPromise<default<T>>
Title admin declines a user's play test request.
Type Parameters
- T
Parameters
- title_id: string
  The ID of the title.
- playtest_id: string
  The ID of the play test.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/PlayTests.ts:104

`Static` invitePlayTester

invitePlayTester<T>(title_id, data, params?): AxiosPromise<default<T>>
Title administrator invites a user to test a title.
Type Parameters
- T
Parameters
- title_id: string
  The ID of the title.
- data: object
  The data containing user_id and other optional fields.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/PlayTests.ts:36

`Static` list

list<T>(title_id, params?): AxiosPromise<default<T>>
Get a list of play tests associated with a title.
Type Parameters
- T
Parameters
- title_id: string
  The ID of the title.
- Optional params: Record<string, any>
  Optional query parameters.
Returns AxiosPromise<default<T>>
Promise
- Defined in api/PlayTests.ts:14

`Static` mine

mine<T>(params?): AxiosPromise<default<T>>
Get all the play tests that are associated with the current user.
Type Parameters
- T
Parameters
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/PlayTests.ts:137

`Static` rejectInvite

rejectInvite<T>(title_id, playtest_id, params?): AxiosPromise<default<T>>
User rejects an invite to a play test.
Type Parameters
- T
Parameters
- title_id: string
  The ID of the title.
- playtest_id: string
  The ID of the play test.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/PlayTests.ts:82

`Static` requestPlayTest

requestPlayTest<T>(title_id, data?, params?): AxiosPromise<default<T>>
User requests to test a title.
Type Parameters
- T
Parameters
- title_id: string
  The ID of the title.
- Optional data: object
  Optional data for the request.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/PlayTests.ts:25

`Static` show

show<T>(title_id, playtest_id, params?): AxiosPromise<default<T>>
Retrieve a single play test.
Type Parameters
- T
Parameters
- title_id: string
  The ID of the title.
- playtest_id: string
  The ID of the play test.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/PlayTests.ts:126

`Static` submitAnswers

submitAnswers<T>(title_id, playtest_id, data, params?): AxiosPromise<default<T>>
User submits or updates their answers for a play test.
Type Parameters
- T
Parameters
- title_id: string
  The ID of the title.
- playtest_id: string
  The ID of the play test.
- data: object
  The answers data.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/PlayTests.ts:48

`Static` updateQuestions

updateQuestions<T>(title_id, playtest_id, data, params?): AxiosPromise<default<T>>
Title admin updates test questions for a play test.
Type Parameters
- T
Parameters
- title_id: string
  The ID of the title.
- playtest_id: string
  The ID of the play test.
- data: object
  The questions data.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise
- Defined in api/PlayTests.ts:60

Generated using TypeDoc