vrchat 1.19.1 → 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 +3547 -409
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +2007 -149
- 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).
|
|
@@ -89,13 +89,6 @@ export interface APIConfig {
|
|
|
89
89
|
* @memberof APIConfig
|
|
90
90
|
*/
|
|
91
91
|
'analyticsSegment_NewUI_Salt': string;
|
|
92
|
-
/**
|
|
93
|
-
* Game name
|
|
94
|
-
* @type {string}
|
|
95
|
-
* @memberof APIConfig
|
|
96
|
-
* @deprecated
|
|
97
|
-
*/
|
|
98
|
-
'appName': string;
|
|
99
92
|
/**
|
|
100
93
|
* List of supported Languages
|
|
101
94
|
* @type {Array<string>}
|
|
@@ -114,12 +107,6 @@ export interface APIConfig {
|
|
|
114
107
|
* @memberof APIConfig
|
|
115
108
|
*/
|
|
116
109
|
'avatarPerfLimiter': APIConfigAvatarPerfLimiter;
|
|
117
|
-
/**
|
|
118
|
-
* Build tag of the API server
|
|
119
|
-
* @type {string}
|
|
120
|
-
* @memberof APIConfig
|
|
121
|
-
*/
|
|
122
|
-
'buildVersionTag': string;
|
|
123
110
|
/**
|
|
124
111
|
* Unknown
|
|
125
112
|
* @type {number}
|
|
@@ -264,12 +251,6 @@ export interface APIConfig {
|
|
|
264
251
|
* @memberof APIConfig
|
|
265
252
|
*/
|
|
266
253
|
'defaultStickerSet': string;
|
|
267
|
-
/**
|
|
268
|
-
*
|
|
269
|
-
* @type {DeploymentGroup}
|
|
270
|
-
* @memberof APIConfig
|
|
271
|
-
*/
|
|
272
|
-
'deploymentGroup': DeploymentGroup;
|
|
273
254
|
/**
|
|
274
255
|
* Unknown
|
|
275
256
|
* @type {Array<string>}
|
|
@@ -591,12 +572,6 @@ export interface APIConfig {
|
|
|
591
572
|
* @memberof APIConfig
|
|
592
573
|
*/
|
|
593
574
|
'sdkUnityVersion': string;
|
|
594
|
-
/**
|
|
595
|
-
* Server name of the API server currently responding
|
|
596
|
-
* @type {string}
|
|
597
|
-
* @memberof APIConfig
|
|
598
|
-
*/
|
|
599
|
-
'serverName': string;
|
|
600
575
|
/**
|
|
601
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).
|
|
602
577
|
* @type {Array<string>}
|
|
@@ -699,6 +674,12 @@ export interface APIConfig {
|
|
|
699
674
|
* @memberof APIConfig
|
|
700
675
|
*/
|
|
701
676
|
'player-url-resolver-sha1': string;
|
|
677
|
+
/**
|
|
678
|
+
* Public key, hex encoded
|
|
679
|
+
* @type {string}
|
|
680
|
+
* @memberof APIConfig
|
|
681
|
+
*/
|
|
682
|
+
'publicKey': string;
|
|
702
683
|
/**
|
|
703
684
|
* Unknown
|
|
704
685
|
* @type {number}
|
|
@@ -1222,6 +1203,12 @@ export interface APIConfigReportCategories {
|
|
|
1222
1203
|
* @memberof APIConfigReportCategories
|
|
1223
1204
|
*/
|
|
1224
1205
|
'avatar': ReportCategory;
|
|
1206
|
+
/**
|
|
1207
|
+
*
|
|
1208
|
+
* @type {ReportCategory}
|
|
1209
|
+
* @memberof APIConfigReportCategories
|
|
1210
|
+
*/
|
|
1211
|
+
'avatarpage'?: ReportCategory;
|
|
1225
1212
|
/**
|
|
1226
1213
|
*
|
|
1227
1214
|
* @type {ReportCategory}
|
|
@@ -1332,6 +1319,12 @@ export interface APIConfigReportOptionsAvatar {
|
|
|
1332
1319
|
* @memberof APIConfigReportOptionsAvatar
|
|
1333
1320
|
*/
|
|
1334
1321
|
'avatar'?: Array<string>;
|
|
1322
|
+
/**
|
|
1323
|
+
*
|
|
1324
|
+
* @type {Array<string>}
|
|
1325
|
+
* @memberof APIConfigReportOptionsAvatar
|
|
1326
|
+
*/
|
|
1327
|
+
'avatarpage'?: Array<string>;
|
|
1335
1328
|
/**
|
|
1336
1329
|
*
|
|
1337
1330
|
* @type {Array<string>}
|
|
@@ -1468,6 +1461,18 @@ export interface APIConfigReportReasons {
|
|
|
1468
1461
|
* @memberof APIConfigReportReasons
|
|
1469
1462
|
*/
|
|
1470
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;
|
|
1471
1476
|
/**
|
|
1472
1477
|
*
|
|
1473
1478
|
* @type {ReportReason}
|
|
@@ -1552,6 +1557,12 @@ export interface APIConfigReportReasons {
|
|
|
1552
1557
|
* @memberof APIConfigReportReasons
|
|
1553
1558
|
*/
|
|
1554
1559
|
'sexual': ReportReason;
|
|
1560
|
+
/**
|
|
1561
|
+
*
|
|
1562
|
+
* @type {ReportReason}
|
|
1563
|
+
* @memberof APIConfigReportReasons
|
|
1564
|
+
*/
|
|
1565
|
+
'technical'?: ReportReason;
|
|
1555
1566
|
/**
|
|
1556
1567
|
*
|
|
1557
1568
|
* @type {ReportReason}
|
|
@@ -1671,13 +1682,19 @@ export type AgeVerificationStatus = typeof AgeVerificationStatus[keyof typeof Ag
|
|
|
1671
1682
|
*/
|
|
1672
1683
|
export interface Avatar {
|
|
1673
1684
|
/**
|
|
1674
|
-
*
|
|
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}`.
|
|
1675
1692
|
* @type {string}
|
|
1676
1693
|
* @memberof Avatar
|
|
1677
1694
|
*/
|
|
1678
1695
|
'assetUrl'?: string;
|
|
1679
1696
|
/**
|
|
1680
|
-
* 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.
|
|
1681
1698
|
* @type {object}
|
|
1682
1699
|
* @memberof Avatar
|
|
1683
1700
|
*/
|
|
@@ -1712,6 +1729,12 @@ export interface Avatar {
|
|
|
1712
1729
|
* @memberof Avatar
|
|
1713
1730
|
*/
|
|
1714
1731
|
'featured': boolean;
|
|
1732
|
+
/**
|
|
1733
|
+
*
|
|
1734
|
+
* @type {number}
|
|
1735
|
+
* @memberof Avatar
|
|
1736
|
+
*/
|
|
1737
|
+
'highestPrice'?: number;
|
|
1715
1738
|
/**
|
|
1716
1739
|
*
|
|
1717
1740
|
* @type {string}
|
|
@@ -1724,18 +1747,48 @@ export interface Avatar {
|
|
|
1724
1747
|
* @memberof Avatar
|
|
1725
1748
|
*/
|
|
1726
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;
|
|
1727
1762
|
/**
|
|
1728
1763
|
*
|
|
1729
1764
|
* @type {string}
|
|
1730
1765
|
* @memberof Avatar
|
|
1731
1766
|
*/
|
|
1732
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>;
|
|
1733
1780
|
/**
|
|
1734
1781
|
*
|
|
1735
1782
|
* @type {ReleaseStatus}
|
|
1736
1783
|
* @memberof Avatar
|
|
1737
1784
|
*/
|
|
1738
1785
|
'releaseStatus': ReleaseStatus;
|
|
1786
|
+
/**
|
|
1787
|
+
*
|
|
1788
|
+
* @type {boolean}
|
|
1789
|
+
* @memberof Avatar
|
|
1790
|
+
*/
|
|
1791
|
+
'searchable'?: boolean;
|
|
1739
1792
|
/**
|
|
1740
1793
|
*
|
|
1741
1794
|
* @type {AvatarStyles}
|
|
@@ -1786,6 +1839,49 @@ export interface Avatar {
|
|
|
1786
1839
|
*/
|
|
1787
1840
|
'version': number;
|
|
1788
1841
|
}
|
|
1842
|
+
/**
|
|
1843
|
+
*
|
|
1844
|
+
* @export
|
|
1845
|
+
* @interface AvatarPublishedListingsInner
|
|
1846
|
+
*/
|
|
1847
|
+
export interface AvatarPublishedListingsInner {
|
|
1848
|
+
/**
|
|
1849
|
+
*
|
|
1850
|
+
* @type {string}
|
|
1851
|
+
* @memberof AvatarPublishedListingsInner
|
|
1852
|
+
*/
|
|
1853
|
+
'description'?: string;
|
|
1854
|
+
/**
|
|
1855
|
+
*
|
|
1856
|
+
* @type {string}
|
|
1857
|
+
* @memberof AvatarPublishedListingsInner
|
|
1858
|
+
*/
|
|
1859
|
+
'displayName'?: string;
|
|
1860
|
+
/**
|
|
1861
|
+
*
|
|
1862
|
+
* @type {string}
|
|
1863
|
+
* @memberof AvatarPublishedListingsInner
|
|
1864
|
+
*/
|
|
1865
|
+
'imageId'?: string;
|
|
1866
|
+
/**
|
|
1867
|
+
*
|
|
1868
|
+
* @type {string}
|
|
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
|
+
}
|
|
1789
1885
|
/**
|
|
1790
1886
|
*
|
|
1791
1887
|
* @export
|
|
@@ -1917,6 +2013,19 @@ export interface BanGroupMemberRequest {
|
|
|
1917
2013
|
*/
|
|
1918
2014
|
'userId': string;
|
|
1919
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
|
+
}
|
|
1920
2029
|
/**
|
|
1921
2030
|
*
|
|
1922
2031
|
* @export
|
|
@@ -1929,6 +2038,30 @@ export interface CreateAvatarRequest {
|
|
|
1929
2038
|
* @memberof CreateAvatarRequest
|
|
1930
2039
|
*/
|
|
1931
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;
|
|
1932
2065
|
/**
|
|
1933
2066
|
*
|
|
1934
2067
|
* @type {string}
|
|
@@ -1959,6 +2092,12 @@ export interface CreateAvatarRequest {
|
|
|
1959
2092
|
* @memberof CreateAvatarRequest
|
|
1960
2093
|
*/
|
|
1961
2094
|
'imageUrl': string;
|
|
2095
|
+
/**
|
|
2096
|
+
*
|
|
2097
|
+
* @type {string}
|
|
2098
|
+
* @memberof CreateAvatarRequest
|
|
2099
|
+
*/
|
|
2100
|
+
'thumbnailImageUrl'?: string;
|
|
1962
2101
|
/**
|
|
1963
2102
|
*
|
|
1964
2103
|
* @type {ReleaseStatus}
|
|
@@ -2352,6 +2491,30 @@ export interface CreateInstanceRequest {
|
|
|
2352
2491
|
* @memberof CreateInstanceRequest
|
|
2353
2492
|
*/
|
|
2354
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;
|
|
2355
2518
|
}
|
|
2356
2519
|
/**
|
|
2357
2520
|
*
|
|
@@ -2498,6 +2661,12 @@ export interface CurrentUser {
|
|
|
2498
2661
|
* @memberof CurrentUser
|
|
2499
2662
|
*/
|
|
2500
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;
|
|
2501
2670
|
/**
|
|
2502
2671
|
*
|
|
2503
2672
|
* @type {Array<Badge>}
|
|
@@ -2517,17 +2686,17 @@ export interface CurrentUser {
|
|
|
2517
2686
|
*/
|
|
2518
2687
|
'bioLinks': Array<string>;
|
|
2519
2688
|
/**
|
|
2520
|
-
*
|
|
2521
|
-
* @type {string}
|
|
2689
|
+
* These tags begin with `content_` and control content gating
|
|
2690
|
+
* @type {Array<string>}
|
|
2522
2691
|
* @memberof CurrentUser
|
|
2523
2692
|
*/
|
|
2524
|
-
'
|
|
2693
|
+
'contentFilters'?: Array<string>;
|
|
2525
2694
|
/**
|
|
2526
2695
|
*
|
|
2527
2696
|
* @type {string}
|
|
2528
2697
|
* @memberof CurrentUser
|
|
2529
2698
|
*/
|
|
2530
|
-
'
|
|
2699
|
+
'currentAvatar': string;
|
|
2531
2700
|
/**
|
|
2532
2701
|
* When profilePicOverride is not empty, use it instead.
|
|
2533
2702
|
* @type {string}
|
|
@@ -3001,18 +3170,6 @@ export interface CurrentUserPresence {
|
|
|
3001
3170
|
*/
|
|
3002
3171
|
'world'?: string;
|
|
3003
3172
|
}
|
|
3004
|
-
/**
|
|
3005
|
-
* 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)
|
|
3006
|
-
* @export
|
|
3007
|
-
* @enum {string}
|
|
3008
|
-
*/
|
|
3009
|
-
export declare const DeploymentGroup: {
|
|
3010
|
-
readonly Blue: "blue";
|
|
3011
|
-
readonly Green: "green";
|
|
3012
|
-
readonly Grape: "grape";
|
|
3013
|
-
readonly Cherry: "cherry";
|
|
3014
|
-
};
|
|
3015
|
-
export type DeploymentGroup = typeof DeploymentGroup[keyof typeof DeploymentGroup];
|
|
3016
3173
|
/**
|
|
3017
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.
|
|
3018
3175
|
* @export
|
|
@@ -3025,6 +3182,19 @@ export declare const DeveloperType: {
|
|
|
3025
3182
|
readonly Moderator: "moderator";
|
|
3026
3183
|
};
|
|
3027
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
|
+
}
|
|
3028
3198
|
/**
|
|
3029
3199
|
*
|
|
3030
3200
|
* @export
|
|
@@ -3286,6 +3456,12 @@ export interface FavoritedWorld {
|
|
|
3286
3456
|
* @memberof FavoritedWorld
|
|
3287
3457
|
*/
|
|
3288
3458
|
'created_at': string;
|
|
3459
|
+
/**
|
|
3460
|
+
*
|
|
3461
|
+
* @type {InstanceContentSettings}
|
|
3462
|
+
* @memberof FavoritedWorld
|
|
3463
|
+
*/
|
|
3464
|
+
'defaultContentSettings'?: InstanceContentSettings;
|
|
3289
3465
|
/**
|
|
3290
3466
|
*
|
|
3291
3467
|
* @type {number}
|
|
@@ -3528,12 +3704,24 @@ export interface FileAnalysis {
|
|
|
3528
3704
|
* @memberof FileAnalysis
|
|
3529
3705
|
*/
|
|
3530
3706
|
'created_at'?: string;
|
|
3707
|
+
/**
|
|
3708
|
+
*
|
|
3709
|
+
* @type {string}
|
|
3710
|
+
* @memberof FileAnalysis
|
|
3711
|
+
*/
|
|
3712
|
+
'encryptionKey'?: string;
|
|
3531
3713
|
/**
|
|
3532
3714
|
*
|
|
3533
3715
|
* @type {number}
|
|
3534
3716
|
* @memberof FileAnalysis
|
|
3535
3717
|
*/
|
|
3536
3718
|
'fileSize': number;
|
|
3719
|
+
/**
|
|
3720
|
+
*
|
|
3721
|
+
* @type {string}
|
|
3722
|
+
* @memberof FileAnalysis
|
|
3723
|
+
*/
|
|
3724
|
+
'performanceRating'?: string;
|
|
3537
3725
|
/**
|
|
3538
3726
|
*
|
|
3539
3727
|
* @type {boolean}
|
|
@@ -4036,6 +4224,19 @@ export interface FriendStatus {
|
|
|
4036
4224
|
*/
|
|
4037
4225
|
'outgoingRequest': boolean;
|
|
4038
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
|
+
}
|
|
4039
4240
|
/**
|
|
4040
4241
|
*
|
|
4041
4242
|
* @export
|
|
@@ -5232,56 +5433,118 @@ export type GroupRoleTemplate = typeof GroupRoleTemplate[keyof typeof GroupRoleT
|
|
|
5232
5433
|
/**
|
|
5233
5434
|
*
|
|
5234
5435
|
* @export
|
|
5235
|
-
* @
|
|
5236
|
-
*/
|
|
5237
|
-
export declare const GroupSearchSort: {
|
|
5238
|
-
readonly Asc: "joinedAt:asc";
|
|
5239
|
-
readonly Desc: "joinedAt:desc";
|
|
5240
|
-
};
|
|
5241
|
-
export type GroupSearchSort = typeof GroupSearchSort[keyof typeof GroupSearchSort];
|
|
5242
|
-
/**
|
|
5243
|
-
*
|
|
5244
|
-
* @export
|
|
5245
|
-
* @enum {string}
|
|
5246
|
-
*/
|
|
5247
|
-
export declare const GroupUserVisibility: {
|
|
5248
|
-
readonly Visible: "visible";
|
|
5249
|
-
readonly Hidden: "hidden";
|
|
5250
|
-
readonly Friends: "friends";
|
|
5251
|
-
};
|
|
5252
|
-
export type GroupUserVisibility = typeof GroupUserVisibility[keyof typeof GroupUserVisibility];
|
|
5253
|
-
/**
|
|
5254
|
-
*
|
|
5255
|
-
* @export
|
|
5256
|
-
* @interface InfoPush
|
|
5436
|
+
* @interface GroupRoleTemplateValues
|
|
5257
5437
|
*/
|
|
5258
|
-
export interface
|
|
5438
|
+
export interface GroupRoleTemplateValues {
|
|
5259
5439
|
/**
|
|
5260
5440
|
*
|
|
5261
|
-
* @type {
|
|
5262
|
-
* @memberof
|
|
5441
|
+
* @type {Array<GroupPermissions>}
|
|
5442
|
+
* @memberof GroupRoleTemplateValues
|
|
5263
5443
|
*/
|
|
5264
|
-
'
|
|
5444
|
+
'basePermissions': Array<GroupPermissions>;
|
|
5265
5445
|
/**
|
|
5266
5446
|
*
|
|
5267
|
-
* @type {
|
|
5268
|
-
* @memberof
|
|
5447
|
+
* @type {string}
|
|
5448
|
+
* @memberof GroupRoleTemplateValues
|
|
5269
5449
|
*/
|
|
5270
|
-
'
|
|
5450
|
+
'description': string;
|
|
5271
5451
|
/**
|
|
5272
5452
|
*
|
|
5273
|
-
* @type {
|
|
5274
|
-
* @memberof
|
|
5453
|
+
* @type {string}
|
|
5454
|
+
* @memberof GroupRoleTemplateValues
|
|
5275
5455
|
*/
|
|
5276
|
-
'
|
|
5456
|
+
'name': string;
|
|
5277
5457
|
/**
|
|
5278
5458
|
*
|
|
5279
|
-
* @type {
|
|
5280
|
-
* @memberof
|
|
5459
|
+
* @type {GroupRoleTemplateValuesRoles}
|
|
5460
|
+
* @memberof GroupRoleTemplateValues
|
|
5281
5461
|
*/
|
|
5282
|
-
'
|
|
5283
|
-
|
|
5284
|
-
|
|
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
|
+
}
|
|
5495
|
+
/**
|
|
5496
|
+
*
|
|
5497
|
+
* @export
|
|
5498
|
+
* @enum {string}
|
|
5499
|
+
*/
|
|
5500
|
+
export declare const GroupSearchSort: {
|
|
5501
|
+
readonly Asc: "joinedAt:asc";
|
|
5502
|
+
readonly Desc: "joinedAt:desc";
|
|
5503
|
+
};
|
|
5504
|
+
export type GroupSearchSort = typeof GroupSearchSort[keyof typeof GroupSearchSort];
|
|
5505
|
+
/**
|
|
5506
|
+
*
|
|
5507
|
+
* @export
|
|
5508
|
+
* @enum {string}
|
|
5509
|
+
*/
|
|
5510
|
+
export declare const GroupUserVisibility: {
|
|
5511
|
+
readonly Visible: "visible";
|
|
5512
|
+
readonly Hidden: "hidden";
|
|
5513
|
+
readonly Friends: "friends";
|
|
5514
|
+
};
|
|
5515
|
+
export type GroupUserVisibility = typeof GroupUserVisibility[keyof typeof GroupUserVisibility];
|
|
5516
|
+
/**
|
|
5517
|
+
*
|
|
5518
|
+
* @export
|
|
5519
|
+
* @interface InfoPush
|
|
5520
|
+
*/
|
|
5521
|
+
export interface InfoPush {
|
|
5522
|
+
/**
|
|
5523
|
+
*
|
|
5524
|
+
* @type {string}
|
|
5525
|
+
* @memberof InfoPush
|
|
5526
|
+
*/
|
|
5527
|
+
'id': string;
|
|
5528
|
+
/**
|
|
5529
|
+
*
|
|
5530
|
+
* @type {boolean}
|
|
5531
|
+
* @memberof InfoPush
|
|
5532
|
+
*/
|
|
5533
|
+
'isEnabled': boolean;
|
|
5534
|
+
/**
|
|
5535
|
+
*
|
|
5536
|
+
* @type {ReleaseStatus}
|
|
5537
|
+
* @memberof InfoPush
|
|
5538
|
+
*/
|
|
5539
|
+
'releaseStatus': ReleaseStatus;
|
|
5540
|
+
/**
|
|
5541
|
+
*
|
|
5542
|
+
* @type {number}
|
|
5543
|
+
* @memberof InfoPush
|
|
5544
|
+
*/
|
|
5545
|
+
'priority': number;
|
|
5546
|
+
/**
|
|
5547
|
+
*
|
|
5285
5548
|
* @type {Array<string>}
|
|
5286
5549
|
* @memberof InfoPush
|
|
5287
5550
|
*/
|
|
@@ -5479,6 +5742,12 @@ export interface Instance {
|
|
|
5479
5742
|
* @deprecated
|
|
5480
5743
|
*/
|
|
5481
5744
|
'clientNumber': string;
|
|
5745
|
+
/**
|
|
5746
|
+
*
|
|
5747
|
+
* @type {InstanceContentSettings}
|
|
5748
|
+
* @memberof Instance
|
|
5749
|
+
*/
|
|
5750
|
+
'contentSettings': InstanceContentSettings;
|
|
5482
5751
|
/**
|
|
5483
5752
|
*
|
|
5484
5753
|
* @type {string}
|
|
@@ -5496,7 +5765,7 @@ export interface Instance {
|
|
|
5496
5765
|
* @type {number}
|
|
5497
5766
|
* @memberof Instance
|
|
5498
5767
|
*/
|
|
5499
|
-
'gameServerVersion'
|
|
5768
|
+
'gameServerVersion'?: number;
|
|
5500
5769
|
/**
|
|
5501
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.
|
|
5502
5771
|
* @type {string}
|
|
@@ -5696,6 +5965,43 @@ export interface Instance {
|
|
|
5696
5965
|
*/
|
|
5697
5966
|
'hardClose'?: boolean | null;
|
|
5698
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
|
+
}
|
|
5699
6005
|
/**
|
|
5700
6006
|
*
|
|
5701
6007
|
* @export
|
|
@@ -6454,6 +6760,12 @@ export interface LimitedWorld {
|
|
|
6454
6760
|
* @memberof LimitedWorld
|
|
6455
6761
|
*/
|
|
6456
6762
|
'created_at': string;
|
|
6763
|
+
/**
|
|
6764
|
+
*
|
|
6765
|
+
* @type {InstanceContentSettings}
|
|
6766
|
+
* @memberof LimitedWorld
|
|
6767
|
+
*/
|
|
6768
|
+
'defaultContentSettings'?: InstanceContentSettings;
|
|
6457
6769
|
/**
|
|
6458
6770
|
*
|
|
6459
6771
|
* @type {number}
|
|
@@ -6532,6 +6844,12 @@ export interface LimitedWorld {
|
|
|
6532
6844
|
* @memberof LimitedWorld
|
|
6533
6845
|
*/
|
|
6534
6846
|
'releaseStatus': ReleaseStatus;
|
|
6847
|
+
/**
|
|
6848
|
+
*
|
|
6849
|
+
* @type {string}
|
|
6850
|
+
* @memberof LimitedWorld
|
|
6851
|
+
*/
|
|
6852
|
+
'storeId'?: string;
|
|
6535
6853
|
/**
|
|
6536
6854
|
*
|
|
6537
6855
|
* @type {Array<string>}
|
|
@@ -6604,6 +6922,18 @@ export interface ModelError {
|
|
|
6604
6922
|
* @interface ModelFile
|
|
6605
6923
|
*/
|
|
6606
6924
|
export interface ModelFile {
|
|
6925
|
+
/**
|
|
6926
|
+
*
|
|
6927
|
+
* @type {string}
|
|
6928
|
+
* @memberof ModelFile
|
|
6929
|
+
*/
|
|
6930
|
+
'animationStyle'?: string;
|
|
6931
|
+
/**
|
|
6932
|
+
*
|
|
6933
|
+
* @type {string}
|
|
6934
|
+
* @memberof ModelFile
|
|
6935
|
+
*/
|
|
6936
|
+
'maskTag'?: string;
|
|
6607
6937
|
/**
|
|
6608
6938
|
*
|
|
6609
6939
|
* @type {string}
|
|
@@ -6898,6 +7228,25 @@ export interface PastDisplayName {
|
|
|
6898
7228
|
*/
|
|
6899
7229
|
'updated_at': string;
|
|
6900
7230
|
}
|
|
7231
|
+
/**
|
|
7232
|
+
*
|
|
7233
|
+
* @export
|
|
7234
|
+
* @interface Pending2FAResult
|
|
7235
|
+
*/
|
|
7236
|
+
export interface Pending2FAResult {
|
|
7237
|
+
/**
|
|
7238
|
+
*
|
|
7239
|
+
* @type {string}
|
|
7240
|
+
* @memberof Pending2FAResult
|
|
7241
|
+
*/
|
|
7242
|
+
'qrCodeDataUrl': string;
|
|
7243
|
+
/**
|
|
7244
|
+
*
|
|
7245
|
+
* @type {string}
|
|
7246
|
+
* @memberof Pending2FAResult
|
|
7247
|
+
*/
|
|
7248
|
+
'secret': string;
|
|
7249
|
+
}
|
|
6901
7250
|
/**
|
|
6902
7251
|
* Info about the performance limits on a platform
|
|
6903
7252
|
* @export
|
|
@@ -7062,6 +7411,92 @@ export declare const PlayerModerationType: {
|
|
|
7062
7411
|
readonly InteractOff: "interactOff";
|
|
7063
7412
|
};
|
|
7064
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
|
+
}
|
|
7065
7500
|
/**
|
|
7066
7501
|
*
|
|
7067
7502
|
* @export
|
|
@@ -7442,6 +7877,67 @@ export declare const Region: {
|
|
|
7442
7877
|
readonly Unknown: "unknown";
|
|
7443
7878
|
};
|
|
7444
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
|
+
}
|
|
7445
7941
|
/**
|
|
7446
7942
|
*
|
|
7447
7943
|
* @export
|
|
@@ -7460,6 +7956,18 @@ export type ReleaseStatus = typeof ReleaseStatus[keyof typeof ReleaseStatus];
|
|
|
7460
7956
|
* @interface ReportCategory
|
|
7461
7957
|
*/
|
|
7462
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;
|
|
7463
7971
|
/**
|
|
7464
7972
|
* The label of the report category
|
|
7465
7973
|
* @type {string}
|
|
@@ -7691,20 +8199,94 @@ export interface SentNotification {
|
|
|
7691
8199
|
'type': NotificationType;
|
|
7692
8200
|
}
|
|
7693
8201
|
/**
|
|
7694
|
-
*
|
|
8202
|
+
* Statistics about the user\'s currently queued service request
|
|
7695
8203
|
* @export
|
|
7696
|
-
* @
|
|
8204
|
+
* @interface ServiceQueueStats
|
|
7697
8205
|
*/
|
|
7698
|
-
export
|
|
7699
|
-
|
|
7700
|
-
|
|
7701
|
-
|
|
7702
|
-
|
|
7703
|
-
|
|
7704
|
-
|
|
7705
|
-
|
|
7706
|
-
|
|
7707
|
-
|
|
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
|
+
}
|
|
8275
|
+
/**
|
|
8276
|
+
*
|
|
8277
|
+
* @export
|
|
8278
|
+
* @enum {string}
|
|
8279
|
+
*/
|
|
8280
|
+
export declare const SortOption: {
|
|
8281
|
+
readonly Popularity: "popularity";
|
|
8282
|
+
readonly Heat: "heat";
|
|
8283
|
+
readonly Trust: "trust";
|
|
8284
|
+
readonly Shuffle: "shuffle";
|
|
8285
|
+
readonly Random: "random";
|
|
8286
|
+
readonly Favorites: "favorites";
|
|
8287
|
+
readonly ReportScore: "reportScore";
|
|
8288
|
+
readonly ReportCount: "reportCount";
|
|
8289
|
+
readonly PublicationDate: "publicationDate";
|
|
7708
8290
|
readonly LabsPublicationDate: "labsPublicationDate";
|
|
7709
8291
|
readonly Created: "created";
|
|
7710
8292
|
readonly CreatedAt: "_created_at";
|
|
@@ -7870,6 +8452,24 @@ export interface TiliaStatus {
|
|
|
7870
8452
|
* @memberof TiliaStatus
|
|
7871
8453
|
*/
|
|
7872
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;
|
|
7873
8473
|
}
|
|
7874
8474
|
/**
|
|
7875
8475
|
*
|
|
@@ -8239,6 +8839,44 @@ export interface TwoFactorEmailCode {
|
|
|
8239
8839
|
*/
|
|
8240
8840
|
'code': string;
|
|
8241
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
|
+
}
|
|
8242
8880
|
/**
|
|
8243
8881
|
*
|
|
8244
8882
|
* @export
|
|
@@ -8625,6 +9263,25 @@ export interface UpdateInviteMessageRequest {
|
|
|
8625
9263
|
*/
|
|
8626
9264
|
'message': string;
|
|
8627
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
|
+
}
|
|
8628
9285
|
/**
|
|
8629
9286
|
*
|
|
8630
9287
|
* @export
|
|
@@ -8656,6 +9313,12 @@ export interface UpdateUserRequest {
|
|
|
8656
9313
|
* @memberof UpdateUserRequest
|
|
8657
9314
|
*/
|
|
8658
9315
|
'email'?: string;
|
|
9316
|
+
/**
|
|
9317
|
+
*
|
|
9318
|
+
* @type {boolean}
|
|
9319
|
+
* @memberof UpdateUserRequest
|
|
9320
|
+
*/
|
|
9321
|
+
'unsubscribe'?: boolean;
|
|
8659
9322
|
/**
|
|
8660
9323
|
*
|
|
8661
9324
|
* @type {string}
|
|
@@ -8716,6 +9379,36 @@ export interface UpdateUserRequest {
|
|
|
8716
9379
|
* @memberof UpdateUserRequest
|
|
8717
9380
|
*/
|
|
8718
9381
|
'userIcon'?: string;
|
|
9382
|
+
/**
|
|
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;
|
|
8719
9412
|
}
|
|
8720
9413
|
/**
|
|
8721
9414
|
*
|
|
@@ -9295,6 +9988,12 @@ export interface Verify2FAResult {
|
|
|
9295
9988
|
* @memberof Verify2FAResult
|
|
9296
9989
|
*/
|
|
9297
9990
|
'verified': boolean;
|
|
9991
|
+
/**
|
|
9992
|
+
*
|
|
9993
|
+
* @type {boolean}
|
|
9994
|
+
* @memberof Verify2FAResult
|
|
9995
|
+
*/
|
|
9996
|
+
'enabled'?: boolean;
|
|
9298
9997
|
}
|
|
9299
9998
|
/**
|
|
9300
9999
|
*
|
|
@@ -9351,6 +10050,12 @@ export interface World {
|
|
|
9351
10050
|
* @memberof World
|
|
9352
10051
|
*/
|
|
9353
10052
|
'created_at': string;
|
|
10053
|
+
/**
|
|
10054
|
+
*
|
|
10055
|
+
* @type {InstanceContentSettings}
|
|
10056
|
+
* @memberof World
|
|
10057
|
+
*/
|
|
10058
|
+
'defaultContentSettings'?: InstanceContentSettings;
|
|
9354
10059
|
/**
|
|
9355
10060
|
*
|
|
9356
10061
|
* @type {string}
|
|
@@ -9459,6 +10164,12 @@ export interface World {
|
|
|
9459
10164
|
* @memberof World
|
|
9460
10165
|
*/
|
|
9461
10166
|
'releaseStatus': ReleaseStatus;
|
|
10167
|
+
/**
|
|
10168
|
+
*
|
|
10169
|
+
* @type {string}
|
|
10170
|
+
* @memberof World
|
|
10171
|
+
*/
|
|
10172
|
+
'storeId'?: string;
|
|
9462
10173
|
/**
|
|
9463
10174
|
*
|
|
9464
10175
|
* @type {Array<string>}
|
|
@@ -9545,6 +10256,13 @@ export interface WorldPublishStatus {
|
|
|
9545
10256
|
* @export
|
|
9546
10257
|
*/
|
|
9547
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>;
|
|
9548
10266
|
/**
|
|
9549
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.
|
|
9550
10268
|
* @summary Check User Exists
|
|
@@ -9556,6 +10274,15 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
9556
10274
|
* @throws {RequiredError}
|
|
9557
10275
|
*/
|
|
9558
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>;
|
|
9559
10286
|
/**
|
|
9560
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.
|
|
9561
10288
|
* @summary Delete User
|
|
@@ -9564,6 +10291,20 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
9564
10291
|
* @throws {RequiredError}
|
|
9565
10292
|
*/
|
|
9566
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>;
|
|
9567
10308
|
/**
|
|
9568
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.
|
|
9569
10310
|
* @summary Login and/or Get Current User Info
|
|
@@ -9571,6 +10312,13 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
9571
10312
|
* @throws {RequiredError}
|
|
9572
10313
|
*/
|
|
9573
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>;
|
|
9574
10322
|
/**
|
|
9575
10323
|
* Invalidates the login session.
|
|
9576
10324
|
* @summary Logout
|
|
@@ -9578,6 +10326,22 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
9578
10326
|
* @throws {RequiredError}
|
|
9579
10327
|
*/
|
|
9580
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>;
|
|
9581
10345
|
/**
|
|
9582
10346
|
* Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
|
|
9583
10347
|
* @summary Verify 2FA code
|
|
@@ -9601,6 +10365,23 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
9601
10365
|
* @throws {RequiredError}
|
|
9602
10366
|
*/
|
|
9603
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>;
|
|
9604
10385
|
/**
|
|
9605
10386
|
* Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
|
|
9606
10387
|
* @summary Verify 2FA code with Recovery code
|
|
@@ -9615,6 +10396,13 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
9615
10396
|
* @export
|
|
9616
10397
|
*/
|
|
9617
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>>;
|
|
9618
10406
|
/**
|
|
9619
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.
|
|
9620
10408
|
* @summary Check User Exists
|
|
@@ -9626,6 +10414,15 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
9626
10414
|
* @throws {RequiredError}
|
|
9627
10415
|
*/
|
|
9628
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>>;
|
|
9629
10426
|
/**
|
|
9630
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.
|
|
9631
10428
|
* @summary Delete User
|
|
@@ -9634,6 +10431,20 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
9634
10431
|
* @throws {RequiredError}
|
|
9635
10432
|
*/
|
|
9636
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>>;
|
|
9637
10448
|
/**
|
|
9638
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.
|
|
9639
10450
|
* @summary Login and/or Get Current User Info
|
|
@@ -9641,6 +10452,13 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
9641
10452
|
* @throws {RequiredError}
|
|
9642
10453
|
*/
|
|
9643
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>>;
|
|
9644
10462
|
/**
|
|
9645
10463
|
* Invalidates the login session.
|
|
9646
10464
|
* @summary Logout
|
|
@@ -9648,6 +10466,22 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
9648
10466
|
* @throws {RequiredError}
|
|
9649
10467
|
*/
|
|
9650
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>>;
|
|
9651
10485
|
/**
|
|
9652
10486
|
* Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
|
|
9653
10487
|
* @summary Verify 2FA code
|
|
@@ -9671,6 +10505,23 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
9671
10505
|
* @throws {RequiredError}
|
|
9672
10506
|
*/
|
|
9673
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>>;
|
|
9674
10525
|
/**
|
|
9675
10526
|
* Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
|
|
9676
10527
|
* @summary Verify 2FA code with Recovery code
|
|
@@ -9685,6 +10536,13 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
9685
10536
|
* @export
|
|
9686
10537
|
*/
|
|
9687
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>;
|
|
9688
10546
|
/**
|
|
9689
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.
|
|
9690
10548
|
* @summary Check User Exists
|
|
@@ -9696,6 +10554,15 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
9696
10554
|
* @throws {RequiredError}
|
|
9697
10555
|
*/
|
|
9698
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>;
|
|
9699
10566
|
/**
|
|
9700
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.
|
|
9701
10568
|
* @summary Delete User
|
|
@@ -9704,6 +10571,20 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
9704
10571
|
* @throws {RequiredError}
|
|
9705
10572
|
*/
|
|
9706
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>;
|
|
9707
10588
|
/**
|
|
9708
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.
|
|
9709
10590
|
* @summary Login and/or Get Current User Info
|
|
@@ -9711,6 +10592,13 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
9711
10592
|
* @throws {RequiredError}
|
|
9712
10593
|
*/
|
|
9713
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>;
|
|
9714
10602
|
/**
|
|
9715
10603
|
* Invalidates the login session.
|
|
9716
10604
|
* @summary Logout
|
|
@@ -9719,7 +10607,23 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
9719
10607
|
*/
|
|
9720
10608
|
logout(options?: any): AxiosPromise<Success>;
|
|
9721
10609
|
/**
|
|
9722
|
-
*
|
|
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>;
|
|
10625
|
+
/**
|
|
10626
|
+
* Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
|
|
9723
10627
|
* @summary Verify 2FA code
|
|
9724
10628
|
* @param {TwoFactorAuthCode} twoFactorAuthCode
|
|
9725
10629
|
* @param {*} [options] Override http request option.
|
|
@@ -9741,6 +10645,23 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
9741
10645
|
* @throws {RequiredError}
|
|
9742
10646
|
*/
|
|
9743
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>;
|
|
9744
10665
|
/**
|
|
9745
10666
|
* Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
|
|
9746
10667
|
* @summary Verify 2FA code with Recovery code
|
|
@@ -9757,6 +10678,14 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
9757
10678
|
* @extends {BaseAPI}
|
|
9758
10679
|
*/
|
|
9759
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>>;
|
|
9760
10689
|
/**
|
|
9761
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.
|
|
9762
10691
|
* @summary Check User Exists
|
|
@@ -9769,6 +10698,16 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
9769
10698
|
* @memberof AuthenticationApi
|
|
9770
10699
|
*/
|
|
9771
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>>;
|
|
9772
10711
|
/**
|
|
9773
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.
|
|
9774
10713
|
* @summary Delete User
|
|
@@ -9778,6 +10717,22 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
9778
10717
|
* @memberof AuthenticationApi
|
|
9779
10718
|
*/
|
|
9780
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>>;
|
|
9781
10736
|
/**
|
|
9782
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.
|
|
9783
10738
|
* @summary Login and/or Get Current User Info
|
|
@@ -9786,6 +10741,14 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
9786
10741
|
* @memberof AuthenticationApi
|
|
9787
10742
|
*/
|
|
9788
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>>;
|
|
9789
10752
|
/**
|
|
9790
10753
|
* Invalidates the login session.
|
|
9791
10754
|
* @summary Logout
|
|
@@ -9794,6 +10757,24 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
9794
10757
|
* @memberof AuthenticationApi
|
|
9795
10758
|
*/
|
|
9796
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>>;
|
|
9797
10778
|
/**
|
|
9798
10779
|
* Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
|
|
9799
10780
|
* @summary Verify 2FA code
|
|
@@ -9820,6 +10801,25 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
9820
10801
|
* @memberof AuthenticationApi
|
|
9821
10802
|
*/
|
|
9822
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>>;
|
|
9823
10823
|
/**
|
|
9824
10824
|
* Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
|
|
9825
10825
|
* @summary Verify 2FA code with Recovery code
|
|
@@ -9851,6 +10851,22 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9851
10851
|
* @throws {RequiredError}
|
|
9852
10852
|
*/
|
|
9853
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>;
|
|
9854
10870
|
/**
|
|
9855
10871
|
* Get information about a specific Avatar.
|
|
9856
10872
|
* @summary Get Avatar
|
|
@@ -9879,6 +10895,22 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9879
10895
|
* @throws {RequiredError}
|
|
9880
10896
|
*/
|
|
9881
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>;
|
|
9882
10914
|
/**
|
|
9883
10915
|
* Get the current avatar for the user. This will return an error for any other user than the one logged in.
|
|
9884
10916
|
* @summary Get Own Avatar
|
|
@@ -9954,6 +10986,22 @@ export declare const AvatarsApiFp: (configuration?: Configuration) => {
|
|
|
9954
10986
|
* @throws {RequiredError}
|
|
9955
10987
|
*/
|
|
9956
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>>;
|
|
9957
11005
|
/**
|
|
9958
11006
|
* Get information about a specific Avatar.
|
|
9959
11007
|
* @summary Get Avatar
|
|
@@ -9982,6 +11030,22 @@ export declare const AvatarsApiFp: (configuration?: Configuration) => {
|
|
|
9982
11030
|
* @throws {RequiredError}
|
|
9983
11031
|
*/
|
|
9984
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>>>;
|
|
9985
11049
|
/**
|
|
9986
11050
|
* Get the current avatar for the user. This will return an error for any other user than the one logged in.
|
|
9987
11051
|
* @summary Get Own Avatar
|
|
@@ -10057,6 +11121,22 @@ export declare const AvatarsApiFactory: (configuration?: Configuration, basePath
|
|
|
10057
11121
|
* @throws {RequiredError}
|
|
10058
11122
|
*/
|
|
10059
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>;
|
|
10060
11140
|
/**
|
|
10061
11141
|
* Get information about a specific Avatar.
|
|
10062
11142
|
* @summary Get Avatar
|
|
@@ -10085,6 +11165,22 @@ export declare const AvatarsApiFactory: (configuration?: Configuration, basePath
|
|
|
10085
11165
|
* @throws {RequiredError}
|
|
10086
11166
|
*/
|
|
10087
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>>;
|
|
10088
11184
|
/**
|
|
10089
11185
|
* Get the current avatar for the user. This will return an error for any other user than the one logged in.
|
|
10090
11186
|
* @summary Get Own Avatar
|
|
@@ -10164,6 +11260,24 @@ export declare class AvatarsApi extends BaseAPI {
|
|
|
10164
11260
|
* @memberof AvatarsApi
|
|
10165
11261
|
*/
|
|
10166
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>>;
|
|
10167
11281
|
/**
|
|
10168
11282
|
* Get information about a specific Avatar.
|
|
10169
11283
|
* @summary Get Avatar
|
|
@@ -10194,6 +11308,24 @@ export declare class AvatarsApi extends BaseAPI {
|
|
|
10194
11308
|
* @memberof AvatarsApi
|
|
10195
11309
|
*/
|
|
10196
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>>;
|
|
10197
11329
|
/**
|
|
10198
11330
|
* Get the current avatar for the user. This will return an error for any other user than the one logged in.
|
|
10199
11331
|
* @summary Get Own Avatar
|
|
@@ -10673,14 +11805,6 @@ export declare const FavoritesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
10673
11805
|
* @throws {RequiredError}
|
|
10674
11806
|
*/
|
|
10675
11807
|
clearFavoriteGroup: (favoriteGroupType: 'world' | 'friend' | 'avatar', favoriteGroupName: string, userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10676
|
-
/**
|
|
10677
|
-
* Return information about a specific Favorite.
|
|
10678
|
-
* @summary Show Favorite
|
|
10679
|
-
* @param {string} favoriteId Must be a valid favorite ID.
|
|
10680
|
-
* @param {*} [options] Override http request option.
|
|
10681
|
-
* @throws {RequiredError}
|
|
10682
|
-
*/
|
|
10683
|
-
getFavorite: (favoriteId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10684
11808
|
/**
|
|
10685
11809
|
* Fetch information about a specific favorite group.
|
|
10686
11810
|
* @summary Show Favorite Group
|
|
@@ -10696,11 +11820,12 @@ export declare const FavoritesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
10696
11820
|
* @summary List Favorite Groups
|
|
10697
11821
|
* @param {number} [n] The number of objects to return.
|
|
10698
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.
|
|
10699
11824
|
* @param {string} [ownerId] The owner of whoms favorite groups to return. Must be a UserID.
|
|
10700
11825
|
* @param {*} [options] Override http request option.
|
|
10701
11826
|
* @throws {RequiredError}
|
|
10702
11827
|
*/
|
|
10703
|
-
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>;
|
|
10704
11829
|
/**
|
|
10705
11830
|
* Return information about a specific Favorite.
|
|
10706
11831
|
* @summary Get Favorite Limits
|
|
@@ -10762,14 +11887,6 @@ export declare const FavoritesApiFp: (configuration?: Configuration) => {
|
|
|
10762
11887
|
* @throws {RequiredError}
|
|
10763
11888
|
*/
|
|
10764
11889
|
clearFavoriteGroup(favoriteGroupType: 'world' | 'friend' | 'avatar', favoriteGroupName: string, userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>>;
|
|
10765
|
-
/**
|
|
10766
|
-
* Return information about a specific Favorite.
|
|
10767
|
-
* @summary Show Favorite
|
|
10768
|
-
* @param {string} favoriteId Must be a valid favorite ID.
|
|
10769
|
-
* @param {*} [options] Override http request option.
|
|
10770
|
-
* @throws {RequiredError}
|
|
10771
|
-
*/
|
|
10772
|
-
getFavorite(favoriteId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Favorite>>;
|
|
10773
11890
|
/**
|
|
10774
11891
|
* Fetch information about a specific favorite group.
|
|
10775
11892
|
* @summary Show Favorite Group
|
|
@@ -10785,11 +11902,12 @@ export declare const FavoritesApiFp: (configuration?: Configuration) => {
|
|
|
10785
11902
|
* @summary List Favorite Groups
|
|
10786
11903
|
* @param {number} [n] The number of objects to return.
|
|
10787
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.
|
|
10788
11906
|
* @param {string} [ownerId] The owner of whoms favorite groups to return. Must be a UserID.
|
|
10789
11907
|
* @param {*} [options] Override http request option.
|
|
10790
11908
|
* @throws {RequiredError}
|
|
10791
11909
|
*/
|
|
10792
|
-
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>>>;
|
|
10793
11911
|
/**
|
|
10794
11912
|
* Return information about a specific Favorite.
|
|
10795
11913
|
* @summary Get Favorite Limits
|
|
@@ -10851,14 +11969,6 @@ export declare const FavoritesApiFactory: (configuration?: Configuration, basePa
|
|
|
10851
11969
|
* @throws {RequiredError}
|
|
10852
11970
|
*/
|
|
10853
11971
|
clearFavoriteGroup(favoriteGroupType: 'world' | 'friend' | 'avatar', favoriteGroupName: string, userId: string, options?: any): AxiosPromise<Success>;
|
|
10854
|
-
/**
|
|
10855
|
-
* Return information about a specific Favorite.
|
|
10856
|
-
* @summary Show Favorite
|
|
10857
|
-
* @param {string} favoriteId Must be a valid favorite ID.
|
|
10858
|
-
* @param {*} [options] Override http request option.
|
|
10859
|
-
* @throws {RequiredError}
|
|
10860
|
-
*/
|
|
10861
|
-
getFavorite(favoriteId: string, options?: any): AxiosPromise<Favorite>;
|
|
10862
11972
|
/**
|
|
10863
11973
|
* Fetch information about a specific favorite group.
|
|
10864
11974
|
* @summary Show Favorite Group
|
|
@@ -10874,11 +11984,12 @@ export declare const FavoritesApiFactory: (configuration?: Configuration, basePa
|
|
|
10874
11984
|
* @summary List Favorite Groups
|
|
10875
11985
|
* @param {number} [n] The number of objects to return.
|
|
10876
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.
|
|
10877
11988
|
* @param {string} [ownerId] The owner of whoms favorite groups to return. Must be a UserID.
|
|
10878
11989
|
* @param {*} [options] Override http request option.
|
|
10879
11990
|
* @throws {RequiredError}
|
|
10880
11991
|
*/
|
|
10881
|
-
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>>;
|
|
10882
11993
|
/**
|
|
10883
11994
|
* Return information about a specific Favorite.
|
|
10884
11995
|
* @summary Get Favorite Limits
|
|
@@ -10944,15 +12055,6 @@ export declare class FavoritesApi extends BaseAPI {
|
|
|
10944
12055
|
* @memberof FavoritesApi
|
|
10945
12056
|
*/
|
|
10946
12057
|
clearFavoriteGroup(favoriteGroupType: 'world' | 'friend' | 'avatar', favoriteGroupName: string, userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
10947
|
-
/**
|
|
10948
|
-
* Return information about a specific Favorite.
|
|
10949
|
-
* @summary Show Favorite
|
|
10950
|
-
* @param {string} favoriteId Must be a valid favorite ID.
|
|
10951
|
-
* @param {*} [options] Override http request option.
|
|
10952
|
-
* @throws {RequiredError}
|
|
10953
|
-
* @memberof FavoritesApi
|
|
10954
|
-
*/
|
|
10955
|
-
getFavorite(favoriteId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Favorite, any>>;
|
|
10956
12058
|
/**
|
|
10957
12059
|
* Fetch information about a specific favorite group.
|
|
10958
12060
|
* @summary Show Favorite Group
|
|
@@ -10969,12 +12071,13 @@ export declare class FavoritesApi extends BaseAPI {
|
|
|
10969
12071
|
* @summary List Favorite Groups
|
|
10970
12072
|
* @param {number} [n] The number of objects to return.
|
|
10971
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.
|
|
10972
12075
|
* @param {string} [ownerId] The owner of whoms favorite groups to return. Must be a UserID.
|
|
10973
12076
|
* @param {*} [options] Override http request option.
|
|
10974
12077
|
* @throws {RequiredError}
|
|
10975
12078
|
* @memberof FavoritesApi
|
|
10976
12079
|
*/
|
|
10977
|
-
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>>;
|
|
10978
12081
|
/**
|
|
10979
12082
|
* Return information about a specific Favorite.
|
|
10980
12083
|
* @summary Get Favorite Limits
|
|
@@ -11143,6 +12246,35 @@ export declare const FilesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
11143
12246
|
* @throws {RequiredError}
|
|
11144
12247
|
*/
|
|
11145
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>;
|
|
11146
12278
|
};
|
|
11147
12279
|
/**
|
|
11148
12280
|
* FilesApi - functional programming interface
|
|
@@ -11191,7 +12323,7 @@ export declare const FilesApiFp: (configuration?: Configuration) => {
|
|
|
11191
12323
|
* @param {*} [options] Override http request option.
|
|
11192
12324
|
* @throws {RequiredError}
|
|
11193
12325
|
*/
|
|
11194
|
-
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>>;
|
|
11195
12327
|
/**
|
|
11196
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.
|
|
11197
12329
|
* @summary Finish FileData Upload
|
|
@@ -11270,6 +12402,35 @@ export declare const FilesApiFp: (configuration?: Configuration) => {
|
|
|
11270
12402
|
* @throws {RequiredError}
|
|
11271
12403
|
*/
|
|
11272
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>>;
|
|
11273
12434
|
};
|
|
11274
12435
|
/**
|
|
11275
12436
|
* FilesApi - factory interface
|
|
@@ -11318,7 +12479,7 @@ export declare const FilesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
11318
12479
|
* @param {*} [options] Override http request option.
|
|
11319
12480
|
* @throws {RequiredError}
|
|
11320
12481
|
*/
|
|
11321
|
-
downloadFileVersion(fileId: string, versionId: number, options?: any): AxiosPromise<
|
|
12482
|
+
downloadFileVersion(fileId: string, versionId: number, options?: any): AxiosPromise<File>;
|
|
11322
12483
|
/**
|
|
11323
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.
|
|
11324
12485
|
* @summary Finish FileData Upload
|
|
@@ -11397,6 +12558,35 @@ export declare const FilesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
11397
12558
|
* @throws {RequiredError}
|
|
11398
12559
|
*/
|
|
11399
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>;
|
|
11400
12590
|
};
|
|
11401
12591
|
/**
|
|
11402
12592
|
* FilesApi - object-oriented interface
|
|
@@ -11452,7 +12642,7 @@ export declare class FilesApi extends BaseAPI {
|
|
|
11452
12642
|
* @throws {RequiredError}
|
|
11453
12643
|
* @memberof FilesApi
|
|
11454
12644
|
*/
|
|
11455
|
-
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>>;
|
|
11456
12646
|
/**
|
|
11457
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.
|
|
11458
12648
|
* @summary Finish FileData Upload
|
|
@@ -11539,6 +12729,38 @@ export declare class FilesApi extends BaseAPI {
|
|
|
11539
12729
|
* @memberof FilesApi
|
|
11540
12730
|
*/
|
|
11541
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>>;
|
|
11542
12764
|
}
|
|
11543
12765
|
/**
|
|
11544
12766
|
* FriendsApi - axios parameter creator
|
|
@@ -12007,7 +13229,7 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
12007
13229
|
* @param {*} [options] Override http request option.
|
|
12008
13230
|
* @throws {RequiredError}
|
|
12009
13231
|
*/
|
|
12010
|
-
|
|
13232
|
+
getGroupPosts: (groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
12011
13233
|
/**
|
|
12012
13234
|
* Returns a list of members that have requested to join the Group.
|
|
12013
13235
|
* @summary Get Group Join Requests
|
|
@@ -12019,6 +13241,13 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
12019
13241
|
* @throws {RequiredError}
|
|
12020
13242
|
*/
|
|
12021
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>;
|
|
12022
13251
|
/**
|
|
12023
13252
|
* Returns a Group Role by ID.
|
|
12024
13253
|
* @summary Get Group Roles
|
|
@@ -12409,7 +13638,7 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
|
|
|
12409
13638
|
* @param {*} [options] Override http request option.
|
|
12410
13639
|
* @throws {RequiredError}
|
|
12411
13640
|
*/
|
|
12412
|
-
|
|
13641
|
+
getGroupPosts(groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetGroupPosts200Response>>;
|
|
12413
13642
|
/**
|
|
12414
13643
|
* Returns a list of members that have requested to join the Group.
|
|
12415
13644
|
* @summary Get Group Join Requests
|
|
@@ -12421,6 +13650,15 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
|
|
|
12421
13650
|
* @throws {RequiredError}
|
|
12422
13651
|
*/
|
|
12423
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
|
+
}>>;
|
|
12424
13662
|
/**
|
|
12425
13663
|
* Returns a Group Role by ID.
|
|
12426
13664
|
* @summary Get Group Roles
|
|
@@ -12811,7 +14049,7 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
|
|
|
12811
14049
|
* @param {*} [options] Override http request option.
|
|
12812
14050
|
* @throws {RequiredError}
|
|
12813
14051
|
*/
|
|
12814
|
-
|
|
14052
|
+
getGroupPosts(groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: any): AxiosPromise<GetGroupPosts200Response>;
|
|
12815
14053
|
/**
|
|
12816
14054
|
* Returns a list of members that have requested to join the Group.
|
|
12817
14055
|
* @summary Get Group Join Requests
|
|
@@ -12823,6 +14061,15 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
|
|
|
12823
14061
|
* @throws {RequiredError}
|
|
12824
14062
|
*/
|
|
12825
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
|
+
}>;
|
|
12826
14073
|
/**
|
|
12827
14074
|
* Returns a Group Role by ID.
|
|
12828
14075
|
* @summary Get Group Roles
|
|
@@ -13243,7 +14490,7 @@ export declare class GroupsApi extends BaseAPI {
|
|
|
13243
14490
|
* @throws {RequiredError}
|
|
13244
14491
|
* @memberof GroupsApi
|
|
13245
14492
|
*/
|
|
13246
|
-
|
|
14493
|
+
getGroupPosts(groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetGroupPosts200Response, any>>;
|
|
13247
14494
|
/**
|
|
13248
14495
|
* Returns a list of members that have requested to join the Group.
|
|
13249
14496
|
* @summary Get Group Join Requests
|
|
@@ -13256,6 +14503,16 @@ export declare class GroupsApi extends BaseAPI {
|
|
|
13256
14503
|
* @memberof GroupsApi
|
|
13257
14504
|
*/
|
|
13258
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>>;
|
|
13259
14516
|
/**
|
|
13260
14517
|
* Returns a Group Role by ID.
|
|
13261
14518
|
* @summary Get Group Roles
|
|
@@ -13397,7 +14654,7 @@ export declare class GroupsApi extends BaseAPI {
|
|
|
13397
14654
|
*/
|
|
13398
14655
|
export declare const InstancesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
13399
14656
|
/**
|
|
13400
|
-
* 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.
|
|
13401
14658
|
* @summary Close Instance
|
|
13402
14659
|
* @param {string} worldId Must be a valid world ID.
|
|
13403
14660
|
* @param {string} instanceId Must be a valid instance ID.
|
|
@@ -13448,7 +14705,7 @@ export declare const InstancesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
13448
14705
|
*/
|
|
13449
14706
|
export declare const InstancesApiFp: (configuration?: Configuration) => {
|
|
13450
14707
|
/**
|
|
13451
|
-
* 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.
|
|
13452
14709
|
* @summary Close Instance
|
|
13453
14710
|
* @param {string} worldId Must be a valid world ID.
|
|
13454
14711
|
* @param {string} instanceId Must be a valid instance ID.
|
|
@@ -13499,7 +14756,7 @@ export declare const InstancesApiFp: (configuration?: Configuration) => {
|
|
|
13499
14756
|
*/
|
|
13500
14757
|
export declare const InstancesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
13501
14758
|
/**
|
|
13502
|
-
* 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.
|
|
13503
14760
|
* @summary Close Instance
|
|
13504
14761
|
* @param {string} worldId Must be a valid world ID.
|
|
13505
14762
|
* @param {string} instanceId Must be a valid instance ID.
|
|
@@ -13552,7 +14809,7 @@ export declare const InstancesApiFactory: (configuration?: Configuration, basePa
|
|
|
13552
14809
|
*/
|
|
13553
14810
|
export declare class InstancesApi extends BaseAPI {
|
|
13554
14811
|
/**
|
|
13555
|
-
* 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.
|
|
13556
14813
|
* @summary Close Instance
|
|
13557
14814
|
* @param {string} worldId Must be a valid world ID.
|
|
13558
14815
|
* @param {string} instanceId Must be a valid instance ID.
|
|
@@ -13644,6 +14901,16 @@ export declare const InviteApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
13644
14901
|
* @throws {RequiredError}
|
|
13645
14902
|
*/
|
|
13646
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>;
|
|
13647
14914
|
/**
|
|
13648
14915
|
* Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
13649
14916
|
* @summary Request Invite
|
|
@@ -13654,8 +14921,18 @@ export declare const InviteApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
13654
14921
|
*/
|
|
13655
14922
|
requestInvite: (userId: string, requestInviteRequest?: RequestInviteRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13656
14923
|
/**
|
|
13657
|
-
*
|
|
13658
|
-
* @summary
|
|
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>;
|
|
14933
|
+
/**
|
|
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.
|
|
14935
|
+
* @summary Reset Invite Message
|
|
13659
14936
|
* @param {string} userId Must be a valid user ID.
|
|
13660
14937
|
* @param {InviteMessageType} messageType The type of message to fetch, must be a valid InviteMessageType.
|
|
13661
14938
|
* @param {number} slot The message slot to fetch of a given message type.
|
|
@@ -13664,7 +14941,7 @@ export declare const InviteApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
13664
14941
|
*/
|
|
13665
14942
|
resetInviteMessage: (userId: string, messageType: InviteMessageType, slot: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13666
14943
|
/**
|
|
13667
|
-
* 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.
|
|
13668
14945
|
* @summary Respond Invite
|
|
13669
14946
|
* @param {string} notificationId Must be a valid notification ID.
|
|
13670
14947
|
* @param {InviteResponse} inviteResponse Slot number of the Response Message to use when responding to a user.
|
|
@@ -13672,6 +14949,16 @@ export declare const InviteApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
13672
14949
|
* @throws {RequiredError}
|
|
13673
14950
|
*/
|
|
13674
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>;
|
|
13675
14962
|
/**
|
|
13676
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
|
|
13677
14964
|
* @summary Update Invite Message
|
|
@@ -13726,6 +15013,16 @@ export declare const InviteApiFp: (configuration?: Configuration) => {
|
|
|
13726
15013
|
* @throws {RequiredError}
|
|
13727
15014
|
*/
|
|
13728
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>>;
|
|
13729
15026
|
/**
|
|
13730
15027
|
* Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
13731
15028
|
* @summary Request Invite
|
|
@@ -13735,6 +15032,16 @@ export declare const InviteApiFp: (configuration?: Configuration) => {
|
|
|
13735
15032
|
* @throws {RequiredError}
|
|
13736
15033
|
*/
|
|
13737
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>>;
|
|
13738
15045
|
/**
|
|
13739
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.
|
|
13740
15047
|
* @summary Reset Invite Message
|
|
@@ -13746,7 +15053,7 @@ export declare const InviteApiFp: (configuration?: Configuration) => {
|
|
|
13746
15053
|
*/
|
|
13747
15054
|
resetInviteMessage(userId: string, messageType: InviteMessageType, slot: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InviteMessage>>>;
|
|
13748
15055
|
/**
|
|
13749
|
-
* 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.
|
|
13750
15057
|
* @summary Respond Invite
|
|
13751
15058
|
* @param {string} notificationId Must be a valid notification ID.
|
|
13752
15059
|
* @param {InviteResponse} inviteResponse Slot number of the Response Message to use when responding to a user.
|
|
@@ -13754,6 +15061,16 @@ export declare const InviteApiFp: (configuration?: Configuration) => {
|
|
|
13754
15061
|
* @throws {RequiredError}
|
|
13755
15062
|
*/
|
|
13756
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>>;
|
|
13757
15074
|
/**
|
|
13758
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
|
|
13759
15076
|
* @summary Update Invite Message
|
|
@@ -13808,6 +15125,16 @@ export declare const InviteApiFactory: (configuration?: Configuration, basePath?
|
|
|
13808
15125
|
* @throws {RequiredError}
|
|
13809
15126
|
*/
|
|
13810
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>;
|
|
13811
15138
|
/**
|
|
13812
15139
|
* Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
13813
15140
|
* @summary Request Invite
|
|
@@ -13817,6 +15144,16 @@ export declare const InviteApiFactory: (configuration?: Configuration, basePath?
|
|
|
13817
15144
|
* @throws {RequiredError}
|
|
13818
15145
|
*/
|
|
13819
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>;
|
|
13820
15157
|
/**
|
|
13821
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.
|
|
13822
15159
|
* @summary Reset Invite Message
|
|
@@ -13828,7 +15165,7 @@ export declare const InviteApiFactory: (configuration?: Configuration, basePath?
|
|
|
13828
15165
|
*/
|
|
13829
15166
|
resetInviteMessage(userId: string, messageType: InviteMessageType, slot: number, options?: any): AxiosPromise<Array<InviteMessage>>;
|
|
13830
15167
|
/**
|
|
13831
|
-
* 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.
|
|
13832
15169
|
* @summary Respond Invite
|
|
13833
15170
|
* @param {string} notificationId Must be a valid notification ID.
|
|
13834
15171
|
* @param {InviteResponse} inviteResponse Slot number of the Response Message to use when responding to a user.
|
|
@@ -13836,6 +15173,16 @@ export declare const InviteApiFactory: (configuration?: Configuration, basePath?
|
|
|
13836
15173
|
* @throws {RequiredError}
|
|
13837
15174
|
*/
|
|
13838
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>;
|
|
13839
15186
|
/**
|
|
13840
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
|
|
13841
15188
|
* @summary Update Invite Message
|
|
@@ -13896,6 +15243,17 @@ export declare class InviteApi extends BaseAPI {
|
|
|
13896
15243
|
* @memberof InviteApi
|
|
13897
15244
|
*/
|
|
13898
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>>;
|
|
13899
15257
|
/**
|
|
13900
15258
|
* Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
13901
15259
|
* @summary Request Invite
|
|
@@ -13906,6 +15264,17 @@ export declare class InviteApi extends BaseAPI {
|
|
|
13906
15264
|
* @memberof InviteApi
|
|
13907
15265
|
*/
|
|
13908
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>>;
|
|
13909
15278
|
/**
|
|
13910
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.
|
|
13911
15280
|
* @summary Reset Invite Message
|
|
@@ -13918,7 +15287,7 @@ export declare class InviteApi extends BaseAPI {
|
|
|
13918
15287
|
*/
|
|
13919
15288
|
resetInviteMessage(userId: string, messageType: InviteMessageType, slot: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InviteMessage[], any>>;
|
|
13920
15289
|
/**
|
|
13921
|
-
* 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.
|
|
13922
15291
|
* @summary Respond Invite
|
|
13923
15292
|
* @param {string} notificationId Must be a valid notification ID.
|
|
13924
15293
|
* @param {InviteResponse} inviteResponse Slot number of the Response Message to use when responding to a user.
|
|
@@ -13927,6 +15296,17 @@ export declare class InviteApi extends BaseAPI {
|
|
|
13927
15296
|
* @memberof InviteApi
|
|
13928
15297
|
*/
|
|
13929
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>>;
|
|
13930
15310
|
/**
|
|
13931
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
|
|
13932
15312
|
* @summary Update Invite Message
|
|
@@ -14551,6 +15931,221 @@ export declare class PlayermoderationApi extends BaseAPI {
|
|
|
14551
15931
|
*/
|
|
14552
15932
|
unmoderateUser(moderateUserRequest: ModerateUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
14553
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
|
+
}
|
|
14554
16149
|
/**
|
|
14555
16150
|
* SystemApi - axios parameter creator
|
|
14556
16151
|
* @export
|
|
@@ -14813,6 +16408,33 @@ export declare class SystemApi extends BaseAPI {
|
|
|
14813
16408
|
* @export
|
|
14814
16409
|
*/
|
|
14815
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>;
|
|
14816
16438
|
/**
|
|
14817
16439
|
* Get public user information about a specific user using their ID.
|
|
14818
16440
|
* @summary Get User by ID
|
|
@@ -14891,6 +16513,15 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
14891
16513
|
* @throws {RequiredError}
|
|
14892
16514
|
*/
|
|
14893
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>;
|
|
14894
16525
|
/**
|
|
14895
16526
|
* Search and list any users by text query
|
|
14896
16527
|
* @summary Search All Users
|
|
@@ -14902,6 +16533,16 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
14902
16533
|
* @throws {RequiredError}
|
|
14903
16534
|
*/
|
|
14904
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>;
|
|
14905
16546
|
/**
|
|
14906
16547
|
* Update a users information such as the email and birthday.
|
|
14907
16548
|
* @summary Update User Info
|
|
@@ -14925,6 +16566,33 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
14925
16566
|
* @export
|
|
14926
16567
|
*/
|
|
14927
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>>;
|
|
14928
16596
|
/**
|
|
14929
16597
|
* Get public user information about a specific user using their ID.
|
|
14930
16598
|
* @summary Get User by ID
|
|
@@ -15003,6 +16671,15 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
15003
16671
|
* @throws {RequiredError}
|
|
15004
16672
|
*/
|
|
15005
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>>;
|
|
15006
16683
|
/**
|
|
15007
16684
|
* Search and list any users by text query
|
|
15008
16685
|
* @summary Search All Users
|
|
@@ -15014,6 +16691,16 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
15014
16691
|
* @throws {RequiredError}
|
|
15015
16692
|
*/
|
|
15016
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>>;
|
|
15017
16704
|
/**
|
|
15018
16705
|
* Update a users information such as the email and birthday.
|
|
15019
16706
|
* @summary Update User Info
|
|
@@ -15037,6 +16724,33 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
15037
16724
|
* @export
|
|
15038
16725
|
*/
|
|
15039
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>;
|
|
15040
16754
|
/**
|
|
15041
16755
|
* Get public user information about a specific user using their ID.
|
|
15042
16756
|
* @summary Get User by ID
|
|
@@ -15115,6 +16829,15 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
15115
16829
|
* @throws {RequiredError}
|
|
15116
16830
|
*/
|
|
15117
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>;
|
|
15118
16841
|
/**
|
|
15119
16842
|
* Search and list any users by text query
|
|
15120
16843
|
* @summary Search All Users
|
|
@@ -15126,6 +16849,16 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
15126
16849
|
* @throws {RequiredError}
|
|
15127
16850
|
*/
|
|
15128
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>;
|
|
15129
16862
|
/**
|
|
15130
16863
|
* Update a users information such as the email and birthday.
|
|
15131
16864
|
* @summary Update User Info
|
|
@@ -15151,6 +16884,36 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
15151
16884
|
* @extends {BaseAPI}
|
|
15152
16885
|
*/
|
|
15153
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>>;
|
|
15154
16917
|
/**
|
|
15155
16918
|
* Get public user information about a specific user using their ID.
|
|
15156
16919
|
* @summary Get User by ID
|
|
@@ -15238,6 +17001,16 @@ export declare class UsersApi extends BaseAPI {
|
|
|
15238
17001
|
* @memberof UsersApi
|
|
15239
17002
|
*/
|
|
15240
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>>;
|
|
15241
17014
|
/**
|
|
15242
17015
|
* Search and list any users by text query
|
|
15243
17016
|
* @summary Search All Users
|
|
@@ -15250,6 +17023,17 @@ export declare class UsersApi extends BaseAPI {
|
|
|
15250
17023
|
* @memberof UsersApi
|
|
15251
17024
|
*/
|
|
15252
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>>;
|
|
15253
17037
|
/**
|
|
15254
17038
|
* Update a users information such as the email and birthday.
|
|
15255
17039
|
* @summary Update User Info
|
|
@@ -15275,6 +17059,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
15275
17059
|
* @export
|
|
15276
17060
|
*/
|
|
15277
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>;
|
|
15278
17071
|
/**
|
|
15279
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.
|
|
15280
17073
|
* @summary Create World
|
|
@@ -15283,6 +17076,15 @@ export declare const WorldsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15283
17076
|
* @throws {RequiredError}
|
|
15284
17077
|
*/
|
|
15285
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>;
|
|
15286
17088
|
/**
|
|
15287
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.
|
|
15288
17090
|
* @summary Delete World
|
|
@@ -15437,6 +17239,15 @@ export declare const WorldsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15437
17239
|
* @export
|
|
15438
17240
|
*/
|
|
15439
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>>;
|
|
15440
17251
|
/**
|
|
15441
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.
|
|
15442
17253
|
* @summary Create World
|
|
@@ -15445,6 +17256,15 @@ export declare const WorldsApiFp: (configuration?: Configuration) => {
|
|
|
15445
17256
|
* @throws {RequiredError}
|
|
15446
17257
|
*/
|
|
15447
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>>;
|
|
15448
17268
|
/**
|
|
15449
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.
|
|
15450
17270
|
* @summary Delete World
|
|
@@ -15599,6 +17419,15 @@ export declare const WorldsApiFp: (configuration?: Configuration) => {
|
|
|
15599
17419
|
* @export
|
|
15600
17420
|
*/
|
|
15601
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>;
|
|
15602
17431
|
/**
|
|
15603
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.
|
|
15604
17433
|
* @summary Create World
|
|
@@ -15607,6 +17436,15 @@ export declare const WorldsApiFactory: (configuration?: Configuration, basePath?
|
|
|
15607
17436
|
* @throws {RequiredError}
|
|
15608
17437
|
*/
|
|
15609
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>;
|
|
15610
17448
|
/**
|
|
15611
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.
|
|
15612
17450
|
* @summary Delete World
|
|
@@ -15763,6 +17601,16 @@ export declare const WorldsApiFactory: (configuration?: Configuration, basePath?
|
|
|
15763
17601
|
* @extends {BaseAPI}
|
|
15764
17602
|
*/
|
|
15765
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>>;
|
|
15766
17614
|
/**
|
|
15767
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.
|
|
15768
17616
|
* @summary Create World
|
|
@@ -15772,6 +17620,16 @@ export declare class WorldsApi extends BaseAPI {
|
|
|
15772
17620
|
* @memberof WorldsApi
|
|
15773
17621
|
*/
|
|
15774
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>>;
|
|
15775
17633
|
/**
|
|
15776
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.
|
|
15777
17635
|
* @summary Delete World
|