glitch-javascript-sdk 0.2.5 → 0.2.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/index.js +289 -160
- package/dist/cjs/index.js.map +1 -1
- package/dist/esm/api/Communities.d.ts +20 -20
- package/dist/esm/api/Competitions.d.ts +40 -40
- package/dist/esm/api/Events.d.ts +17 -17
- package/dist/esm/api/Teams.d.ts +7 -7
- package/dist/esm/api/Templates.d.ts +9 -9
- package/dist/esm/api/Users.d.ts +3 -3
- package/dist/esm/api/Waitlist.d.ts +5 -5
- package/dist/esm/config/Config.d.ts +12 -0
- package/dist/esm/index.js +445 -316
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/models/community.d.ts +40 -0
- package/dist/esm/models/template.d.ts +15 -0
- package/dist/esm/models/user.d.ts +29 -0
- package/dist/esm/util/Requests.d.ts +14 -7
- package/dist/index.d.ts +208 -108
- package/package.json +1 -1
- package/src/api/Communities.ts +39 -39
- package/src/api/Competitions.ts +45 -45
- package/src/api/Events.ts +21 -21
- package/src/api/Teams.ts +14 -14
- package/src/api/Templates.ts +14 -14
- package/src/api/Users.ts +7 -6
- package/src/api/Waitlist.ts +10 -10
- package/src/config/Config.ts +20 -0
- package/src/models/community.ts +42 -0
- package/src/models/template.ts +16 -0
- package/src/models/user.ts +31 -0
- package/src/util/Requests.ts +102 -11
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,87 @@
|
|
|
1
1
|
import { AxiosPromise } from 'axios';
|
|
2
2
|
|
|
3
|
+
interface Template {
|
|
4
|
+
id?: string;
|
|
5
|
+
name?: string;
|
|
6
|
+
description?: string;
|
|
7
|
+
version?: string;
|
|
8
|
+
directory?: string;
|
|
9
|
+
entry_point_file?: string;
|
|
10
|
+
author_name?: string;
|
|
11
|
+
author_website?: string;
|
|
12
|
+
author_email?: string;
|
|
13
|
+
main_image?: string;
|
|
14
|
+
logo?: string;
|
|
15
|
+
is_private?: boolean;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
interface User {
|
|
19
|
+
id?: string;
|
|
20
|
+
first_name?: string;
|
|
21
|
+
last_name?: string;
|
|
22
|
+
username?: string;
|
|
23
|
+
display_name?: string;
|
|
24
|
+
bio?: string;
|
|
25
|
+
avatar?: string;
|
|
26
|
+
banner_image?: string;
|
|
27
|
+
twitter_page?: string;
|
|
28
|
+
facebook_page?: string;
|
|
29
|
+
instagram_page?: string;
|
|
30
|
+
snapchat_page?: string;
|
|
31
|
+
tiktok_page?: string;
|
|
32
|
+
twitch_page?: string;
|
|
33
|
+
youtube_page?: string;
|
|
34
|
+
paetron_page?: string;
|
|
35
|
+
twitter_handle?: string;
|
|
36
|
+
facebook_handle?: string;
|
|
37
|
+
instagram_handle?: string;
|
|
38
|
+
snapchat_handle?: string;
|
|
39
|
+
tiktok_handle?: string;
|
|
40
|
+
twitch_handle?: string;
|
|
41
|
+
youtube_handle?: string;
|
|
42
|
+
paetron_handle?: string;
|
|
43
|
+
created_at?: string;
|
|
44
|
+
updated_at?: string;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
interface Community {
|
|
48
|
+
id?: string;
|
|
49
|
+
name?: string;
|
|
50
|
+
description?: string;
|
|
51
|
+
logo?: string;
|
|
52
|
+
banner_image?: string;
|
|
53
|
+
video_logo?: string;
|
|
54
|
+
subdomain?: string;
|
|
55
|
+
cname?: string;
|
|
56
|
+
bannner_image?: string;
|
|
57
|
+
cname_enabled?: boolean;
|
|
58
|
+
require_attendee_rsvp?: boolean;
|
|
59
|
+
is_private?: boolean;
|
|
60
|
+
disable_streams?: boolean;
|
|
61
|
+
disable_competitions?: boolean;
|
|
62
|
+
disable_forums?: boolean;
|
|
63
|
+
disable_teams?: boolean;
|
|
64
|
+
custom_css?: boolean;
|
|
65
|
+
twitter_page?: string;
|
|
66
|
+
facebook_page?: string;
|
|
67
|
+
instagram_page?: string;
|
|
68
|
+
snapchat_page?: string;
|
|
69
|
+
tiktok_page?: string;
|
|
70
|
+
twitch_page?: string;
|
|
71
|
+
youtube_page?: string;
|
|
72
|
+
paetron_page?: string;
|
|
73
|
+
twitter_handle?: string;
|
|
74
|
+
facebook_handle?: string;
|
|
75
|
+
instagram_handle?: string;
|
|
76
|
+
snapchat_handle?: string;
|
|
77
|
+
tiktok_handle?: string;
|
|
78
|
+
twitch_handle?: string;
|
|
79
|
+
youtube_handle?: string;
|
|
80
|
+
paetron_handle?: string;
|
|
81
|
+
template?: Template;
|
|
82
|
+
admins?: User[];
|
|
83
|
+
}
|
|
84
|
+
|
|
3
85
|
/**
|
|
4
86
|
* Config
|
|
5
87
|
*
|
|
@@ -9,6 +91,7 @@ import { AxiosPromise } from 'axios';
|
|
|
9
91
|
declare class Config {
|
|
10
92
|
private static _baseUrl;
|
|
11
93
|
private static _authToken;
|
|
94
|
+
private static _community;
|
|
12
95
|
private static _baseUrlLocked;
|
|
13
96
|
/**
|
|
14
97
|
* Set the configuration
|
|
@@ -30,6 +113,12 @@ declare class Config {
|
|
|
30
113
|
* @param authToken The JWT
|
|
31
114
|
*/
|
|
32
115
|
static setAuthToken(authToken: string): void;
|
|
116
|
+
/**
|
|
117
|
+
* Set the community to be associated with this config through
|
|
118
|
+
*
|
|
119
|
+
* @param authToken The JWT
|
|
120
|
+
*/
|
|
121
|
+
static setCommunity(community: Community): void;
|
|
33
122
|
/**
|
|
34
123
|
* Gets base url
|
|
35
124
|
*/
|
|
@@ -38,6 +127,10 @@ declare class Config {
|
|
|
38
127
|
* Gets auth token
|
|
39
128
|
*/
|
|
40
129
|
static get authToken(): string;
|
|
130
|
+
/**
|
|
131
|
+
* Gets the community currently associated
|
|
132
|
+
*/
|
|
133
|
+
static get getCommunity(): Community;
|
|
41
134
|
}
|
|
42
135
|
|
|
43
136
|
interface Response<T> {
|
|
@@ -117,7 +210,7 @@ declare class Competitions {
|
|
|
117
210
|
*
|
|
118
211
|
* @returns promise
|
|
119
212
|
*/
|
|
120
|
-
static list<T>(): AxiosPromise<Response<T>>;
|
|
213
|
+
static list<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
121
214
|
/**
|
|
122
215
|
* Create a new competition
|
|
123
216
|
*
|
|
@@ -127,7 +220,7 @@ declare class Competitions {
|
|
|
127
220
|
*
|
|
128
221
|
* @returns Promise
|
|
129
222
|
*/
|
|
130
|
-
static create<T>(data: object): AxiosPromise<Response<T>>;
|
|
223
|
+
static create<T>(data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
131
224
|
/**
|
|
132
225
|
* Update a competition
|
|
133
226
|
*
|
|
@@ -138,7 +231,7 @@ declare class Competitions {
|
|
|
138
231
|
*
|
|
139
232
|
* @returns promise
|
|
140
233
|
*/
|
|
141
|
-
static update<T>(competition_id: string, data: object): AxiosPromise<Response<T>>;
|
|
234
|
+
static update<T>(competition_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
142
235
|
/**
|
|
143
236
|
* Retrieve the information for a single competition.
|
|
144
237
|
*
|
|
@@ -148,7 +241,7 @@ declare class Competitions {
|
|
|
148
241
|
*
|
|
149
242
|
* @returns promise
|
|
150
243
|
*/
|
|
151
|
-
static view<T>(competition_id: string): AxiosPromise<Response<T>>;
|
|
244
|
+
static view<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
152
245
|
/**
|
|
153
246
|
* Deletes a competition.
|
|
154
247
|
*
|
|
@@ -157,7 +250,7 @@ declare class Competitions {
|
|
|
157
250
|
* @param competition_id The id of the competition to delete.
|
|
158
251
|
* @returns promise
|
|
159
252
|
*/
|
|
160
|
-
static delete<T>(competition_id: string): AxiosPromise<Response<T>>;
|
|
253
|
+
static delete<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
161
254
|
/**
|
|
162
255
|
* Add a team
|
|
163
256
|
*
|
|
@@ -167,7 +260,7 @@ declare class Competitions {
|
|
|
167
260
|
* @param team_id
|
|
168
261
|
* @returns promise
|
|
169
262
|
*/
|
|
170
|
-
static addTeam<T>(competition_id: string, team_id: string): AxiosPromise<Response<T>>;
|
|
263
|
+
static addTeam<T>(competition_id: string, team_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
171
264
|
/**
|
|
172
265
|
* Adds participant
|
|
173
266
|
*
|
|
@@ -177,7 +270,7 @@ declare class Competitions {
|
|
|
177
270
|
* @param user_id
|
|
178
271
|
* @returns promise
|
|
179
272
|
*/
|
|
180
|
-
static addParticipant<T>(competition_id: string, user_id: string): AxiosPromise<Response<T>>;
|
|
273
|
+
static addParticipant<T>(competition_id: string, user_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
181
274
|
/**
|
|
182
275
|
* Register a team
|
|
183
276
|
*
|
|
@@ -187,7 +280,7 @@ declare class Competitions {
|
|
|
187
280
|
* @param team_id
|
|
188
281
|
* @returns promise
|
|
189
282
|
*/
|
|
190
|
-
static registerTeam<T>(competition_id: string, team_id: string): AxiosPromise<Response<T>>;
|
|
283
|
+
static registerTeam<T>(competition_id: string, team_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
191
284
|
/**
|
|
192
285
|
* Register a user
|
|
193
286
|
*
|
|
@@ -196,7 +289,7 @@ declare class Competitions {
|
|
|
196
289
|
* @param competition_id
|
|
197
290
|
* @returns promise
|
|
198
291
|
*/
|
|
199
|
-
static registerUser<T>(competition_id: string): AxiosPromise<Response<T>>;
|
|
292
|
+
static registerUser<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
200
293
|
/**
|
|
201
294
|
* Sync rounds
|
|
202
295
|
*
|
|
@@ -207,7 +300,7 @@ declare class Competitions {
|
|
|
207
300
|
* @param competitors_per_bracket
|
|
208
301
|
* @returns promise
|
|
209
302
|
*/
|
|
210
|
-
static syncRounds<T>(competition_id: string): AxiosPromise<Response<T>>;
|
|
303
|
+
static syncRounds<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
211
304
|
/**
|
|
212
305
|
* auto generate team brackets
|
|
213
306
|
*
|
|
@@ -217,7 +310,7 @@ declare class Competitions {
|
|
|
217
310
|
* @param round_id
|
|
218
311
|
* @returns promise
|
|
219
312
|
*/
|
|
220
|
-
static autoGenerate<T>(competition_id: string, round_id: number): AxiosPromise<Response<T>>;
|
|
313
|
+
static autoGenerate<T>(competition_id: string, round_id: number, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
221
314
|
/**
|
|
222
315
|
* auto generate user brackets
|
|
223
316
|
*
|
|
@@ -226,7 +319,7 @@ declare class Competitions {
|
|
|
226
319
|
* @param competition_id
|
|
227
320
|
* @returns promise
|
|
228
321
|
*/
|
|
229
|
-
static autoGenerateUserBrackets<T>(competition_id: string): AxiosPromise<Response<T>>;
|
|
322
|
+
static autoGenerateUserBrackets<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
230
323
|
/**
|
|
231
324
|
* Updates the main image for the event using a File object.
|
|
232
325
|
*
|
|
@@ -237,7 +330,7 @@ declare class Competitions {
|
|
|
237
330
|
*
|
|
238
331
|
* @returns promise
|
|
239
332
|
*/
|
|
240
|
-
static uploadCompetitionMainImageFile<T>(competition_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
|
|
333
|
+
static uploadCompetitionMainImageFile<T>(competition_id: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
241
334
|
/**
|
|
242
335
|
* Updates the main image for the competition using a Blob.
|
|
243
336
|
*
|
|
@@ -248,7 +341,7 @@ declare class Competitions {
|
|
|
248
341
|
*
|
|
249
342
|
* @returns promise
|
|
250
343
|
*/
|
|
251
|
-
static uploadCompetitionMainImageBlob<T>(competition_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
|
|
344
|
+
static uploadCompetitionMainImageBlob<T>(competition_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
252
345
|
/**
|
|
253
346
|
* Updates the banner image for the competition using a File object.
|
|
254
347
|
*
|
|
@@ -259,7 +352,7 @@ declare class Competitions {
|
|
|
259
352
|
*
|
|
260
353
|
* @returns promise
|
|
261
354
|
*/
|
|
262
|
-
static uploadCompetitionBannerImageFile<T>(competition_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
|
|
355
|
+
static uploadCompetitionBannerImageFile<T>(competition_id: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
263
356
|
/**
|
|
264
357
|
* Updates the banner image for the competition using a Blob.
|
|
265
358
|
*
|
|
@@ -270,7 +363,7 @@ declare class Competitions {
|
|
|
270
363
|
*
|
|
271
364
|
* @returns promise
|
|
272
365
|
*/
|
|
273
|
-
static uploadCompetitionsBannerImageBlob<T>(competition_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
|
|
366
|
+
static uploadCompetitionsBannerImageBlob<T>(competition_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
274
367
|
/**
|
|
275
368
|
* Invites
|
|
276
369
|
*
|
|
@@ -279,7 +372,7 @@ declare class Competitions {
|
|
|
279
372
|
* @param competition_id
|
|
280
373
|
* @returns promise
|
|
281
374
|
*/
|
|
282
|
-
static invites<T>(competition_id: string): AxiosPromise<Response<T>>;
|
|
375
|
+
static invites<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
283
376
|
/**
|
|
284
377
|
* Sends invite
|
|
285
378
|
*
|
|
@@ -308,7 +401,7 @@ declare class Competitions {
|
|
|
308
401
|
* @param round_id
|
|
309
402
|
* @returns promise
|
|
310
403
|
*/
|
|
311
|
-
static brackets<T>(competition_id: string, round_id: number): AxiosPromise<Response<T>>;
|
|
404
|
+
static brackets<T>(competition_id: string, round_id: number, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
312
405
|
/**
|
|
313
406
|
* Store round brackets
|
|
314
407
|
*
|
|
@@ -318,7 +411,7 @@ declare class Competitions {
|
|
|
318
411
|
* @param round_id
|
|
319
412
|
* @returns promise
|
|
320
413
|
*/
|
|
321
|
-
static createBracket<T>(competition_id: string, round_id: number, data?: object): AxiosPromise<Response<T>>;
|
|
414
|
+
static createBracket<T>(competition_id: string, round_id: number, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
322
415
|
/**
|
|
323
416
|
* Show round bracket
|
|
324
417
|
*
|
|
@@ -329,7 +422,7 @@ declare class Competitions {
|
|
|
329
422
|
* @param bracket_id
|
|
330
423
|
* @returns promise
|
|
331
424
|
*/
|
|
332
|
-
static showBracket<T>(competition_id: string, round_id: number, bracket_id: number): AxiosPromise<Response<T>>;
|
|
425
|
+
static showBracket<T>(competition_id: string, round_id: number, bracket_id: number, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
333
426
|
/**
|
|
334
427
|
* Update bracket
|
|
335
428
|
*
|
|
@@ -340,7 +433,7 @@ declare class Competitions {
|
|
|
340
433
|
* @param bracket_id
|
|
341
434
|
* @returns promise
|
|
342
435
|
*/
|
|
343
|
-
static updateBracket<T>(competition_id: string, round_id: number, bracket_id: number, data?: object): AxiosPromise<Response<T>>;
|
|
436
|
+
static updateBracket<T>(competition_id: string, round_id: number, bracket_id: number, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
344
437
|
/**
|
|
345
438
|
* Delete bracket
|
|
346
439
|
*
|
|
@@ -360,7 +453,7 @@ declare class Competitions {
|
|
|
360
453
|
* @param competition_id
|
|
361
454
|
* @returns promise
|
|
362
455
|
*/
|
|
363
|
-
static rounds<T>(competition_id: string): AxiosPromise<Response<T>>;
|
|
456
|
+
static rounds<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
364
457
|
/**
|
|
365
458
|
* Create a new round for competition
|
|
366
459
|
*
|
|
@@ -369,7 +462,7 @@ declare class Competitions {
|
|
|
369
462
|
* @param competition_id
|
|
370
463
|
* @returns promise
|
|
371
464
|
*/
|
|
372
|
-
static createRound<T>(competition_id: string, data?: object): AxiosPromise<Response<T>>;
|
|
465
|
+
static createRound<T>(competition_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
373
466
|
/**
|
|
374
467
|
* Retrieve the information for a single round.
|
|
375
468
|
*
|
|
@@ -379,7 +472,7 @@ declare class Competitions {
|
|
|
379
472
|
* @param round_id
|
|
380
473
|
* @returns promise
|
|
381
474
|
*/
|
|
382
|
-
static showRound<T>(competition_id: string, round_id: number): AxiosPromise<Response<T>>;
|
|
475
|
+
static showRound<T>(competition_id: string, round_id: number, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
383
476
|
/**
|
|
384
477
|
* Updating resource in storage with new information.
|
|
385
478
|
*
|
|
@@ -389,7 +482,7 @@ declare class Competitions {
|
|
|
389
482
|
* @param round_id
|
|
390
483
|
* @returns promise
|
|
391
484
|
*/
|
|
392
|
-
static updateRound<T>(competition_id: string, round_id: number, data?: object): AxiosPromise<Response<T>>;
|
|
485
|
+
static updateRound<T>(competition_id: string, round_id: number, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
393
486
|
/**
|
|
394
487
|
* Deletes the round for the competition.
|
|
395
488
|
*
|
|
@@ -408,7 +501,7 @@ declare class Competitions {
|
|
|
408
501
|
* @param competition_id
|
|
409
502
|
* @returns promise
|
|
410
503
|
*/
|
|
411
|
-
static team<T>(competition_id: string): AxiosPromise<Response<T>>;
|
|
504
|
+
static team<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
412
505
|
/**
|
|
413
506
|
* Associate a new team with the competition.
|
|
414
507
|
*
|
|
@@ -417,7 +510,7 @@ declare class Competitions {
|
|
|
417
510
|
* @param competition_id
|
|
418
511
|
* @returns promise
|
|
419
512
|
*/
|
|
420
|
-
static createCompetitionTeam<T>(competition_id: string, data?: object): AxiosPromise<Response<T>>;
|
|
513
|
+
static createCompetitionTeam<T>(competition_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
421
514
|
/**
|
|
422
515
|
* Display the contents of a single team associated with the competition.
|
|
423
516
|
*
|
|
@@ -427,7 +520,7 @@ declare class Competitions {
|
|
|
427
520
|
* @param team_id The id of the team
|
|
428
521
|
* @returns promise
|
|
429
522
|
*/
|
|
430
|
-
static showTeam<T>(competition_id: string, team_id: string): AxiosPromise<Response<T>>;
|
|
523
|
+
static showTeam<T>(competition_id: string, team_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
431
524
|
/**
|
|
432
525
|
* Update the team information associated with the competition.
|
|
433
526
|
*
|
|
@@ -447,7 +540,7 @@ declare class Competitions {
|
|
|
447
540
|
* @param team_id
|
|
448
541
|
* @returns promise
|
|
449
542
|
*/
|
|
450
|
-
static destroyTeam<T>(competition_id: string, team_id: string): AxiosPromise<Response<T>>;
|
|
543
|
+
static destroyTeam<T>(competition_id: string, team_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
451
544
|
/**
|
|
452
545
|
* List all the users associated with a competition.
|
|
453
546
|
*
|
|
@@ -456,7 +549,7 @@ declare class Competitions {
|
|
|
456
549
|
* @param competition_id
|
|
457
550
|
* @returns promise
|
|
458
551
|
*/
|
|
459
|
-
static users<T>(competition_id: string): AxiosPromise<Response<T>>;
|
|
552
|
+
static users<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
460
553
|
/**
|
|
461
554
|
* Associate a new users with the competition.
|
|
462
555
|
*
|
|
@@ -475,7 +568,7 @@ declare class Competitions {
|
|
|
475
568
|
* @param user_id
|
|
476
569
|
* @returns promise
|
|
477
570
|
*/
|
|
478
|
-
static showCompetitionUser<T>(competition_id: string, user_id: string): AxiosPromise<Response<T>>;
|
|
571
|
+
static showCompetitionUser<T>(competition_id: string, user_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
479
572
|
/**
|
|
480
573
|
* Update the user associated with competition.
|
|
481
574
|
*
|
|
@@ -485,7 +578,7 @@ declare class Competitions {
|
|
|
485
578
|
* @param user_id
|
|
486
579
|
* @returns promise
|
|
487
580
|
*/
|
|
488
|
-
static updateCompetitionUser<T>(competition_id: string, user_id: string, data?: object): AxiosPromise<Response<T>>;
|
|
581
|
+
static updateCompetitionUser<T>(competition_id: string, user_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
489
582
|
/**
|
|
490
583
|
* Remove the associated user from the competition.
|
|
491
584
|
*
|
|
@@ -495,7 +588,7 @@ declare class Competitions {
|
|
|
495
588
|
* @param user_id
|
|
496
589
|
* @returns promise
|
|
497
590
|
*/
|
|
498
|
-
static destroyCompetitionUser<T>(competition_id: string, user_id: string): AxiosPromise<Response<T>>;
|
|
591
|
+
static destroyCompetitionUser<T>(competition_id: string, user_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
499
592
|
/**
|
|
500
593
|
* List all the venues associated with a competition.
|
|
501
594
|
*
|
|
@@ -504,7 +597,7 @@ declare class Competitions {
|
|
|
504
597
|
* @param competition_id
|
|
505
598
|
* @returns promise
|
|
506
599
|
*/
|
|
507
|
-
static venues<T>(competition_id: string): AxiosPromise<Response<T>>;
|
|
600
|
+
static venues<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
508
601
|
/**
|
|
509
602
|
* Creating a new venue.
|
|
510
603
|
*
|
|
@@ -513,7 +606,7 @@ declare class Competitions {
|
|
|
513
606
|
* @param competition_id
|
|
514
607
|
* @returns promise
|
|
515
608
|
*/
|
|
516
|
-
static createVenue<T>(competition_id: string, data: object): AxiosPromise<Response<T>>;
|
|
609
|
+
static createVenue<T>(competition_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
517
610
|
/**
|
|
518
611
|
* Show a single venue by its ID.
|
|
519
612
|
*
|
|
@@ -523,7 +616,7 @@ declare class Competitions {
|
|
|
523
616
|
* @param venue_id
|
|
524
617
|
* @returns promise
|
|
525
618
|
*/
|
|
526
|
-
static showVenue<T>(competition_id: string, venue_id: string): AxiosPromise<Response<T>>;
|
|
619
|
+
static showVenue<T>(competition_id: string, venue_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
527
620
|
/**
|
|
528
621
|
* Update the venue.
|
|
529
622
|
*
|
|
@@ -533,7 +626,7 @@ declare class Competitions {
|
|
|
533
626
|
* @param venue_id
|
|
534
627
|
* @returns promise
|
|
535
628
|
*/
|
|
536
|
-
static updateVenue<T>(competition_id: string, venue_id: string, data: object): AxiosPromise<Response<T>>;
|
|
629
|
+
static updateVenue<T>(competition_id: string, venue_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
537
630
|
/**
|
|
538
631
|
* Deletes the venue from the competition.
|
|
539
632
|
*
|
|
@@ -543,7 +636,7 @@ declare class Competitions {
|
|
|
543
636
|
* @param venue_id
|
|
544
637
|
* @returns promise
|
|
545
638
|
*/
|
|
546
|
-
static destroyVenue<T>(competition_id: string, venue_id: string): AxiosPromise<Response<T>>;
|
|
639
|
+
static destroyVenue<T>(competition_id: string, venue_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
547
640
|
/**
|
|
548
641
|
* Updates the main image for the venue using a File object.
|
|
549
642
|
*
|
|
@@ -554,7 +647,7 @@ declare class Competitions {
|
|
|
554
647
|
*
|
|
555
648
|
* @returns promise
|
|
556
649
|
*/
|
|
557
|
-
static uploadVenueMainImageFile<T>(competition_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
|
|
650
|
+
static uploadVenueMainImageFile<T>(competition_id: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
558
651
|
/**
|
|
559
652
|
* Updates the main image for the venue using a Blob.
|
|
560
653
|
*
|
|
@@ -565,7 +658,7 @@ declare class Competitions {
|
|
|
565
658
|
*
|
|
566
659
|
* @returns promise
|
|
567
660
|
*/
|
|
568
|
-
static uploadVenueMainImageBlob<T>(competition_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
|
|
661
|
+
static uploadVenueMainImageBlob<T>(competition_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
569
662
|
}
|
|
570
663
|
|
|
571
664
|
declare class Communities {
|
|
@@ -576,7 +669,7 @@ declare class Communities {
|
|
|
576
669
|
*
|
|
577
670
|
* @returns promise
|
|
578
671
|
*/
|
|
579
|
-
static list<T>(): AxiosPromise<Response<T>>;
|
|
672
|
+
static list<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
580
673
|
/**
|
|
581
674
|
* Create a new community.
|
|
582
675
|
*
|
|
@@ -586,7 +679,7 @@ declare class Communities {
|
|
|
586
679
|
*
|
|
587
680
|
* @returns Promise
|
|
588
681
|
*/
|
|
589
|
-
static create<T>(data: object): AxiosPromise<Response<T>>;
|
|
682
|
+
static create<T>(data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
590
683
|
/**
|
|
591
684
|
* Update a community.
|
|
592
685
|
*
|
|
@@ -597,7 +690,7 @@ declare class Communities {
|
|
|
597
690
|
*
|
|
598
691
|
* @returns promise
|
|
599
692
|
*/
|
|
600
|
-
static update<T>(community_id: string, data: object): AxiosPromise<Response<T>>;
|
|
693
|
+
static update<T>(community_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
601
694
|
/**
|
|
602
695
|
* Retrieve the information for a single community.
|
|
603
696
|
*
|
|
@@ -607,7 +700,7 @@ declare class Communities {
|
|
|
607
700
|
*
|
|
608
701
|
* @returns promise
|
|
609
702
|
*/
|
|
610
|
-
static view<T>(community_id: string): AxiosPromise<Response<T>>;
|
|
703
|
+
static view<T>(community_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
611
704
|
/**
|
|
612
705
|
* Deletes a community.
|
|
613
706
|
*
|
|
@@ -616,7 +709,7 @@ declare class Communities {
|
|
|
616
709
|
* @param community_id The id of the community to delete.
|
|
617
710
|
* @returns promise
|
|
618
711
|
*/
|
|
619
|
-
static delete<T>(community_id: string): AxiosPromise<Response<T>>;
|
|
712
|
+
static delete<T>(community_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
620
713
|
/**
|
|
621
714
|
* Updates the main image for the community using a File object.
|
|
622
715
|
*
|
|
@@ -627,7 +720,7 @@ declare class Communities {
|
|
|
627
720
|
*
|
|
628
721
|
* @returns promise
|
|
629
722
|
*/
|
|
630
|
-
static uploadLogoFile<T>(community_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
|
|
723
|
+
static uploadLogoFile<T>(community_id: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
631
724
|
/**
|
|
632
725
|
* Updates the main image for the community using a Blob.
|
|
633
726
|
*
|
|
@@ -638,7 +731,7 @@ declare class Communities {
|
|
|
638
731
|
*
|
|
639
732
|
* @returns promise
|
|
640
733
|
*/
|
|
641
|
-
static uploadLogoBlob<T>(community_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
|
|
734
|
+
static uploadLogoBlob<T>(community_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
642
735
|
/**
|
|
643
736
|
* Updates the banner image for the community using a File object.
|
|
644
737
|
*
|
|
@@ -649,7 +742,7 @@ declare class Communities {
|
|
|
649
742
|
*
|
|
650
743
|
* @returns promise
|
|
651
744
|
*/
|
|
652
|
-
static uploadBannerImageFile<T>(community_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
|
|
745
|
+
static uploadBannerImageFile<T>(community_id: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
653
746
|
/**
|
|
654
747
|
* Updates the banner image for the community using a Blob.
|
|
655
748
|
*
|
|
@@ -660,7 +753,7 @@ declare class Communities {
|
|
|
660
753
|
*
|
|
661
754
|
* @returns promise
|
|
662
755
|
*/
|
|
663
|
-
static uploadBannerImageBlob<T>(community_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
|
|
756
|
+
static uploadBannerImageBlob<T>(community_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
664
757
|
/**
|
|
665
758
|
* Updates the banner image for the community using a File object.
|
|
666
759
|
*
|
|
@@ -671,7 +764,7 @@ declare class Communities {
|
|
|
671
764
|
*
|
|
672
765
|
* @returns promise
|
|
673
766
|
*/
|
|
674
|
-
static uploadVideoLogoFile<T>(community_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
|
|
767
|
+
static uploadVideoLogoFile<T>(community_id: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
675
768
|
/**
|
|
676
769
|
* Updates the banner image for the community using a Blob.
|
|
677
770
|
*
|
|
@@ -682,7 +775,7 @@ declare class Communities {
|
|
|
682
775
|
*
|
|
683
776
|
* @returns promise
|
|
684
777
|
*/
|
|
685
|
-
static uploadVideoLogoBlob<T>(community_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
|
|
778
|
+
static uploadVideoLogoBlob<T>(community_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
686
779
|
/**
|
|
687
780
|
* List the invites that have been sent for the community to users.
|
|
688
781
|
*
|
|
@@ -692,7 +785,7 @@ declare class Communities {
|
|
|
692
785
|
*
|
|
693
786
|
* @returns promise
|
|
694
787
|
*/
|
|
695
|
-
static listInvites<T>(community_id: string): AxiosPromise<Response<T>>;
|
|
788
|
+
static listInvites<T>(community_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
696
789
|
/**
|
|
697
790
|
* Send an invitation to a user to join the community.
|
|
698
791
|
*
|
|
@@ -703,7 +796,7 @@ declare class Communities {
|
|
|
703
796
|
*
|
|
704
797
|
* @returns promise
|
|
705
798
|
*/
|
|
706
|
-
static sendInvite<T>(community_id: string, data?: object): AxiosPromise<Response<T>>;
|
|
799
|
+
static sendInvite<T>(community_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
707
800
|
/**
|
|
708
801
|
* Accept an invite to a community. The JSON Web Token (JWT) must be related to the token.
|
|
709
802
|
*
|
|
@@ -714,7 +807,7 @@ declare class Communities {
|
|
|
714
807
|
*
|
|
715
808
|
* @returns promise
|
|
716
809
|
*/
|
|
717
|
-
static acceptInvite<T>(community_id: string, token: string): AxiosPromise<Response<T>>;
|
|
810
|
+
static acceptInvite<T>(community_id: string, token: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
718
811
|
/**
|
|
719
812
|
* List the users who are currently associated with the community.
|
|
720
813
|
*
|
|
@@ -724,7 +817,7 @@ declare class Communities {
|
|
|
724
817
|
*
|
|
725
818
|
* @returns promise
|
|
726
819
|
*/
|
|
727
|
-
static listUsers<T>(community_id: string): AxiosPromise<Response<T>>;
|
|
820
|
+
static listUsers<T>(community_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
728
821
|
/**
|
|
729
822
|
* Add a user to a community.
|
|
730
823
|
*
|
|
@@ -735,7 +828,7 @@ declare class Communities {
|
|
|
735
828
|
*
|
|
736
829
|
* @returns promise
|
|
737
830
|
*/
|
|
738
|
-
static addUser<T>(community_id: string, data?: object): AxiosPromise<Response<T>>;
|
|
831
|
+
static addUser<T>(community_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
739
832
|
/**
|
|
740
833
|
* Retrieves a single user and their information that is associated with a community.
|
|
741
834
|
*
|
|
@@ -746,7 +839,7 @@ declare class Communities {
|
|
|
746
839
|
*
|
|
747
840
|
* @returns promise
|
|
748
841
|
*/
|
|
749
|
-
static getUser<T>(community_id: string, user_id: string): AxiosPromise<Response<T>>;
|
|
842
|
+
static getUser<T>(community_id: string, user_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
750
843
|
/**
|
|
751
844
|
* Updates the users information associated with the community.
|
|
752
845
|
*
|
|
@@ -755,7 +848,7 @@ declare class Communities {
|
|
|
755
848
|
*
|
|
756
849
|
* @returns promise
|
|
757
850
|
*/
|
|
758
|
-
static updatetUser<T>(community_id: string, user_id: string, data?: object): AxiosPromise<Response<T>>;
|
|
851
|
+
static updatetUser<T>(community_id: string, user_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
759
852
|
/**
|
|
760
853
|
* Removes a user from a community.
|
|
761
854
|
*
|
|
@@ -764,7 +857,7 @@ declare class Communities {
|
|
|
764
857
|
*
|
|
765
858
|
* @returns promise
|
|
766
859
|
*/
|
|
767
|
-
static removetUser<T>(community_id: string, user_id: string): AxiosPromise<Response<T>>;
|
|
860
|
+
static removetUser<T>(community_id: string, user_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
768
861
|
/**
|
|
769
862
|
* Finds a community either by its subdomain or cname. The cname must be active.
|
|
770
863
|
*
|
|
@@ -772,7 +865,7 @@ declare class Communities {
|
|
|
772
865
|
*
|
|
773
866
|
* @returns promise
|
|
774
867
|
*/
|
|
775
|
-
static findByDomain<T>(domain: string): AxiosPromise<Response<T>>;
|
|
868
|
+
static findByDomain<T>(domain: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
776
869
|
}
|
|
777
870
|
|
|
778
871
|
declare class Users {
|
|
@@ -783,7 +876,7 @@ declare class Users {
|
|
|
783
876
|
*
|
|
784
877
|
* @returns promise
|
|
785
878
|
*/
|
|
786
|
-
static list<T>(): AxiosPromise<Response<T>>;
|
|
879
|
+
static list<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
787
880
|
/**
|
|
788
881
|
* Updates a users information. Requires the users JSON Web Token (JWT) for them to update their profile.
|
|
789
882
|
*
|
|
@@ -793,7 +886,7 @@ declare class Users {
|
|
|
793
886
|
*
|
|
794
887
|
* @returns Promise
|
|
795
888
|
*/
|
|
796
|
-
static update<T>(data: object): AxiosPromise<Response<T>>;
|
|
889
|
+
static update<T>(data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
797
890
|
/**
|
|
798
891
|
* Gets the current users information based on the current Json Web Token (JWT).
|
|
799
892
|
*
|
|
@@ -804,7 +897,7 @@ declare class Users {
|
|
|
804
897
|
*
|
|
805
898
|
* @returns promise
|
|
806
899
|
*/
|
|
807
|
-
static me<T>(): AxiosPromise<Response<T>>;
|
|
900
|
+
static me<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
808
901
|
/**
|
|
809
902
|
* Will follow and unfollow a user. If the user is not being following, it will follow the user. If they are following, it will unfollow the user. The current JWT is used for the follower.
|
|
810
903
|
*
|
|
@@ -896,7 +989,7 @@ declare class Events {
|
|
|
896
989
|
*
|
|
897
990
|
* @returns promise
|
|
898
991
|
*/
|
|
899
|
-
static list<T>(): AxiosPromise<Response<T>>;
|
|
992
|
+
static list<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
900
993
|
/**
|
|
901
994
|
* Create a new event.
|
|
902
995
|
*
|
|
@@ -906,7 +999,7 @@ declare class Events {
|
|
|
906
999
|
*
|
|
907
1000
|
* @returns Promise
|
|
908
1001
|
*/
|
|
909
|
-
static create<T>(data: object): AxiosPromise<Response<T>>;
|
|
1002
|
+
static create<T>(data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
910
1003
|
/**
|
|
911
1004
|
* Update a event
|
|
912
1005
|
*
|
|
@@ -917,7 +1010,7 @@ declare class Events {
|
|
|
917
1010
|
*
|
|
918
1011
|
* @returns promise
|
|
919
1012
|
*/
|
|
920
|
-
static update<T>(event_id: string, data: object): AxiosPromise<Response<T>>;
|
|
1013
|
+
static update<T>(event_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
921
1014
|
/**
|
|
922
1015
|
* Retrieve the information for a single event.
|
|
923
1016
|
*
|
|
@@ -927,7 +1020,7 @@ declare class Events {
|
|
|
927
1020
|
*
|
|
928
1021
|
* @returns promise
|
|
929
1022
|
*/
|
|
930
|
-
static view<T>(event_id: string): AxiosPromise<Response<T>>;
|
|
1023
|
+
static view<T>(event_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
931
1024
|
/**
|
|
932
1025
|
* Deletes a event.
|
|
933
1026
|
*
|
|
@@ -936,7 +1029,7 @@ declare class Events {
|
|
|
936
1029
|
* @param event_id The id of the event to delete.
|
|
937
1030
|
* @returns promise
|
|
938
1031
|
*/
|
|
939
|
-
static delete<T>(event_id: string): AxiosPromise<Response<T>>;
|
|
1032
|
+
static delete<T>(event_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
940
1033
|
/**
|
|
941
1034
|
* The event is synced with Invirtu for the lie streams. This will allow you to update
|
|
942
1035
|
*
|
|
@@ -948,7 +1041,7 @@ declare class Events {
|
|
|
948
1041
|
*
|
|
949
1042
|
* @returns promise
|
|
950
1043
|
*/
|
|
951
|
-
static updateInvirtuEvent<T>(event_id: string, data: object): AxiosPromise<Response<T>>;
|
|
1044
|
+
static updateInvirtuEvent<T>(event_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
952
1045
|
/**
|
|
953
1046
|
* Add an RTMP source to multicast a stream too.
|
|
954
1047
|
*
|
|
@@ -959,7 +1052,7 @@ declare class Events {
|
|
|
959
1052
|
*
|
|
960
1053
|
* @returns promise
|
|
961
1054
|
*/
|
|
962
|
-
static addRTMPSource<T>(event_id: string, data?: object): AxiosPromise<Response<T>>;
|
|
1055
|
+
static addRTMPSource<T>(event_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
963
1056
|
/**
|
|
964
1057
|
* Update an RTMP Source for multicasing.
|
|
965
1058
|
*
|
|
@@ -970,7 +1063,7 @@ declare class Events {
|
|
|
970
1063
|
*
|
|
971
1064
|
* @returns promise
|
|
972
1065
|
*/
|
|
973
|
-
static updateRTMPSource<T>(event_id: string, stream_id: string, data?: object): AxiosPromise<Response<T>>;
|
|
1066
|
+
static updateRTMPSource<T>(event_id: string, stream_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
974
1067
|
/**
|
|
975
1068
|
* Remove a RTMP source for multicasing.
|
|
976
1069
|
*
|
|
@@ -981,7 +1074,7 @@ declare class Events {
|
|
|
981
1074
|
*
|
|
982
1075
|
* @returns promise
|
|
983
1076
|
*/
|
|
984
|
-
static removeRTMPSource<T>(event_id: string, stream_id: string): AxiosPromise<Response<T>>;
|
|
1077
|
+
static removeRTMPSource<T>(event_id: string, stream_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
985
1078
|
/**
|
|
986
1079
|
* A function that should be run on an interval to set the event as live when the live stream is active.
|
|
987
1080
|
*
|
|
@@ -991,7 +1084,7 @@ declare class Events {
|
|
|
991
1084
|
*
|
|
992
1085
|
* @returns promise
|
|
993
1086
|
*/
|
|
994
|
-
static syncAsLive<T>(event_id: string): AxiosPromise<Response<T>>;
|
|
1087
|
+
static syncAsLive<T>(event_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
995
1088
|
/**
|
|
996
1089
|
* Updates the main image for the event using a File object.
|
|
997
1090
|
*
|
|
@@ -1002,7 +1095,7 @@ declare class Events {
|
|
|
1002
1095
|
*
|
|
1003
1096
|
* @returns promise
|
|
1004
1097
|
*/
|
|
1005
|
-
static uploadMainImageFile<T>(event_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
|
|
1098
|
+
static uploadMainImageFile<T>(event_id: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1006
1099
|
/**
|
|
1007
1100
|
* Updates the main image for the event using a Blob.
|
|
1008
1101
|
*
|
|
@@ -1013,7 +1106,7 @@ declare class Events {
|
|
|
1013
1106
|
*
|
|
1014
1107
|
* @returns promise
|
|
1015
1108
|
*/
|
|
1016
|
-
static uploadMainImageBlob<T>(event_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
|
|
1109
|
+
static uploadMainImageBlob<T>(event_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1017
1110
|
/**
|
|
1018
1111
|
* Updates the banner image for the team using a File object.
|
|
1019
1112
|
*
|
|
@@ -1024,7 +1117,7 @@ declare class Events {
|
|
|
1024
1117
|
*
|
|
1025
1118
|
* @returns promise
|
|
1026
1119
|
*/
|
|
1027
|
-
static uploadBannerImageFile<T>(event_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
|
|
1120
|
+
static uploadBannerImageFile<T>(event_id: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1028
1121
|
/**
|
|
1029
1122
|
* Updates the banner image for the team using a Blob.
|
|
1030
1123
|
*
|
|
@@ -1035,7 +1128,7 @@ declare class Events {
|
|
|
1035
1128
|
*
|
|
1036
1129
|
* @returns promise
|
|
1037
1130
|
*/
|
|
1038
|
-
static uploadBannerImageBlob<T>(event_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
|
|
1131
|
+
static uploadBannerImageBlob<T>(event_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1039
1132
|
/**
|
|
1040
1133
|
* Enable Broadcast Mode. Broadcast mode is when the live stream is broadcasted from the game play through a protocol
|
|
1041
1134
|
* such as screen sharing.
|
|
@@ -1046,7 +1139,7 @@ declare class Events {
|
|
|
1046
1139
|
*
|
|
1047
1140
|
* @returns promise
|
|
1048
1141
|
*/
|
|
1049
|
-
static enableBroadcastMode<T>(event_id: string): AxiosPromise<Response<T>>;
|
|
1142
|
+
static enableBroadcastMode<T>(event_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1050
1143
|
/**
|
|
1051
1144
|
* Enable livestream mode, in which the stream will be delivered to the invirtu RTMP endpoint for
|
|
1052
1145
|
* streaming.
|
|
@@ -1055,7 +1148,7 @@ declare class Events {
|
|
|
1055
1148
|
*
|
|
1056
1149
|
* @returns promise
|
|
1057
1150
|
*/
|
|
1058
|
-
static enableLivestreamMode<T>(event_id: string): AxiosPromise<Response<T>>;
|
|
1151
|
+
static enableLivestreamMode<T>(event_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1059
1152
|
/**
|
|
1060
1153
|
* Sends content that will appear on-screen to the user.
|
|
1061
1154
|
*
|
|
@@ -1066,7 +1159,7 @@ declare class Events {
|
|
|
1066
1159
|
*
|
|
1067
1160
|
* @returns promise
|
|
1068
1161
|
*/
|
|
1069
|
-
static sendOnScreenContent<T>(event_id: string, data: object): AxiosPromise<Response<T>>;
|
|
1162
|
+
static sendOnScreenContent<T>(event_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1070
1163
|
/**
|
|
1071
1164
|
* Uploads an image that can be used and overlay later. A File object is used.
|
|
1072
1165
|
*
|
|
@@ -1152,7 +1245,7 @@ declare class Teams {
|
|
|
1152
1245
|
*
|
|
1153
1246
|
* @returns promise
|
|
1154
1247
|
*/
|
|
1155
|
-
static list<T>(): AxiosPromise<Response<T>>;
|
|
1248
|
+
static list<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1156
1249
|
/**
|
|
1157
1250
|
* Create a new team.
|
|
1158
1251
|
*
|
|
@@ -1162,7 +1255,7 @@ declare class Teams {
|
|
|
1162
1255
|
*
|
|
1163
1256
|
* @returns Promise
|
|
1164
1257
|
*/
|
|
1165
|
-
static create<T>(data: object): AxiosPromise<Response<T>>;
|
|
1258
|
+
static create<T>(data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1166
1259
|
/**
|
|
1167
1260
|
* Update a team.
|
|
1168
1261
|
*
|
|
@@ -1173,7 +1266,7 @@ declare class Teams {
|
|
|
1173
1266
|
*
|
|
1174
1267
|
* @returns promise
|
|
1175
1268
|
*/
|
|
1176
|
-
static update<T>(team_id: string, data: object): AxiosPromise<Response<T>>;
|
|
1269
|
+
static update<T>(team_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1177
1270
|
/**
|
|
1178
1271
|
* Retrieve the information for a single team.
|
|
1179
1272
|
*
|
|
@@ -1183,7 +1276,7 @@ declare class Teams {
|
|
|
1183
1276
|
*
|
|
1184
1277
|
* @returns promise
|
|
1185
1278
|
*/
|
|
1186
|
-
static view<T>(team_id: string): AxiosPromise<Response<T>>;
|
|
1279
|
+
static view<T>(team_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1187
1280
|
/**
|
|
1188
1281
|
* Deletes a team.
|
|
1189
1282
|
*
|
|
@@ -1192,7 +1285,7 @@ declare class Teams {
|
|
|
1192
1285
|
* @param team_id The id of the team to delete.
|
|
1193
1286
|
* @returns promise
|
|
1194
1287
|
*/
|
|
1195
|
-
static delete<T>(team_id: string): AxiosPromise<Response<T>>;
|
|
1288
|
+
static delete<T>(team_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1196
1289
|
/**
|
|
1197
1290
|
* Updates the main image for the team using a File object.
|
|
1198
1291
|
*
|
|
@@ -1246,7 +1339,7 @@ declare class Teams {
|
|
|
1246
1339
|
*
|
|
1247
1340
|
* @returns promise
|
|
1248
1341
|
*/
|
|
1249
|
-
static listInvites<T>(team_id: string): AxiosPromise<Response<T>>;
|
|
1342
|
+
static listInvites<T>(team_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1250
1343
|
/**
|
|
1251
1344
|
* Send an invitation to a user to join the team.
|
|
1252
1345
|
*
|
|
@@ -1278,7 +1371,7 @@ declare class Teams {
|
|
|
1278
1371
|
*
|
|
1279
1372
|
* @returns promise
|
|
1280
1373
|
*/
|
|
1281
|
-
static listUsers<T>(team_id: string): AxiosPromise<Response<T>>;
|
|
1374
|
+
static listUsers<T>(team_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1282
1375
|
/**
|
|
1283
1376
|
* Add a user to a team.
|
|
1284
1377
|
*
|
|
@@ -1329,7 +1422,7 @@ declare class Waitlists {
|
|
|
1329
1422
|
*
|
|
1330
1423
|
* @returns promise
|
|
1331
1424
|
*/
|
|
1332
|
-
static list<T>(): AxiosPromise<Response<T>>;
|
|
1425
|
+
static list<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1333
1426
|
/**
|
|
1334
1427
|
* Sign-up to the waitlist.
|
|
1335
1428
|
*
|
|
@@ -1339,7 +1432,7 @@ declare class Waitlists {
|
|
|
1339
1432
|
*
|
|
1340
1433
|
* @returns Promise
|
|
1341
1434
|
*/
|
|
1342
|
-
static create<T>(data: object): AxiosPromise<Response<T>>;
|
|
1435
|
+
static create<T>(data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1343
1436
|
/**
|
|
1344
1437
|
* Update a waitlist.
|
|
1345
1438
|
*
|
|
@@ -1350,7 +1443,7 @@ declare class Waitlists {
|
|
|
1350
1443
|
*
|
|
1351
1444
|
* @returns promise
|
|
1352
1445
|
*/
|
|
1353
|
-
static update<T>(waitlist_id: string, data: object): AxiosPromise<Response<T>>;
|
|
1446
|
+
static update<T>(waitlist_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1354
1447
|
/**
|
|
1355
1448
|
* Retrieve the information for a single user who signed-up to the waitlist.
|
|
1356
1449
|
*
|
|
@@ -1360,7 +1453,7 @@ declare class Waitlists {
|
|
|
1360
1453
|
*
|
|
1361
1454
|
* @returns promise
|
|
1362
1455
|
*/
|
|
1363
|
-
static view<T>(waitlist_id: string): AxiosPromise<Response<T>>;
|
|
1456
|
+
static view<T>(waitlist_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1364
1457
|
/**
|
|
1365
1458
|
* Deletes an entry from the waitlist.
|
|
1366
1459
|
*
|
|
@@ -1369,7 +1462,7 @@ declare class Waitlists {
|
|
|
1369
1462
|
* @param waitlist_id The id of the team to delete.
|
|
1370
1463
|
* @returns promise
|
|
1371
1464
|
*/
|
|
1372
|
-
static delete<T>(waitlist_id: string): AxiosPromise<Response<T>>;
|
|
1465
|
+
static delete<T>(waitlist_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1373
1466
|
}
|
|
1374
1467
|
|
|
1375
1468
|
declare class Templates {
|
|
@@ -1380,7 +1473,7 @@ declare class Templates {
|
|
|
1380
1473
|
*
|
|
1381
1474
|
* @returns promise
|
|
1382
1475
|
*/
|
|
1383
|
-
static list<T>(): AxiosPromise<Response<T>>;
|
|
1476
|
+
static list<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1384
1477
|
/**
|
|
1385
1478
|
* Create a new template.
|
|
1386
1479
|
*
|
|
@@ -1390,7 +1483,7 @@ declare class Templates {
|
|
|
1390
1483
|
*
|
|
1391
1484
|
* @returns Promise
|
|
1392
1485
|
*/
|
|
1393
|
-
static create<T>(data: object): AxiosPromise<Response<T>>;
|
|
1486
|
+
static create<T>(data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1394
1487
|
/**
|
|
1395
1488
|
* Update a template.
|
|
1396
1489
|
*
|
|
@@ -1401,7 +1494,7 @@ declare class Templates {
|
|
|
1401
1494
|
*
|
|
1402
1495
|
* @returns promise
|
|
1403
1496
|
*/
|
|
1404
|
-
static update<T>(template_id: string, data: object): AxiosPromise<Response<T>>;
|
|
1497
|
+
static update<T>(template_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1405
1498
|
/**
|
|
1406
1499
|
* Retrieve the information for a single template.
|
|
1407
1500
|
*
|
|
@@ -1411,7 +1504,7 @@ declare class Templates {
|
|
|
1411
1504
|
*
|
|
1412
1505
|
* @returns promise
|
|
1413
1506
|
*/
|
|
1414
|
-
static view<T>(template_id: string): AxiosPromise<Response<T>>;
|
|
1507
|
+
static view<T>(template_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1415
1508
|
/**
|
|
1416
1509
|
* Deletes a template.
|
|
1417
1510
|
*
|
|
@@ -1420,7 +1513,7 @@ declare class Templates {
|
|
|
1420
1513
|
* @param template_id The id of the template to delete.
|
|
1421
1514
|
* @returns promise
|
|
1422
1515
|
*/
|
|
1423
|
-
static delete<T>(template_id: string): AxiosPromise<Response<T>>;
|
|
1516
|
+
static delete<T>(template_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1424
1517
|
/**
|
|
1425
1518
|
* Updates the logo for the template using a File object.
|
|
1426
1519
|
*
|
|
@@ -1431,7 +1524,7 @@ declare class Templates {
|
|
|
1431
1524
|
*
|
|
1432
1525
|
* @returns promise
|
|
1433
1526
|
*/
|
|
1434
|
-
static uploadLogoFile<T>(template_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
|
|
1527
|
+
static uploadLogoFile<T>(template_id: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1435
1528
|
/**
|
|
1436
1529
|
* Updates the logo for the template using a Blob.
|
|
1437
1530
|
*
|
|
@@ -1442,7 +1535,7 @@ declare class Templates {
|
|
|
1442
1535
|
*
|
|
1443
1536
|
* @returns promise
|
|
1444
1537
|
*/
|
|
1445
|
-
static uploadLogoBlob<T>(template_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
|
|
1538
|
+
static uploadLogoBlob<T>(template_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1446
1539
|
/**
|
|
1447
1540
|
* Updates the main image for the template using a File object.
|
|
1448
1541
|
*
|
|
@@ -1453,7 +1546,7 @@ declare class Templates {
|
|
|
1453
1546
|
*
|
|
1454
1547
|
* @returns promise
|
|
1455
1548
|
*/
|
|
1456
|
-
static uploadMainImageFile<T>(template_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
|
|
1549
|
+
static uploadMainImageFile<T>(template_id: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1457
1550
|
/**
|
|
1458
1551
|
* Updates the main image for the template using a Blob.
|
|
1459
1552
|
*
|
|
@@ -1464,7 +1557,7 @@ declare class Templates {
|
|
|
1464
1557
|
*
|
|
1465
1558
|
* @returns promise
|
|
1466
1559
|
*/
|
|
1467
|
-
static uploadMainImageBlob<T>(template_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
|
|
1560
|
+
static uploadMainImageBlob<T>(template_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1468
1561
|
}
|
|
1469
1562
|
|
|
1470
1563
|
interface Route {
|
|
@@ -1476,6 +1569,7 @@ declare class Requests {
|
|
|
1476
1569
|
config: Config;
|
|
1477
1570
|
private static baseUrl;
|
|
1478
1571
|
private static authToken;
|
|
1572
|
+
private static community_id?;
|
|
1479
1573
|
constructor(config: Config);
|
|
1480
1574
|
/**
|
|
1481
1575
|
* Sets the base url of the API.
|
|
@@ -1489,6 +1583,12 @@ declare class Requests {
|
|
|
1489
1583
|
* @param token
|
|
1490
1584
|
*/
|
|
1491
1585
|
static setAuthToken(token: string): void;
|
|
1586
|
+
/**
|
|
1587
|
+
* Sets the community id that will be associated with all requests
|
|
1588
|
+
*
|
|
1589
|
+
* @param token
|
|
1590
|
+
*/
|
|
1591
|
+
static setCommunityID(community_id: string | undefined): void;
|
|
1492
1592
|
private static request;
|
|
1493
1593
|
/**
|
|
1494
1594
|
* Calls a GET request to the url endpoint.
|
|
@@ -1496,12 +1596,12 @@ declare class Requests {
|
|
|
1496
1596
|
* @param url
|
|
1497
1597
|
* @returns
|
|
1498
1598
|
*/
|
|
1499
|
-
static get<T>(url: string): AxiosPromise<Response<T>>;
|
|
1500
|
-
static post<T>(url: string, data: any): AxiosPromise<Response<T>>;
|
|
1501
|
-
static put<T>(url: string, data: any): AxiosPromise<Response<T>>;
|
|
1502
|
-
static delete<T>(url: string): AxiosPromise<Response<T>>;
|
|
1503
|
-
static uploadFile<T>(url: string, filename: string, file: File, data?: any): AxiosPromise<Response<T>>;
|
|
1504
|
-
static uploadBlob<T>(url: string, filename: string, blob: Blob, data?: any): AxiosPromise<Response<T>>;
|
|
1599
|
+
static get<T>(url: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1600
|
+
static post<T>(url: string, data: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1601
|
+
static put<T>(url: string, data: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1602
|
+
static delete<T>(url: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1603
|
+
static uploadFile<T>(url: string, filename: string, file: File, data?: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1604
|
+
static uploadBlob<T>(url: string, filename: string, blob: Blob, data?: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1505
1605
|
/**
|
|
1506
1606
|
* The Route class contains the method and url, thereforce items can be
|
|
1507
1607
|
* automatically routed depending on the configuration.
|
|
@@ -1512,7 +1612,7 @@ declare class Requests {
|
|
|
1512
1612
|
*/
|
|
1513
1613
|
static processRoute<T>(route: Route, data?: object, routeReplace?: {
|
|
1514
1614
|
[key: string]: any;
|
|
1515
|
-
}): AxiosPromise<Response<T>>;
|
|
1615
|
+
}, params?: Record<string, any>): AxiosPromise<Response<T>>;
|
|
1516
1616
|
}
|
|
1517
1617
|
|
|
1518
1618
|
declare class Parser {
|