Class default

Index

Constructors

Methods

acceptInvite addUser create delete getUser list listInvites listUsers removetUser sendInvite update updatetUser uploadBannerImageBlob uploadBannerImageFile uploadMainImageBlob uploadMainImageFile view

Constructors

constructor

new default(): default
Returns default

Methods

`Static` acceptInvite

acceptInvite<T>(team_id, token): AxiosPromise<default<T>>
Accept an invite to a team. The JSON Web Token (JWT) must be related to the token.
Type Parameters
- T
Parameters
- team_id: string
  The id of the team
- token: string
  The token required to accept the user.
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Teams%20Route/teamAcceptInvite
- Defined in api/Teams.ts:180

`Static` addUser

addUser<T>(team_id, data?): AxiosPromise<default<T>>
Add a user to a team.
Type Parameters
- T
Parameters
- team_id: string
  The id of the team.
- Optional data: object
  The data to be passed when adding a user.
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Teams%20Route/createTeamUser
- Defined in api/Teams.ts:207

`Static` create

create<T>(data, params?): AxiosPromise<default<T>>
Create a new team.
Type Parameters
- T
Parameters
- data: object
  The data to be passed when creating a team.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise

See
https://api.glitch.fun/api/documentation#/Teams%20Route/teamCreate
- Defined in api/Teams.ts:28

`Static` delete

delete<T>(team_id, params?): AxiosPromise<default<T>>
Deletes a team.
Type Parameters
- T
Parameters
- team_id: string
  The id of the team to delete.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Teams%20Route/teamDelete
- Defined in api/Teams.ts:70

`Static` getUser

getUser<T>(team_id, user_id): AxiosPromise<default<T>>
Retrieves a single user and their information that is associated with a team.
Type Parameters
- T
Parameters
- team_id: string
  The id of the team.
- user_id: string
  The id of the user.
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Teams%20Route/showTeamUser
- Defined in api/Teams.ts:221

`Static` list

list<T>(params?): AxiosPromise<default<T>>
List all the teams
Type Parameters
- T
Parameters
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Teams%20Route/teamsList
- Defined in api/Teams.ts:15

`Static` listInvites

listInvites<T>(team_id, params?): AxiosPromise<default<T>>
List the invites that have been sent for the team to users.
Type Parameters
- T
Parameters
- team_id: string
  The id of the team
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Teams%20Route/teamsUserInviteList
- Defined in api/Teams.ts:152

`Static` listUsers

listUsers<T>(team_id, params?): AxiosPromise<default<T>>
List the users who are currently associated with the team.
Type Parameters
- T
Parameters
- team_id: string
  The id of the team.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Teams%20Route/teamUserList
- Defined in api/Teams.ts:193

`Static` removetUser

removetUser<T>(team_id, user_id): AxiosPromise<default<T>>
Removes a user from a team.
Type Parameters
- T
Parameters
- team_id: string
  The id of team.
- user_id: string
  The id of the user.
Returns AxiosPromise<default<T>>
promise
- Defined in api/Teams.ts:245

`Static` sendInvite

sendInvite<T>(team_id, data?): AxiosPromise<default<T>>
Send an invitation to a user to join the team.
Type Parameters
- T
Parameters
- team_id: string
  The id of the team.
- Optional data: object
  The data that will be passed into sending an invite.
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Teams%20Route/teamSendInvite
- Defined in api/Teams.ts:166

`Static` update

update<T>(team_id, data, params?): AxiosPromise<default<T>>
Update a team.
Type Parameters
- T
Parameters
- team_id: string
  The id of the team to update.
- data: object
  The data to update.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Teams%20Route/teamUpdate
- Defined in api/Teams.ts:43

`Static` updatetUser

updatetUser<T>(team_id, user_id, data?): AxiosPromise<default<T>>
Updates the users information associated with the team.
Type Parameters
- T
Parameters
- team_id: string
  The id of the team.
- user_id: string
  The id of the user.
- Optional data: object
Returns AxiosPromise<default<T>>
promise
- Defined in api/Teams.ts:233

`Static` uploadBannerImageBlob

uploadBannerImageBlob<T>(team_id, blob, data?): AxiosPromise<default<T>>
Updates the banner image for the team using a Blob.
Type Parameters
- T
Parameters
- team_id: string
- blob: Blob
  The blob to upload.
- Optional data: object
  Any additional data to pass along to the upload
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Teams%20Route/teamUploadMainImage
- Defined in api/Teams.ts:136

`Static` uploadBannerImageFile

uploadBannerImageFile<T>(team_id, file, data?): AxiosPromise<default<T>>
Updates the banner image for the team using a File object.
Type Parameters
- T
Parameters
- team_id: string
- file: File
  The file object to upload.
- Optional data: object
  Any additional data to pass along to the upload.
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Teams%20Route/teamUploadMainImage
- Defined in api/Teams.ts:119

`Static` uploadMainImageBlob

uploadMainImageBlob<T>(team_id, blob, data?): AxiosPromise<default<T>>
Updates the main image for the team using a Blob.
Type Parameters
- T
Parameters
- team_id: string
- blob: Blob
  The blob to upload.
- Optional data: object
  Any additional data to pass along to the upload
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Teams%20Route/teamUploadMainImage
- Defined in api/Teams.ts:102

`Static` uploadMainImageFile

uploadMainImageFile<T>(team_id, file, data?): AxiosPromise<default<T>>
Updates the main image for the team using a File object.
Type Parameters
- T
Parameters
- team_id: string
- file: File
  The file object to upload.
- Optional data: object
  Any additional data to pass along to the upload.
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Teams%20Route/teamUploadMainImage
- Defined in api/Teams.ts:85

`Static` view

view<T>(team_id, params?): AxiosPromise<default<T>>
Retrieve the information for a single team.
Type Parameters
- T
Parameters
- team_id: string
  The id fo the team to retrieve.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Teams%20Route/teamShow
- Defined in api/Teams.ts:57

Class default

Index

Constructors

Methods

Constructors

constructor

Returns default

Methods

Static acceptInvite

Type Parameters

T

Parameters

team_id: string

token: string

Returns AxiosPromise<default<T>>

See

Static addUser

Type Parameters

T

Parameters

team_id: string

Optional data: object

Returns AxiosPromise<default<T>>

See

Static create

Type Parameters

T

Parameters

data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

See

Static delete

Type Parameters

T

Parameters

team_id: string

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

See

Static getUser

Type Parameters

T

Parameters

team_id: string

user_id: string

Returns AxiosPromise<default<T>>

See

Static list

Type Parameters

T

Parameters

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

See

Static listInvites

Type Parameters

T

Parameters

team_id: string

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

See

Static listUsers

Type Parameters

T

Parameters

team_id: string

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

See

Static removetUser

Type Parameters

T

Parameters

team_id: string

user_id: string

Returns AxiosPromise<default<T>>

Static sendInvite

Type Parameters

`Static` acceptInvite

`Static` addUser

`Optional` data: object

`Static` create

`Optional` params: Record<string, any>

`Static` delete

`Optional` params: Record<string, any>

`Static` getUser

`Static` list

`Optional` params: Record<string, any>

`Static` listInvites

`Optional` params: Record<string, any>

`Static` listUsers

`Optional` params: Record<string, any>

`Static` removetUser

`Static` sendInvite

`Optional` data: object

`Static` update

`Optional` params: Record<string, any>

`Static` updatetUser

`Optional` data: object

`Static` uploadBannerImageBlob

`Optional` data: object

`Static` uploadBannerImageFile

`Optional` data: object

`Static` uploadMainImageBlob

`Optional` data: object

`Static` uploadMainImageFile

`Optional` data: object

`Static` view

`Optional` params: Record<string, any>