vrchat 1.19.0 → 1.19.3
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/.github/workflows/ci.yaml +1 -1
- package/api.ts +3828 -431
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +2257 -140
- package/dist/api.js +2802 -197
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* VRChat API Documentation
|
|
3
3
|
*
|
|
4
|
-
* The version of the OpenAPI document: 1.19.
|
|
4
|
+
* The version of the OpenAPI document: 1.19.3
|
|
5
5
|
* Contact: vrchatapi.lpv0t@aries.fyi
|
|
6
6
|
*
|
|
7
7
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -29,12 +29,24 @@ export interface APIConfig {
|
|
|
29
29
|
* @memberof APIConfig
|
|
30
30
|
*/
|
|
31
31
|
'VoiceEnableReceiverLimiting': boolean;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {APIConfigAccessLogsUrls}
|
|
35
|
+
* @memberof APIConfig
|
|
36
|
+
*/
|
|
37
|
+
'accessLogsUrls': APIConfigAccessLogsUrls;
|
|
32
38
|
/**
|
|
33
39
|
* VRChat\'s office address
|
|
34
40
|
* @type {string}
|
|
35
41
|
* @memberof APIConfig
|
|
36
42
|
*/
|
|
37
43
|
'address': string;
|
|
44
|
+
/**
|
|
45
|
+
*
|
|
46
|
+
* @type {boolean}
|
|
47
|
+
* @memberof APIConfig
|
|
48
|
+
*/
|
|
49
|
+
'ageVerificationInviteVisible': boolean;
|
|
38
50
|
/**
|
|
39
51
|
*
|
|
40
52
|
* @type {boolean}
|
|
@@ -47,6 +59,18 @@ export interface APIConfig {
|
|
|
47
59
|
* @memberof APIConfig
|
|
48
60
|
*/
|
|
49
61
|
'ageVerificationStatusVisible': boolean;
|
|
62
|
+
/**
|
|
63
|
+
* Max retries for avatar analysis requests
|
|
64
|
+
* @type {number}
|
|
65
|
+
* @memberof APIConfig
|
|
66
|
+
*/
|
|
67
|
+
'analysisMaxRetries': number;
|
|
68
|
+
/**
|
|
69
|
+
* Interval between retries for avatar analysis requests
|
|
70
|
+
* @type {number}
|
|
71
|
+
* @memberof APIConfig
|
|
72
|
+
*/
|
|
73
|
+
'analysisRetryInterval': number;
|
|
50
74
|
/**
|
|
51
75
|
* Public Announcements
|
|
52
76
|
* @type {Set<APIConfigAnnouncement>}
|
|
@@ -65,13 +89,6 @@ export interface APIConfig {
|
|
|
65
89
|
* @memberof APIConfig
|
|
66
90
|
*/
|
|
67
91
|
'analyticsSegment_NewUI_Salt': string;
|
|
68
|
-
/**
|
|
69
|
-
* Game name
|
|
70
|
-
* @type {string}
|
|
71
|
-
* @memberof APIConfig
|
|
72
|
-
* @deprecated
|
|
73
|
-
*/
|
|
74
|
-
'appName': string;
|
|
75
92
|
/**
|
|
76
93
|
* List of supported Languages
|
|
77
94
|
* @type {Array<string>}
|
|
@@ -90,12 +107,6 @@ export interface APIConfig {
|
|
|
90
107
|
* @memberof APIConfig
|
|
91
108
|
*/
|
|
92
109
|
'avatarPerfLimiter': APIConfigAvatarPerfLimiter;
|
|
93
|
-
/**
|
|
94
|
-
* Build tag of the API server
|
|
95
|
-
* @type {string}
|
|
96
|
-
* @memberof APIConfig
|
|
97
|
-
*/
|
|
98
|
-
'buildVersionTag': string;
|
|
99
110
|
/**
|
|
100
111
|
* Unknown
|
|
101
112
|
* @type {number}
|
|
@@ -240,12 +251,6 @@ export interface APIConfig {
|
|
|
240
251
|
* @memberof APIConfig
|
|
241
252
|
*/
|
|
242
253
|
'defaultStickerSet': string;
|
|
243
|
-
/**
|
|
244
|
-
*
|
|
245
|
-
* @type {DeploymentGroup}
|
|
246
|
-
* @memberof APIConfig
|
|
247
|
-
*/
|
|
248
|
-
'deploymentGroup': DeploymentGroup;
|
|
249
254
|
/**
|
|
250
255
|
* Unknown
|
|
251
256
|
* @type {Array<string>}
|
|
@@ -332,6 +337,12 @@ export interface APIConfig {
|
|
|
332
337
|
* @memberof APIConfig
|
|
333
338
|
*/
|
|
334
339
|
'disableFrontendBuilds': boolean;
|
|
340
|
+
/**
|
|
341
|
+
* Toggles if gift drops should be disabled
|
|
342
|
+
* @type {boolean}
|
|
343
|
+
* @memberof APIConfig
|
|
344
|
+
*/
|
|
345
|
+
'disableGiftDrops': boolean;
|
|
335
346
|
/**
|
|
336
347
|
* Unknown
|
|
337
348
|
* @type {boolean}
|
|
@@ -423,6 +434,12 @@ export interface APIConfig {
|
|
|
423
434
|
* @memberof APIConfig
|
|
424
435
|
*/
|
|
425
436
|
'forceUseLatestWorld': boolean;
|
|
437
|
+
/**
|
|
438
|
+
* Display type of gifts
|
|
439
|
+
* @type {string}
|
|
440
|
+
* @memberof APIConfig
|
|
441
|
+
*/
|
|
442
|
+
'giftDisplayType': string;
|
|
426
443
|
/**
|
|
427
444
|
* Unknown
|
|
428
445
|
* @type {string}
|
|
@@ -514,17 +531,23 @@ export interface APIConfig {
|
|
|
514
531
|
*/
|
|
515
532
|
'reportFormUrl': string;
|
|
516
533
|
/**
|
|
517
|
-
*
|
|
518
|
-
* @type {
|
|
534
|
+
*
|
|
535
|
+
* @type {APIConfigReportOptions}
|
|
519
536
|
* @memberof APIConfig
|
|
520
537
|
*/
|
|
521
|
-
'reportOptions':
|
|
538
|
+
'reportOptions': APIConfigReportOptions;
|
|
522
539
|
/**
|
|
523
540
|
*
|
|
524
541
|
* @type {APIConfigReportReasons}
|
|
525
542
|
* @memberof APIConfig
|
|
526
543
|
*/
|
|
527
544
|
'reportReasons': APIConfigReportReasons;
|
|
545
|
+
/**
|
|
546
|
+
*
|
|
547
|
+
* @type {boolean}
|
|
548
|
+
* @memberof APIConfig
|
|
549
|
+
*/
|
|
550
|
+
'requireAgeVerificationBetaTag': boolean;
|
|
528
551
|
/**
|
|
529
552
|
* Link to the developer FAQ
|
|
530
553
|
* @type {string}
|
|
@@ -549,12 +572,6 @@ export interface APIConfig {
|
|
|
549
572
|
* @memberof APIConfig
|
|
550
573
|
*/
|
|
551
574
|
'sdkUnityVersion': string;
|
|
552
|
-
/**
|
|
553
|
-
* Server name of the API server currently responding
|
|
554
|
-
* @type {string}
|
|
555
|
-
* @memberof APIConfig
|
|
556
|
-
*/
|
|
557
|
-
'serverName': string;
|
|
558
575
|
/**
|
|
559
576
|
* A list of explicitly allowed origins that worlds can request strings from via the Udon\'s [VRCStringDownloader.LoadUrl](https://creators.vrchat.com/worlds/udon/string-loading/#ivrcstringdownload).
|
|
560
577
|
* @type {Array<string>}
|
|
@@ -657,6 +674,12 @@ export interface APIConfig {
|
|
|
657
674
|
* @memberof APIConfig
|
|
658
675
|
*/
|
|
659
676
|
'player-url-resolver-sha1': string;
|
|
677
|
+
/**
|
|
678
|
+
* Public key, hex encoded
|
|
679
|
+
* @type {string}
|
|
680
|
+
* @memberof APIConfig
|
|
681
|
+
*/
|
|
682
|
+
'publicKey': string;
|
|
660
683
|
/**
|
|
661
684
|
* Unknown
|
|
662
685
|
* @type {number}
|
|
@@ -676,6 +699,37 @@ export interface APIConfig {
|
|
|
676
699
|
*/
|
|
677
700
|
'websocketReconnectMaxDelay': number;
|
|
678
701
|
}
|
|
702
|
+
/**
|
|
703
|
+
*
|
|
704
|
+
* @export
|
|
705
|
+
* @interface APIConfigAccessLogsUrls
|
|
706
|
+
*/
|
|
707
|
+
export interface APIConfigAccessLogsUrls {
|
|
708
|
+
/**
|
|
709
|
+
*
|
|
710
|
+
* @type {string}
|
|
711
|
+
* @memberof APIConfigAccessLogsUrls
|
|
712
|
+
*/
|
|
713
|
+
'Default'?: string;
|
|
714
|
+
/**
|
|
715
|
+
*
|
|
716
|
+
* @type {string}
|
|
717
|
+
* @memberof APIConfigAccessLogsUrls
|
|
718
|
+
*/
|
|
719
|
+
'Pico'?: string;
|
|
720
|
+
/**
|
|
721
|
+
*
|
|
722
|
+
* @type {string}
|
|
723
|
+
* @memberof APIConfigAccessLogsUrls
|
|
724
|
+
*/
|
|
725
|
+
'Quest'?: string;
|
|
726
|
+
/**
|
|
727
|
+
*
|
|
728
|
+
* @type {string}
|
|
729
|
+
* @memberof APIConfigAccessLogsUrls
|
|
730
|
+
*/
|
|
731
|
+
'XRElite'?: string;
|
|
732
|
+
}
|
|
679
733
|
/**
|
|
680
734
|
* Public Announcement
|
|
681
735
|
* @export
|
|
@@ -1149,6 +1203,12 @@ export interface APIConfigReportCategories {
|
|
|
1149
1203
|
* @memberof APIConfigReportCategories
|
|
1150
1204
|
*/
|
|
1151
1205
|
'avatar': ReportCategory;
|
|
1206
|
+
/**
|
|
1207
|
+
*
|
|
1208
|
+
* @type {ReportCategory}
|
|
1209
|
+
* @memberof APIConfigReportCategories
|
|
1210
|
+
*/
|
|
1211
|
+
'avatarpage'?: ReportCategory;
|
|
1152
1212
|
/**
|
|
1153
1213
|
*
|
|
1154
1214
|
* @type {ReportCategory}
|
|
@@ -1216,6 +1276,167 @@ export interface APIConfigReportCategories {
|
|
|
1216
1276
|
*/
|
|
1217
1277
|
'worldstore': ReportCategory;
|
|
1218
1278
|
}
|
|
1279
|
+
/**
|
|
1280
|
+
* Options for reporting content
|
|
1281
|
+
* @export
|
|
1282
|
+
* @interface APIConfigReportOptions
|
|
1283
|
+
*/
|
|
1284
|
+
export interface APIConfigReportOptions {
|
|
1285
|
+
/**
|
|
1286
|
+
*
|
|
1287
|
+
* @type {APIConfigReportOptionsAvatar}
|
|
1288
|
+
* @memberof APIConfigReportOptions
|
|
1289
|
+
*/
|
|
1290
|
+
'avatar'?: APIConfigReportOptionsAvatar;
|
|
1291
|
+
/**
|
|
1292
|
+
*
|
|
1293
|
+
* @type {APIConfigReportOptionsGroup}
|
|
1294
|
+
* @memberof APIConfigReportOptions
|
|
1295
|
+
*/
|
|
1296
|
+
'group'?: APIConfigReportOptionsGroup;
|
|
1297
|
+
/**
|
|
1298
|
+
*
|
|
1299
|
+
* @type {APIConfigReportOptionsUser}
|
|
1300
|
+
* @memberof APIConfigReportOptions
|
|
1301
|
+
*/
|
|
1302
|
+
'user'?: APIConfigReportOptionsUser;
|
|
1303
|
+
/**
|
|
1304
|
+
*
|
|
1305
|
+
* @type {APIConfigReportOptionsWorld}
|
|
1306
|
+
* @memberof APIConfigReportOptions
|
|
1307
|
+
*/
|
|
1308
|
+
'world'?: APIConfigReportOptionsWorld;
|
|
1309
|
+
}
|
|
1310
|
+
/**
|
|
1311
|
+
*
|
|
1312
|
+
* @export
|
|
1313
|
+
* @interface APIConfigReportOptionsAvatar
|
|
1314
|
+
*/
|
|
1315
|
+
export interface APIConfigReportOptionsAvatar {
|
|
1316
|
+
/**
|
|
1317
|
+
*
|
|
1318
|
+
* @type {Array<string>}
|
|
1319
|
+
* @memberof APIConfigReportOptionsAvatar
|
|
1320
|
+
*/
|
|
1321
|
+
'avatar'?: Array<string>;
|
|
1322
|
+
/**
|
|
1323
|
+
*
|
|
1324
|
+
* @type {Array<string>}
|
|
1325
|
+
* @memberof APIConfigReportOptionsAvatar
|
|
1326
|
+
*/
|
|
1327
|
+
'avatarpage'?: Array<string>;
|
|
1328
|
+
/**
|
|
1329
|
+
*
|
|
1330
|
+
* @type {Array<string>}
|
|
1331
|
+
* @memberof APIConfigReportOptionsAvatar
|
|
1332
|
+
*/
|
|
1333
|
+
'warnings'?: Array<string>;
|
|
1334
|
+
}
|
|
1335
|
+
/**
|
|
1336
|
+
*
|
|
1337
|
+
* @export
|
|
1338
|
+
* @interface APIConfigReportOptionsGroup
|
|
1339
|
+
*/
|
|
1340
|
+
export interface APIConfigReportOptionsGroup {
|
|
1341
|
+
/**
|
|
1342
|
+
*
|
|
1343
|
+
* @type {Array<string>}
|
|
1344
|
+
* @memberof APIConfigReportOptionsGroup
|
|
1345
|
+
*/
|
|
1346
|
+
'groupstore'?: Array<string>;
|
|
1347
|
+
/**
|
|
1348
|
+
*
|
|
1349
|
+
* @type {Array<string>}
|
|
1350
|
+
* @memberof APIConfigReportOptionsGroup
|
|
1351
|
+
*/
|
|
1352
|
+
'image'?: Array<string>;
|
|
1353
|
+
/**
|
|
1354
|
+
*
|
|
1355
|
+
* @type {Array<string>}
|
|
1356
|
+
* @memberof APIConfigReportOptionsGroup
|
|
1357
|
+
*/
|
|
1358
|
+
'text'?: Array<string>;
|
|
1359
|
+
}
|
|
1360
|
+
/**
|
|
1361
|
+
*
|
|
1362
|
+
* @export
|
|
1363
|
+
* @interface APIConfigReportOptionsUser
|
|
1364
|
+
*/
|
|
1365
|
+
export interface APIConfigReportOptionsUser {
|
|
1366
|
+
/**
|
|
1367
|
+
*
|
|
1368
|
+
* @type {Array<string>}
|
|
1369
|
+
* @memberof APIConfigReportOptionsUser
|
|
1370
|
+
*/
|
|
1371
|
+
'behavior'?: Array<string>;
|
|
1372
|
+
/**
|
|
1373
|
+
*
|
|
1374
|
+
* @type {Array<string>}
|
|
1375
|
+
* @memberof APIConfigReportOptionsUser
|
|
1376
|
+
*/
|
|
1377
|
+
'chat'?: Array<string>;
|
|
1378
|
+
/**
|
|
1379
|
+
*
|
|
1380
|
+
* @type {Array<string>}
|
|
1381
|
+
* @memberof APIConfigReportOptionsUser
|
|
1382
|
+
*/
|
|
1383
|
+
'emoji'?: Array<string>;
|
|
1384
|
+
/**
|
|
1385
|
+
*
|
|
1386
|
+
* @type {Array<string>}
|
|
1387
|
+
* @memberof APIConfigReportOptionsUser
|
|
1388
|
+
*/
|
|
1389
|
+
'image'?: Array<string>;
|
|
1390
|
+
/**
|
|
1391
|
+
*
|
|
1392
|
+
* @type {Array<string>}
|
|
1393
|
+
* @memberof APIConfigReportOptionsUser
|
|
1394
|
+
*/
|
|
1395
|
+
'sticker'?: Array<string>;
|
|
1396
|
+
/**
|
|
1397
|
+
*
|
|
1398
|
+
* @type {Array<string>}
|
|
1399
|
+
* @memberof APIConfigReportOptionsUser
|
|
1400
|
+
*/
|
|
1401
|
+
'text'?: Array<string>;
|
|
1402
|
+
}
|
|
1403
|
+
/**
|
|
1404
|
+
*
|
|
1405
|
+
* @export
|
|
1406
|
+
* @interface APIConfigReportOptionsWorld
|
|
1407
|
+
*/
|
|
1408
|
+
export interface APIConfigReportOptionsWorld {
|
|
1409
|
+
/**
|
|
1410
|
+
*
|
|
1411
|
+
* @type {Array<string>}
|
|
1412
|
+
* @memberof APIConfigReportOptionsWorld
|
|
1413
|
+
*/
|
|
1414
|
+
'environment'?: Array<string>;
|
|
1415
|
+
/**
|
|
1416
|
+
*
|
|
1417
|
+
* @type {Array<string>}
|
|
1418
|
+
* @memberof APIConfigReportOptionsWorld
|
|
1419
|
+
*/
|
|
1420
|
+
'text'?: Array<string>;
|
|
1421
|
+
/**
|
|
1422
|
+
*
|
|
1423
|
+
* @type {Array<string>}
|
|
1424
|
+
* @memberof APIConfigReportOptionsWorld
|
|
1425
|
+
*/
|
|
1426
|
+
'warnings'?: Array<string>;
|
|
1427
|
+
/**
|
|
1428
|
+
*
|
|
1429
|
+
* @type {Array<string>}
|
|
1430
|
+
* @memberof APIConfigReportOptionsWorld
|
|
1431
|
+
*/
|
|
1432
|
+
'worldimage'?: Array<string>;
|
|
1433
|
+
/**
|
|
1434
|
+
*
|
|
1435
|
+
* @type {Array<string>}
|
|
1436
|
+
* @memberof APIConfigReportOptionsWorld
|
|
1437
|
+
*/
|
|
1438
|
+
'worldstore'?: Array<string>;
|
|
1439
|
+
}
|
|
1219
1440
|
/**
|
|
1220
1441
|
* Reasons available for reporting users
|
|
1221
1442
|
* @export
|
|
@@ -1240,6 +1461,18 @@ export interface APIConfigReportReasons {
|
|
|
1240
1461
|
* @memberof APIConfigReportReasons
|
|
1241
1462
|
*/
|
|
1242
1463
|
'cancellation': ReportReason;
|
|
1464
|
+
/**
|
|
1465
|
+
*
|
|
1466
|
+
* @type {ReportReason}
|
|
1467
|
+
* @memberof APIConfigReportReasons
|
|
1468
|
+
*/
|
|
1469
|
+
'copyright'?: ReportReason;
|
|
1470
|
+
/**
|
|
1471
|
+
*
|
|
1472
|
+
* @type {ReportReason}
|
|
1473
|
+
* @memberof APIConfigReportReasons
|
|
1474
|
+
*/
|
|
1475
|
+
'fraud'?: ReportReason;
|
|
1243
1476
|
/**
|
|
1244
1477
|
*
|
|
1245
1478
|
* @type {ReportReason}
|
|
@@ -1324,6 +1557,12 @@ export interface APIConfigReportReasons {
|
|
|
1324
1557
|
* @memberof APIConfigReportReasons
|
|
1325
1558
|
*/
|
|
1326
1559
|
'sexual': ReportReason;
|
|
1560
|
+
/**
|
|
1561
|
+
*
|
|
1562
|
+
* @type {ReportReason}
|
|
1563
|
+
* @memberof APIConfigReportReasons
|
|
1564
|
+
*/
|
|
1565
|
+
'technical'?: ReportReason;
|
|
1327
1566
|
/**
|
|
1328
1567
|
*
|
|
1329
1568
|
* @type {ReportReason}
|
|
@@ -1426,7 +1665,7 @@ export interface AddGroupGalleryImageRequest {
|
|
|
1426
1665
|
'fileId': string;
|
|
1427
1666
|
}
|
|
1428
1667
|
/**
|
|
1429
|
-
*
|
|
1668
|
+
* `verified` is obsolete. User who have verified and are 18+ can switch to `plus18` status.
|
|
1430
1669
|
* @export
|
|
1431
1670
|
* @enum {string}
|
|
1432
1671
|
*/
|
|
@@ -1443,13 +1682,19 @@ export type AgeVerificationStatus = typeof AgeVerificationStatus[keyof typeof Ag
|
|
|
1443
1682
|
*/
|
|
1444
1683
|
export interface Avatar {
|
|
1445
1684
|
/**
|
|
1446
|
-
*
|
|
1685
|
+
*
|
|
1686
|
+
* @type {string}
|
|
1687
|
+
* @memberof Avatar
|
|
1688
|
+
*/
|
|
1689
|
+
'acknowledgements'?: string;
|
|
1690
|
+
/**
|
|
1691
|
+
* Not present from general search `/avatars`, only on specific requests `/avatars/{avatarId}`.
|
|
1447
1692
|
* @type {string}
|
|
1448
1693
|
* @memberof Avatar
|
|
1449
1694
|
*/
|
|
1450
1695
|
'assetUrl'?: string;
|
|
1451
1696
|
/**
|
|
1452
|
-
* Not present from general
|
|
1697
|
+
* Not present from general search `/avatars`, only on specific requests `/avatars/{avatarId}`. **Deprecation:** `Object` has unknown usage/fields, and is always empty. Use normal `Url` field instead.
|
|
1453
1698
|
* @type {object}
|
|
1454
1699
|
* @memberof Avatar
|
|
1455
1700
|
*/
|
|
@@ -1484,6 +1729,12 @@ export interface Avatar {
|
|
|
1484
1729
|
* @memberof Avatar
|
|
1485
1730
|
*/
|
|
1486
1731
|
'featured': boolean;
|
|
1732
|
+
/**
|
|
1733
|
+
*
|
|
1734
|
+
* @type {number}
|
|
1735
|
+
* @memberof Avatar
|
|
1736
|
+
*/
|
|
1737
|
+
'highestPrice'?: number;
|
|
1487
1738
|
/**
|
|
1488
1739
|
*
|
|
1489
1740
|
* @type {string}
|
|
@@ -1496,18 +1747,48 @@ export interface Avatar {
|
|
|
1496
1747
|
* @memberof Avatar
|
|
1497
1748
|
*/
|
|
1498
1749
|
'imageUrl': string;
|
|
1750
|
+
/**
|
|
1751
|
+
*
|
|
1752
|
+
* @type {boolean}
|
|
1753
|
+
* @memberof Avatar
|
|
1754
|
+
*/
|
|
1755
|
+
'lock'?: boolean;
|
|
1756
|
+
/**
|
|
1757
|
+
*
|
|
1758
|
+
* @type {number}
|
|
1759
|
+
* @memberof Avatar
|
|
1760
|
+
*/
|
|
1761
|
+
'lowestPrice'?: number;
|
|
1499
1762
|
/**
|
|
1500
1763
|
*
|
|
1501
1764
|
* @type {string}
|
|
1502
1765
|
* @memberof Avatar
|
|
1503
1766
|
*/
|
|
1504
1767
|
'name': string;
|
|
1768
|
+
/**
|
|
1769
|
+
*
|
|
1770
|
+
* @type {string}
|
|
1771
|
+
* @memberof Avatar
|
|
1772
|
+
*/
|
|
1773
|
+
'productId'?: string;
|
|
1774
|
+
/**
|
|
1775
|
+
*
|
|
1776
|
+
* @type {Array<AvatarPublishedListingsInner>}
|
|
1777
|
+
* @memberof Avatar
|
|
1778
|
+
*/
|
|
1779
|
+
'publishedListings'?: Array<AvatarPublishedListingsInner>;
|
|
1505
1780
|
/**
|
|
1506
1781
|
*
|
|
1507
1782
|
* @type {ReleaseStatus}
|
|
1508
1783
|
* @memberof Avatar
|
|
1509
1784
|
*/
|
|
1510
1785
|
'releaseStatus': ReleaseStatus;
|
|
1786
|
+
/**
|
|
1787
|
+
*
|
|
1788
|
+
* @type {boolean}
|
|
1789
|
+
* @memberof Avatar
|
|
1790
|
+
*/
|
|
1791
|
+
'searchable'?: boolean;
|
|
1511
1792
|
/**
|
|
1512
1793
|
*
|
|
1513
1794
|
* @type {AvatarStyles}
|
|
@@ -1561,38 +1842,81 @@ export interface Avatar {
|
|
|
1561
1842
|
/**
|
|
1562
1843
|
*
|
|
1563
1844
|
* @export
|
|
1564
|
-
* @interface
|
|
1845
|
+
* @interface AvatarPublishedListingsInner
|
|
1565
1846
|
*/
|
|
1566
|
-
export interface
|
|
1847
|
+
export interface AvatarPublishedListingsInner {
|
|
1567
1848
|
/**
|
|
1568
1849
|
*
|
|
1569
1850
|
* @type {string}
|
|
1570
|
-
* @memberof
|
|
1851
|
+
* @memberof AvatarPublishedListingsInner
|
|
1571
1852
|
*/
|
|
1572
|
-
'
|
|
1853
|
+
'description'?: string;
|
|
1573
1854
|
/**
|
|
1574
1855
|
*
|
|
1575
1856
|
* @type {string}
|
|
1576
|
-
* @memberof
|
|
1857
|
+
* @memberof AvatarPublishedListingsInner
|
|
1577
1858
|
*/
|
|
1578
|
-
'
|
|
1859
|
+
'displayName'?: string;
|
|
1579
1860
|
/**
|
|
1580
1861
|
*
|
|
1581
|
-
* @type {
|
|
1582
|
-
* @memberof
|
|
1862
|
+
* @type {string}
|
|
1863
|
+
* @memberof AvatarPublishedListingsInner
|
|
1583
1864
|
*/
|
|
1584
|
-
'
|
|
1585
|
-
}
|
|
1586
|
-
/**
|
|
1587
|
-
* **Deprecation:** `Object` has unknown usage/fields, and is always empty. Use normal `Url` field instead.
|
|
1588
|
-
* @export
|
|
1589
|
-
* @interface AvatarUnityPackageUrlObject
|
|
1590
|
-
*/
|
|
1591
|
-
export interface AvatarUnityPackageUrlObject {
|
|
1865
|
+
'imageId'?: string;
|
|
1592
1866
|
/**
|
|
1593
1867
|
*
|
|
1594
1868
|
* @type {string}
|
|
1595
|
-
* @memberof
|
|
1869
|
+
* @memberof AvatarPublishedListingsInner
|
|
1870
|
+
*/
|
|
1871
|
+
'listingId'?: string;
|
|
1872
|
+
/**
|
|
1873
|
+
*
|
|
1874
|
+
* @type {string}
|
|
1875
|
+
* @memberof AvatarPublishedListingsInner
|
|
1876
|
+
*/
|
|
1877
|
+
'listingType'?: string;
|
|
1878
|
+
/**
|
|
1879
|
+
*
|
|
1880
|
+
* @type {number}
|
|
1881
|
+
* @memberof AvatarPublishedListingsInner
|
|
1882
|
+
*/
|
|
1883
|
+
'priceTokens'?: number;
|
|
1884
|
+
}
|
|
1885
|
+
/**
|
|
1886
|
+
*
|
|
1887
|
+
* @export
|
|
1888
|
+
* @interface AvatarStyles
|
|
1889
|
+
*/
|
|
1890
|
+
export interface AvatarStyles {
|
|
1891
|
+
/**
|
|
1892
|
+
*
|
|
1893
|
+
* @type {string}
|
|
1894
|
+
* @memberof AvatarStyles
|
|
1895
|
+
*/
|
|
1896
|
+
'primary'?: string | null;
|
|
1897
|
+
/**
|
|
1898
|
+
*
|
|
1899
|
+
* @type {string}
|
|
1900
|
+
* @memberof AvatarStyles
|
|
1901
|
+
*/
|
|
1902
|
+
'secondary'?: string | null;
|
|
1903
|
+
/**
|
|
1904
|
+
*
|
|
1905
|
+
* @type {Array<string>}
|
|
1906
|
+
* @memberof AvatarStyles
|
|
1907
|
+
*/
|
|
1908
|
+
'supplementary'?: Array<string>;
|
|
1909
|
+
}
|
|
1910
|
+
/**
|
|
1911
|
+
* **Deprecation:** `Object` has unknown usage/fields, and is always empty. Use normal `Url` field instead.
|
|
1912
|
+
* @export
|
|
1913
|
+
* @interface AvatarUnityPackageUrlObject
|
|
1914
|
+
*/
|
|
1915
|
+
export interface AvatarUnityPackageUrlObject {
|
|
1916
|
+
/**
|
|
1917
|
+
*
|
|
1918
|
+
* @type {string}
|
|
1919
|
+
* @memberof AvatarUnityPackageUrlObject
|
|
1596
1920
|
*/
|
|
1597
1921
|
'unityPackageUrl'?: string;
|
|
1598
1922
|
}
|
|
@@ -1689,6 +2013,19 @@ export interface BanGroupMemberRequest {
|
|
|
1689
2013
|
*/
|
|
1690
2014
|
'userId': string;
|
|
1691
2015
|
}
|
|
2016
|
+
/**
|
|
2017
|
+
*
|
|
2018
|
+
* @export
|
|
2019
|
+
* @interface ChangeUserTagsRequest
|
|
2020
|
+
*/
|
|
2021
|
+
export interface ChangeUserTagsRequest {
|
|
2022
|
+
/**
|
|
2023
|
+
* The tags being added or removed.
|
|
2024
|
+
* @type {Array<string>}
|
|
2025
|
+
* @memberof ChangeUserTagsRequest
|
|
2026
|
+
*/
|
|
2027
|
+
'tags': Array<string>;
|
|
2028
|
+
}
|
|
1692
2029
|
/**
|
|
1693
2030
|
*
|
|
1694
2031
|
* @export
|
|
@@ -1701,6 +2038,30 @@ export interface CreateAvatarRequest {
|
|
|
1701
2038
|
* @memberof CreateAvatarRequest
|
|
1702
2039
|
*/
|
|
1703
2040
|
'assetUrl'?: string;
|
|
2041
|
+
/**
|
|
2042
|
+
*
|
|
2043
|
+
* @type {string}
|
|
2044
|
+
* @memberof CreateAvatarRequest
|
|
2045
|
+
*/
|
|
2046
|
+
'assetVersion'?: string;
|
|
2047
|
+
/**
|
|
2048
|
+
* This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`.
|
|
2049
|
+
* @type {string}
|
|
2050
|
+
* @memberof CreateAvatarRequest
|
|
2051
|
+
*/
|
|
2052
|
+
'platform'?: string;
|
|
2053
|
+
/**
|
|
2054
|
+
* A date and time of the pattern `M/d/yyyy h:mm:ss tt` (see C Sharp `System.DateTime`)
|
|
2055
|
+
* @type {string}
|
|
2056
|
+
* @memberof CreateAvatarRequest
|
|
2057
|
+
*/
|
|
2058
|
+
'created_at'?: string;
|
|
2059
|
+
/**
|
|
2060
|
+
* A date and time of the pattern `M/d/yyyy h:mm:ss tt` (see C Sharp `System.DateTime`)
|
|
2061
|
+
* @type {string}
|
|
2062
|
+
* @memberof CreateAvatarRequest
|
|
2063
|
+
*/
|
|
2064
|
+
'updated_at'?: string;
|
|
1704
2065
|
/**
|
|
1705
2066
|
*
|
|
1706
2067
|
* @type {string}
|
|
@@ -1731,6 +2092,12 @@ export interface CreateAvatarRequest {
|
|
|
1731
2092
|
* @memberof CreateAvatarRequest
|
|
1732
2093
|
*/
|
|
1733
2094
|
'imageUrl': string;
|
|
2095
|
+
/**
|
|
2096
|
+
*
|
|
2097
|
+
* @type {string}
|
|
2098
|
+
* @memberof CreateAvatarRequest
|
|
2099
|
+
*/
|
|
2100
|
+
'thumbnailImageUrl'?: string;
|
|
1734
2101
|
/**
|
|
1735
2102
|
*
|
|
1736
2103
|
* @type {ReleaseStatus}
|
|
@@ -2124,6 +2491,30 @@ export interface CreateInstanceRequest {
|
|
|
2124
2491
|
* @memberof CreateInstanceRequest
|
|
2125
2492
|
*/
|
|
2126
2493
|
'inviteOnly'?: boolean;
|
|
2494
|
+
/**
|
|
2495
|
+
*
|
|
2496
|
+
* @type {boolean}
|
|
2497
|
+
* @memberof CreateInstanceRequest
|
|
2498
|
+
*/
|
|
2499
|
+
'ageGate'?: boolean;
|
|
2500
|
+
/**
|
|
2501
|
+
*
|
|
2502
|
+
* @type {boolean}
|
|
2503
|
+
* @memberof CreateInstanceRequest
|
|
2504
|
+
*/
|
|
2505
|
+
'instancePersistenceEnabled'?: boolean | null;
|
|
2506
|
+
/**
|
|
2507
|
+
*
|
|
2508
|
+
* @type {string}
|
|
2509
|
+
* @memberof CreateInstanceRequest
|
|
2510
|
+
*/
|
|
2511
|
+
'displayName'?: string | null;
|
|
2512
|
+
/**
|
|
2513
|
+
*
|
|
2514
|
+
* @type {InstanceContentSettings}
|
|
2515
|
+
* @memberof CreateInstanceRequest
|
|
2516
|
+
*/
|
|
2517
|
+
'contentSettings'?: InstanceContentSettings;
|
|
2127
2518
|
}
|
|
2128
2519
|
/**
|
|
2129
2520
|
*
|
|
@@ -2259,7 +2650,7 @@ export interface CurrentUser {
|
|
|
2259
2650
|
*/
|
|
2260
2651
|
'ageVerificationStatus': AgeVerificationStatus;
|
|
2261
2652
|
/**
|
|
2262
|
-
*
|
|
2653
|
+
* `true` if, user is age verified (not 18+).
|
|
2263
2654
|
* @type {boolean}
|
|
2264
2655
|
* @memberof CurrentUser
|
|
2265
2656
|
*/
|
|
@@ -2270,6 +2661,12 @@ export interface CurrentUser {
|
|
|
2270
2661
|
* @memberof CurrentUser
|
|
2271
2662
|
*/
|
|
2272
2663
|
'allowAvatarCopying': boolean;
|
|
2664
|
+
/**
|
|
2665
|
+
* The auth token for NEWLY REGISTERED ACCOUNTS ONLY (/auth/register)
|
|
2666
|
+
* @type {string}
|
|
2667
|
+
* @memberof CurrentUser
|
|
2668
|
+
*/
|
|
2669
|
+
'authToken'?: string;
|
|
2273
2670
|
/**
|
|
2274
2671
|
*
|
|
2275
2672
|
* @type {Array<Badge>}
|
|
@@ -2289,17 +2686,17 @@ export interface CurrentUser {
|
|
|
2289
2686
|
*/
|
|
2290
2687
|
'bioLinks': Array<string>;
|
|
2291
2688
|
/**
|
|
2292
|
-
*
|
|
2293
|
-
* @type {string}
|
|
2689
|
+
* These tags begin with `content_` and control content gating
|
|
2690
|
+
* @type {Array<string>}
|
|
2294
2691
|
* @memberof CurrentUser
|
|
2295
2692
|
*/
|
|
2296
|
-
'
|
|
2693
|
+
'contentFilters'?: Array<string>;
|
|
2297
2694
|
/**
|
|
2298
2695
|
*
|
|
2299
2696
|
* @type {string}
|
|
2300
2697
|
* @memberof CurrentUser
|
|
2301
2698
|
*/
|
|
2302
|
-
'
|
|
2699
|
+
'currentAvatar': string;
|
|
2303
2700
|
/**
|
|
2304
2701
|
* When profilePicOverride is not empty, use it instead.
|
|
2305
2702
|
* @type {string}
|
|
@@ -2529,6 +2926,12 @@ export interface CurrentUser {
|
|
|
2529
2926
|
* @memberof CurrentUser
|
|
2530
2927
|
*/
|
|
2531
2928
|
'presence'?: CurrentUserPresence;
|
|
2929
|
+
/**
|
|
2930
|
+
*
|
|
2931
|
+
* @type {Array<CurrentUserPlatformHistoryInner>}
|
|
2932
|
+
* @memberof CurrentUser
|
|
2933
|
+
*/
|
|
2934
|
+
'platform_history'?: Array<CurrentUserPlatformHistoryInner>;
|
|
2532
2935
|
/**
|
|
2533
2936
|
*
|
|
2534
2937
|
* @type {string}
|
|
@@ -2645,6 +3048,31 @@ export interface CurrentUser {
|
|
|
2645
3048
|
*/
|
|
2646
3049
|
'username'?: string;
|
|
2647
3050
|
}
|
|
3051
|
+
/**
|
|
3052
|
+
*
|
|
3053
|
+
* @export
|
|
3054
|
+
* @interface CurrentUserPlatformHistoryInner
|
|
3055
|
+
*/
|
|
3056
|
+
export interface CurrentUserPlatformHistoryInner {
|
|
3057
|
+
/**
|
|
3058
|
+
*
|
|
3059
|
+
* @type {boolean}
|
|
3060
|
+
* @memberof CurrentUserPlatformHistoryInner
|
|
3061
|
+
*/
|
|
3062
|
+
'isMobile'?: boolean;
|
|
3063
|
+
/**
|
|
3064
|
+
*
|
|
3065
|
+
* @type {string}
|
|
3066
|
+
* @memberof CurrentUserPlatformHistoryInner
|
|
3067
|
+
*/
|
|
3068
|
+
'platform'?: string | null;
|
|
3069
|
+
/**
|
|
3070
|
+
*
|
|
3071
|
+
* @type {string}
|
|
3072
|
+
* @memberof CurrentUserPlatformHistoryInner
|
|
3073
|
+
*/
|
|
3074
|
+
'recorded'?: string;
|
|
3075
|
+
}
|
|
2648
3076
|
/**
|
|
2649
3077
|
*
|
|
2650
3078
|
* @export
|
|
@@ -2742,18 +3170,6 @@ export interface CurrentUserPresence {
|
|
|
2742
3170
|
*/
|
|
2743
3171
|
'world'?: string;
|
|
2744
3172
|
}
|
|
2745
|
-
/**
|
|
2746
|
-
* Used to identify which API deployment cluster is currently responding. `blue` and `green` are used by Production. `grape`and `cherry` are used during Development. [Blue Green Deployment by Martin Fowler](https://martinfowler.com/bliki/BlueGreenDeployment.html)
|
|
2747
|
-
* @export
|
|
2748
|
-
* @enum {string}
|
|
2749
|
-
*/
|
|
2750
|
-
export declare const DeploymentGroup: {
|
|
2751
|
-
readonly Blue: "blue";
|
|
2752
|
-
readonly Green: "green";
|
|
2753
|
-
readonly Grape: "grape";
|
|
2754
|
-
readonly Cherry: "cherry";
|
|
2755
|
-
};
|
|
2756
|
-
export type DeploymentGroup = typeof DeploymentGroup[keyof typeof DeploymentGroup];
|
|
2757
3173
|
/**
|
|
2758
3174
|
* \"none\" User is a normal user \"trusted\" Unknown \"internal\" Is a VRChat Developer \"moderator\" Is a VRChat Moderator Staff can hide their developerType at will.
|
|
2759
3175
|
* @export
|
|
@@ -2766,6 +3182,19 @@ export declare const DeveloperType: {
|
|
|
2766
3182
|
readonly Moderator: "moderator";
|
|
2767
3183
|
};
|
|
2768
3184
|
export type DeveloperType = typeof DeveloperType[keyof typeof DeveloperType];
|
|
3185
|
+
/**
|
|
3186
|
+
*
|
|
3187
|
+
* @export
|
|
3188
|
+
* @interface Disable2FAResult
|
|
3189
|
+
*/
|
|
3190
|
+
export interface Disable2FAResult {
|
|
3191
|
+
/**
|
|
3192
|
+
*
|
|
3193
|
+
* @type {boolean}
|
|
3194
|
+
* @memberof Disable2FAResult
|
|
3195
|
+
*/
|
|
3196
|
+
'removed': boolean;
|
|
3197
|
+
}
|
|
2769
3198
|
/**
|
|
2770
3199
|
*
|
|
2771
3200
|
* @export
|
|
@@ -3027,6 +3456,12 @@ export interface FavoritedWorld {
|
|
|
3027
3456
|
* @memberof FavoritedWorld
|
|
3028
3457
|
*/
|
|
3029
3458
|
'created_at': string;
|
|
3459
|
+
/**
|
|
3460
|
+
*
|
|
3461
|
+
* @type {InstanceContentSettings}
|
|
3462
|
+
* @memberof FavoritedWorld
|
|
3463
|
+
*/
|
|
3464
|
+
'defaultContentSettings'?: InstanceContentSettings;
|
|
3030
3465
|
/**
|
|
3031
3466
|
*
|
|
3032
3467
|
* @type {number}
|
|
@@ -3269,12 +3704,24 @@ export interface FileAnalysis {
|
|
|
3269
3704
|
* @memberof FileAnalysis
|
|
3270
3705
|
*/
|
|
3271
3706
|
'created_at'?: string;
|
|
3707
|
+
/**
|
|
3708
|
+
*
|
|
3709
|
+
* @type {string}
|
|
3710
|
+
* @memberof FileAnalysis
|
|
3711
|
+
*/
|
|
3712
|
+
'encryptionKey'?: string;
|
|
3272
3713
|
/**
|
|
3273
3714
|
*
|
|
3274
3715
|
* @type {number}
|
|
3275
3716
|
* @memberof FileAnalysis
|
|
3276
3717
|
*/
|
|
3277
3718
|
'fileSize': number;
|
|
3719
|
+
/**
|
|
3720
|
+
*
|
|
3721
|
+
* @type {string}
|
|
3722
|
+
* @memberof FileAnalysis
|
|
3723
|
+
*/
|
|
3724
|
+
'performanceRating'?: string;
|
|
3278
3725
|
/**
|
|
3279
3726
|
*
|
|
3280
3727
|
* @type {boolean}
|
|
@@ -3777,6 +4224,19 @@ export interface FriendStatus {
|
|
|
3777
4224
|
*/
|
|
3778
4225
|
'outgoingRequest': boolean;
|
|
3779
4226
|
}
|
|
4227
|
+
/**
|
|
4228
|
+
*
|
|
4229
|
+
* @export
|
|
4230
|
+
* @interface GetGroupPosts200Response
|
|
4231
|
+
*/
|
|
4232
|
+
export interface GetGroupPosts200Response {
|
|
4233
|
+
/**
|
|
4234
|
+
*
|
|
4235
|
+
* @type {Array<GroupPost>}
|
|
4236
|
+
* @memberof GetGroupPosts200Response
|
|
4237
|
+
*/
|
|
4238
|
+
'posts'?: Array<GroupPost>;
|
|
4239
|
+
}
|
|
3780
4240
|
/**
|
|
3781
4241
|
*
|
|
3782
4242
|
* @export
|
|
@@ -4970,6 +5430,68 @@ export declare const GroupRoleTemplate: {
|
|
|
4970
5430
|
readonly ManagedRequest: "managedRequest";
|
|
4971
5431
|
};
|
|
4972
5432
|
export type GroupRoleTemplate = typeof GroupRoleTemplate[keyof typeof GroupRoleTemplate];
|
|
5433
|
+
/**
|
|
5434
|
+
*
|
|
5435
|
+
* @export
|
|
5436
|
+
* @interface GroupRoleTemplateValues
|
|
5437
|
+
*/
|
|
5438
|
+
export interface GroupRoleTemplateValues {
|
|
5439
|
+
/**
|
|
5440
|
+
*
|
|
5441
|
+
* @type {Array<GroupPermissions>}
|
|
5442
|
+
* @memberof GroupRoleTemplateValues
|
|
5443
|
+
*/
|
|
5444
|
+
'basePermissions': Array<GroupPermissions>;
|
|
5445
|
+
/**
|
|
5446
|
+
*
|
|
5447
|
+
* @type {string}
|
|
5448
|
+
* @memberof GroupRoleTemplateValues
|
|
5449
|
+
*/
|
|
5450
|
+
'description': string;
|
|
5451
|
+
/**
|
|
5452
|
+
*
|
|
5453
|
+
* @type {string}
|
|
5454
|
+
* @memberof GroupRoleTemplateValues
|
|
5455
|
+
*/
|
|
5456
|
+
'name': string;
|
|
5457
|
+
/**
|
|
5458
|
+
*
|
|
5459
|
+
* @type {GroupRoleTemplateValuesRoles}
|
|
5460
|
+
* @memberof GroupRoleTemplateValues
|
|
5461
|
+
*/
|
|
5462
|
+
'roles': GroupRoleTemplateValuesRoles;
|
|
5463
|
+
}
|
|
5464
|
+
/**
|
|
5465
|
+
*
|
|
5466
|
+
* @export
|
|
5467
|
+
* @interface GroupRoleTemplateValuesRoles
|
|
5468
|
+
*/
|
|
5469
|
+
export interface GroupRoleTemplateValuesRoles {
|
|
5470
|
+
/**
|
|
5471
|
+
*
|
|
5472
|
+
* @type {string}
|
|
5473
|
+
* @memberof GroupRoleTemplateValuesRoles
|
|
5474
|
+
*/
|
|
5475
|
+
'description'?: string;
|
|
5476
|
+
/**
|
|
5477
|
+
*
|
|
5478
|
+
* @type {string}
|
|
5479
|
+
* @memberof GroupRoleTemplateValuesRoles
|
|
5480
|
+
*/
|
|
5481
|
+
'name'?: string;
|
|
5482
|
+
/**
|
|
5483
|
+
*
|
|
5484
|
+
* @type {Array<GroupPermissions>}
|
|
5485
|
+
* @memberof GroupRoleTemplateValuesRoles
|
|
5486
|
+
*/
|
|
5487
|
+
'basePermissions'?: Array<GroupPermissions>;
|
|
5488
|
+
/**
|
|
5489
|
+
*
|
|
5490
|
+
* @type {boolean}
|
|
5491
|
+
* @memberof GroupRoleTemplateValuesRoles
|
|
5492
|
+
*/
|
|
5493
|
+
'isAddedOnJoin'?: boolean;
|
|
5494
|
+
}
|
|
4973
5495
|
/**
|
|
4974
5496
|
*
|
|
4975
5497
|
* @export
|
|
@@ -5220,6 +5742,12 @@ export interface Instance {
|
|
|
5220
5742
|
* @deprecated
|
|
5221
5743
|
*/
|
|
5222
5744
|
'clientNumber': string;
|
|
5745
|
+
/**
|
|
5746
|
+
*
|
|
5747
|
+
* @type {InstanceContentSettings}
|
|
5748
|
+
* @memberof Instance
|
|
5749
|
+
*/
|
|
5750
|
+
'contentSettings': InstanceContentSettings;
|
|
5223
5751
|
/**
|
|
5224
5752
|
*
|
|
5225
5753
|
* @type {string}
|
|
@@ -5237,7 +5765,7 @@ export interface Instance {
|
|
|
5237
5765
|
* @type {number}
|
|
5238
5766
|
* @memberof Instance
|
|
5239
5767
|
*/
|
|
5240
|
-
'gameServerVersion'
|
|
5768
|
+
'gameServerVersion'?: number;
|
|
5241
5769
|
/**
|
|
5242
5770
|
* InstanceID can be \"offline\" on User profiles if you are not friends with that user and \"private\" if you are friends and user is in private instance.
|
|
5243
5771
|
* @type {string}
|
|
@@ -5437,6 +5965,43 @@ export interface Instance {
|
|
|
5437
5965
|
*/
|
|
5438
5966
|
'hardClose'?: boolean | null;
|
|
5439
5967
|
}
|
|
5968
|
+
/**
|
|
5969
|
+
* Types of dynamic user content permitted in an instance
|
|
5970
|
+
* @export
|
|
5971
|
+
* @interface InstanceContentSettings
|
|
5972
|
+
*/
|
|
5973
|
+
export interface InstanceContentSettings {
|
|
5974
|
+
/**
|
|
5975
|
+
*
|
|
5976
|
+
* @type {boolean}
|
|
5977
|
+
* @memberof InstanceContentSettings
|
|
5978
|
+
*/
|
|
5979
|
+
'drones'?: boolean;
|
|
5980
|
+
/**
|
|
5981
|
+
*
|
|
5982
|
+
* @type {boolean}
|
|
5983
|
+
* @memberof InstanceContentSettings
|
|
5984
|
+
*/
|
|
5985
|
+
'emoji'?: boolean;
|
|
5986
|
+
/**
|
|
5987
|
+
*
|
|
5988
|
+
* @type {boolean}
|
|
5989
|
+
* @memberof InstanceContentSettings
|
|
5990
|
+
*/
|
|
5991
|
+
'pedestals'?: boolean;
|
|
5992
|
+
/**
|
|
5993
|
+
*
|
|
5994
|
+
* @type {boolean}
|
|
5995
|
+
* @memberof InstanceContentSettings
|
|
5996
|
+
*/
|
|
5997
|
+
'prints'?: boolean;
|
|
5998
|
+
/**
|
|
5999
|
+
*
|
|
6000
|
+
* @type {boolean}
|
|
6001
|
+
* @memberof InstanceContentSettings
|
|
6002
|
+
*/
|
|
6003
|
+
'stickers'?: boolean;
|
|
6004
|
+
}
|
|
5440
6005
|
/**
|
|
5441
6006
|
*
|
|
5442
6007
|
* @export
|
|
@@ -6195,6 +6760,12 @@ export interface LimitedWorld {
|
|
|
6195
6760
|
* @memberof LimitedWorld
|
|
6196
6761
|
*/
|
|
6197
6762
|
'created_at': string;
|
|
6763
|
+
/**
|
|
6764
|
+
*
|
|
6765
|
+
* @type {InstanceContentSettings}
|
|
6766
|
+
* @memberof LimitedWorld
|
|
6767
|
+
*/
|
|
6768
|
+
'defaultContentSettings'?: InstanceContentSettings;
|
|
6198
6769
|
/**
|
|
6199
6770
|
*
|
|
6200
6771
|
* @type {number}
|
|
@@ -6273,6 +6844,12 @@ export interface LimitedWorld {
|
|
|
6273
6844
|
* @memberof LimitedWorld
|
|
6274
6845
|
*/
|
|
6275
6846
|
'releaseStatus': ReleaseStatus;
|
|
6847
|
+
/**
|
|
6848
|
+
*
|
|
6849
|
+
* @type {string}
|
|
6850
|
+
* @memberof LimitedWorld
|
|
6851
|
+
*/
|
|
6852
|
+
'storeId'?: string;
|
|
6276
6853
|
/**
|
|
6277
6854
|
*
|
|
6278
6855
|
* @type {Array<string>}
|
|
@@ -6350,19 +6927,31 @@ export interface ModelFile {
|
|
|
6350
6927
|
* @type {string}
|
|
6351
6928
|
* @memberof ModelFile
|
|
6352
6929
|
*/
|
|
6353
|
-
'
|
|
6930
|
+
'animationStyle'?: string;
|
|
6354
6931
|
/**
|
|
6355
6932
|
*
|
|
6356
6933
|
* @type {string}
|
|
6357
6934
|
* @memberof ModelFile
|
|
6358
6935
|
*/
|
|
6359
|
-
'
|
|
6936
|
+
'maskTag'?: string;
|
|
6360
6937
|
/**
|
|
6361
6938
|
*
|
|
6362
|
-
* @type {
|
|
6939
|
+
* @type {string}
|
|
6363
6940
|
* @memberof ModelFile
|
|
6364
6941
|
*/
|
|
6365
|
-
'
|
|
6942
|
+
'extension': string;
|
|
6943
|
+
/**
|
|
6944
|
+
*
|
|
6945
|
+
* @type {string}
|
|
6946
|
+
* @memberof ModelFile
|
|
6947
|
+
*/
|
|
6948
|
+
'id': string;
|
|
6949
|
+
/**
|
|
6950
|
+
*
|
|
6951
|
+
* @type {MIMEType}
|
|
6952
|
+
* @memberof ModelFile
|
|
6953
|
+
*/
|
|
6954
|
+
'mimeType': MIMEType;
|
|
6366
6955
|
/**
|
|
6367
6956
|
*
|
|
6368
6957
|
* @type {string}
|
|
@@ -6640,17 +7229,30 @@ export interface PastDisplayName {
|
|
|
6640
7229
|
'updated_at': string;
|
|
6641
7230
|
}
|
|
6642
7231
|
/**
|
|
6643
|
-
*
|
|
7232
|
+
*
|
|
6644
7233
|
* @export
|
|
6645
|
-
* @interface
|
|
7234
|
+
* @interface Pending2FAResult
|
|
6646
7235
|
*/
|
|
6647
|
-
export interface
|
|
7236
|
+
export interface Pending2FAResult {
|
|
6648
7237
|
/**
|
|
6649
7238
|
*
|
|
6650
|
-
* @type {
|
|
6651
|
-
* @memberof
|
|
7239
|
+
* @type {string}
|
|
7240
|
+
* @memberof Pending2FAResult
|
|
7241
|
+
*/
|
|
7242
|
+
'qrCodeDataUrl': string;
|
|
7243
|
+
/**
|
|
7244
|
+
*
|
|
7245
|
+
* @type {string}
|
|
7246
|
+
* @memberof Pending2FAResult
|
|
6652
7247
|
*/
|
|
6653
|
-
'
|
|
7248
|
+
'secret': string;
|
|
7249
|
+
}
|
|
7250
|
+
/**
|
|
7251
|
+
* Info about the performance limits on a platform
|
|
7252
|
+
* @export
|
|
7253
|
+
* @interface PerformanceLimiterInfo
|
|
7254
|
+
*/
|
|
7255
|
+
export interface PerformanceLimiterInfo {
|
|
6654
7256
|
/**
|
|
6655
7257
|
* Maximum amount of seats. -1 means no limit.
|
|
6656
7258
|
* @type {number}
|
|
@@ -6744,7 +7346,7 @@ export interface PlatformBuildInfo {
|
|
|
6744
7346
|
* @type {string}
|
|
6745
7347
|
* @memberof PlatformBuildInfo
|
|
6746
7348
|
*/
|
|
6747
|
-
'redirectionAddress'
|
|
7349
|
+
'redirectionAddress'?: string;
|
|
6748
7350
|
}
|
|
6749
7351
|
/**
|
|
6750
7352
|
*
|
|
@@ -6809,6 +7411,92 @@ export declare const PlayerModerationType: {
|
|
|
6809
7411
|
readonly InteractOff: "interactOff";
|
|
6810
7412
|
};
|
|
6811
7413
|
export type PlayerModerationType = typeof PlayerModerationType[keyof typeof PlayerModerationType];
|
|
7414
|
+
/**
|
|
7415
|
+
* Info about a print
|
|
7416
|
+
* @export
|
|
7417
|
+
* @interface Print
|
|
7418
|
+
*/
|
|
7419
|
+
export interface Print {
|
|
7420
|
+
/**
|
|
7421
|
+
* A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
|
|
7422
|
+
* @type {string}
|
|
7423
|
+
* @memberof Print
|
|
7424
|
+
*/
|
|
7425
|
+
'authorId': string;
|
|
7426
|
+
/**
|
|
7427
|
+
*
|
|
7428
|
+
* @type {string}
|
|
7429
|
+
* @memberof Print
|
|
7430
|
+
*/
|
|
7431
|
+
'authorName': string;
|
|
7432
|
+
/**
|
|
7433
|
+
*
|
|
7434
|
+
* @type {string}
|
|
7435
|
+
* @memberof Print
|
|
7436
|
+
*/
|
|
7437
|
+
'createdAt': string;
|
|
7438
|
+
/**
|
|
7439
|
+
*
|
|
7440
|
+
* @type {PrintFiles}
|
|
7441
|
+
* @memberof Print
|
|
7442
|
+
*/
|
|
7443
|
+
'files': PrintFiles;
|
|
7444
|
+
/**
|
|
7445
|
+
*
|
|
7446
|
+
* @type {string}
|
|
7447
|
+
* @memberof Print
|
|
7448
|
+
*/
|
|
7449
|
+
'id': string;
|
|
7450
|
+
/**
|
|
7451
|
+
*
|
|
7452
|
+
* @type {string}
|
|
7453
|
+
* @memberof Print
|
|
7454
|
+
*/
|
|
7455
|
+
'note': string;
|
|
7456
|
+
/**
|
|
7457
|
+
* A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
|
|
7458
|
+
* @type {string}
|
|
7459
|
+
* @memberof Print
|
|
7460
|
+
*/
|
|
7461
|
+
'ownerId'?: string;
|
|
7462
|
+
/**
|
|
7463
|
+
*
|
|
7464
|
+
* @type {string}
|
|
7465
|
+
* @memberof Print
|
|
7466
|
+
*/
|
|
7467
|
+
'timestamp': string;
|
|
7468
|
+
/**
|
|
7469
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
7470
|
+
* @type {string}
|
|
7471
|
+
* @memberof Print
|
|
7472
|
+
*/
|
|
7473
|
+
'worldId': string;
|
|
7474
|
+
/**
|
|
7475
|
+
*
|
|
7476
|
+
* @type {string}
|
|
7477
|
+
* @memberof Print
|
|
7478
|
+
*/
|
|
7479
|
+
'worldName': string;
|
|
7480
|
+
}
|
|
7481
|
+
/**
|
|
7482
|
+
*
|
|
7483
|
+
* @export
|
|
7484
|
+
* @interface PrintFiles
|
|
7485
|
+
*/
|
|
7486
|
+
export interface PrintFiles {
|
|
7487
|
+
/**
|
|
7488
|
+
*
|
|
7489
|
+
* @type {string}
|
|
7490
|
+
* @memberof PrintFiles
|
|
7491
|
+
*/
|
|
7492
|
+
'fileId'?: string;
|
|
7493
|
+
/**
|
|
7494
|
+
* Link to file, e.g. https://api.vrchat.cloud/api/1/file/file_66fe782d-f2bd-4462-9761-1d766d7b2b26/1/file
|
|
7495
|
+
* @type {string}
|
|
7496
|
+
* @memberof PrintFiles
|
|
7497
|
+
*/
|
|
7498
|
+
'image'?: string;
|
|
7499
|
+
}
|
|
6812
7500
|
/**
|
|
6813
7501
|
*
|
|
6814
7502
|
* @export
|
|
@@ -7189,6 +7877,67 @@ export declare const Region: {
|
|
|
7189
7877
|
readonly Unknown: "unknown";
|
|
7190
7878
|
};
|
|
7191
7879
|
export type Region = typeof Region[keyof typeof Region];
|
|
7880
|
+
/**
|
|
7881
|
+
*
|
|
7882
|
+
* @export
|
|
7883
|
+
* @interface RegisterUserAccountRequest
|
|
7884
|
+
*/
|
|
7885
|
+
export interface RegisterUserAccountRequest {
|
|
7886
|
+
/**
|
|
7887
|
+
* Display Name / Username (Username is a sanitized version)
|
|
7888
|
+
* @type {string}
|
|
7889
|
+
* @memberof RegisterUserAccountRequest
|
|
7890
|
+
*/
|
|
7891
|
+
'username': string;
|
|
7892
|
+
/**
|
|
7893
|
+
* Password
|
|
7894
|
+
* @type {string}
|
|
7895
|
+
* @memberof RegisterUserAccountRequest
|
|
7896
|
+
*/
|
|
7897
|
+
'password': string;
|
|
7898
|
+
/**
|
|
7899
|
+
* Email address
|
|
7900
|
+
* @type {string}
|
|
7901
|
+
* @memberof RegisterUserAccountRequest
|
|
7902
|
+
*/
|
|
7903
|
+
'email': string;
|
|
7904
|
+
/**
|
|
7905
|
+
* Birth year
|
|
7906
|
+
* @type {string}
|
|
7907
|
+
* @memberof RegisterUserAccountRequest
|
|
7908
|
+
*/
|
|
7909
|
+
'year': string;
|
|
7910
|
+
/**
|
|
7911
|
+
* Birth month of year
|
|
7912
|
+
* @type {string}
|
|
7913
|
+
* @memberof RegisterUserAccountRequest
|
|
7914
|
+
*/
|
|
7915
|
+
'month': string;
|
|
7916
|
+
/**
|
|
7917
|
+
* Birth day of month
|
|
7918
|
+
* @type {string}
|
|
7919
|
+
* @memberof RegisterUserAccountRequest
|
|
7920
|
+
*/
|
|
7921
|
+
'day': string;
|
|
7922
|
+
/**
|
|
7923
|
+
* Captcha code
|
|
7924
|
+
* @type {string}
|
|
7925
|
+
* @memberof RegisterUserAccountRequest
|
|
7926
|
+
*/
|
|
7927
|
+
'captchaCode': string;
|
|
7928
|
+
/**
|
|
7929
|
+
* Whether to recieve promotional emails
|
|
7930
|
+
* @type {boolean}
|
|
7931
|
+
* @memberof RegisterUserAccountRequest
|
|
7932
|
+
*/
|
|
7933
|
+
'subscribe': boolean;
|
|
7934
|
+
/**
|
|
7935
|
+
* The most recent version of the TOS
|
|
7936
|
+
* @type {number}
|
|
7937
|
+
* @memberof RegisterUserAccountRequest
|
|
7938
|
+
*/
|
|
7939
|
+
'acceptedTOSVersion': number;
|
|
7940
|
+
}
|
|
7192
7941
|
/**
|
|
7193
7942
|
*
|
|
7194
7943
|
* @export
|
|
@@ -7207,6 +7956,18 @@ export type ReleaseStatus = typeof ReleaseStatus[keyof typeof ReleaseStatus];
|
|
|
7207
7956
|
* @interface ReportCategory
|
|
7208
7957
|
*/
|
|
7209
7958
|
export interface ReportCategory {
|
|
7959
|
+
/**
|
|
7960
|
+
* The description of the report category
|
|
7961
|
+
* @type {string}
|
|
7962
|
+
* @memberof ReportCategory
|
|
7963
|
+
*/
|
|
7964
|
+
'description'?: string;
|
|
7965
|
+
/**
|
|
7966
|
+
* The title of the report category
|
|
7967
|
+
* @type {string}
|
|
7968
|
+
* @memberof ReportCategory
|
|
7969
|
+
*/
|
|
7970
|
+
'title'?: string;
|
|
7210
7971
|
/**
|
|
7211
7972
|
* The label of the report category
|
|
7212
7973
|
* @type {string}
|
|
@@ -7437,6 +8198,80 @@ export interface SentNotification {
|
|
|
7437
8198
|
*/
|
|
7438
8199
|
'type': NotificationType;
|
|
7439
8200
|
}
|
|
8201
|
+
/**
|
|
8202
|
+
* Statistics about the user\'s currently queued service request
|
|
8203
|
+
* @export
|
|
8204
|
+
* @interface ServiceQueueStats
|
|
8205
|
+
*/
|
|
8206
|
+
export interface ServiceQueueStats {
|
|
8207
|
+
/**
|
|
8208
|
+
*
|
|
8209
|
+
* @type {number}
|
|
8210
|
+
* @memberof ServiceQueueStats
|
|
8211
|
+
*/
|
|
8212
|
+
'estimatedServiceDurationSeconds': number;
|
|
8213
|
+
}
|
|
8214
|
+
/**
|
|
8215
|
+
* Status information for a service request
|
|
8216
|
+
* @export
|
|
8217
|
+
* @interface ServiceStatus
|
|
8218
|
+
*/
|
|
8219
|
+
export interface ServiceStatus {
|
|
8220
|
+
/**
|
|
8221
|
+
*
|
|
8222
|
+
* @type {string}
|
|
8223
|
+
* @memberof ServiceStatus
|
|
8224
|
+
*/
|
|
8225
|
+
'created_at': string;
|
|
8226
|
+
/**
|
|
8227
|
+
* The id of this service, NOT the id of the thing this service was requested for.
|
|
8228
|
+
* @type {string}
|
|
8229
|
+
* @memberof ServiceStatus
|
|
8230
|
+
*/
|
|
8231
|
+
'id': string;
|
|
8232
|
+
/**
|
|
8233
|
+
*
|
|
8234
|
+
* @type {Array<object>}
|
|
8235
|
+
* @memberof ServiceStatus
|
|
8236
|
+
*/
|
|
8237
|
+
'progress': Array<object>;
|
|
8238
|
+
/**
|
|
8239
|
+
* A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
|
|
8240
|
+
* @type {string}
|
|
8241
|
+
* @memberof ServiceStatus
|
|
8242
|
+
*/
|
|
8243
|
+
'requesterUserId': string;
|
|
8244
|
+
/**
|
|
8245
|
+
*
|
|
8246
|
+
* @type {string}
|
|
8247
|
+
* @memberof ServiceStatus
|
|
8248
|
+
*/
|
|
8249
|
+
'state': string;
|
|
8250
|
+
/**
|
|
8251
|
+
* The id of the thing this service was requested for.
|
|
8252
|
+
* @type {string}
|
|
8253
|
+
* @memberof ServiceStatus
|
|
8254
|
+
*/
|
|
8255
|
+
'subjectId': string;
|
|
8256
|
+
/**
|
|
8257
|
+
* The kind of the thing this service was requested for.
|
|
8258
|
+
* @type {string}
|
|
8259
|
+
* @memberof ServiceStatus
|
|
8260
|
+
*/
|
|
8261
|
+
'subjectType': string;
|
|
8262
|
+
/**
|
|
8263
|
+
* The kind of service that was requested.
|
|
8264
|
+
* @type {string}
|
|
8265
|
+
* @memberof ServiceStatus
|
|
8266
|
+
*/
|
|
8267
|
+
'type': string;
|
|
8268
|
+
/**
|
|
8269
|
+
*
|
|
8270
|
+
* @type {string}
|
|
8271
|
+
* @memberof ServiceStatus
|
|
8272
|
+
*/
|
|
8273
|
+
'updated_at': string;
|
|
8274
|
+
}
|
|
7440
8275
|
/**
|
|
7441
8276
|
*
|
|
7442
8277
|
* @export
|
|
@@ -7617,6 +8452,24 @@ export interface TiliaStatus {
|
|
|
7617
8452
|
* @memberof TiliaStatus
|
|
7618
8453
|
*/
|
|
7619
8454
|
'economyOnline': boolean;
|
|
8455
|
+
/**
|
|
8456
|
+
*
|
|
8457
|
+
* @type {number}
|
|
8458
|
+
* @memberof TiliaStatus
|
|
8459
|
+
*/
|
|
8460
|
+
'economyState'?: number;
|
|
8461
|
+
/**
|
|
8462
|
+
*
|
|
8463
|
+
* @type {string}
|
|
8464
|
+
* @memberof TiliaStatus
|
|
8465
|
+
*/
|
|
8466
|
+
'plannedOfflineWindowStart'?: string;
|
|
8467
|
+
/**
|
|
8468
|
+
*
|
|
8469
|
+
* @type {string}
|
|
8470
|
+
* @memberof TiliaStatus
|
|
8471
|
+
*/
|
|
8472
|
+
'plannedOfflineWindowEnd'?: string;
|
|
7620
8473
|
}
|
|
7621
8474
|
/**
|
|
7622
8475
|
*
|
|
@@ -7986,6 +8839,44 @@ export interface TwoFactorEmailCode {
|
|
|
7986
8839
|
*/
|
|
7987
8840
|
'code': string;
|
|
7988
8841
|
}
|
|
8842
|
+
/**
|
|
8843
|
+
*
|
|
8844
|
+
* @export
|
|
8845
|
+
* @interface TwoFactorRecoveryCodes
|
|
8846
|
+
*/
|
|
8847
|
+
export interface TwoFactorRecoveryCodes {
|
|
8848
|
+
/**
|
|
8849
|
+
*
|
|
8850
|
+
* @type {Array<string>}
|
|
8851
|
+
* @memberof TwoFactorRecoveryCodes
|
|
8852
|
+
*/
|
|
8853
|
+
'requiresTwoFactorAuth'?: Array<string>;
|
|
8854
|
+
/**
|
|
8855
|
+
*
|
|
8856
|
+
* @type {Array<TwoFactorRecoveryCodesOtpInner>}
|
|
8857
|
+
* @memberof TwoFactorRecoveryCodes
|
|
8858
|
+
*/
|
|
8859
|
+
'otp'?: Array<TwoFactorRecoveryCodesOtpInner>;
|
|
8860
|
+
}
|
|
8861
|
+
/**
|
|
8862
|
+
*
|
|
8863
|
+
* @export
|
|
8864
|
+
* @interface TwoFactorRecoveryCodesOtpInner
|
|
8865
|
+
*/
|
|
8866
|
+
export interface TwoFactorRecoveryCodesOtpInner {
|
|
8867
|
+
/**
|
|
8868
|
+
*
|
|
8869
|
+
* @type {string}
|
|
8870
|
+
* @memberof TwoFactorRecoveryCodesOtpInner
|
|
8871
|
+
*/
|
|
8872
|
+
'code': string;
|
|
8873
|
+
/**
|
|
8874
|
+
*
|
|
8875
|
+
* @type {boolean}
|
|
8876
|
+
* @memberof TwoFactorRecoveryCodesOtpInner
|
|
8877
|
+
*/
|
|
8878
|
+
'used': boolean;
|
|
8879
|
+
}
|
|
7989
8880
|
/**
|
|
7990
8881
|
*
|
|
7991
8882
|
* @export
|
|
@@ -8372,6 +9263,25 @@ export interface UpdateInviteMessageRequest {
|
|
|
8372
9263
|
*/
|
|
8373
9264
|
'message': string;
|
|
8374
9265
|
}
|
|
9266
|
+
/**
|
|
9267
|
+
*
|
|
9268
|
+
* @export
|
|
9269
|
+
* @interface UpdateUserBadgeRequest
|
|
9270
|
+
*/
|
|
9271
|
+
export interface UpdateUserBadgeRequest {
|
|
9272
|
+
/**
|
|
9273
|
+
*
|
|
9274
|
+
* @type {boolean}
|
|
9275
|
+
* @memberof UpdateUserBadgeRequest
|
|
9276
|
+
*/
|
|
9277
|
+
'hidden'?: boolean;
|
|
9278
|
+
/**
|
|
9279
|
+
*
|
|
9280
|
+
* @type {boolean}
|
|
9281
|
+
* @memberof UpdateUserBadgeRequest
|
|
9282
|
+
*/
|
|
9283
|
+
'showcased'?: boolean;
|
|
9284
|
+
}
|
|
8375
9285
|
/**
|
|
8376
9286
|
*
|
|
8377
9287
|
* @export
|
|
@@ -8403,6 +9313,12 @@ export interface UpdateUserRequest {
|
|
|
8403
9313
|
* @memberof UpdateUserRequest
|
|
8404
9314
|
*/
|
|
8405
9315
|
'email'?: string;
|
|
9316
|
+
/**
|
|
9317
|
+
*
|
|
9318
|
+
* @type {boolean}
|
|
9319
|
+
* @memberof UpdateUserRequest
|
|
9320
|
+
*/
|
|
9321
|
+
'unsubscribe'?: boolean;
|
|
8406
9322
|
/**
|
|
8407
9323
|
*
|
|
8408
9324
|
* @type {string}
|
|
@@ -8463,17 +9379,47 @@ export interface UpdateUserRequest {
|
|
|
8463
9379
|
* @memberof UpdateUserRequest
|
|
8464
9380
|
*/
|
|
8465
9381
|
'userIcon'?: string;
|
|
8466
|
-
}
|
|
8467
|
-
/**
|
|
8468
|
-
*
|
|
8469
|
-
* @export
|
|
8470
|
-
* @interface UpdateWorldRequest
|
|
8471
|
-
*/
|
|
8472
|
-
export interface UpdateWorldRequest {
|
|
8473
9382
|
/**
|
|
8474
|
-
*
|
|
8475
|
-
* @type {string}
|
|
8476
|
-
* @memberof
|
|
9383
|
+
* These tags begin with `content_` and control content gating
|
|
9384
|
+
* @type {Array<string>}
|
|
9385
|
+
* @memberof UpdateUserRequest
|
|
9386
|
+
*/
|
|
9387
|
+
'contentFilters'?: Array<string>;
|
|
9388
|
+
/**
|
|
9389
|
+
* MUST specify currentPassword as well to change display name
|
|
9390
|
+
* @type {string}
|
|
9391
|
+
* @memberof UpdateUserRequest
|
|
9392
|
+
*/
|
|
9393
|
+
'displayName'?: string;
|
|
9394
|
+
/**
|
|
9395
|
+
* MUST specify currentPassword as well to revert display name
|
|
9396
|
+
* @type {boolean}
|
|
9397
|
+
* @memberof UpdateUserRequest
|
|
9398
|
+
*/
|
|
9399
|
+
'revertDisplayName'?: boolean;
|
|
9400
|
+
/**
|
|
9401
|
+
* MUST specify currentPassword as well to change password
|
|
9402
|
+
* @type {string}
|
|
9403
|
+
* @memberof UpdateUserRequest
|
|
9404
|
+
*/
|
|
9405
|
+
'password'?: string;
|
|
9406
|
+
/**
|
|
9407
|
+
*
|
|
9408
|
+
* @type {string}
|
|
9409
|
+
* @memberof UpdateUserRequest
|
|
9410
|
+
*/
|
|
9411
|
+
'currentPassword'?: string;
|
|
9412
|
+
}
|
|
9413
|
+
/**
|
|
9414
|
+
*
|
|
9415
|
+
* @export
|
|
9416
|
+
* @interface UpdateWorldRequest
|
|
9417
|
+
*/
|
|
9418
|
+
export interface UpdateWorldRequest {
|
|
9419
|
+
/**
|
|
9420
|
+
*
|
|
9421
|
+
* @type {string}
|
|
9422
|
+
* @memberof UpdateWorldRequest
|
|
8477
9423
|
*/
|
|
8478
9424
|
'assetUrl'?: string;
|
|
8479
9425
|
/**
|
|
@@ -8561,6 +9507,12 @@ export interface User {
|
|
|
8561
9507
|
* @memberof User
|
|
8562
9508
|
*/
|
|
8563
9509
|
'ageVerificationStatus': AgeVerificationStatus;
|
|
9510
|
+
/**
|
|
9511
|
+
* `true` if, user is age verified (not 18+).
|
|
9512
|
+
* @type {boolean}
|
|
9513
|
+
* @memberof User
|
|
9514
|
+
*/
|
|
9515
|
+
'ageVerified': boolean;
|
|
8564
9516
|
/**
|
|
8565
9517
|
*
|
|
8566
9518
|
* @type {boolean}
|
|
@@ -9036,6 +9988,12 @@ export interface Verify2FAResult {
|
|
|
9036
9988
|
* @memberof Verify2FAResult
|
|
9037
9989
|
*/
|
|
9038
9990
|
'verified': boolean;
|
|
9991
|
+
/**
|
|
9992
|
+
*
|
|
9993
|
+
* @type {boolean}
|
|
9994
|
+
* @memberof Verify2FAResult
|
|
9995
|
+
*/
|
|
9996
|
+
'enabled'?: boolean;
|
|
9039
9997
|
}
|
|
9040
9998
|
/**
|
|
9041
9999
|
*
|
|
@@ -9092,6 +10050,12 @@ export interface World {
|
|
|
9092
10050
|
* @memberof World
|
|
9093
10051
|
*/
|
|
9094
10052
|
'created_at': string;
|
|
10053
|
+
/**
|
|
10054
|
+
*
|
|
10055
|
+
* @type {InstanceContentSettings}
|
|
10056
|
+
* @memberof World
|
|
10057
|
+
*/
|
|
10058
|
+
'defaultContentSettings'?: InstanceContentSettings;
|
|
9095
10059
|
/**
|
|
9096
10060
|
*
|
|
9097
10061
|
* @type {string}
|
|
@@ -9200,6 +10164,12 @@ export interface World {
|
|
|
9200
10164
|
* @memberof World
|
|
9201
10165
|
*/
|
|
9202
10166
|
'releaseStatus': ReleaseStatus;
|
|
10167
|
+
/**
|
|
10168
|
+
*
|
|
10169
|
+
* @type {string}
|
|
10170
|
+
* @memberof World
|
|
10171
|
+
*/
|
|
10172
|
+
'storeId'?: string;
|
|
9203
10173
|
/**
|
|
9204
10174
|
*
|
|
9205
10175
|
* @type {Array<string>}
|
|
@@ -9286,6 +10256,13 @@ export interface WorldPublishStatus {
|
|
|
9286
10256
|
* @export
|
|
9287
10257
|
*/
|
|
9288
10258
|
export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
10259
|
+
/**
|
|
10260
|
+
* Cancels the sequence for enabling time-based 2FA.
|
|
10261
|
+
* @summary Cancel pending enabling of time-based 2FA codes
|
|
10262
|
+
* @param {*} [options] Override http request option.
|
|
10263
|
+
* @throws {RequiredError}
|
|
10264
|
+
*/
|
|
10265
|
+
cancelPending2FA: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9289
10266
|
/**
|
|
9290
10267
|
* Checks if a user by a given `username`, `displayName` or `email` exist. This is used during registration to check if a username has already been taken, during change of displayName to check if a displayName is available, and during change of email to check if the email is already used. In the later two cases the `excludeUserId` is used to exclude oneself, otherwise the result would always be true. It is **REQUIRED** to include **AT LEAST** `username`, `displayName` **or** `email` query parameter. Although they can be combined - in addition with `excludeUserId` (generally to exclude yourself) - to further fine-tune the search.
|
|
9291
10268
|
* @summary Check User Exists
|
|
@@ -9297,6 +10274,15 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
9297
10274
|
* @throws {RequiredError}
|
|
9298
10275
|
*/
|
|
9299
10276
|
checkUserExists: (email?: string, displayName?: string, username?: string, excludeUserId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10277
|
+
/**
|
|
10278
|
+
* Confirms the email address for a user
|
|
10279
|
+
* @summary Confirm Email
|
|
10280
|
+
* @param {string} id Target user for which to verify email.
|
|
10281
|
+
* @param {string} verifyEmail Token to verify email.
|
|
10282
|
+
* @param {*} [options] Override http request option.
|
|
10283
|
+
* @throws {RequiredError}
|
|
10284
|
+
*/
|
|
10285
|
+
confirmEmail: (id: string, verifyEmail: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9300
10286
|
/**
|
|
9301
10287
|
* Deletes the account with given ID. Normal users only have permission to delete their own account. Account deletion is 14 days from this request, and will be cancelled if you do an authenticated request with the account afterwards. **VRC+ NOTE:** Despite the 14-days cooldown, any VRC+ subscription will be cancelled **immediately**. **METHOD NOTE:** Despite this being a Delete action, the method type required is PUT.
|
|
9302
10288
|
* @summary Delete User
|
|
@@ -9305,6 +10291,20 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
9305
10291
|
* @throws {RequiredError}
|
|
9306
10292
|
*/
|
|
9307
10293
|
deleteUser: (userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10294
|
+
/**
|
|
10295
|
+
* Disables 2FA for the currently logged in account
|
|
10296
|
+
* @summary Disable 2FA
|
|
10297
|
+
* @param {*} [options] Override http request option.
|
|
10298
|
+
* @throws {RequiredError}
|
|
10299
|
+
*/
|
|
10300
|
+
disable2FA: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10301
|
+
/**
|
|
10302
|
+
* Begins the sequence for enabling time-based 2FA.
|
|
10303
|
+
* @summary Enable time-based 2FA codes
|
|
10304
|
+
* @param {*} [options] Override http request option.
|
|
10305
|
+
* @throws {RequiredError}
|
|
10306
|
+
*/
|
|
10307
|
+
enable2FA: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9308
10308
|
/**
|
|
9309
10309
|
* This endpoint does the following two operations: 1) Checks if you are already logged in by looking for a valid `auth` cookie. If you are have a valid auth cookie then no additional auth-related actions are taken. If you are **not** logged in then it will log you in with the `Authorization` header and set the `auth` cookie. The `auth` cookie will only be sent once. 2) If logged in, this function will also return the CurrentUser object containing detailed information about the currently logged in user. The auth string after `Authorization: Basic {string}` is a base64-encoded string of the username and password, both individually url-encoded, and then joined with a colon. > base64(urlencode(username):urlencode(password)) **WARNING: Session Limit:** Each authentication with login credentials counts as a separate session, out of which you have a limited amount. Make sure to save and reuse the `auth` cookie if you are often restarting the program. The provided API libraries automatically save cookies during runtime, but does not persist during restart. While it can be fine to use username/password during development, expect in production to very fast run into the rate-limit and be temporarily blocked from making new sessions until older ones expire. The exact number of simultaneous sessions is unknown/undisclosed.
|
|
9310
10310
|
* @summary Login and/or Get Current User Info
|
|
@@ -9312,6 +10312,13 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
9312
10312
|
* @throws {RequiredError}
|
|
9313
10313
|
*/
|
|
9314
10314
|
getCurrentUser: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10315
|
+
/**
|
|
10316
|
+
* Gets the OTP (One Time Password) recovery codes for accounts with 2FA-protection enabled.
|
|
10317
|
+
* @summary Get 2FA Recovery codes
|
|
10318
|
+
* @param {*} [options] Override http request option.
|
|
10319
|
+
* @throws {RequiredError}
|
|
10320
|
+
*/
|
|
10321
|
+
getRecoveryCodes: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9315
10322
|
/**
|
|
9316
10323
|
* Invalidates the login session.
|
|
9317
10324
|
* @summary Logout
|
|
@@ -9319,6 +10326,22 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
9319
10326
|
* @throws {RequiredError}
|
|
9320
10327
|
*/
|
|
9321
10328
|
logout: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10329
|
+
/**
|
|
10330
|
+
* ~~Register a new user account.~~ **DEPRECATED:** Automated creation of accounts has no legitimate public third-party use case, and would be in violation of ToS §13.2: *By using the Platform, you agree not to: i. [...] use the Platform in a manner inconsistent with individual human usage* This endpoint is documented in the interest of completeness
|
|
10331
|
+
* @summary Register User Account
|
|
10332
|
+
* @param {RegisterUserAccountRequest} registerUserAccountRequest
|
|
10333
|
+
* @param {*} [options] Override http request option.
|
|
10334
|
+
* @deprecated
|
|
10335
|
+
* @throws {RequiredError}
|
|
10336
|
+
*/
|
|
10337
|
+
registerUserAccount: (registerUserAccountRequest: RegisterUserAccountRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10338
|
+
/**
|
|
10339
|
+
* Requests a resend of pending email address confirmation email
|
|
10340
|
+
* @summary Resend Email Confirmation
|
|
10341
|
+
* @param {*} [options] Override http request option.
|
|
10342
|
+
* @throws {RequiredError}
|
|
10343
|
+
*/
|
|
10344
|
+
resendEmailConfirmation: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9322
10345
|
/**
|
|
9323
10346
|
* Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
|
|
9324
10347
|
* @summary Verify 2FA code
|
|
@@ -9342,6 +10365,23 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
9342
10365
|
* @throws {RequiredError}
|
|
9343
10366
|
*/
|
|
9344
10367
|
verifyAuthToken: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10368
|
+
/**
|
|
10369
|
+
* Verifies a login attempt for a user
|
|
10370
|
+
* @summary Verify Login Place
|
|
10371
|
+
* @param {string} token Token to verify login attempt.
|
|
10372
|
+
* @param {string} [userId] Filter by UserID.
|
|
10373
|
+
* @param {*} [options] Override http request option.
|
|
10374
|
+
* @throws {RequiredError}
|
|
10375
|
+
*/
|
|
10376
|
+
verifyLoginPlace: (token: string, userId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10377
|
+
/**
|
|
10378
|
+
* Finishes sequence for enabling time-based 2FA.
|
|
10379
|
+
* @summary Verify Pending 2FA code
|
|
10380
|
+
* @param {TwoFactorAuthCode} twoFactorAuthCode
|
|
10381
|
+
* @param {*} [options] Override http request option.
|
|
10382
|
+
* @throws {RequiredError}
|
|
10383
|
+
*/
|
|
10384
|
+
verifyPending2FA: (twoFactorAuthCode: TwoFactorAuthCode, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9345
10385
|
/**
|
|
9346
10386
|
* Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
|
|
9347
10387
|
* @summary Verify 2FA code with Recovery code
|
|
@@ -9356,6 +10396,13 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
9356
10396
|
* @export
|
|
9357
10397
|
*/
|
|
9358
10398
|
export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
10399
|
+
/**
|
|
10400
|
+
* Cancels the sequence for enabling time-based 2FA.
|
|
10401
|
+
* @summary Cancel pending enabling of time-based 2FA codes
|
|
10402
|
+
* @param {*} [options] Override http request option.
|
|
10403
|
+
* @throws {RequiredError}
|
|
10404
|
+
*/
|
|
10405
|
+
cancelPending2FA(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Disable2FAResult>>;
|
|
9359
10406
|
/**
|
|
9360
10407
|
* Checks if a user by a given `username`, `displayName` or `email` exist. This is used during registration to check if a username has already been taken, during change of displayName to check if a displayName is available, and during change of email to check if the email is already used. In the later two cases the `excludeUserId` is used to exclude oneself, otherwise the result would always be true. It is **REQUIRED** to include **AT LEAST** `username`, `displayName` **or** `email` query parameter. Although they can be combined - in addition with `excludeUserId` (generally to exclude yourself) - to further fine-tune the search.
|
|
9361
10408
|
* @summary Check User Exists
|
|
@@ -9367,6 +10414,15 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
9367
10414
|
* @throws {RequiredError}
|
|
9368
10415
|
*/
|
|
9369
10416
|
checkUserExists(email?: string, displayName?: string, username?: string, excludeUserId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserExists>>;
|
|
10417
|
+
/**
|
|
10418
|
+
* Confirms the email address for a user
|
|
10419
|
+
* @summary Confirm Email
|
|
10420
|
+
* @param {string} id Target user for which to verify email.
|
|
10421
|
+
* @param {string} verifyEmail Token to verify email.
|
|
10422
|
+
* @param {*} [options] Override http request option.
|
|
10423
|
+
* @throws {RequiredError}
|
|
10424
|
+
*/
|
|
10425
|
+
confirmEmail(id: string, verifyEmail: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9370
10426
|
/**
|
|
9371
10427
|
* Deletes the account with given ID. Normal users only have permission to delete their own account. Account deletion is 14 days from this request, and will be cancelled if you do an authenticated request with the account afterwards. **VRC+ NOTE:** Despite the 14-days cooldown, any VRC+ subscription will be cancelled **immediately**. **METHOD NOTE:** Despite this being a Delete action, the method type required is PUT.
|
|
9372
10428
|
* @summary Delete User
|
|
@@ -9375,6 +10431,20 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
9375
10431
|
* @throws {RequiredError}
|
|
9376
10432
|
*/
|
|
9377
10433
|
deleteUser(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>>;
|
|
10434
|
+
/**
|
|
10435
|
+
* Disables 2FA for the currently logged in account
|
|
10436
|
+
* @summary Disable 2FA
|
|
10437
|
+
* @param {*} [options] Override http request option.
|
|
10438
|
+
* @throws {RequiredError}
|
|
10439
|
+
*/
|
|
10440
|
+
disable2FA(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Disable2FAResult>>;
|
|
10441
|
+
/**
|
|
10442
|
+
* Begins the sequence for enabling time-based 2FA.
|
|
10443
|
+
* @summary Enable time-based 2FA codes
|
|
10444
|
+
* @param {*} [options] Override http request option.
|
|
10445
|
+
* @throws {RequiredError}
|
|
10446
|
+
*/
|
|
10447
|
+
enable2FA(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pending2FAResult>>;
|
|
9378
10448
|
/**
|
|
9379
10449
|
* This endpoint does the following two operations: 1) Checks if you are already logged in by looking for a valid `auth` cookie. If you are have a valid auth cookie then no additional auth-related actions are taken. If you are **not** logged in then it will log you in with the `Authorization` header and set the `auth` cookie. The `auth` cookie will only be sent once. 2) If logged in, this function will also return the CurrentUser object containing detailed information about the currently logged in user. The auth string after `Authorization: Basic {string}` is a base64-encoded string of the username and password, both individually url-encoded, and then joined with a colon. > base64(urlencode(username):urlencode(password)) **WARNING: Session Limit:** Each authentication with login credentials counts as a separate session, out of which you have a limited amount. Make sure to save and reuse the `auth` cookie if you are often restarting the program. The provided API libraries automatically save cookies during runtime, but does not persist during restart. While it can be fine to use username/password during development, expect in production to very fast run into the rate-limit and be temporarily blocked from making new sessions until older ones expire. The exact number of simultaneous sessions is unknown/undisclosed.
|
|
9380
10450
|
* @summary Login and/or Get Current User Info
|
|
@@ -9382,6 +10452,13 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
9382
10452
|
* @throws {RequiredError}
|
|
9383
10453
|
*/
|
|
9384
10454
|
getCurrentUser(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>>;
|
|
10455
|
+
/**
|
|
10456
|
+
* Gets the OTP (One Time Password) recovery codes for accounts with 2FA-protection enabled.
|
|
10457
|
+
* @summary Get 2FA Recovery codes
|
|
10458
|
+
* @param {*} [options] Override http request option.
|
|
10459
|
+
* @throws {RequiredError}
|
|
10460
|
+
*/
|
|
10461
|
+
getRecoveryCodes(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TwoFactorRecoveryCodes>>;
|
|
9385
10462
|
/**
|
|
9386
10463
|
* Invalidates the login session.
|
|
9387
10464
|
* @summary Logout
|
|
@@ -9389,6 +10466,22 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
9389
10466
|
* @throws {RequiredError}
|
|
9390
10467
|
*/
|
|
9391
10468
|
logout(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>>;
|
|
10469
|
+
/**
|
|
10470
|
+
* ~~Register a new user account.~~ **DEPRECATED:** Automated creation of accounts has no legitimate public third-party use case, and would be in violation of ToS §13.2: *By using the Platform, you agree not to: i. [...] use the Platform in a manner inconsistent with individual human usage* This endpoint is documented in the interest of completeness
|
|
10471
|
+
* @summary Register User Account
|
|
10472
|
+
* @param {RegisterUserAccountRequest} registerUserAccountRequest
|
|
10473
|
+
* @param {*} [options] Override http request option.
|
|
10474
|
+
* @deprecated
|
|
10475
|
+
* @throws {RequiredError}
|
|
10476
|
+
*/
|
|
10477
|
+
registerUserAccount(registerUserAccountRequest: RegisterUserAccountRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>>;
|
|
10478
|
+
/**
|
|
10479
|
+
* Requests a resend of pending email address confirmation email
|
|
10480
|
+
* @summary Resend Email Confirmation
|
|
10481
|
+
* @param {*} [options] Override http request option.
|
|
10482
|
+
* @throws {RequiredError}
|
|
10483
|
+
*/
|
|
10484
|
+
resendEmailConfirmation(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>>;
|
|
9392
10485
|
/**
|
|
9393
10486
|
* Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
|
|
9394
10487
|
* @summary Verify 2FA code
|
|
@@ -9412,6 +10505,23 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
9412
10505
|
* @throws {RequiredError}
|
|
9413
10506
|
*/
|
|
9414
10507
|
verifyAuthToken(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VerifyAuthTokenResult>>;
|
|
10508
|
+
/**
|
|
10509
|
+
* Verifies a login attempt for a user
|
|
10510
|
+
* @summary Verify Login Place
|
|
10511
|
+
* @param {string} token Token to verify login attempt.
|
|
10512
|
+
* @param {string} [userId] Filter by UserID.
|
|
10513
|
+
* @param {*} [options] Override http request option.
|
|
10514
|
+
* @throws {RequiredError}
|
|
10515
|
+
*/
|
|
10516
|
+
verifyLoginPlace(token: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
10517
|
+
/**
|
|
10518
|
+
* Finishes sequence for enabling time-based 2FA.
|
|
10519
|
+
* @summary Verify Pending 2FA code
|
|
10520
|
+
* @param {TwoFactorAuthCode} twoFactorAuthCode
|
|
10521
|
+
* @param {*} [options] Override http request option.
|
|
10522
|
+
* @throws {RequiredError}
|
|
10523
|
+
*/
|
|
10524
|
+
verifyPending2FA(twoFactorAuthCode: TwoFactorAuthCode, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Verify2FAResult>>;
|
|
9415
10525
|
/**
|
|
9416
10526
|
* Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
|
|
9417
10527
|
* @summary Verify 2FA code with Recovery code
|
|
@@ -9426,6 +10536,13 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
9426
10536
|
* @export
|
|
9427
10537
|
*/
|
|
9428
10538
|
export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
10539
|
+
/**
|
|
10540
|
+
* Cancels the sequence for enabling time-based 2FA.
|
|
10541
|
+
* @summary Cancel pending enabling of time-based 2FA codes
|
|
10542
|
+
* @param {*} [options] Override http request option.
|
|
10543
|
+
* @throws {RequiredError}
|
|
10544
|
+
*/
|
|
10545
|
+
cancelPending2FA(options?: any): AxiosPromise<Disable2FAResult>;
|
|
9429
10546
|
/**
|
|
9430
10547
|
* Checks if a user by a given `username`, `displayName` or `email` exist. This is used during registration to check if a username has already been taken, during change of displayName to check if a displayName is available, and during change of email to check if the email is already used. In the later two cases the `excludeUserId` is used to exclude oneself, otherwise the result would always be true. It is **REQUIRED** to include **AT LEAST** `username`, `displayName` **or** `email` query parameter. Although they can be combined - in addition with `excludeUserId` (generally to exclude yourself) - to further fine-tune the search.
|
|
9431
10548
|
* @summary Check User Exists
|
|
@@ -9437,6 +10554,15 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
9437
10554
|
* @throws {RequiredError}
|
|
9438
10555
|
*/
|
|
9439
10556
|
checkUserExists(email?: string, displayName?: string, username?: string, excludeUserId?: string, options?: any): AxiosPromise<UserExists>;
|
|
10557
|
+
/**
|
|
10558
|
+
* Confirms the email address for a user
|
|
10559
|
+
* @summary Confirm Email
|
|
10560
|
+
* @param {string} id Target user for which to verify email.
|
|
10561
|
+
* @param {string} verifyEmail Token to verify email.
|
|
10562
|
+
* @param {*} [options] Override http request option.
|
|
10563
|
+
* @throws {RequiredError}
|
|
10564
|
+
*/
|
|
10565
|
+
confirmEmail(id: string, verifyEmail: string, options?: any): AxiosPromise<void>;
|
|
9440
10566
|
/**
|
|
9441
10567
|
* Deletes the account with given ID. Normal users only have permission to delete their own account. Account deletion is 14 days from this request, and will be cancelled if you do an authenticated request with the account afterwards. **VRC+ NOTE:** Despite the 14-days cooldown, any VRC+ subscription will be cancelled **immediately**. **METHOD NOTE:** Despite this being a Delete action, the method type required is PUT.
|
|
9442
10568
|
* @summary Delete User
|
|
@@ -9445,6 +10571,20 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
9445
10571
|
* @throws {RequiredError}
|
|
9446
10572
|
*/
|
|
9447
10573
|
deleteUser(userId: string, options?: any): AxiosPromise<CurrentUser>;
|
|
10574
|
+
/**
|
|
10575
|
+
* Disables 2FA for the currently logged in account
|
|
10576
|
+
* @summary Disable 2FA
|
|
10577
|
+
* @param {*} [options] Override http request option.
|
|
10578
|
+
* @throws {RequiredError}
|
|
10579
|
+
*/
|
|
10580
|
+
disable2FA(options?: any): AxiosPromise<Disable2FAResult>;
|
|
10581
|
+
/**
|
|
10582
|
+
* Begins the sequence for enabling time-based 2FA.
|
|
10583
|
+
* @summary Enable time-based 2FA codes
|
|
10584
|
+
* @param {*} [options] Override http request option.
|
|
10585
|
+
* @throws {RequiredError}
|
|
10586
|
+
*/
|
|
10587
|
+
enable2FA(options?: any): AxiosPromise<Pending2FAResult>;
|
|
9448
10588
|
/**
|
|
9449
10589
|
* This endpoint does the following two operations: 1) Checks if you are already logged in by looking for a valid `auth` cookie. If you are have a valid auth cookie then no additional auth-related actions are taken. If you are **not** logged in then it will log you in with the `Authorization` header and set the `auth` cookie. The `auth` cookie will only be sent once. 2) If logged in, this function will also return the CurrentUser object containing detailed information about the currently logged in user. The auth string after `Authorization: Basic {string}` is a base64-encoded string of the username and password, both individually url-encoded, and then joined with a colon. > base64(urlencode(username):urlencode(password)) **WARNING: Session Limit:** Each authentication with login credentials counts as a separate session, out of which you have a limited amount. Make sure to save and reuse the `auth` cookie if you are often restarting the program. The provided API libraries automatically save cookies during runtime, but does not persist during restart. While it can be fine to use username/password during development, expect in production to very fast run into the rate-limit and be temporarily blocked from making new sessions until older ones expire. The exact number of simultaneous sessions is unknown/undisclosed.
|
|
9450
10590
|
* @summary Login and/or Get Current User Info
|
|
@@ -9452,6 +10592,13 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
9452
10592
|
* @throws {RequiredError}
|
|
9453
10593
|
*/
|
|
9454
10594
|
getCurrentUser(options?: any): AxiosPromise<CurrentUser>;
|
|
10595
|
+
/**
|
|
10596
|
+
* Gets the OTP (One Time Password) recovery codes for accounts with 2FA-protection enabled.
|
|
10597
|
+
* @summary Get 2FA Recovery codes
|
|
10598
|
+
* @param {*} [options] Override http request option.
|
|
10599
|
+
* @throws {RequiredError}
|
|
10600
|
+
*/
|
|
10601
|
+
getRecoveryCodes(options?: any): AxiosPromise<TwoFactorRecoveryCodes>;
|
|
9455
10602
|
/**
|
|
9456
10603
|
* Invalidates the login session.
|
|
9457
10604
|
* @summary Logout
|
|
@@ -9459,6 +10606,22 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
9459
10606
|
* @throws {RequiredError}
|
|
9460
10607
|
*/
|
|
9461
10608
|
logout(options?: any): AxiosPromise<Success>;
|
|
10609
|
+
/**
|
|
10610
|
+
* ~~Register a new user account.~~ **DEPRECATED:** Automated creation of accounts has no legitimate public third-party use case, and would be in violation of ToS §13.2: *By using the Platform, you agree not to: i. [...] use the Platform in a manner inconsistent with individual human usage* This endpoint is documented in the interest of completeness
|
|
10611
|
+
* @summary Register User Account
|
|
10612
|
+
* @param {RegisterUserAccountRequest} registerUserAccountRequest
|
|
10613
|
+
* @param {*} [options] Override http request option.
|
|
10614
|
+
* @deprecated
|
|
10615
|
+
* @throws {RequiredError}
|
|
10616
|
+
*/
|
|
10617
|
+
registerUserAccount(registerUserAccountRequest: RegisterUserAccountRequest, options?: any): AxiosPromise<CurrentUser>;
|
|
10618
|
+
/**
|
|
10619
|
+
* Requests a resend of pending email address confirmation email
|
|
10620
|
+
* @summary Resend Email Confirmation
|
|
10621
|
+
* @param {*} [options] Override http request option.
|
|
10622
|
+
* @throws {RequiredError}
|
|
10623
|
+
*/
|
|
10624
|
+
resendEmailConfirmation(options?: any): AxiosPromise<Success>;
|
|
9462
10625
|
/**
|
|
9463
10626
|
* Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
|
|
9464
10627
|
* @summary Verify 2FA code
|
|
@@ -9482,6 +10645,23 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
9482
10645
|
* @throws {RequiredError}
|
|
9483
10646
|
*/
|
|
9484
10647
|
verifyAuthToken(options?: any): AxiosPromise<VerifyAuthTokenResult>;
|
|
10648
|
+
/**
|
|
10649
|
+
* Verifies a login attempt for a user
|
|
10650
|
+
* @summary Verify Login Place
|
|
10651
|
+
* @param {string} token Token to verify login attempt.
|
|
10652
|
+
* @param {string} [userId] Filter by UserID.
|
|
10653
|
+
* @param {*} [options] Override http request option.
|
|
10654
|
+
* @throws {RequiredError}
|
|
10655
|
+
*/
|
|
10656
|
+
verifyLoginPlace(token: string, userId?: string, options?: any): AxiosPromise<void>;
|
|
10657
|
+
/**
|
|
10658
|
+
* Finishes sequence for enabling time-based 2FA.
|
|
10659
|
+
* @summary Verify Pending 2FA code
|
|
10660
|
+
* @param {TwoFactorAuthCode} twoFactorAuthCode
|
|
10661
|
+
* @param {*} [options] Override http request option.
|
|
10662
|
+
* @throws {RequiredError}
|
|
10663
|
+
*/
|
|
10664
|
+
verifyPending2FA(twoFactorAuthCode: TwoFactorAuthCode, options?: any): AxiosPromise<Verify2FAResult>;
|
|
9485
10665
|
/**
|
|
9486
10666
|
* Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
|
|
9487
10667
|
* @summary Verify 2FA code with Recovery code
|
|
@@ -9498,6 +10678,14 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
9498
10678
|
* @extends {BaseAPI}
|
|
9499
10679
|
*/
|
|
9500
10680
|
export declare class AuthenticationApi extends BaseAPI {
|
|
10681
|
+
/**
|
|
10682
|
+
* Cancels the sequence for enabling time-based 2FA.
|
|
10683
|
+
* @summary Cancel pending enabling of time-based 2FA codes
|
|
10684
|
+
* @param {*} [options] Override http request option.
|
|
10685
|
+
* @throws {RequiredError}
|
|
10686
|
+
* @memberof AuthenticationApi
|
|
10687
|
+
*/
|
|
10688
|
+
cancelPending2FA(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Disable2FAResult, any>>;
|
|
9501
10689
|
/**
|
|
9502
10690
|
* Checks if a user by a given `username`, `displayName` or `email` exist. This is used during registration to check if a username has already been taken, during change of displayName to check if a displayName is available, and during change of email to check if the email is already used. In the later two cases the `excludeUserId` is used to exclude oneself, otherwise the result would always be true. It is **REQUIRED** to include **AT LEAST** `username`, `displayName` **or** `email` query parameter. Although they can be combined - in addition with `excludeUserId` (generally to exclude yourself) - to further fine-tune the search.
|
|
9503
10691
|
* @summary Check User Exists
|
|
@@ -9510,6 +10698,16 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
9510
10698
|
* @memberof AuthenticationApi
|
|
9511
10699
|
*/
|
|
9512
10700
|
checkUserExists(email?: string, displayName?: string, username?: string, excludeUserId?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserExists, any>>;
|
|
10701
|
+
/**
|
|
10702
|
+
* Confirms the email address for a user
|
|
10703
|
+
* @summary Confirm Email
|
|
10704
|
+
* @param {string} id Target user for which to verify email.
|
|
10705
|
+
* @param {string} verifyEmail Token to verify email.
|
|
10706
|
+
* @param {*} [options] Override http request option.
|
|
10707
|
+
* @throws {RequiredError}
|
|
10708
|
+
* @memberof AuthenticationApi
|
|
10709
|
+
*/
|
|
10710
|
+
confirmEmail(id: string, verifyEmail: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9513
10711
|
/**
|
|
9514
10712
|
* Deletes the account with given ID. Normal users only have permission to delete their own account. Account deletion is 14 days from this request, and will be cancelled if you do an authenticated request with the account afterwards. **VRC+ NOTE:** Despite the 14-days cooldown, any VRC+ subscription will be cancelled **immediately**. **METHOD NOTE:** Despite this being a Delete action, the method type required is PUT.
|
|
9515
10713
|
* @summary Delete User
|
|
@@ -9519,6 +10717,22 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
9519
10717
|
* @memberof AuthenticationApi
|
|
9520
10718
|
*/
|
|
9521
10719
|
deleteUser(userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CurrentUser, any>>;
|
|
10720
|
+
/**
|
|
10721
|
+
* Disables 2FA for the currently logged in account
|
|
10722
|
+
* @summary Disable 2FA
|
|
10723
|
+
* @param {*} [options] Override http request option.
|
|
10724
|
+
* @throws {RequiredError}
|
|
10725
|
+
* @memberof AuthenticationApi
|
|
10726
|
+
*/
|
|
10727
|
+
disable2FA(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Disable2FAResult, any>>;
|
|
10728
|
+
/**
|
|
10729
|
+
* Begins the sequence for enabling time-based 2FA.
|
|
10730
|
+
* @summary Enable time-based 2FA codes
|
|
10731
|
+
* @param {*} [options] Override http request option.
|
|
10732
|
+
* @throws {RequiredError}
|
|
10733
|
+
* @memberof AuthenticationApi
|
|
10734
|
+
*/
|
|
10735
|
+
enable2FA(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Pending2FAResult, any>>;
|
|
9522
10736
|
/**
|
|
9523
10737
|
* This endpoint does the following two operations: 1) Checks if you are already logged in by looking for a valid `auth` cookie. If you are have a valid auth cookie then no additional auth-related actions are taken. If you are **not** logged in then it will log you in with the `Authorization` header and set the `auth` cookie. The `auth` cookie will only be sent once. 2) If logged in, this function will also return the CurrentUser object containing detailed information about the currently logged in user. The auth string after `Authorization: Basic {string}` is a base64-encoded string of the username and password, both individually url-encoded, and then joined with a colon. > base64(urlencode(username):urlencode(password)) **WARNING: Session Limit:** Each authentication with login credentials counts as a separate session, out of which you have a limited amount. Make sure to save and reuse the `auth` cookie if you are often restarting the program. The provided API libraries automatically save cookies during runtime, but does not persist during restart. While it can be fine to use username/password during development, expect in production to very fast run into the rate-limit and be temporarily blocked from making new sessions until older ones expire. The exact number of simultaneous sessions is unknown/undisclosed.
|
|
9524
10738
|
* @summary Login and/or Get Current User Info
|
|
@@ -9527,6 +10741,14 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
9527
10741
|
* @memberof AuthenticationApi
|
|
9528
10742
|
*/
|
|
9529
10743
|
getCurrentUser(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CurrentUser, any>>;
|
|
10744
|
+
/**
|
|
10745
|
+
* Gets the OTP (One Time Password) recovery codes for accounts with 2FA-protection enabled.
|
|
10746
|
+
* @summary Get 2FA Recovery codes
|
|
10747
|
+
* @param {*} [options] Override http request option.
|
|
10748
|
+
* @throws {RequiredError}
|
|
10749
|
+
* @memberof AuthenticationApi
|
|
10750
|
+
*/
|
|
10751
|
+
getRecoveryCodes(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TwoFactorRecoveryCodes, any>>;
|
|
9530
10752
|
/**
|
|
9531
10753
|
* Invalidates the login session.
|
|
9532
10754
|
* @summary Logout
|
|
@@ -9535,6 +10757,24 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
9535
10757
|
* @memberof AuthenticationApi
|
|
9536
10758
|
*/
|
|
9537
10759
|
logout(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
10760
|
+
/**
|
|
10761
|
+
* ~~Register a new user account.~~ **DEPRECATED:** Automated creation of accounts has no legitimate public third-party use case, and would be in violation of ToS §13.2: *By using the Platform, you agree not to: i. [...] use the Platform in a manner inconsistent with individual human usage* This endpoint is documented in the interest of completeness
|
|
10762
|
+
* @summary Register User Account
|
|
10763
|
+
* @param {RegisterUserAccountRequest} registerUserAccountRequest
|
|
10764
|
+
* @param {*} [options] Override http request option.
|
|
10765
|
+
* @deprecated
|
|
10766
|
+
* @throws {RequiredError}
|
|
10767
|
+
* @memberof AuthenticationApi
|
|
10768
|
+
*/
|
|
10769
|
+
registerUserAccount(registerUserAccountRequest: RegisterUserAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CurrentUser, any>>;
|
|
10770
|
+
/**
|
|
10771
|
+
* Requests a resend of pending email address confirmation email
|
|
10772
|
+
* @summary Resend Email Confirmation
|
|
10773
|
+
* @param {*} [options] Override http request option.
|
|
10774
|
+
* @throws {RequiredError}
|
|
10775
|
+
* @memberof AuthenticationApi
|
|
10776
|
+
*/
|
|
10777
|
+
resendEmailConfirmation(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
9538
10778
|
/**
|
|
9539
10779
|
* Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
|
|
9540
10780
|
* @summary Verify 2FA code
|
|
@@ -9561,6 +10801,25 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
9561
10801
|
* @memberof AuthenticationApi
|
|
9562
10802
|
*/
|
|
9563
10803
|
verifyAuthToken(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VerifyAuthTokenResult, any>>;
|
|
10804
|
+
/**
|
|
10805
|
+
* Verifies a login attempt for a user
|
|
10806
|
+
* @summary Verify Login Place
|
|
10807
|
+
* @param {string} token Token to verify login attempt.
|
|
10808
|
+
* @param {string} [userId] Filter by UserID.
|
|
10809
|
+
* @param {*} [options] Override http request option.
|
|
10810
|
+
* @throws {RequiredError}
|
|
10811
|
+
* @memberof AuthenticationApi
|
|
10812
|
+
*/
|
|
10813
|
+
verifyLoginPlace(token: string, userId?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
10814
|
+
/**
|
|
10815
|
+
* Finishes sequence for enabling time-based 2FA.
|
|
10816
|
+
* @summary Verify Pending 2FA code
|
|
10817
|
+
* @param {TwoFactorAuthCode} twoFactorAuthCode
|
|
10818
|
+
* @param {*} [options] Override http request option.
|
|
10819
|
+
* @throws {RequiredError}
|
|
10820
|
+
* @memberof AuthenticationApi
|
|
10821
|
+
*/
|
|
10822
|
+
verifyPending2FA(twoFactorAuthCode: TwoFactorAuthCode, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Verify2FAResult, any>>;
|
|
9564
10823
|
/**
|
|
9565
10824
|
* Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
|
|
9566
10825
|
* @summary Verify 2FA code with Recovery code
|
|
@@ -9592,6 +10851,22 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9592
10851
|
* @throws {RequiredError}
|
|
9593
10852
|
*/
|
|
9594
10853
|
deleteAvatar: (avatarId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10854
|
+
/**
|
|
10855
|
+
* Delete generated Impostor for that avatar.
|
|
10856
|
+
* @summary Delete generated Impostor
|
|
10857
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
10858
|
+
* @param {*} [options] Override http request option.
|
|
10859
|
+
* @throws {RequiredError}
|
|
10860
|
+
*/
|
|
10861
|
+
deleteImpostor: (avatarId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10862
|
+
/**
|
|
10863
|
+
* Enqueue Impostor generation for that avatar.
|
|
10864
|
+
* @summary Enqueue Impostor generation
|
|
10865
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
10866
|
+
* @param {*} [options] Override http request option.
|
|
10867
|
+
* @throws {RequiredError}
|
|
10868
|
+
*/
|
|
10869
|
+
enqueueImpostor: (avatarId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9595
10870
|
/**
|
|
9596
10871
|
* Get information about a specific Avatar.
|
|
9597
10872
|
* @summary Get Avatar
|
|
@@ -9620,6 +10895,22 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9620
10895
|
* @throws {RequiredError}
|
|
9621
10896
|
*/
|
|
9622
10897
|
getFavoritedAvatars: (featured?: boolean, sort?: SortOption, n?: number, order?: OrderOption, offset?: number, search?: string, tag?: string, notag?: string, releaseStatus?: ReleaseStatus, maxUnityVersion?: string, minUnityVersion?: string, platform?: string, userId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10898
|
+
/**
|
|
10899
|
+
* Gets service stats for queued impostor.
|
|
10900
|
+
* @summary Get Impostor Queue Stats
|
|
10901
|
+
* @param {*} [options] Override http request option.
|
|
10902
|
+
* @throws {RequiredError}
|
|
10903
|
+
*/
|
|
10904
|
+
getImpostorQueueStats: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10905
|
+
/**
|
|
10906
|
+
* List licensed avatars.
|
|
10907
|
+
* @summary List Licensed Avatars
|
|
10908
|
+
* @param {number} [n] The number of objects to return.
|
|
10909
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
10910
|
+
* @param {*} [options] Override http request option.
|
|
10911
|
+
* @throws {RequiredError}
|
|
10912
|
+
*/
|
|
10913
|
+
getLicensedAvatars: (n?: number, offset?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9623
10914
|
/**
|
|
9624
10915
|
* Get the current avatar for the user. This will return an error for any other user than the one logged in.
|
|
9625
10916
|
* @summary Get Own Avatar
|
|
@@ -9695,6 +10986,22 @@ export declare const AvatarsApiFp: (configuration?: Configuration) => {
|
|
|
9695
10986
|
* @throws {RequiredError}
|
|
9696
10987
|
*/
|
|
9697
10988
|
deleteAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Avatar>>;
|
|
10989
|
+
/**
|
|
10990
|
+
* Delete generated Impostor for that avatar.
|
|
10991
|
+
* @summary Delete generated Impostor
|
|
10992
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
10993
|
+
* @param {*} [options] Override http request option.
|
|
10994
|
+
* @throws {RequiredError}
|
|
10995
|
+
*/
|
|
10996
|
+
deleteImpostor(avatarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
10997
|
+
/**
|
|
10998
|
+
* Enqueue Impostor generation for that avatar.
|
|
10999
|
+
* @summary Enqueue Impostor generation
|
|
11000
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11001
|
+
* @param {*} [options] Override http request option.
|
|
11002
|
+
* @throws {RequiredError}
|
|
11003
|
+
*/
|
|
11004
|
+
enqueueImpostor(avatarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceStatus>>;
|
|
9698
11005
|
/**
|
|
9699
11006
|
* Get information about a specific Avatar.
|
|
9700
11007
|
* @summary Get Avatar
|
|
@@ -9723,6 +11030,22 @@ export declare const AvatarsApiFp: (configuration?: Configuration) => {
|
|
|
9723
11030
|
* @throws {RequiredError}
|
|
9724
11031
|
*/
|
|
9725
11032
|
getFavoritedAvatars(featured?: boolean, sort?: SortOption, n?: number, order?: OrderOption, offset?: number, search?: string, tag?: string, notag?: string, releaseStatus?: ReleaseStatus, maxUnityVersion?: string, minUnityVersion?: string, platform?: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Avatar>>>;
|
|
11033
|
+
/**
|
|
11034
|
+
* Gets service stats for queued impostor.
|
|
11035
|
+
* @summary Get Impostor Queue Stats
|
|
11036
|
+
* @param {*} [options] Override http request option.
|
|
11037
|
+
* @throws {RequiredError}
|
|
11038
|
+
*/
|
|
11039
|
+
getImpostorQueueStats(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceQueueStats>>;
|
|
11040
|
+
/**
|
|
11041
|
+
* List licensed avatars.
|
|
11042
|
+
* @summary List Licensed Avatars
|
|
11043
|
+
* @param {number} [n] The number of objects to return.
|
|
11044
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11045
|
+
* @param {*} [options] Override http request option.
|
|
11046
|
+
* @throws {RequiredError}
|
|
11047
|
+
*/
|
|
11048
|
+
getLicensedAvatars(n?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Avatar>>>;
|
|
9726
11049
|
/**
|
|
9727
11050
|
* Get the current avatar for the user. This will return an error for any other user than the one logged in.
|
|
9728
11051
|
* @summary Get Own Avatar
|
|
@@ -9798,6 +11121,22 @@ export declare const AvatarsApiFactory: (configuration?: Configuration, basePath
|
|
|
9798
11121
|
* @throws {RequiredError}
|
|
9799
11122
|
*/
|
|
9800
11123
|
deleteAvatar(avatarId: string, options?: any): AxiosPromise<Avatar>;
|
|
11124
|
+
/**
|
|
11125
|
+
* Delete generated Impostor for that avatar.
|
|
11126
|
+
* @summary Delete generated Impostor
|
|
11127
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11128
|
+
* @param {*} [options] Override http request option.
|
|
11129
|
+
* @throws {RequiredError}
|
|
11130
|
+
*/
|
|
11131
|
+
deleteImpostor(avatarId: string, options?: any): AxiosPromise<void>;
|
|
11132
|
+
/**
|
|
11133
|
+
* Enqueue Impostor generation for that avatar.
|
|
11134
|
+
* @summary Enqueue Impostor generation
|
|
11135
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11136
|
+
* @param {*} [options] Override http request option.
|
|
11137
|
+
* @throws {RequiredError}
|
|
11138
|
+
*/
|
|
11139
|
+
enqueueImpostor(avatarId: string, options?: any): AxiosPromise<ServiceStatus>;
|
|
9801
11140
|
/**
|
|
9802
11141
|
* Get information about a specific Avatar.
|
|
9803
11142
|
* @summary Get Avatar
|
|
@@ -9826,6 +11165,22 @@ export declare const AvatarsApiFactory: (configuration?: Configuration, basePath
|
|
|
9826
11165
|
* @throws {RequiredError}
|
|
9827
11166
|
*/
|
|
9828
11167
|
getFavoritedAvatars(featured?: boolean, sort?: SortOption, n?: number, order?: OrderOption, offset?: number, search?: string, tag?: string, notag?: string, releaseStatus?: ReleaseStatus, maxUnityVersion?: string, minUnityVersion?: string, platform?: string, userId?: string, options?: any): AxiosPromise<Array<Avatar>>;
|
|
11168
|
+
/**
|
|
11169
|
+
* Gets service stats for queued impostor.
|
|
11170
|
+
* @summary Get Impostor Queue Stats
|
|
11171
|
+
* @param {*} [options] Override http request option.
|
|
11172
|
+
* @throws {RequiredError}
|
|
11173
|
+
*/
|
|
11174
|
+
getImpostorQueueStats(options?: any): AxiosPromise<ServiceQueueStats>;
|
|
11175
|
+
/**
|
|
11176
|
+
* List licensed avatars.
|
|
11177
|
+
* @summary List Licensed Avatars
|
|
11178
|
+
* @param {number} [n] The number of objects to return.
|
|
11179
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11180
|
+
* @param {*} [options] Override http request option.
|
|
11181
|
+
* @throws {RequiredError}
|
|
11182
|
+
*/
|
|
11183
|
+
getLicensedAvatars(n?: number, offset?: number, options?: any): AxiosPromise<Array<Avatar>>;
|
|
9829
11184
|
/**
|
|
9830
11185
|
* Get the current avatar for the user. This will return an error for any other user than the one logged in.
|
|
9831
11186
|
* @summary Get Own Avatar
|
|
@@ -9905,6 +11260,24 @@ export declare class AvatarsApi extends BaseAPI {
|
|
|
9905
11260
|
* @memberof AvatarsApi
|
|
9906
11261
|
*/
|
|
9907
11262
|
deleteAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Avatar, any>>;
|
|
11263
|
+
/**
|
|
11264
|
+
* Delete generated Impostor for that avatar.
|
|
11265
|
+
* @summary Delete generated Impostor
|
|
11266
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11267
|
+
* @param {*} [options] Override http request option.
|
|
11268
|
+
* @throws {RequiredError}
|
|
11269
|
+
* @memberof AvatarsApi
|
|
11270
|
+
*/
|
|
11271
|
+
deleteImpostor(avatarId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
11272
|
+
/**
|
|
11273
|
+
* Enqueue Impostor generation for that avatar.
|
|
11274
|
+
* @summary Enqueue Impostor generation
|
|
11275
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11276
|
+
* @param {*} [options] Override http request option.
|
|
11277
|
+
* @throws {RequiredError}
|
|
11278
|
+
* @memberof AvatarsApi
|
|
11279
|
+
*/
|
|
11280
|
+
enqueueImpostor(avatarId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceStatus, any>>;
|
|
9908
11281
|
/**
|
|
9909
11282
|
* Get information about a specific Avatar.
|
|
9910
11283
|
* @summary Get Avatar
|
|
@@ -9935,6 +11308,24 @@ export declare class AvatarsApi extends BaseAPI {
|
|
|
9935
11308
|
* @memberof AvatarsApi
|
|
9936
11309
|
*/
|
|
9937
11310
|
getFavoritedAvatars(featured?: boolean, sort?: SortOption, n?: number, order?: OrderOption, offset?: number, search?: string, tag?: string, notag?: string, releaseStatus?: ReleaseStatus, maxUnityVersion?: string, minUnityVersion?: string, platform?: string, userId?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Avatar[], any>>;
|
|
11311
|
+
/**
|
|
11312
|
+
* Gets service stats for queued impostor.
|
|
11313
|
+
* @summary Get Impostor Queue Stats
|
|
11314
|
+
* @param {*} [options] Override http request option.
|
|
11315
|
+
* @throws {RequiredError}
|
|
11316
|
+
* @memberof AvatarsApi
|
|
11317
|
+
*/
|
|
11318
|
+
getImpostorQueueStats(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceQueueStats, any>>;
|
|
11319
|
+
/**
|
|
11320
|
+
* List licensed avatars.
|
|
11321
|
+
* @summary List Licensed Avatars
|
|
11322
|
+
* @param {number} [n] The number of objects to return.
|
|
11323
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11324
|
+
* @param {*} [options] Override http request option.
|
|
11325
|
+
* @throws {RequiredError}
|
|
11326
|
+
* @memberof AvatarsApi
|
|
11327
|
+
*/
|
|
11328
|
+
getLicensedAvatars(n?: number, offset?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Avatar[], any>>;
|
|
9938
11329
|
/**
|
|
9939
11330
|
* Get the current avatar for the user. This will return an error for any other user than the one logged in.
|
|
9940
11331
|
* @summary Get Own Avatar
|
|
@@ -10414,14 +11805,6 @@ export declare const FavoritesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
10414
11805
|
* @throws {RequiredError}
|
|
10415
11806
|
*/
|
|
10416
11807
|
clearFavoriteGroup: (favoriteGroupType: 'world' | 'friend' | 'avatar', favoriteGroupName: string, userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10417
|
-
/**
|
|
10418
|
-
* Return information about a specific Favorite.
|
|
10419
|
-
* @summary Show Favorite
|
|
10420
|
-
* @param {string} favoriteId Must be a valid favorite ID.
|
|
10421
|
-
* @param {*} [options] Override http request option.
|
|
10422
|
-
* @throws {RequiredError}
|
|
10423
|
-
*/
|
|
10424
|
-
getFavorite: (favoriteId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10425
11808
|
/**
|
|
10426
11809
|
* Fetch information about a specific favorite group.
|
|
10427
11810
|
* @summary Show Favorite Group
|
|
@@ -10437,11 +11820,12 @@ export declare const FavoritesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
10437
11820
|
* @summary List Favorite Groups
|
|
10438
11821
|
* @param {number} [n] The number of objects to return.
|
|
10439
11822
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11823
|
+
* @param {string} [userId] Target user to see information on, admin-only.
|
|
10440
11824
|
* @param {string} [ownerId] The owner of whoms favorite groups to return. Must be a UserID.
|
|
10441
11825
|
* @param {*} [options] Override http request option.
|
|
10442
11826
|
* @throws {RequiredError}
|
|
10443
11827
|
*/
|
|
10444
|
-
getFavoriteGroups: (n?: number, offset?: number, ownerId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11828
|
+
getFavoriteGroups: (n?: number, offset?: number, userId?: string, ownerId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10445
11829
|
/**
|
|
10446
11830
|
* Return information about a specific Favorite.
|
|
10447
11831
|
* @summary Get Favorite Limits
|
|
@@ -10503,14 +11887,6 @@ export declare const FavoritesApiFp: (configuration?: Configuration) => {
|
|
|
10503
11887
|
* @throws {RequiredError}
|
|
10504
11888
|
*/
|
|
10505
11889
|
clearFavoriteGroup(favoriteGroupType: 'world' | 'friend' | 'avatar', favoriteGroupName: string, userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>>;
|
|
10506
|
-
/**
|
|
10507
|
-
* Return information about a specific Favorite.
|
|
10508
|
-
* @summary Show Favorite
|
|
10509
|
-
* @param {string} favoriteId Must be a valid favorite ID.
|
|
10510
|
-
* @param {*} [options] Override http request option.
|
|
10511
|
-
* @throws {RequiredError}
|
|
10512
|
-
*/
|
|
10513
|
-
getFavorite(favoriteId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Favorite>>;
|
|
10514
11890
|
/**
|
|
10515
11891
|
* Fetch information about a specific favorite group.
|
|
10516
11892
|
* @summary Show Favorite Group
|
|
@@ -10526,11 +11902,12 @@ export declare const FavoritesApiFp: (configuration?: Configuration) => {
|
|
|
10526
11902
|
* @summary List Favorite Groups
|
|
10527
11903
|
* @param {number} [n] The number of objects to return.
|
|
10528
11904
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11905
|
+
* @param {string} [userId] Target user to see information on, admin-only.
|
|
10529
11906
|
* @param {string} [ownerId] The owner of whoms favorite groups to return. Must be a UserID.
|
|
10530
11907
|
* @param {*} [options] Override http request option.
|
|
10531
11908
|
* @throws {RequiredError}
|
|
10532
11909
|
*/
|
|
10533
|
-
getFavoriteGroups(n?: number, offset?: number, ownerId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<FavoriteGroup>>>;
|
|
11910
|
+
getFavoriteGroups(n?: number, offset?: number, userId?: string, ownerId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<FavoriteGroup>>>;
|
|
10534
11911
|
/**
|
|
10535
11912
|
* Return information about a specific Favorite.
|
|
10536
11913
|
* @summary Get Favorite Limits
|
|
@@ -10592,14 +11969,6 @@ export declare const FavoritesApiFactory: (configuration?: Configuration, basePa
|
|
|
10592
11969
|
* @throws {RequiredError}
|
|
10593
11970
|
*/
|
|
10594
11971
|
clearFavoriteGroup(favoriteGroupType: 'world' | 'friend' | 'avatar', favoriteGroupName: string, userId: string, options?: any): AxiosPromise<Success>;
|
|
10595
|
-
/**
|
|
10596
|
-
* Return information about a specific Favorite.
|
|
10597
|
-
* @summary Show Favorite
|
|
10598
|
-
* @param {string} favoriteId Must be a valid favorite ID.
|
|
10599
|
-
* @param {*} [options] Override http request option.
|
|
10600
|
-
* @throws {RequiredError}
|
|
10601
|
-
*/
|
|
10602
|
-
getFavorite(favoriteId: string, options?: any): AxiosPromise<Favorite>;
|
|
10603
11972
|
/**
|
|
10604
11973
|
* Fetch information about a specific favorite group.
|
|
10605
11974
|
* @summary Show Favorite Group
|
|
@@ -10615,11 +11984,12 @@ export declare const FavoritesApiFactory: (configuration?: Configuration, basePa
|
|
|
10615
11984
|
* @summary List Favorite Groups
|
|
10616
11985
|
* @param {number} [n] The number of objects to return.
|
|
10617
11986
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11987
|
+
* @param {string} [userId] Target user to see information on, admin-only.
|
|
10618
11988
|
* @param {string} [ownerId] The owner of whoms favorite groups to return. Must be a UserID.
|
|
10619
11989
|
* @param {*} [options] Override http request option.
|
|
10620
11990
|
* @throws {RequiredError}
|
|
10621
11991
|
*/
|
|
10622
|
-
getFavoriteGroups(n?: number, offset?: number, ownerId?: string, options?: any): AxiosPromise<Array<FavoriteGroup>>;
|
|
11992
|
+
getFavoriteGroups(n?: number, offset?: number, userId?: string, ownerId?: string, options?: any): AxiosPromise<Array<FavoriteGroup>>;
|
|
10623
11993
|
/**
|
|
10624
11994
|
* Return information about a specific Favorite.
|
|
10625
11995
|
* @summary Get Favorite Limits
|
|
@@ -10685,15 +12055,6 @@ export declare class FavoritesApi extends BaseAPI {
|
|
|
10685
12055
|
* @memberof FavoritesApi
|
|
10686
12056
|
*/
|
|
10687
12057
|
clearFavoriteGroup(favoriteGroupType: 'world' | 'friend' | 'avatar', favoriteGroupName: string, userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
10688
|
-
/**
|
|
10689
|
-
* Return information about a specific Favorite.
|
|
10690
|
-
* @summary Show Favorite
|
|
10691
|
-
* @param {string} favoriteId Must be a valid favorite ID.
|
|
10692
|
-
* @param {*} [options] Override http request option.
|
|
10693
|
-
* @throws {RequiredError}
|
|
10694
|
-
* @memberof FavoritesApi
|
|
10695
|
-
*/
|
|
10696
|
-
getFavorite(favoriteId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Favorite, any>>;
|
|
10697
12058
|
/**
|
|
10698
12059
|
* Fetch information about a specific favorite group.
|
|
10699
12060
|
* @summary Show Favorite Group
|
|
@@ -10710,12 +12071,13 @@ export declare class FavoritesApi extends BaseAPI {
|
|
|
10710
12071
|
* @summary List Favorite Groups
|
|
10711
12072
|
* @param {number} [n] The number of objects to return.
|
|
10712
12073
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
12074
|
+
* @param {string} [userId] Target user to see information on, admin-only.
|
|
10713
12075
|
* @param {string} [ownerId] The owner of whoms favorite groups to return. Must be a UserID.
|
|
10714
12076
|
* @param {*} [options] Override http request option.
|
|
10715
12077
|
* @throws {RequiredError}
|
|
10716
12078
|
* @memberof FavoritesApi
|
|
10717
12079
|
*/
|
|
10718
|
-
getFavoriteGroups(n?: number, offset?: number, ownerId?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FavoriteGroup[], any>>;
|
|
12080
|
+
getFavoriteGroups(n?: number, offset?: number, userId?: string, ownerId?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FavoriteGroup[], any>>;
|
|
10719
12081
|
/**
|
|
10720
12082
|
* Return information about a specific Favorite.
|
|
10721
12083
|
* @summary Get Favorite Limits
|
|
@@ -10884,6 +12246,35 @@ export declare const FilesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
10884
12246
|
* @throws {RequiredError}
|
|
10885
12247
|
*/
|
|
10886
12248
|
startFileDataUpload: (fileId: string, versionId: number, fileType: 'file' | 'signature' | 'delta', partNumber?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
12249
|
+
/**
|
|
12250
|
+
* Upload a gallery image
|
|
12251
|
+
* @summary Upload gallery image
|
|
12252
|
+
* @param {File} file The binary blob of the png file.
|
|
12253
|
+
* @param {*} [options] Override http request option.
|
|
12254
|
+
* @throws {RequiredError}
|
|
12255
|
+
*/
|
|
12256
|
+
uploadGalleryImage: (file: File, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
12257
|
+
/**
|
|
12258
|
+
* Upload an icon
|
|
12259
|
+
* @summary Upload icon
|
|
12260
|
+
* @param {File} file The binary blob of the png file.
|
|
12261
|
+
* @param {*} [options] Override http request option.
|
|
12262
|
+
* @throws {RequiredError}
|
|
12263
|
+
*/
|
|
12264
|
+
uploadIcon: (file: File, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
12265
|
+
/**
|
|
12266
|
+
* Upload an image, which can be an icon, gallery image, sticker or emoji
|
|
12267
|
+
* @summary Upload gallery image, icon, emoji or sticker
|
|
12268
|
+
* @param {File} file The binary blob of the png file.
|
|
12269
|
+
* @param {string} tag Needs to be either icon, gallery, sticker, emoji, or emojianimated
|
|
12270
|
+
* @param {number} [frames] Required for emojianimated. Total number of frames to be animated (2-64)
|
|
12271
|
+
* @param {number} [framesOverTime] Required for emojianimated. Animation frames per second (1-64)
|
|
12272
|
+
* @param {string} [animationStyle] Animation style for sticker, required for emoji.
|
|
12273
|
+
* @param {string} [maskTag] Mask of the sticker, optional for emoji.
|
|
12274
|
+
* @param {*} [options] Override http request option.
|
|
12275
|
+
* @throws {RequiredError}
|
|
12276
|
+
*/
|
|
12277
|
+
uploadImage: (file: File, tag: string, frames?: number, framesOverTime?: number, animationStyle?: string, maskTag?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10887
12278
|
};
|
|
10888
12279
|
/**
|
|
10889
12280
|
* FilesApi - functional programming interface
|
|
@@ -10932,7 +12323,7 @@ export declare const FilesApiFp: (configuration?: Configuration) => {
|
|
|
10932
12323
|
* @param {*} [options] Override http request option.
|
|
10933
12324
|
* @throws {RequiredError}
|
|
10934
12325
|
*/
|
|
10935
|
-
downloadFileVersion(fileId: string, versionId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
12326
|
+
downloadFileVersion(fileId: string, versionId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
10936
12327
|
/**
|
|
10937
12328
|
* Finish an upload of a FileData. This will mark it as \"complete\". After uploading the `file` for Avatars and Worlds you then have to upload a `signature` file.
|
|
10938
12329
|
* @summary Finish FileData Upload
|
|
@@ -11011,6 +12402,35 @@ export declare const FilesApiFp: (configuration?: Configuration) => {
|
|
|
11011
12402
|
* @throws {RequiredError}
|
|
11012
12403
|
*/
|
|
11013
12404
|
startFileDataUpload(fileId: string, versionId: number, fileType: 'file' | 'signature' | 'delta', partNumber?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileUploadURL>>;
|
|
12405
|
+
/**
|
|
12406
|
+
* Upload a gallery image
|
|
12407
|
+
* @summary Upload gallery image
|
|
12408
|
+
* @param {File} file The binary blob of the png file.
|
|
12409
|
+
* @param {*} [options] Override http request option.
|
|
12410
|
+
* @throws {RequiredError}
|
|
12411
|
+
*/
|
|
12412
|
+
uploadGalleryImage(file: File, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
12413
|
+
/**
|
|
12414
|
+
* Upload an icon
|
|
12415
|
+
* @summary Upload icon
|
|
12416
|
+
* @param {File} file The binary blob of the png file.
|
|
12417
|
+
* @param {*} [options] Override http request option.
|
|
12418
|
+
* @throws {RequiredError}
|
|
12419
|
+
*/
|
|
12420
|
+
uploadIcon(file: File, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
12421
|
+
/**
|
|
12422
|
+
* Upload an image, which can be an icon, gallery image, sticker or emoji
|
|
12423
|
+
* @summary Upload gallery image, icon, emoji or sticker
|
|
12424
|
+
* @param {File} file The binary blob of the png file.
|
|
12425
|
+
* @param {string} tag Needs to be either icon, gallery, sticker, emoji, or emojianimated
|
|
12426
|
+
* @param {number} [frames] Required for emojianimated. Total number of frames to be animated (2-64)
|
|
12427
|
+
* @param {number} [framesOverTime] Required for emojianimated. Animation frames per second (1-64)
|
|
12428
|
+
* @param {string} [animationStyle] Animation style for sticker, required for emoji.
|
|
12429
|
+
* @param {string} [maskTag] Mask of the sticker, optional for emoji.
|
|
12430
|
+
* @param {*} [options] Override http request option.
|
|
12431
|
+
* @throws {RequiredError}
|
|
12432
|
+
*/
|
|
12433
|
+
uploadImage(file: File, tag: string, frames?: number, framesOverTime?: number, animationStyle?: string, maskTag?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
11014
12434
|
};
|
|
11015
12435
|
/**
|
|
11016
12436
|
* FilesApi - factory interface
|
|
@@ -11059,7 +12479,7 @@ export declare const FilesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
11059
12479
|
* @param {*} [options] Override http request option.
|
|
11060
12480
|
* @throws {RequiredError}
|
|
11061
12481
|
*/
|
|
11062
|
-
downloadFileVersion(fileId: string, versionId: number, options?: any): AxiosPromise<
|
|
12482
|
+
downloadFileVersion(fileId: string, versionId: number, options?: any): AxiosPromise<File>;
|
|
11063
12483
|
/**
|
|
11064
12484
|
* Finish an upload of a FileData. This will mark it as \"complete\". After uploading the `file` for Avatars and Worlds you then have to upload a `signature` file.
|
|
11065
12485
|
* @summary Finish FileData Upload
|
|
@@ -11138,6 +12558,35 @@ export declare const FilesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
11138
12558
|
* @throws {RequiredError}
|
|
11139
12559
|
*/
|
|
11140
12560
|
startFileDataUpload(fileId: string, versionId: number, fileType: 'file' | 'signature' | 'delta', partNumber?: number, options?: any): AxiosPromise<FileUploadURL>;
|
|
12561
|
+
/**
|
|
12562
|
+
* Upload a gallery image
|
|
12563
|
+
* @summary Upload gallery image
|
|
12564
|
+
* @param {File} file The binary blob of the png file.
|
|
12565
|
+
* @param {*} [options] Override http request option.
|
|
12566
|
+
* @throws {RequiredError}
|
|
12567
|
+
*/
|
|
12568
|
+
uploadGalleryImage(file: File, options?: any): AxiosPromise<any>;
|
|
12569
|
+
/**
|
|
12570
|
+
* Upload an icon
|
|
12571
|
+
* @summary Upload icon
|
|
12572
|
+
* @param {File} file The binary blob of the png file.
|
|
12573
|
+
* @param {*} [options] Override http request option.
|
|
12574
|
+
* @throws {RequiredError}
|
|
12575
|
+
*/
|
|
12576
|
+
uploadIcon(file: File, options?: any): AxiosPromise<any>;
|
|
12577
|
+
/**
|
|
12578
|
+
* Upload an image, which can be an icon, gallery image, sticker or emoji
|
|
12579
|
+
* @summary Upload gallery image, icon, emoji or sticker
|
|
12580
|
+
* @param {File} file The binary blob of the png file.
|
|
12581
|
+
* @param {string} tag Needs to be either icon, gallery, sticker, emoji, or emojianimated
|
|
12582
|
+
* @param {number} [frames] Required for emojianimated. Total number of frames to be animated (2-64)
|
|
12583
|
+
* @param {number} [framesOverTime] Required for emojianimated. Animation frames per second (1-64)
|
|
12584
|
+
* @param {string} [animationStyle] Animation style for sticker, required for emoji.
|
|
12585
|
+
* @param {string} [maskTag] Mask of the sticker, optional for emoji.
|
|
12586
|
+
* @param {*} [options] Override http request option.
|
|
12587
|
+
* @throws {RequiredError}
|
|
12588
|
+
*/
|
|
12589
|
+
uploadImage(file: File, tag: string, frames?: number, framesOverTime?: number, animationStyle?: string, maskTag?: string, options?: any): AxiosPromise<any>;
|
|
11141
12590
|
};
|
|
11142
12591
|
/**
|
|
11143
12592
|
* FilesApi - object-oriented interface
|
|
@@ -11193,7 +12642,7 @@ export declare class FilesApi extends BaseAPI {
|
|
|
11193
12642
|
* @throws {RequiredError}
|
|
11194
12643
|
* @memberof FilesApi
|
|
11195
12644
|
*/
|
|
11196
|
-
downloadFileVersion(fileId: string, versionId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
12645
|
+
downloadFileVersion(fileId: string, versionId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
11197
12646
|
/**
|
|
11198
12647
|
* Finish an upload of a FileData. This will mark it as \"complete\". After uploading the `file` for Avatars and Worlds you then have to upload a `signature` file.
|
|
11199
12648
|
* @summary Finish FileData Upload
|
|
@@ -11280,6 +12729,38 @@ export declare class FilesApi extends BaseAPI {
|
|
|
11280
12729
|
* @memberof FilesApi
|
|
11281
12730
|
*/
|
|
11282
12731
|
startFileDataUpload(fileId: string, versionId: number, fileType: 'file' | 'signature' | 'delta', partNumber?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileUploadURL, any>>;
|
|
12732
|
+
/**
|
|
12733
|
+
* Upload a gallery image
|
|
12734
|
+
* @summary Upload gallery image
|
|
12735
|
+
* @param {File} file The binary blob of the png file.
|
|
12736
|
+
* @param {*} [options] Override http request option.
|
|
12737
|
+
* @throws {RequiredError}
|
|
12738
|
+
* @memberof FilesApi
|
|
12739
|
+
*/
|
|
12740
|
+
uploadGalleryImage(file: File, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
12741
|
+
/**
|
|
12742
|
+
* Upload an icon
|
|
12743
|
+
* @summary Upload icon
|
|
12744
|
+
* @param {File} file The binary blob of the png file.
|
|
12745
|
+
* @param {*} [options] Override http request option.
|
|
12746
|
+
* @throws {RequiredError}
|
|
12747
|
+
* @memberof FilesApi
|
|
12748
|
+
*/
|
|
12749
|
+
uploadIcon(file: File, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
12750
|
+
/**
|
|
12751
|
+
* Upload an image, which can be an icon, gallery image, sticker or emoji
|
|
12752
|
+
* @summary Upload gallery image, icon, emoji or sticker
|
|
12753
|
+
* @param {File} file The binary blob of the png file.
|
|
12754
|
+
* @param {string} tag Needs to be either icon, gallery, sticker, emoji, or emojianimated
|
|
12755
|
+
* @param {number} [frames] Required for emojianimated. Total number of frames to be animated (2-64)
|
|
12756
|
+
* @param {number} [framesOverTime] Required for emojianimated. Animation frames per second (1-64)
|
|
12757
|
+
* @param {string} [animationStyle] Animation style for sticker, required for emoji.
|
|
12758
|
+
* @param {string} [maskTag] Mask of the sticker, optional for emoji.
|
|
12759
|
+
* @param {*} [options] Override http request option.
|
|
12760
|
+
* @throws {RequiredError}
|
|
12761
|
+
* @memberof FilesApi
|
|
12762
|
+
*/
|
|
12763
|
+
uploadImage(file: File, tag: string, frames?: number, framesOverTime?: number, animationStyle?: string, maskTag?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
11283
12764
|
}
|
|
11284
12765
|
/**
|
|
11285
12766
|
* FriendsApi - axios parameter creator
|
|
@@ -11748,7 +13229,7 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
11748
13229
|
* @param {*} [options] Override http request option.
|
|
11749
13230
|
* @throws {RequiredError}
|
|
11750
13231
|
*/
|
|
11751
|
-
|
|
13232
|
+
getGroupPosts: (groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11752
13233
|
/**
|
|
11753
13234
|
* Returns a list of members that have requested to join the Group.
|
|
11754
13235
|
* @summary Get Group Join Requests
|
|
@@ -11760,6 +13241,13 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
11760
13241
|
* @throws {RequiredError}
|
|
11761
13242
|
*/
|
|
11762
13243
|
getGroupRequests: (groupId: string, n?: number, offset?: number, blocked?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13244
|
+
/**
|
|
13245
|
+
* Obtain predefined templates for group roles
|
|
13246
|
+
* @summary Get Group Role Templates
|
|
13247
|
+
* @param {*} [options] Override http request option.
|
|
13248
|
+
* @throws {RequiredError}
|
|
13249
|
+
*/
|
|
13250
|
+
getGroupRoleTemplates: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11763
13251
|
/**
|
|
11764
13252
|
* Returns a Group Role by ID.
|
|
11765
13253
|
* @summary Get Group Roles
|
|
@@ -12150,7 +13638,7 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
|
|
|
12150
13638
|
* @param {*} [options] Override http request option.
|
|
12151
13639
|
* @throws {RequiredError}
|
|
12152
13640
|
*/
|
|
12153
|
-
|
|
13641
|
+
getGroupPosts(groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetGroupPosts200Response>>;
|
|
12154
13642
|
/**
|
|
12155
13643
|
* Returns a list of members that have requested to join the Group.
|
|
12156
13644
|
* @summary Get Group Join Requests
|
|
@@ -12162,6 +13650,15 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
|
|
|
12162
13650
|
* @throws {RequiredError}
|
|
12163
13651
|
*/
|
|
12164
13652
|
getGroupRequests(groupId: string, n?: number, offset?: number, blocked?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GroupMember>>>;
|
|
13653
|
+
/**
|
|
13654
|
+
* Obtain predefined templates for group roles
|
|
13655
|
+
* @summary Get Group Role Templates
|
|
13656
|
+
* @param {*} [options] Override http request option.
|
|
13657
|
+
* @throws {RequiredError}
|
|
13658
|
+
*/
|
|
13659
|
+
getGroupRoleTemplates(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
13660
|
+
[key: string]: GroupRoleTemplateValues;
|
|
13661
|
+
}>>;
|
|
12165
13662
|
/**
|
|
12166
13663
|
* Returns a Group Role by ID.
|
|
12167
13664
|
* @summary Get Group Roles
|
|
@@ -12552,7 +14049,7 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
|
|
|
12552
14049
|
* @param {*} [options] Override http request option.
|
|
12553
14050
|
* @throws {RequiredError}
|
|
12554
14051
|
*/
|
|
12555
|
-
|
|
14052
|
+
getGroupPosts(groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: any): AxiosPromise<GetGroupPosts200Response>;
|
|
12556
14053
|
/**
|
|
12557
14054
|
* Returns a list of members that have requested to join the Group.
|
|
12558
14055
|
* @summary Get Group Join Requests
|
|
@@ -12564,6 +14061,15 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
|
|
|
12564
14061
|
* @throws {RequiredError}
|
|
12565
14062
|
*/
|
|
12566
14063
|
getGroupRequests(groupId: string, n?: number, offset?: number, blocked?: boolean, options?: any): AxiosPromise<Array<GroupMember>>;
|
|
14064
|
+
/**
|
|
14065
|
+
* Obtain predefined templates for group roles
|
|
14066
|
+
* @summary Get Group Role Templates
|
|
14067
|
+
* @param {*} [options] Override http request option.
|
|
14068
|
+
* @throws {RequiredError}
|
|
14069
|
+
*/
|
|
14070
|
+
getGroupRoleTemplates(options?: any): AxiosPromise<{
|
|
14071
|
+
[key: string]: GroupRoleTemplateValues;
|
|
14072
|
+
}>;
|
|
12567
14073
|
/**
|
|
12568
14074
|
* Returns a Group Role by ID.
|
|
12569
14075
|
* @summary Get Group Roles
|
|
@@ -12984,7 +14490,7 @@ export declare class GroupsApi extends BaseAPI {
|
|
|
12984
14490
|
* @throws {RequiredError}
|
|
12985
14491
|
* @memberof GroupsApi
|
|
12986
14492
|
*/
|
|
12987
|
-
|
|
14493
|
+
getGroupPosts(groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetGroupPosts200Response, any>>;
|
|
12988
14494
|
/**
|
|
12989
14495
|
* Returns a list of members that have requested to join the Group.
|
|
12990
14496
|
* @summary Get Group Join Requests
|
|
@@ -12997,6 +14503,16 @@ export declare class GroupsApi extends BaseAPI {
|
|
|
12997
14503
|
* @memberof GroupsApi
|
|
12998
14504
|
*/
|
|
12999
14505
|
getGroupRequests(groupId: string, n?: number, offset?: number, blocked?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupMember[], any>>;
|
|
14506
|
+
/**
|
|
14507
|
+
* Obtain predefined templates for group roles
|
|
14508
|
+
* @summary Get Group Role Templates
|
|
14509
|
+
* @param {*} [options] Override http request option.
|
|
14510
|
+
* @throws {RequiredError}
|
|
14511
|
+
* @memberof GroupsApi
|
|
14512
|
+
*/
|
|
14513
|
+
getGroupRoleTemplates(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
14514
|
+
[key: string]: GroupRoleTemplateValues;
|
|
14515
|
+
}, any>>;
|
|
13000
14516
|
/**
|
|
13001
14517
|
* Returns a Group Role by ID.
|
|
13002
14518
|
* @summary Get Group Roles
|
|
@@ -13138,7 +14654,7 @@ export declare class GroupsApi extends BaseAPI {
|
|
|
13138
14654
|
*/
|
|
13139
14655
|
export declare const InstancesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
13140
14656
|
/**
|
|
13141
|
-
* Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-
|
|
14657
|
+
* Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-manage` permission.
|
|
13142
14658
|
* @summary Close Instance
|
|
13143
14659
|
* @param {string} worldId Must be a valid world ID.
|
|
13144
14660
|
* @param {string} instanceId Must be a valid instance ID.
|
|
@@ -13189,7 +14705,7 @@ export declare const InstancesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
13189
14705
|
*/
|
|
13190
14706
|
export declare const InstancesApiFp: (configuration?: Configuration) => {
|
|
13191
14707
|
/**
|
|
13192
|
-
* Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-
|
|
14708
|
+
* Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-manage` permission.
|
|
13193
14709
|
* @summary Close Instance
|
|
13194
14710
|
* @param {string} worldId Must be a valid world ID.
|
|
13195
14711
|
* @param {string} instanceId Must be a valid instance ID.
|
|
@@ -13240,7 +14756,7 @@ export declare const InstancesApiFp: (configuration?: Configuration) => {
|
|
|
13240
14756
|
*/
|
|
13241
14757
|
export declare const InstancesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
13242
14758
|
/**
|
|
13243
|
-
* Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-
|
|
14759
|
+
* Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-manage` permission.
|
|
13244
14760
|
* @summary Close Instance
|
|
13245
14761
|
* @param {string} worldId Must be a valid world ID.
|
|
13246
14762
|
* @param {string} instanceId Must be a valid instance ID.
|
|
@@ -13293,7 +14809,7 @@ export declare const InstancesApiFactory: (configuration?: Configuration, basePa
|
|
|
13293
14809
|
*/
|
|
13294
14810
|
export declare class InstancesApi extends BaseAPI {
|
|
13295
14811
|
/**
|
|
13296
|
-
* Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-
|
|
14812
|
+
* Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-manage` permission.
|
|
13297
14813
|
* @summary Close Instance
|
|
13298
14814
|
* @param {string} worldId Must be a valid world ID.
|
|
13299
14815
|
* @param {string} instanceId Must be a valid instance ID.
|
|
@@ -13385,6 +14901,16 @@ export declare const InviteApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
13385
14901
|
* @throws {RequiredError}
|
|
13386
14902
|
*/
|
|
13387
14903
|
inviteUser: (userId: string, inviteRequest: InviteRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14904
|
+
/**
|
|
14905
|
+
* Sends an photo invite to a user. Returns the Notification of type `invite` that was sent.
|
|
14906
|
+
* @summary Invite User with photo
|
|
14907
|
+
* @param {string} userId Must be a valid user ID.
|
|
14908
|
+
* @param {File} image The binary blob of the png file.
|
|
14909
|
+
* @param {InviteRequest} data
|
|
14910
|
+
* @param {*} [options] Override http request option.
|
|
14911
|
+
* @throws {RequiredError}
|
|
14912
|
+
*/
|
|
14913
|
+
inviteUserWithPhoto: (userId: string, image: File, data: InviteRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13388
14914
|
/**
|
|
13389
14915
|
* Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
13390
14916
|
* @summary Request Invite
|
|
@@ -13394,6 +14920,16 @@ export declare const InviteApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
13394
14920
|
* @throws {RequiredError}
|
|
13395
14921
|
*/
|
|
13396
14922
|
requestInvite: (userId: string, requestInviteRequest?: RequestInviteRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14923
|
+
/**
|
|
14924
|
+
* Requests with photo an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
14925
|
+
* @summary Request Invite with photo
|
|
14926
|
+
* @param {string} userId Must be a valid user ID.
|
|
14927
|
+
* @param {File} image The binary blob of the png file.
|
|
14928
|
+
* @param {RequestInviteRequest} data
|
|
14929
|
+
* @param {*} [options] Override http request option.
|
|
14930
|
+
* @throws {RequiredError}
|
|
14931
|
+
*/
|
|
14932
|
+
requestInviteWithPhoto: (userId: string, image: File, data: RequestInviteRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13397
14933
|
/**
|
|
13398
14934
|
* Resets a single Invite Message back to its original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users! Resetting a message respects the rate-limit, so it is not possible to reset within the 60 minutes countdown. Resetting it does however not set the rate-limit to 60 like when editing it. It is possible to edit it right after resetting it. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite The DELETE endpoint does not have/require any request body.
|
|
13399
14935
|
* @summary Reset Invite Message
|
|
@@ -13405,7 +14941,7 @@ export declare const InviteApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
13405
14941
|
*/
|
|
13406
14942
|
resetInviteMessage: (userId: string, messageType: InviteMessageType, slot: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13407
14943
|
/**
|
|
13408
|
-
* Respond to an invite
|
|
14944
|
+
* Respond to an invite or invite request without accepting it. `:notificationId` is the ID of the requesting notification. In case the notification being replied to is an invite, the `responseSlot` refers to a response message from the the `message` collection. In case the notification is an invite request, it will refer to one from the `requestResponse` collection instead.
|
|
13409
14945
|
* @summary Respond Invite
|
|
13410
14946
|
* @param {string} notificationId Must be a valid notification ID.
|
|
13411
14947
|
* @param {InviteResponse} inviteResponse Slot number of the Response Message to use when responding to a user.
|
|
@@ -13413,6 +14949,16 @@ export declare const InviteApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
13413
14949
|
* @throws {RequiredError}
|
|
13414
14950
|
*/
|
|
13415
14951
|
respondInvite: (notificationId: string, inviteResponse: InviteResponse, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14952
|
+
/**
|
|
14953
|
+
* Respond with photo to an invite or invite request without accepting it. `:notificationId` is the ID of the requesting notification. In case the notification being replied to is an invite, the `responseSlot` refers to a response message from the the `message` collection. In case the notification is an invite request, it will refer to one from the `requestResponse` collection instead.\'
|
|
14954
|
+
* @summary Respond Invite with photo
|
|
14955
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
14956
|
+
* @param {File} image The binary blob of the png file.
|
|
14957
|
+
* @param {InviteResponse} data
|
|
14958
|
+
* @param {*} [options] Override http request option.
|
|
14959
|
+
* @throws {RequiredError}
|
|
14960
|
+
*/
|
|
14961
|
+
respondInviteWithPhoto: (notificationId: string, image: File, data: InviteResponse, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13416
14962
|
/**
|
|
13417
14963
|
* Updates a single Invite Message and then returns a list of all of them. Admin Credentials are required to update messages of other users! Updating a message automatically sets the cooldown timer to 60 minutes. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite
|
|
13418
14964
|
* @summary Update Invite Message
|
|
@@ -13467,6 +15013,16 @@ export declare const InviteApiFp: (configuration?: Configuration) => {
|
|
|
13467
15013
|
* @throws {RequiredError}
|
|
13468
15014
|
*/
|
|
13469
15015
|
inviteUser(userId: string, inviteRequest: InviteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SentNotification>>;
|
|
15016
|
+
/**
|
|
15017
|
+
* Sends an photo invite to a user. Returns the Notification of type `invite` that was sent.
|
|
15018
|
+
* @summary Invite User with photo
|
|
15019
|
+
* @param {string} userId Must be a valid user ID.
|
|
15020
|
+
* @param {File} image The binary blob of the png file.
|
|
15021
|
+
* @param {InviteRequest} data
|
|
15022
|
+
* @param {*} [options] Override http request option.
|
|
15023
|
+
* @throws {RequiredError}
|
|
15024
|
+
*/
|
|
15025
|
+
inviteUserWithPhoto(userId: string, image: File, data: InviteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SentNotification>>;
|
|
13470
15026
|
/**
|
|
13471
15027
|
* Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
13472
15028
|
* @summary Request Invite
|
|
@@ -13476,6 +15032,16 @@ export declare const InviteApiFp: (configuration?: Configuration) => {
|
|
|
13476
15032
|
* @throws {RequiredError}
|
|
13477
15033
|
*/
|
|
13478
15034
|
requestInvite(userId: string, requestInviteRequest?: RequestInviteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
|
|
15035
|
+
/**
|
|
15036
|
+
* Requests with photo an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
15037
|
+
* @summary Request Invite with photo
|
|
15038
|
+
* @param {string} userId Must be a valid user ID.
|
|
15039
|
+
* @param {File} image The binary blob of the png file.
|
|
15040
|
+
* @param {RequestInviteRequest} data
|
|
15041
|
+
* @param {*} [options] Override http request option.
|
|
15042
|
+
* @throws {RequiredError}
|
|
15043
|
+
*/
|
|
15044
|
+
requestInviteWithPhoto(userId: string, image: File, data: RequestInviteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
|
|
13479
15045
|
/**
|
|
13480
15046
|
* Resets a single Invite Message back to its original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users! Resetting a message respects the rate-limit, so it is not possible to reset within the 60 minutes countdown. Resetting it does however not set the rate-limit to 60 like when editing it. It is possible to edit it right after resetting it. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite The DELETE endpoint does not have/require any request body.
|
|
13481
15047
|
* @summary Reset Invite Message
|
|
@@ -13487,7 +15053,7 @@ export declare const InviteApiFp: (configuration?: Configuration) => {
|
|
|
13487
15053
|
*/
|
|
13488
15054
|
resetInviteMessage(userId: string, messageType: InviteMessageType, slot: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InviteMessage>>>;
|
|
13489
15055
|
/**
|
|
13490
|
-
* Respond to an invite
|
|
15056
|
+
* Respond to an invite or invite request without accepting it. `:notificationId` is the ID of the requesting notification. In case the notification being replied to is an invite, the `responseSlot` refers to a response message from the the `message` collection. In case the notification is an invite request, it will refer to one from the `requestResponse` collection instead.
|
|
13491
15057
|
* @summary Respond Invite
|
|
13492
15058
|
* @param {string} notificationId Must be a valid notification ID.
|
|
13493
15059
|
* @param {InviteResponse} inviteResponse Slot number of the Response Message to use when responding to a user.
|
|
@@ -13495,6 +15061,16 @@ export declare const InviteApiFp: (configuration?: Configuration) => {
|
|
|
13495
15061
|
* @throws {RequiredError}
|
|
13496
15062
|
*/
|
|
13497
15063
|
respondInvite(notificationId: string, inviteResponse: InviteResponse, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
|
|
15064
|
+
/**
|
|
15065
|
+
* Respond with photo to an invite or invite request without accepting it. `:notificationId` is the ID of the requesting notification. In case the notification being replied to is an invite, the `responseSlot` refers to a response message from the the `message` collection. In case the notification is an invite request, it will refer to one from the `requestResponse` collection instead.\'
|
|
15066
|
+
* @summary Respond Invite with photo
|
|
15067
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15068
|
+
* @param {File} image The binary blob of the png file.
|
|
15069
|
+
* @param {InviteResponse} data
|
|
15070
|
+
* @param {*} [options] Override http request option.
|
|
15071
|
+
* @throws {RequiredError}
|
|
15072
|
+
*/
|
|
15073
|
+
respondInviteWithPhoto(notificationId: string, image: File, data: InviteResponse, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
|
|
13498
15074
|
/**
|
|
13499
15075
|
* Updates a single Invite Message and then returns a list of all of them. Admin Credentials are required to update messages of other users! Updating a message automatically sets the cooldown timer to 60 minutes. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite
|
|
13500
15076
|
* @summary Update Invite Message
|
|
@@ -13549,6 +15125,16 @@ export declare const InviteApiFactory: (configuration?: Configuration, basePath?
|
|
|
13549
15125
|
* @throws {RequiredError}
|
|
13550
15126
|
*/
|
|
13551
15127
|
inviteUser(userId: string, inviteRequest: InviteRequest, options?: any): AxiosPromise<SentNotification>;
|
|
15128
|
+
/**
|
|
15129
|
+
* Sends an photo invite to a user. Returns the Notification of type `invite` that was sent.
|
|
15130
|
+
* @summary Invite User with photo
|
|
15131
|
+
* @param {string} userId Must be a valid user ID.
|
|
15132
|
+
* @param {File} image The binary blob of the png file.
|
|
15133
|
+
* @param {InviteRequest} data
|
|
15134
|
+
* @param {*} [options] Override http request option.
|
|
15135
|
+
* @throws {RequiredError}
|
|
15136
|
+
*/
|
|
15137
|
+
inviteUserWithPhoto(userId: string, image: File, data: InviteRequest, options?: any): AxiosPromise<SentNotification>;
|
|
13552
15138
|
/**
|
|
13553
15139
|
* Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
13554
15140
|
* @summary Request Invite
|
|
@@ -13558,6 +15144,16 @@ export declare const InviteApiFactory: (configuration?: Configuration, basePath?
|
|
|
13558
15144
|
* @throws {RequiredError}
|
|
13559
15145
|
*/
|
|
13560
15146
|
requestInvite(userId: string, requestInviteRequest?: RequestInviteRequest, options?: any): AxiosPromise<Notification>;
|
|
15147
|
+
/**
|
|
15148
|
+
* Requests with photo an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
15149
|
+
* @summary Request Invite with photo
|
|
15150
|
+
* @param {string} userId Must be a valid user ID.
|
|
15151
|
+
* @param {File} image The binary blob of the png file.
|
|
15152
|
+
* @param {RequestInviteRequest} data
|
|
15153
|
+
* @param {*} [options] Override http request option.
|
|
15154
|
+
* @throws {RequiredError}
|
|
15155
|
+
*/
|
|
15156
|
+
requestInviteWithPhoto(userId: string, image: File, data: RequestInviteRequest, options?: any): AxiosPromise<Notification>;
|
|
13561
15157
|
/**
|
|
13562
15158
|
* Resets a single Invite Message back to its original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users! Resetting a message respects the rate-limit, so it is not possible to reset within the 60 minutes countdown. Resetting it does however not set the rate-limit to 60 like when editing it. It is possible to edit it right after resetting it. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite The DELETE endpoint does not have/require any request body.
|
|
13563
15159
|
* @summary Reset Invite Message
|
|
@@ -13569,7 +15165,7 @@ export declare const InviteApiFactory: (configuration?: Configuration, basePath?
|
|
|
13569
15165
|
*/
|
|
13570
15166
|
resetInviteMessage(userId: string, messageType: InviteMessageType, slot: number, options?: any): AxiosPromise<Array<InviteMessage>>;
|
|
13571
15167
|
/**
|
|
13572
|
-
* Respond to an invite
|
|
15168
|
+
* Respond to an invite or invite request without accepting it. `:notificationId` is the ID of the requesting notification. In case the notification being replied to is an invite, the `responseSlot` refers to a response message from the the `message` collection. In case the notification is an invite request, it will refer to one from the `requestResponse` collection instead.
|
|
13573
15169
|
* @summary Respond Invite
|
|
13574
15170
|
* @param {string} notificationId Must be a valid notification ID.
|
|
13575
15171
|
* @param {InviteResponse} inviteResponse Slot number of the Response Message to use when responding to a user.
|
|
@@ -13577,6 +15173,16 @@ export declare const InviteApiFactory: (configuration?: Configuration, basePath?
|
|
|
13577
15173
|
* @throws {RequiredError}
|
|
13578
15174
|
*/
|
|
13579
15175
|
respondInvite(notificationId: string, inviteResponse: InviteResponse, options?: any): AxiosPromise<Notification>;
|
|
15176
|
+
/**
|
|
15177
|
+
* Respond with photo to an invite or invite request without accepting it. `:notificationId` is the ID of the requesting notification. In case the notification being replied to is an invite, the `responseSlot` refers to a response message from the the `message` collection. In case the notification is an invite request, it will refer to one from the `requestResponse` collection instead.\'
|
|
15178
|
+
* @summary Respond Invite with photo
|
|
15179
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15180
|
+
* @param {File} image The binary blob of the png file.
|
|
15181
|
+
* @param {InviteResponse} data
|
|
15182
|
+
* @param {*} [options] Override http request option.
|
|
15183
|
+
* @throws {RequiredError}
|
|
15184
|
+
*/
|
|
15185
|
+
respondInviteWithPhoto(notificationId: string, image: File, data: InviteResponse, options?: any): AxiosPromise<Notification>;
|
|
13580
15186
|
/**
|
|
13581
15187
|
* Updates a single Invite Message and then returns a list of all of them. Admin Credentials are required to update messages of other users! Updating a message automatically sets the cooldown timer to 60 minutes. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite
|
|
13582
15188
|
* @summary Update Invite Message
|
|
@@ -13637,6 +15243,17 @@ export declare class InviteApi extends BaseAPI {
|
|
|
13637
15243
|
* @memberof InviteApi
|
|
13638
15244
|
*/
|
|
13639
15245
|
inviteUser(userId: string, inviteRequest: InviteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SentNotification, any>>;
|
|
15246
|
+
/**
|
|
15247
|
+
* Sends an photo invite to a user. Returns the Notification of type `invite` that was sent.
|
|
15248
|
+
* @summary Invite User with photo
|
|
15249
|
+
* @param {string} userId Must be a valid user ID.
|
|
15250
|
+
* @param {File} image The binary blob of the png file.
|
|
15251
|
+
* @param {InviteRequest} data
|
|
15252
|
+
* @param {*} [options] Override http request option.
|
|
15253
|
+
* @throws {RequiredError}
|
|
15254
|
+
* @memberof InviteApi
|
|
15255
|
+
*/
|
|
15256
|
+
inviteUserWithPhoto(userId: string, image: File, data: InviteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SentNotification, any>>;
|
|
13640
15257
|
/**
|
|
13641
15258
|
* Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
13642
15259
|
* @summary Request Invite
|
|
@@ -13647,6 +15264,17 @@ export declare class InviteApi extends BaseAPI {
|
|
|
13647
15264
|
* @memberof InviteApi
|
|
13648
15265
|
*/
|
|
13649
15266
|
requestInvite(userId: string, requestInviteRequest?: RequestInviteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification, any>>;
|
|
15267
|
+
/**
|
|
15268
|
+
* Requests with photo an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
15269
|
+
* @summary Request Invite with photo
|
|
15270
|
+
* @param {string} userId Must be a valid user ID.
|
|
15271
|
+
* @param {File} image The binary blob of the png file.
|
|
15272
|
+
* @param {RequestInviteRequest} data
|
|
15273
|
+
* @param {*} [options] Override http request option.
|
|
15274
|
+
* @throws {RequiredError}
|
|
15275
|
+
* @memberof InviteApi
|
|
15276
|
+
*/
|
|
15277
|
+
requestInviteWithPhoto(userId: string, image: File, data: RequestInviteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification, any>>;
|
|
13650
15278
|
/**
|
|
13651
15279
|
* Resets a single Invite Message back to its original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users! Resetting a message respects the rate-limit, so it is not possible to reset within the 60 minutes countdown. Resetting it does however not set the rate-limit to 60 like when editing it. It is possible to edit it right after resetting it. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite The DELETE endpoint does not have/require any request body.
|
|
13652
15280
|
* @summary Reset Invite Message
|
|
@@ -13659,7 +15287,7 @@ export declare class InviteApi extends BaseAPI {
|
|
|
13659
15287
|
*/
|
|
13660
15288
|
resetInviteMessage(userId: string, messageType: InviteMessageType, slot: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InviteMessage[], any>>;
|
|
13661
15289
|
/**
|
|
13662
|
-
* Respond to an invite
|
|
15290
|
+
* Respond to an invite or invite request without accepting it. `:notificationId` is the ID of the requesting notification. In case the notification being replied to is an invite, the `responseSlot` refers to a response message from the the `message` collection. In case the notification is an invite request, it will refer to one from the `requestResponse` collection instead.
|
|
13663
15291
|
* @summary Respond Invite
|
|
13664
15292
|
* @param {string} notificationId Must be a valid notification ID.
|
|
13665
15293
|
* @param {InviteResponse} inviteResponse Slot number of the Response Message to use when responding to a user.
|
|
@@ -13668,6 +15296,17 @@ export declare class InviteApi extends BaseAPI {
|
|
|
13668
15296
|
* @memberof InviteApi
|
|
13669
15297
|
*/
|
|
13670
15298
|
respondInvite(notificationId: string, inviteResponse: InviteResponse, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification, any>>;
|
|
15299
|
+
/**
|
|
15300
|
+
* Respond with photo to an invite or invite request without accepting it. `:notificationId` is the ID of the requesting notification. In case the notification being replied to is an invite, the `responseSlot` refers to a response message from the the `message` collection. In case the notification is an invite request, it will refer to one from the `requestResponse` collection instead.\'
|
|
15301
|
+
* @summary Respond Invite with photo
|
|
15302
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15303
|
+
* @param {File} image The binary blob of the png file.
|
|
15304
|
+
* @param {InviteResponse} data
|
|
15305
|
+
* @param {*} [options] Override http request option.
|
|
15306
|
+
* @throws {RequiredError}
|
|
15307
|
+
* @memberof InviteApi
|
|
15308
|
+
*/
|
|
15309
|
+
respondInviteWithPhoto(notificationId: string, image: File, data: InviteResponse, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification, any>>;
|
|
13671
15310
|
/**
|
|
13672
15311
|
* Updates a single Invite Message and then returns a list of all of them. Admin Credentials are required to update messages of other users! Updating a message automatically sets the cooldown timer to 60 minutes. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite
|
|
13673
15312
|
* @summary Update Invite Message
|
|
@@ -14292,6 +15931,221 @@ export declare class PlayermoderationApi extends BaseAPI {
|
|
|
14292
15931
|
*/
|
|
14293
15932
|
unmoderateUser(moderateUserRequest: ModerateUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
14294
15933
|
}
|
|
15934
|
+
/**
|
|
15935
|
+
* PrintsApi - axios parameter creator
|
|
15936
|
+
* @export
|
|
15937
|
+
*/
|
|
15938
|
+
export declare const PrintsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15939
|
+
/**
|
|
15940
|
+
* Returns a print.
|
|
15941
|
+
* @summary Delete Print
|
|
15942
|
+
* @param {string} printId Print ID.
|
|
15943
|
+
* @param {*} [options] Override http request option.
|
|
15944
|
+
* @throws {RequiredError}
|
|
15945
|
+
*/
|
|
15946
|
+
deletePrint: (printId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15947
|
+
/**
|
|
15948
|
+
* Edits a print.
|
|
15949
|
+
* @summary Edit Print
|
|
15950
|
+
* @param {string} printId Print ID.
|
|
15951
|
+
* @param {File} image The binary blob of the png file.
|
|
15952
|
+
* @param {string} [note] The caption for the image.
|
|
15953
|
+
* @param {*} [options] Override http request option.
|
|
15954
|
+
* @throws {RequiredError}
|
|
15955
|
+
*/
|
|
15956
|
+
editPrint: (printId: string, image: File, note?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15957
|
+
/**
|
|
15958
|
+
* Returns a print.
|
|
15959
|
+
* @summary Get Print
|
|
15960
|
+
* @param {string} printId Print ID.
|
|
15961
|
+
* @param {*} [options] Override http request option.
|
|
15962
|
+
* @throws {RequiredError}
|
|
15963
|
+
*/
|
|
15964
|
+
getPrint: (printId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15965
|
+
/**
|
|
15966
|
+
* Returns a list of all prints of the user. User id has to be your own userId, as you can\'t request other user\'s prints.
|
|
15967
|
+
* @summary Get Own Prints
|
|
15968
|
+
* @param {string} userId Must be a valid user ID.
|
|
15969
|
+
* @param {*} [options] Override http request option.
|
|
15970
|
+
* @throws {RequiredError}
|
|
15971
|
+
*/
|
|
15972
|
+
getUserPrints: (userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15973
|
+
/**
|
|
15974
|
+
* Uploads and creates a print.
|
|
15975
|
+
* @summary Upload Print
|
|
15976
|
+
* @param {File} image The binary blob of the png file.
|
|
15977
|
+
* @param {string} timestamp The time the image was captured.
|
|
15978
|
+
* @param {string} [note] The caption for the image.
|
|
15979
|
+
* @param {string} [worldId] The id of the world in which the image was captured.
|
|
15980
|
+
* @param {string} [worldName] The name of the world in which the image was captured.
|
|
15981
|
+
* @param {*} [options] Override http request option.
|
|
15982
|
+
* @throws {RequiredError}
|
|
15983
|
+
*/
|
|
15984
|
+
uploadPrint: (image: File, timestamp: string, note?: string, worldId?: string, worldName?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15985
|
+
};
|
|
15986
|
+
/**
|
|
15987
|
+
* PrintsApi - functional programming interface
|
|
15988
|
+
* @export
|
|
15989
|
+
*/
|
|
15990
|
+
export declare const PrintsApiFp: (configuration?: Configuration) => {
|
|
15991
|
+
/**
|
|
15992
|
+
* Returns a print.
|
|
15993
|
+
* @summary Delete Print
|
|
15994
|
+
* @param {string} printId Print ID.
|
|
15995
|
+
* @param {*} [options] Override http request option.
|
|
15996
|
+
* @throws {RequiredError}
|
|
15997
|
+
*/
|
|
15998
|
+
deletePrint(printId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
15999
|
+
/**
|
|
16000
|
+
* Edits a print.
|
|
16001
|
+
* @summary Edit Print
|
|
16002
|
+
* @param {string} printId Print ID.
|
|
16003
|
+
* @param {File} image The binary blob of the png file.
|
|
16004
|
+
* @param {string} [note] The caption for the image.
|
|
16005
|
+
* @param {*} [options] Override http request option.
|
|
16006
|
+
* @throws {RequiredError}
|
|
16007
|
+
*/
|
|
16008
|
+
editPrint(printId: string, image: File, note?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Print>>;
|
|
16009
|
+
/**
|
|
16010
|
+
* Returns a print.
|
|
16011
|
+
* @summary Get Print
|
|
16012
|
+
* @param {string} printId Print ID.
|
|
16013
|
+
* @param {*} [options] Override http request option.
|
|
16014
|
+
* @throws {RequiredError}
|
|
16015
|
+
*/
|
|
16016
|
+
getPrint(printId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Print>>;
|
|
16017
|
+
/**
|
|
16018
|
+
* Returns a list of all prints of the user. User id has to be your own userId, as you can\'t request other user\'s prints.
|
|
16019
|
+
* @summary Get Own Prints
|
|
16020
|
+
* @param {string} userId Must be a valid user ID.
|
|
16021
|
+
* @param {*} [options] Override http request option.
|
|
16022
|
+
* @throws {RequiredError}
|
|
16023
|
+
*/
|
|
16024
|
+
getUserPrints(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Print>>>;
|
|
16025
|
+
/**
|
|
16026
|
+
* Uploads and creates a print.
|
|
16027
|
+
* @summary Upload Print
|
|
16028
|
+
* @param {File} image The binary blob of the png file.
|
|
16029
|
+
* @param {string} timestamp The time the image was captured.
|
|
16030
|
+
* @param {string} [note] The caption for the image.
|
|
16031
|
+
* @param {string} [worldId] The id of the world in which the image was captured.
|
|
16032
|
+
* @param {string} [worldName] The name of the world in which the image was captured.
|
|
16033
|
+
* @param {*} [options] Override http request option.
|
|
16034
|
+
* @throws {RequiredError}
|
|
16035
|
+
*/
|
|
16036
|
+
uploadPrint(image: File, timestamp: string, note?: string, worldId?: string, worldName?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Print>>;
|
|
16037
|
+
};
|
|
16038
|
+
/**
|
|
16039
|
+
* PrintsApi - factory interface
|
|
16040
|
+
* @export
|
|
16041
|
+
*/
|
|
16042
|
+
export declare const PrintsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
16043
|
+
/**
|
|
16044
|
+
* Returns a print.
|
|
16045
|
+
* @summary Delete Print
|
|
16046
|
+
* @param {string} printId Print ID.
|
|
16047
|
+
* @param {*} [options] Override http request option.
|
|
16048
|
+
* @throws {RequiredError}
|
|
16049
|
+
*/
|
|
16050
|
+
deletePrint(printId: string, options?: any): AxiosPromise<void>;
|
|
16051
|
+
/**
|
|
16052
|
+
* Edits a print.
|
|
16053
|
+
* @summary Edit Print
|
|
16054
|
+
* @param {string} printId Print ID.
|
|
16055
|
+
* @param {File} image The binary blob of the png file.
|
|
16056
|
+
* @param {string} [note] The caption for the image.
|
|
16057
|
+
* @param {*} [options] Override http request option.
|
|
16058
|
+
* @throws {RequiredError}
|
|
16059
|
+
*/
|
|
16060
|
+
editPrint(printId: string, image: File, note?: string, options?: any): AxiosPromise<Print>;
|
|
16061
|
+
/**
|
|
16062
|
+
* Returns a print.
|
|
16063
|
+
* @summary Get Print
|
|
16064
|
+
* @param {string} printId Print ID.
|
|
16065
|
+
* @param {*} [options] Override http request option.
|
|
16066
|
+
* @throws {RequiredError}
|
|
16067
|
+
*/
|
|
16068
|
+
getPrint(printId: string, options?: any): AxiosPromise<Print>;
|
|
16069
|
+
/**
|
|
16070
|
+
* Returns a list of all prints of the user. User id has to be your own userId, as you can\'t request other user\'s prints.
|
|
16071
|
+
* @summary Get Own Prints
|
|
16072
|
+
* @param {string} userId Must be a valid user ID.
|
|
16073
|
+
* @param {*} [options] Override http request option.
|
|
16074
|
+
* @throws {RequiredError}
|
|
16075
|
+
*/
|
|
16076
|
+
getUserPrints(userId: string, options?: any): AxiosPromise<Array<Print>>;
|
|
16077
|
+
/**
|
|
16078
|
+
* Uploads and creates a print.
|
|
16079
|
+
* @summary Upload Print
|
|
16080
|
+
* @param {File} image The binary blob of the png file.
|
|
16081
|
+
* @param {string} timestamp The time the image was captured.
|
|
16082
|
+
* @param {string} [note] The caption for the image.
|
|
16083
|
+
* @param {string} [worldId] The id of the world in which the image was captured.
|
|
16084
|
+
* @param {string} [worldName] The name of the world in which the image was captured.
|
|
16085
|
+
* @param {*} [options] Override http request option.
|
|
16086
|
+
* @throws {RequiredError}
|
|
16087
|
+
*/
|
|
16088
|
+
uploadPrint(image: File, timestamp: string, note?: string, worldId?: string, worldName?: string, options?: any): AxiosPromise<Print>;
|
|
16089
|
+
};
|
|
16090
|
+
/**
|
|
16091
|
+
* PrintsApi - object-oriented interface
|
|
16092
|
+
* @export
|
|
16093
|
+
* @class PrintsApi
|
|
16094
|
+
* @extends {BaseAPI}
|
|
16095
|
+
*/
|
|
16096
|
+
export declare class PrintsApi extends BaseAPI {
|
|
16097
|
+
/**
|
|
16098
|
+
* Returns a print.
|
|
16099
|
+
* @summary Delete Print
|
|
16100
|
+
* @param {string} printId Print ID.
|
|
16101
|
+
* @param {*} [options] Override http request option.
|
|
16102
|
+
* @throws {RequiredError}
|
|
16103
|
+
* @memberof PrintsApi
|
|
16104
|
+
*/
|
|
16105
|
+
deletePrint(printId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
16106
|
+
/**
|
|
16107
|
+
* Edits a print.
|
|
16108
|
+
* @summary Edit Print
|
|
16109
|
+
* @param {string} printId Print ID.
|
|
16110
|
+
* @param {File} image The binary blob of the png file.
|
|
16111
|
+
* @param {string} [note] The caption for the image.
|
|
16112
|
+
* @param {*} [options] Override http request option.
|
|
16113
|
+
* @throws {RequiredError}
|
|
16114
|
+
* @memberof PrintsApi
|
|
16115
|
+
*/
|
|
16116
|
+
editPrint(printId: string, image: File, note?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Print, any>>;
|
|
16117
|
+
/**
|
|
16118
|
+
* Returns a print.
|
|
16119
|
+
* @summary Get Print
|
|
16120
|
+
* @param {string} printId Print ID.
|
|
16121
|
+
* @param {*} [options] Override http request option.
|
|
16122
|
+
* @throws {RequiredError}
|
|
16123
|
+
* @memberof PrintsApi
|
|
16124
|
+
*/
|
|
16125
|
+
getPrint(printId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Print, any>>;
|
|
16126
|
+
/**
|
|
16127
|
+
* Returns a list of all prints of the user. User id has to be your own userId, as you can\'t request other user\'s prints.
|
|
16128
|
+
* @summary Get Own Prints
|
|
16129
|
+
* @param {string} userId Must be a valid user ID.
|
|
16130
|
+
* @param {*} [options] Override http request option.
|
|
16131
|
+
* @throws {RequiredError}
|
|
16132
|
+
* @memberof PrintsApi
|
|
16133
|
+
*/
|
|
16134
|
+
getUserPrints(userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Print[], any>>;
|
|
16135
|
+
/**
|
|
16136
|
+
* Uploads and creates a print.
|
|
16137
|
+
* @summary Upload Print
|
|
16138
|
+
* @param {File} image The binary blob of the png file.
|
|
16139
|
+
* @param {string} timestamp The time the image was captured.
|
|
16140
|
+
* @param {string} [note] The caption for the image.
|
|
16141
|
+
* @param {string} [worldId] The id of the world in which the image was captured.
|
|
16142
|
+
* @param {string} [worldName] The name of the world in which the image was captured.
|
|
16143
|
+
* @param {*} [options] Override http request option.
|
|
16144
|
+
* @throws {RequiredError}
|
|
16145
|
+
* @memberof PrintsApi
|
|
16146
|
+
*/
|
|
16147
|
+
uploadPrint(image: File, timestamp: string, note?: string, worldId?: string, worldName?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Print, any>>;
|
|
16148
|
+
}
|
|
14295
16149
|
/**
|
|
14296
16150
|
* SystemApi - axios parameter creator
|
|
14297
16151
|
* @export
|
|
@@ -14554,6 +16408,33 @@ export declare class SystemApi extends BaseAPI {
|
|
|
14554
16408
|
* @export
|
|
14555
16409
|
*/
|
|
14556
16410
|
export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
16411
|
+
/**
|
|
16412
|
+
* Adds tags to the user\'s profile
|
|
16413
|
+
* @summary Add User Tags
|
|
16414
|
+
* @param {string} userId Must be a valid user ID.
|
|
16415
|
+
* @param {ChangeUserTagsRequest} changeUserTagsRequest
|
|
16416
|
+
* @param {*} [options] Override http request option.
|
|
16417
|
+
* @throws {RequiredError}
|
|
16418
|
+
*/
|
|
16419
|
+
addTags: (userId: string, changeUserTagsRequest: ChangeUserTagsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16420
|
+
/**
|
|
16421
|
+
* Checks whether the user has persistence data for a given world
|
|
16422
|
+
* @summary Check User Persistence Exists
|
|
16423
|
+
* @param {string} userId Must be a valid user ID.
|
|
16424
|
+
* @param {string} worldId Must be a valid world ID.
|
|
16425
|
+
* @param {*} [options] Override http request option.
|
|
16426
|
+
* @throws {RequiredError}
|
|
16427
|
+
*/
|
|
16428
|
+
checkUserPersistenceExists: (userId: string, worldId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16429
|
+
/**
|
|
16430
|
+
* Deletes the user\'s persistence data for a given world
|
|
16431
|
+
* @summary Delete User Persistence
|
|
16432
|
+
* @param {string} userId Must be a valid user ID.
|
|
16433
|
+
* @param {string} worldId Must be a valid world ID.
|
|
16434
|
+
* @param {*} [options] Override http request option.
|
|
16435
|
+
* @throws {RequiredError}
|
|
16436
|
+
*/
|
|
16437
|
+
deleteUserPersistence: (userId: string, worldId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14557
16438
|
/**
|
|
14558
16439
|
* Get public user information about a specific user using their ID.
|
|
14559
16440
|
* @summary Get User by ID
|
|
@@ -14632,6 +16513,15 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
14632
16513
|
* @throws {RequiredError}
|
|
14633
16514
|
*/
|
|
14634
16515
|
getUserRepresentedGroup: (userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16516
|
+
/**
|
|
16517
|
+
* Removes tags from the user\'s profile
|
|
16518
|
+
* @summary Remove User Tags
|
|
16519
|
+
* @param {string} userId Must be a valid user ID.
|
|
16520
|
+
* @param {ChangeUserTagsRequest} changeUserTagsRequest
|
|
16521
|
+
* @param {*} [options] Override http request option.
|
|
16522
|
+
* @throws {RequiredError}
|
|
16523
|
+
*/
|
|
16524
|
+
removeTags: (userId: string, changeUserTagsRequest: ChangeUserTagsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14635
16525
|
/**
|
|
14636
16526
|
* Search and list any users by text query
|
|
14637
16527
|
* @summary Search All Users
|
|
@@ -14643,6 +16533,16 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
14643
16533
|
* @throws {RequiredError}
|
|
14644
16534
|
*/
|
|
14645
16535
|
searchUsers: (search?: string, developerType?: string, n?: number, offset?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16536
|
+
/**
|
|
16537
|
+
* Updates a user\'s badge
|
|
16538
|
+
* @summary Update User Badge
|
|
16539
|
+
* @param {string} userId Must be a valid user ID.
|
|
16540
|
+
* @param {string} badgeId Must be a valid badge ID.
|
|
16541
|
+
* @param {UpdateUserBadgeRequest} updateUserBadgeRequest
|
|
16542
|
+
* @param {*} [options] Override http request option.
|
|
16543
|
+
* @throws {RequiredError}
|
|
16544
|
+
*/
|
|
16545
|
+
updateBadge: (userId: string, badgeId: string, updateUserBadgeRequest: UpdateUserBadgeRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14646
16546
|
/**
|
|
14647
16547
|
* Update a users information such as the email and birthday.
|
|
14648
16548
|
* @summary Update User Info
|
|
@@ -14666,6 +16566,33 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
14666
16566
|
* @export
|
|
14667
16567
|
*/
|
|
14668
16568
|
export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
16569
|
+
/**
|
|
16570
|
+
* Adds tags to the user\'s profile
|
|
16571
|
+
* @summary Add User Tags
|
|
16572
|
+
* @param {string} userId Must be a valid user ID.
|
|
16573
|
+
* @param {ChangeUserTagsRequest} changeUserTagsRequest
|
|
16574
|
+
* @param {*} [options] Override http request option.
|
|
16575
|
+
* @throws {RequiredError}
|
|
16576
|
+
*/
|
|
16577
|
+
addTags(userId: string, changeUserTagsRequest: ChangeUserTagsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>>;
|
|
16578
|
+
/**
|
|
16579
|
+
* Checks whether the user has persistence data for a given world
|
|
16580
|
+
* @summary Check User Persistence Exists
|
|
16581
|
+
* @param {string} userId Must be a valid user ID.
|
|
16582
|
+
* @param {string} worldId Must be a valid world ID.
|
|
16583
|
+
* @param {*} [options] Override http request option.
|
|
16584
|
+
* @throws {RequiredError}
|
|
16585
|
+
*/
|
|
16586
|
+
checkUserPersistenceExists(userId: string, worldId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
16587
|
+
/**
|
|
16588
|
+
* Deletes the user\'s persistence data for a given world
|
|
16589
|
+
* @summary Delete User Persistence
|
|
16590
|
+
* @param {string} userId Must be a valid user ID.
|
|
16591
|
+
* @param {string} worldId Must be a valid world ID.
|
|
16592
|
+
* @param {*} [options] Override http request option.
|
|
16593
|
+
* @throws {RequiredError}
|
|
16594
|
+
*/
|
|
16595
|
+
deleteUserPersistence(userId: string, worldId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
14669
16596
|
/**
|
|
14670
16597
|
* Get public user information about a specific user using their ID.
|
|
14671
16598
|
* @summary Get User by ID
|
|
@@ -14744,6 +16671,15 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
14744
16671
|
* @throws {RequiredError}
|
|
14745
16672
|
*/
|
|
14746
16673
|
getUserRepresentedGroup(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RepresentedGroup>>;
|
|
16674
|
+
/**
|
|
16675
|
+
* Removes tags from the user\'s profile
|
|
16676
|
+
* @summary Remove User Tags
|
|
16677
|
+
* @param {string} userId Must be a valid user ID.
|
|
16678
|
+
* @param {ChangeUserTagsRequest} changeUserTagsRequest
|
|
16679
|
+
* @param {*} [options] Override http request option.
|
|
16680
|
+
* @throws {RequiredError}
|
|
16681
|
+
*/
|
|
16682
|
+
removeTags(userId: string, changeUserTagsRequest: ChangeUserTagsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>>;
|
|
14747
16683
|
/**
|
|
14748
16684
|
* Search and list any users by text query
|
|
14749
16685
|
* @summary Search All Users
|
|
@@ -14755,6 +16691,16 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
14755
16691
|
* @throws {RequiredError}
|
|
14756
16692
|
*/
|
|
14757
16693
|
searchUsers(search?: string, developerType?: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<LimitedUser>>>;
|
|
16694
|
+
/**
|
|
16695
|
+
* Updates a user\'s badge
|
|
16696
|
+
* @summary Update User Badge
|
|
16697
|
+
* @param {string} userId Must be a valid user ID.
|
|
16698
|
+
* @param {string} badgeId Must be a valid badge ID.
|
|
16699
|
+
* @param {UpdateUserBadgeRequest} updateUserBadgeRequest
|
|
16700
|
+
* @param {*} [options] Override http request option.
|
|
16701
|
+
* @throws {RequiredError}
|
|
16702
|
+
*/
|
|
16703
|
+
updateBadge(userId: string, badgeId: string, updateUserBadgeRequest: UpdateUserBadgeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
14758
16704
|
/**
|
|
14759
16705
|
* Update a users information such as the email and birthday.
|
|
14760
16706
|
* @summary Update User Info
|
|
@@ -14778,6 +16724,33 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
14778
16724
|
* @export
|
|
14779
16725
|
*/
|
|
14780
16726
|
export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
16727
|
+
/**
|
|
16728
|
+
* Adds tags to the user\'s profile
|
|
16729
|
+
* @summary Add User Tags
|
|
16730
|
+
* @param {string} userId Must be a valid user ID.
|
|
16731
|
+
* @param {ChangeUserTagsRequest} changeUserTagsRequest
|
|
16732
|
+
* @param {*} [options] Override http request option.
|
|
16733
|
+
* @throws {RequiredError}
|
|
16734
|
+
*/
|
|
16735
|
+
addTags(userId: string, changeUserTagsRequest: ChangeUserTagsRequest, options?: any): AxiosPromise<CurrentUser>;
|
|
16736
|
+
/**
|
|
16737
|
+
* Checks whether the user has persistence data for a given world
|
|
16738
|
+
* @summary Check User Persistence Exists
|
|
16739
|
+
* @param {string} userId Must be a valid user ID.
|
|
16740
|
+
* @param {string} worldId Must be a valid world ID.
|
|
16741
|
+
* @param {*} [options] Override http request option.
|
|
16742
|
+
* @throws {RequiredError}
|
|
16743
|
+
*/
|
|
16744
|
+
checkUserPersistenceExists(userId: string, worldId: string, options?: any): AxiosPromise<void>;
|
|
16745
|
+
/**
|
|
16746
|
+
* Deletes the user\'s persistence data for a given world
|
|
16747
|
+
* @summary Delete User Persistence
|
|
16748
|
+
* @param {string} userId Must be a valid user ID.
|
|
16749
|
+
* @param {string} worldId Must be a valid world ID.
|
|
16750
|
+
* @param {*} [options] Override http request option.
|
|
16751
|
+
* @throws {RequiredError}
|
|
16752
|
+
*/
|
|
16753
|
+
deleteUserPersistence(userId: string, worldId: string, options?: any): AxiosPromise<void>;
|
|
14781
16754
|
/**
|
|
14782
16755
|
* Get public user information about a specific user using their ID.
|
|
14783
16756
|
* @summary Get User by ID
|
|
@@ -14856,6 +16829,15 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
14856
16829
|
* @throws {RequiredError}
|
|
14857
16830
|
*/
|
|
14858
16831
|
getUserRepresentedGroup(userId: string, options?: any): AxiosPromise<RepresentedGroup>;
|
|
16832
|
+
/**
|
|
16833
|
+
* Removes tags from the user\'s profile
|
|
16834
|
+
* @summary Remove User Tags
|
|
16835
|
+
* @param {string} userId Must be a valid user ID.
|
|
16836
|
+
* @param {ChangeUserTagsRequest} changeUserTagsRequest
|
|
16837
|
+
* @param {*} [options] Override http request option.
|
|
16838
|
+
* @throws {RequiredError}
|
|
16839
|
+
*/
|
|
16840
|
+
removeTags(userId: string, changeUserTagsRequest: ChangeUserTagsRequest, options?: any): AxiosPromise<CurrentUser>;
|
|
14859
16841
|
/**
|
|
14860
16842
|
* Search and list any users by text query
|
|
14861
16843
|
* @summary Search All Users
|
|
@@ -14867,6 +16849,16 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
14867
16849
|
* @throws {RequiredError}
|
|
14868
16850
|
*/
|
|
14869
16851
|
searchUsers(search?: string, developerType?: string, n?: number, offset?: number, options?: any): AxiosPromise<Array<LimitedUser>>;
|
|
16852
|
+
/**
|
|
16853
|
+
* Updates a user\'s badge
|
|
16854
|
+
* @summary Update User Badge
|
|
16855
|
+
* @param {string} userId Must be a valid user ID.
|
|
16856
|
+
* @param {string} badgeId Must be a valid badge ID.
|
|
16857
|
+
* @param {UpdateUserBadgeRequest} updateUserBadgeRequest
|
|
16858
|
+
* @param {*} [options] Override http request option.
|
|
16859
|
+
* @throws {RequiredError}
|
|
16860
|
+
*/
|
|
16861
|
+
updateBadge(userId: string, badgeId: string, updateUserBadgeRequest: UpdateUserBadgeRequest, options?: any): AxiosPromise<void>;
|
|
14870
16862
|
/**
|
|
14871
16863
|
* Update a users information such as the email and birthday.
|
|
14872
16864
|
* @summary Update User Info
|
|
@@ -14892,6 +16884,36 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
14892
16884
|
* @extends {BaseAPI}
|
|
14893
16885
|
*/
|
|
14894
16886
|
export declare class UsersApi extends BaseAPI {
|
|
16887
|
+
/**
|
|
16888
|
+
* Adds tags to the user\'s profile
|
|
16889
|
+
* @summary Add User Tags
|
|
16890
|
+
* @param {string} userId Must be a valid user ID.
|
|
16891
|
+
* @param {ChangeUserTagsRequest} changeUserTagsRequest
|
|
16892
|
+
* @param {*} [options] Override http request option.
|
|
16893
|
+
* @throws {RequiredError}
|
|
16894
|
+
* @memberof UsersApi
|
|
16895
|
+
*/
|
|
16896
|
+
addTags(userId: string, changeUserTagsRequest: ChangeUserTagsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CurrentUser, any>>;
|
|
16897
|
+
/**
|
|
16898
|
+
* Checks whether the user has persistence data for a given world
|
|
16899
|
+
* @summary Check User Persistence Exists
|
|
16900
|
+
* @param {string} userId Must be a valid user ID.
|
|
16901
|
+
* @param {string} worldId Must be a valid world ID.
|
|
16902
|
+
* @param {*} [options] Override http request option.
|
|
16903
|
+
* @throws {RequiredError}
|
|
16904
|
+
* @memberof UsersApi
|
|
16905
|
+
*/
|
|
16906
|
+
checkUserPersistenceExists(userId: string, worldId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
16907
|
+
/**
|
|
16908
|
+
* Deletes the user\'s persistence data for a given world
|
|
16909
|
+
* @summary Delete User Persistence
|
|
16910
|
+
* @param {string} userId Must be a valid user ID.
|
|
16911
|
+
* @param {string} worldId Must be a valid world ID.
|
|
16912
|
+
* @param {*} [options] Override http request option.
|
|
16913
|
+
* @throws {RequiredError}
|
|
16914
|
+
* @memberof UsersApi
|
|
16915
|
+
*/
|
|
16916
|
+
deleteUserPersistence(userId: string, worldId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
14895
16917
|
/**
|
|
14896
16918
|
* Get public user information about a specific user using their ID.
|
|
14897
16919
|
* @summary Get User by ID
|
|
@@ -14979,6 +17001,16 @@ export declare class UsersApi extends BaseAPI {
|
|
|
14979
17001
|
* @memberof UsersApi
|
|
14980
17002
|
*/
|
|
14981
17003
|
getUserRepresentedGroup(userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RepresentedGroup, any>>;
|
|
17004
|
+
/**
|
|
17005
|
+
* Removes tags from the user\'s profile
|
|
17006
|
+
* @summary Remove User Tags
|
|
17007
|
+
* @param {string} userId Must be a valid user ID.
|
|
17008
|
+
* @param {ChangeUserTagsRequest} changeUserTagsRequest
|
|
17009
|
+
* @param {*} [options] Override http request option.
|
|
17010
|
+
* @throws {RequiredError}
|
|
17011
|
+
* @memberof UsersApi
|
|
17012
|
+
*/
|
|
17013
|
+
removeTags(userId: string, changeUserTagsRequest: ChangeUserTagsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CurrentUser, any>>;
|
|
14982
17014
|
/**
|
|
14983
17015
|
* Search and list any users by text query
|
|
14984
17016
|
* @summary Search All Users
|
|
@@ -14991,6 +17023,17 @@ export declare class UsersApi extends BaseAPI {
|
|
|
14991
17023
|
* @memberof UsersApi
|
|
14992
17024
|
*/
|
|
14993
17025
|
searchUsers(search?: string, developerType?: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LimitedUser[], any>>;
|
|
17026
|
+
/**
|
|
17027
|
+
* Updates a user\'s badge
|
|
17028
|
+
* @summary Update User Badge
|
|
17029
|
+
* @param {string} userId Must be a valid user ID.
|
|
17030
|
+
* @param {string} badgeId Must be a valid badge ID.
|
|
17031
|
+
* @param {UpdateUserBadgeRequest} updateUserBadgeRequest
|
|
17032
|
+
* @param {*} [options] Override http request option.
|
|
17033
|
+
* @throws {RequiredError}
|
|
17034
|
+
* @memberof UsersApi
|
|
17035
|
+
*/
|
|
17036
|
+
updateBadge(userId: string, badgeId: string, updateUserBadgeRequest: UpdateUserBadgeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
14994
17037
|
/**
|
|
14995
17038
|
* Update a users information such as the email and birthday.
|
|
14996
17039
|
* @summary Update User Info
|
|
@@ -15016,6 +17059,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
15016
17059
|
* @export
|
|
15017
17060
|
*/
|
|
15018
17061
|
export declare const WorldsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
17062
|
+
/**
|
|
17063
|
+
* Checks whether the user has persistence data for a given world
|
|
17064
|
+
* @summary Check User Persistence Exists
|
|
17065
|
+
* @param {string} userId Must be a valid user ID.
|
|
17066
|
+
* @param {string} worldId Must be a valid world ID.
|
|
17067
|
+
* @param {*} [options] Override http request option.
|
|
17068
|
+
* @throws {RequiredError}
|
|
17069
|
+
*/
|
|
17070
|
+
checkUserPersistenceExists: (userId: string, worldId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15019
17071
|
/**
|
|
15020
17072
|
* Create a new world. This endpoint requires `assetUrl` to be a valid File object with `.vrcw` file extension, and `imageUrl` to be a valid File object with an image file extension.
|
|
15021
17073
|
* @summary Create World
|
|
@@ -15024,6 +17076,15 @@ export declare const WorldsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15024
17076
|
* @throws {RequiredError}
|
|
15025
17077
|
*/
|
|
15026
17078
|
createWorld: (createWorldRequest?: CreateWorldRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
17079
|
+
/**
|
|
17080
|
+
* Deletes the user\'s persistence data for a given world
|
|
17081
|
+
* @summary Delete User Persistence
|
|
17082
|
+
* @param {string} userId Must be a valid user ID.
|
|
17083
|
+
* @param {string} worldId Must be a valid world ID.
|
|
17084
|
+
* @param {*} [options] Override http request option.
|
|
17085
|
+
* @throws {RequiredError}
|
|
17086
|
+
*/
|
|
17087
|
+
deleteUserPersistence: (userId: string, worldId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15027
17088
|
/**
|
|
15028
17089
|
* Delete a world. Notice a world is never fully \"deleted\", only its ReleaseStatus is set to \"hidden\" and the linked Files are deleted. The WorldID is permanently reserved.
|
|
15029
17090
|
* @summary Delete World
|
|
@@ -15178,6 +17239,15 @@ export declare const WorldsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15178
17239
|
* @export
|
|
15179
17240
|
*/
|
|
15180
17241
|
export declare const WorldsApiFp: (configuration?: Configuration) => {
|
|
17242
|
+
/**
|
|
17243
|
+
* Checks whether the user has persistence data for a given world
|
|
17244
|
+
* @summary Check User Persistence Exists
|
|
17245
|
+
* @param {string} userId Must be a valid user ID.
|
|
17246
|
+
* @param {string} worldId Must be a valid world ID.
|
|
17247
|
+
* @param {*} [options] Override http request option.
|
|
17248
|
+
* @throws {RequiredError}
|
|
17249
|
+
*/
|
|
17250
|
+
checkUserPersistenceExists(userId: string, worldId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
15181
17251
|
/**
|
|
15182
17252
|
* Create a new world. This endpoint requires `assetUrl` to be a valid File object with `.vrcw` file extension, and `imageUrl` to be a valid File object with an image file extension.
|
|
15183
17253
|
* @summary Create World
|
|
@@ -15186,6 +17256,15 @@ export declare const WorldsApiFp: (configuration?: Configuration) => {
|
|
|
15186
17256
|
* @throws {RequiredError}
|
|
15187
17257
|
*/
|
|
15188
17258
|
createWorld(createWorldRequest?: CreateWorldRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<World>>;
|
|
17259
|
+
/**
|
|
17260
|
+
* Deletes the user\'s persistence data for a given world
|
|
17261
|
+
* @summary Delete User Persistence
|
|
17262
|
+
* @param {string} userId Must be a valid user ID.
|
|
17263
|
+
* @param {string} worldId Must be a valid world ID.
|
|
17264
|
+
* @param {*} [options] Override http request option.
|
|
17265
|
+
* @throws {RequiredError}
|
|
17266
|
+
*/
|
|
17267
|
+
deleteUserPersistence(userId: string, worldId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
15189
17268
|
/**
|
|
15190
17269
|
* Delete a world. Notice a world is never fully \"deleted\", only its ReleaseStatus is set to \"hidden\" and the linked Files are deleted. The WorldID is permanently reserved.
|
|
15191
17270
|
* @summary Delete World
|
|
@@ -15340,6 +17419,15 @@ export declare const WorldsApiFp: (configuration?: Configuration) => {
|
|
|
15340
17419
|
* @export
|
|
15341
17420
|
*/
|
|
15342
17421
|
export declare const WorldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
17422
|
+
/**
|
|
17423
|
+
* Checks whether the user has persistence data for a given world
|
|
17424
|
+
* @summary Check User Persistence Exists
|
|
17425
|
+
* @param {string} userId Must be a valid user ID.
|
|
17426
|
+
* @param {string} worldId Must be a valid world ID.
|
|
17427
|
+
* @param {*} [options] Override http request option.
|
|
17428
|
+
* @throws {RequiredError}
|
|
17429
|
+
*/
|
|
17430
|
+
checkUserPersistenceExists(userId: string, worldId: string, options?: any): AxiosPromise<void>;
|
|
15343
17431
|
/**
|
|
15344
17432
|
* Create a new world. This endpoint requires `assetUrl` to be a valid File object with `.vrcw` file extension, and `imageUrl` to be a valid File object with an image file extension.
|
|
15345
17433
|
* @summary Create World
|
|
@@ -15348,6 +17436,15 @@ export declare const WorldsApiFactory: (configuration?: Configuration, basePath?
|
|
|
15348
17436
|
* @throws {RequiredError}
|
|
15349
17437
|
*/
|
|
15350
17438
|
createWorld(createWorldRequest?: CreateWorldRequest, options?: any): AxiosPromise<World>;
|
|
17439
|
+
/**
|
|
17440
|
+
* Deletes the user\'s persistence data for a given world
|
|
17441
|
+
* @summary Delete User Persistence
|
|
17442
|
+
* @param {string} userId Must be a valid user ID.
|
|
17443
|
+
* @param {string} worldId Must be a valid world ID.
|
|
17444
|
+
* @param {*} [options] Override http request option.
|
|
17445
|
+
* @throws {RequiredError}
|
|
17446
|
+
*/
|
|
17447
|
+
deleteUserPersistence(userId: string, worldId: string, options?: any): AxiosPromise<void>;
|
|
15351
17448
|
/**
|
|
15352
17449
|
* Delete a world. Notice a world is never fully \"deleted\", only its ReleaseStatus is set to \"hidden\" and the linked Files are deleted. The WorldID is permanently reserved.
|
|
15353
17450
|
* @summary Delete World
|
|
@@ -15504,6 +17601,16 @@ export declare const WorldsApiFactory: (configuration?: Configuration, basePath?
|
|
|
15504
17601
|
* @extends {BaseAPI}
|
|
15505
17602
|
*/
|
|
15506
17603
|
export declare class WorldsApi extends BaseAPI {
|
|
17604
|
+
/**
|
|
17605
|
+
* Checks whether the user has persistence data for a given world
|
|
17606
|
+
* @summary Check User Persistence Exists
|
|
17607
|
+
* @param {string} userId Must be a valid user ID.
|
|
17608
|
+
* @param {string} worldId Must be a valid world ID.
|
|
17609
|
+
* @param {*} [options] Override http request option.
|
|
17610
|
+
* @throws {RequiredError}
|
|
17611
|
+
* @memberof WorldsApi
|
|
17612
|
+
*/
|
|
17613
|
+
checkUserPersistenceExists(userId: string, worldId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
15507
17614
|
/**
|
|
15508
17615
|
* Create a new world. This endpoint requires `assetUrl` to be a valid File object with `.vrcw` file extension, and `imageUrl` to be a valid File object with an image file extension.
|
|
15509
17616
|
* @summary Create World
|
|
@@ -15513,6 +17620,16 @@ export declare class WorldsApi extends BaseAPI {
|
|
|
15513
17620
|
* @memberof WorldsApi
|
|
15514
17621
|
*/
|
|
15515
17622
|
createWorld(createWorldRequest?: CreateWorldRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<World, any>>;
|
|
17623
|
+
/**
|
|
17624
|
+
* Deletes the user\'s persistence data for a given world
|
|
17625
|
+
* @summary Delete User Persistence
|
|
17626
|
+
* @param {string} userId Must be a valid user ID.
|
|
17627
|
+
* @param {string} worldId Must be a valid world ID.
|
|
17628
|
+
* @param {*} [options] Override http request option.
|
|
17629
|
+
* @throws {RequiredError}
|
|
17630
|
+
* @memberof WorldsApi
|
|
17631
|
+
*/
|
|
17632
|
+
deleteUserPersistence(userId: string, worldId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
15516
17633
|
/**
|
|
15517
17634
|
* Delete a world. Notice a world is never fully \"deleted\", only its ReleaseStatus is set to \"hidden\" and the linked Files are deleted. The WorldID is permanently reserved.
|
|
15518
17635
|
* @summary Delete World
|