vrchat 1.19.1 → 1.19.4
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 +9251 -6056
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/cookies_load.js +21 -5
- package/cookies_store.js +16 -6
- package/dist/api.d.ts +2367 -481
- package/dist/api.js +3350 -702
- 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.4
|
|
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
|
|
@@ -8508,6 +9146,19 @@ export interface UpdateGroupMemberRequest {
|
|
|
8508
9146
|
*/
|
|
8509
9147
|
'managerNotes'?: string;
|
|
8510
9148
|
}
|
|
9149
|
+
/**
|
|
9150
|
+
*
|
|
9151
|
+
* @export
|
|
9152
|
+
* @interface UpdateGroupRepresentationRequest
|
|
9153
|
+
*/
|
|
9154
|
+
export interface UpdateGroupRepresentationRequest {
|
|
9155
|
+
/**
|
|
9156
|
+
* Whether the user is representing the group.
|
|
9157
|
+
* @type {boolean}
|
|
9158
|
+
* @memberof UpdateGroupRepresentationRequest
|
|
9159
|
+
*/
|
|
9160
|
+
'isRepresenting': boolean;
|
|
9161
|
+
}
|
|
8511
9162
|
/**
|
|
8512
9163
|
*
|
|
8513
9164
|
* @export
|
|
@@ -8625,6 +9276,25 @@ export interface UpdateInviteMessageRequest {
|
|
|
8625
9276
|
*/
|
|
8626
9277
|
'message': string;
|
|
8627
9278
|
}
|
|
9279
|
+
/**
|
|
9280
|
+
*
|
|
9281
|
+
* @export
|
|
9282
|
+
* @interface UpdateUserBadgeRequest
|
|
9283
|
+
*/
|
|
9284
|
+
export interface UpdateUserBadgeRequest {
|
|
9285
|
+
/**
|
|
9286
|
+
*
|
|
9287
|
+
* @type {boolean}
|
|
9288
|
+
* @memberof UpdateUserBadgeRequest
|
|
9289
|
+
*/
|
|
9290
|
+
'hidden'?: boolean;
|
|
9291
|
+
/**
|
|
9292
|
+
*
|
|
9293
|
+
* @type {boolean}
|
|
9294
|
+
* @memberof UpdateUserBadgeRequest
|
|
9295
|
+
*/
|
|
9296
|
+
'showcased'?: boolean;
|
|
9297
|
+
}
|
|
8628
9298
|
/**
|
|
8629
9299
|
*
|
|
8630
9300
|
* @export
|
|
@@ -8656,6 +9326,12 @@ export interface UpdateUserRequest {
|
|
|
8656
9326
|
* @memberof UpdateUserRequest
|
|
8657
9327
|
*/
|
|
8658
9328
|
'email'?: string;
|
|
9329
|
+
/**
|
|
9330
|
+
*
|
|
9331
|
+
* @type {boolean}
|
|
9332
|
+
* @memberof UpdateUserRequest
|
|
9333
|
+
*/
|
|
9334
|
+
'unsubscribe'?: boolean;
|
|
8659
9335
|
/**
|
|
8660
9336
|
*
|
|
8661
9337
|
* @type {string}
|
|
@@ -8716,6 +9392,36 @@ export interface UpdateUserRequest {
|
|
|
8716
9392
|
* @memberof UpdateUserRequest
|
|
8717
9393
|
*/
|
|
8718
9394
|
'userIcon'?: string;
|
|
9395
|
+
/**
|
|
9396
|
+
* These tags begin with `content_` and control content gating
|
|
9397
|
+
* @type {Array<string>}
|
|
9398
|
+
* @memberof UpdateUserRequest
|
|
9399
|
+
*/
|
|
9400
|
+
'contentFilters'?: Array<string>;
|
|
9401
|
+
/**
|
|
9402
|
+
* MUST specify currentPassword as well to change display name
|
|
9403
|
+
* @type {string}
|
|
9404
|
+
* @memberof UpdateUserRequest
|
|
9405
|
+
*/
|
|
9406
|
+
'displayName'?: string;
|
|
9407
|
+
/**
|
|
9408
|
+
* MUST specify currentPassword as well to revert display name
|
|
9409
|
+
* @type {boolean}
|
|
9410
|
+
* @memberof UpdateUserRequest
|
|
9411
|
+
*/
|
|
9412
|
+
'revertDisplayName'?: boolean;
|
|
9413
|
+
/**
|
|
9414
|
+
* MUST specify currentPassword as well to change password
|
|
9415
|
+
* @type {string}
|
|
9416
|
+
* @memberof UpdateUserRequest
|
|
9417
|
+
*/
|
|
9418
|
+
'password'?: string;
|
|
9419
|
+
/**
|
|
9420
|
+
*
|
|
9421
|
+
* @type {string}
|
|
9422
|
+
* @memberof UpdateUserRequest
|
|
9423
|
+
*/
|
|
9424
|
+
'currentPassword'?: string;
|
|
8719
9425
|
}
|
|
8720
9426
|
/**
|
|
8721
9427
|
*
|
|
@@ -9295,6 +10001,12 @@ export interface Verify2FAResult {
|
|
|
9295
10001
|
* @memberof Verify2FAResult
|
|
9296
10002
|
*/
|
|
9297
10003
|
'verified': boolean;
|
|
10004
|
+
/**
|
|
10005
|
+
*
|
|
10006
|
+
* @type {boolean}
|
|
10007
|
+
* @memberof Verify2FAResult
|
|
10008
|
+
*/
|
|
10009
|
+
'enabled'?: boolean;
|
|
9298
10010
|
}
|
|
9299
10011
|
/**
|
|
9300
10012
|
*
|
|
@@ -9351,6 +10063,12 @@ export interface World {
|
|
|
9351
10063
|
* @memberof World
|
|
9352
10064
|
*/
|
|
9353
10065
|
'created_at': string;
|
|
10066
|
+
/**
|
|
10067
|
+
*
|
|
10068
|
+
* @type {InstanceContentSettings}
|
|
10069
|
+
* @memberof World
|
|
10070
|
+
*/
|
|
10071
|
+
'defaultContentSettings'?: InstanceContentSettings;
|
|
9354
10072
|
/**
|
|
9355
10073
|
*
|
|
9356
10074
|
* @type {string}
|
|
@@ -9459,6 +10177,12 @@ export interface World {
|
|
|
9459
10177
|
* @memberof World
|
|
9460
10178
|
*/
|
|
9461
10179
|
'releaseStatus': ReleaseStatus;
|
|
10180
|
+
/**
|
|
10181
|
+
*
|
|
10182
|
+
* @type {string}
|
|
10183
|
+
* @memberof World
|
|
10184
|
+
*/
|
|
10185
|
+
'storeId'?: string;
|
|
9462
10186
|
/**
|
|
9463
10187
|
*
|
|
9464
10188
|
* @type {Array<string>}
|
|
@@ -9545,6 +10269,13 @@ export interface WorldPublishStatus {
|
|
|
9545
10269
|
* @export
|
|
9546
10270
|
*/
|
|
9547
10271
|
export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
10272
|
+
/**
|
|
10273
|
+
* Cancels the sequence for enabling time-based 2FA.
|
|
10274
|
+
* @summary Cancel pending enabling of time-based 2FA codes
|
|
10275
|
+
* @param {*} [options] Override http request option.
|
|
10276
|
+
* @throws {RequiredError}
|
|
10277
|
+
*/
|
|
10278
|
+
cancelPending2FA: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9548
10279
|
/**
|
|
9549
10280
|
* 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
10281
|
* @summary Check User Exists
|
|
@@ -9556,6 +10287,15 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
9556
10287
|
* @throws {RequiredError}
|
|
9557
10288
|
*/
|
|
9558
10289
|
checkUserExists: (email?: string, displayName?: string, username?: string, excludeUserId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10290
|
+
/**
|
|
10291
|
+
* Confirms the email address for a user
|
|
10292
|
+
* @summary Confirm Email
|
|
10293
|
+
* @param {string} id Target user for which to verify email.
|
|
10294
|
+
* @param {string} verifyEmail Token to verify email.
|
|
10295
|
+
* @param {*} [options] Override http request option.
|
|
10296
|
+
* @throws {RequiredError}
|
|
10297
|
+
*/
|
|
10298
|
+
confirmEmail: (id: string, verifyEmail: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9559
10299
|
/**
|
|
9560
10300
|
* 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
10301
|
* @summary Delete User
|
|
@@ -9564,6 +10304,20 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
9564
10304
|
* @throws {RequiredError}
|
|
9565
10305
|
*/
|
|
9566
10306
|
deleteUser: (userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10307
|
+
/**
|
|
10308
|
+
* Disables 2FA for the currently logged in account
|
|
10309
|
+
* @summary Disable 2FA
|
|
10310
|
+
* @param {*} [options] Override http request option.
|
|
10311
|
+
* @throws {RequiredError}
|
|
10312
|
+
*/
|
|
10313
|
+
disable2FA: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10314
|
+
/**
|
|
10315
|
+
* Begins the sequence for enabling time-based 2FA.
|
|
10316
|
+
* @summary Enable time-based 2FA codes
|
|
10317
|
+
* @param {*} [options] Override http request option.
|
|
10318
|
+
* @throws {RequiredError}
|
|
10319
|
+
*/
|
|
10320
|
+
enable2FA: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9567
10321
|
/**
|
|
9568
10322
|
* 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
10323
|
* @summary Login and/or Get Current User Info
|
|
@@ -9571,6 +10325,13 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
9571
10325
|
* @throws {RequiredError}
|
|
9572
10326
|
*/
|
|
9573
10327
|
getCurrentUser: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10328
|
+
/**
|
|
10329
|
+
* Gets the OTP (One Time Password) recovery codes for accounts with 2FA-protection enabled.
|
|
10330
|
+
* @summary Get 2FA Recovery codes
|
|
10331
|
+
* @param {*} [options] Override http request option.
|
|
10332
|
+
* @throws {RequiredError}
|
|
10333
|
+
*/
|
|
10334
|
+
getRecoveryCodes: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9574
10335
|
/**
|
|
9575
10336
|
* Invalidates the login session.
|
|
9576
10337
|
* @summary Logout
|
|
@@ -9578,6 +10339,22 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
9578
10339
|
* @throws {RequiredError}
|
|
9579
10340
|
*/
|
|
9580
10341
|
logout: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10342
|
+
/**
|
|
10343
|
+
* ~~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
|
|
10344
|
+
* @summary Register User Account
|
|
10345
|
+
* @param {RegisterUserAccountRequest} registerUserAccountRequest
|
|
10346
|
+
* @param {*} [options] Override http request option.
|
|
10347
|
+
* @deprecated
|
|
10348
|
+
* @throws {RequiredError}
|
|
10349
|
+
*/
|
|
10350
|
+
registerUserAccount: (registerUserAccountRequest: RegisterUserAccountRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10351
|
+
/**
|
|
10352
|
+
* Requests a resend of pending email address confirmation email
|
|
10353
|
+
* @summary Resend Email Confirmation
|
|
10354
|
+
* @param {*} [options] Override http request option.
|
|
10355
|
+
* @throws {RequiredError}
|
|
10356
|
+
*/
|
|
10357
|
+
resendEmailConfirmation: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9581
10358
|
/**
|
|
9582
10359
|
* Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
|
|
9583
10360
|
* @summary Verify 2FA code
|
|
@@ -9601,6 +10378,23 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
9601
10378
|
* @throws {RequiredError}
|
|
9602
10379
|
*/
|
|
9603
10380
|
verifyAuthToken: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10381
|
+
/**
|
|
10382
|
+
* Verifies a login attempt for a user
|
|
10383
|
+
* @summary Verify Login Place
|
|
10384
|
+
* @param {string} token Token to verify login attempt.
|
|
10385
|
+
* @param {string} [userId] Filter by UserID.
|
|
10386
|
+
* @param {*} [options] Override http request option.
|
|
10387
|
+
* @throws {RequiredError}
|
|
10388
|
+
*/
|
|
10389
|
+
verifyLoginPlace: (token: string, userId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10390
|
+
/**
|
|
10391
|
+
* Finishes sequence for enabling time-based 2FA.
|
|
10392
|
+
* @summary Verify Pending 2FA code
|
|
10393
|
+
* @param {TwoFactorAuthCode} twoFactorAuthCode
|
|
10394
|
+
* @param {*} [options] Override http request option.
|
|
10395
|
+
* @throws {RequiredError}
|
|
10396
|
+
*/
|
|
10397
|
+
verifyPending2FA: (twoFactorAuthCode: TwoFactorAuthCode, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9604
10398
|
/**
|
|
9605
10399
|
* Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
|
|
9606
10400
|
* @summary Verify 2FA code with Recovery code
|
|
@@ -9615,6 +10409,13 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
9615
10409
|
* @export
|
|
9616
10410
|
*/
|
|
9617
10411
|
export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
10412
|
+
/**
|
|
10413
|
+
* Cancels the sequence for enabling time-based 2FA.
|
|
10414
|
+
* @summary Cancel pending enabling of time-based 2FA codes
|
|
10415
|
+
* @param {*} [options] Override http request option.
|
|
10416
|
+
* @throws {RequiredError}
|
|
10417
|
+
*/
|
|
10418
|
+
cancelPending2FA(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Disable2FAResult>>;
|
|
9618
10419
|
/**
|
|
9619
10420
|
* 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
10421
|
* @summary Check User Exists
|
|
@@ -9626,6 +10427,15 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
9626
10427
|
* @throws {RequiredError}
|
|
9627
10428
|
*/
|
|
9628
10429
|
checkUserExists(email?: string, displayName?: string, username?: string, excludeUserId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserExists>>;
|
|
10430
|
+
/**
|
|
10431
|
+
* Confirms the email address for a user
|
|
10432
|
+
* @summary Confirm Email
|
|
10433
|
+
* @param {string} id Target user for which to verify email.
|
|
10434
|
+
* @param {string} verifyEmail Token to verify email.
|
|
10435
|
+
* @param {*} [options] Override http request option.
|
|
10436
|
+
* @throws {RequiredError}
|
|
10437
|
+
*/
|
|
10438
|
+
confirmEmail(id: string, verifyEmail: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9629
10439
|
/**
|
|
9630
10440
|
* 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
10441
|
* @summary Delete User
|
|
@@ -9634,6 +10444,20 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
9634
10444
|
* @throws {RequiredError}
|
|
9635
10445
|
*/
|
|
9636
10446
|
deleteUser(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>>;
|
|
10447
|
+
/**
|
|
10448
|
+
* Disables 2FA for the currently logged in account
|
|
10449
|
+
* @summary Disable 2FA
|
|
10450
|
+
* @param {*} [options] Override http request option.
|
|
10451
|
+
* @throws {RequiredError}
|
|
10452
|
+
*/
|
|
10453
|
+
disable2FA(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Disable2FAResult>>;
|
|
10454
|
+
/**
|
|
10455
|
+
* Begins the sequence for enabling time-based 2FA.
|
|
10456
|
+
* @summary Enable time-based 2FA codes
|
|
10457
|
+
* @param {*} [options] Override http request option.
|
|
10458
|
+
* @throws {RequiredError}
|
|
10459
|
+
*/
|
|
10460
|
+
enable2FA(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pending2FAResult>>;
|
|
9637
10461
|
/**
|
|
9638
10462
|
* 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
10463
|
* @summary Login and/or Get Current User Info
|
|
@@ -9641,6 +10465,13 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
9641
10465
|
* @throws {RequiredError}
|
|
9642
10466
|
*/
|
|
9643
10467
|
getCurrentUser(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>>;
|
|
10468
|
+
/**
|
|
10469
|
+
* Gets the OTP (One Time Password) recovery codes for accounts with 2FA-protection enabled.
|
|
10470
|
+
* @summary Get 2FA Recovery codes
|
|
10471
|
+
* @param {*} [options] Override http request option.
|
|
10472
|
+
* @throws {RequiredError}
|
|
10473
|
+
*/
|
|
10474
|
+
getRecoveryCodes(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TwoFactorRecoveryCodes>>;
|
|
9644
10475
|
/**
|
|
9645
10476
|
* Invalidates the login session.
|
|
9646
10477
|
* @summary Logout
|
|
@@ -9648,6 +10479,22 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
9648
10479
|
* @throws {RequiredError}
|
|
9649
10480
|
*/
|
|
9650
10481
|
logout(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>>;
|
|
10482
|
+
/**
|
|
10483
|
+
* ~~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
|
|
10484
|
+
* @summary Register User Account
|
|
10485
|
+
* @param {RegisterUserAccountRequest} registerUserAccountRequest
|
|
10486
|
+
* @param {*} [options] Override http request option.
|
|
10487
|
+
* @deprecated
|
|
10488
|
+
* @throws {RequiredError}
|
|
10489
|
+
*/
|
|
10490
|
+
registerUserAccount(registerUserAccountRequest: RegisterUserAccountRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>>;
|
|
10491
|
+
/**
|
|
10492
|
+
* Requests a resend of pending email address confirmation email
|
|
10493
|
+
* @summary Resend Email Confirmation
|
|
10494
|
+
* @param {*} [options] Override http request option.
|
|
10495
|
+
* @throws {RequiredError}
|
|
10496
|
+
*/
|
|
10497
|
+
resendEmailConfirmation(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>>;
|
|
9651
10498
|
/**
|
|
9652
10499
|
* Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
|
|
9653
10500
|
* @summary Verify 2FA code
|
|
@@ -9671,6 +10518,23 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
9671
10518
|
* @throws {RequiredError}
|
|
9672
10519
|
*/
|
|
9673
10520
|
verifyAuthToken(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VerifyAuthTokenResult>>;
|
|
10521
|
+
/**
|
|
10522
|
+
* Verifies a login attempt for a user
|
|
10523
|
+
* @summary Verify Login Place
|
|
10524
|
+
* @param {string} token Token to verify login attempt.
|
|
10525
|
+
* @param {string} [userId] Filter by UserID.
|
|
10526
|
+
* @param {*} [options] Override http request option.
|
|
10527
|
+
* @throws {RequiredError}
|
|
10528
|
+
*/
|
|
10529
|
+
verifyLoginPlace(token: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
10530
|
+
/**
|
|
10531
|
+
* Finishes sequence for enabling time-based 2FA.
|
|
10532
|
+
* @summary Verify Pending 2FA code
|
|
10533
|
+
* @param {TwoFactorAuthCode} twoFactorAuthCode
|
|
10534
|
+
* @param {*} [options] Override http request option.
|
|
10535
|
+
* @throws {RequiredError}
|
|
10536
|
+
*/
|
|
10537
|
+
verifyPending2FA(twoFactorAuthCode: TwoFactorAuthCode, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Verify2FAResult>>;
|
|
9674
10538
|
/**
|
|
9675
10539
|
* Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
|
|
9676
10540
|
* @summary Verify 2FA code with Recovery code
|
|
@@ -9685,6 +10549,13 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
9685
10549
|
* @export
|
|
9686
10550
|
*/
|
|
9687
10551
|
export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
10552
|
+
/**
|
|
10553
|
+
* Cancels the sequence for enabling time-based 2FA.
|
|
10554
|
+
* @summary Cancel pending enabling of time-based 2FA codes
|
|
10555
|
+
* @param {*} [options] Override http request option.
|
|
10556
|
+
* @throws {RequiredError}
|
|
10557
|
+
*/
|
|
10558
|
+
cancelPending2FA(options?: any): AxiosPromise<Disable2FAResult>;
|
|
9688
10559
|
/**
|
|
9689
10560
|
* 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
10561
|
* @summary Check User Exists
|
|
@@ -9696,6 +10567,15 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
9696
10567
|
* @throws {RequiredError}
|
|
9697
10568
|
*/
|
|
9698
10569
|
checkUserExists(email?: string, displayName?: string, username?: string, excludeUserId?: string, options?: any): AxiosPromise<UserExists>;
|
|
10570
|
+
/**
|
|
10571
|
+
* Confirms the email address for a user
|
|
10572
|
+
* @summary Confirm Email
|
|
10573
|
+
* @param {string} id Target user for which to verify email.
|
|
10574
|
+
* @param {string} verifyEmail Token to verify email.
|
|
10575
|
+
* @param {*} [options] Override http request option.
|
|
10576
|
+
* @throws {RequiredError}
|
|
10577
|
+
*/
|
|
10578
|
+
confirmEmail(id: string, verifyEmail: string, options?: any): AxiosPromise<void>;
|
|
9699
10579
|
/**
|
|
9700
10580
|
* 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
10581
|
* @summary Delete User
|
|
@@ -9705,19 +10585,56 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
9705
10585
|
*/
|
|
9706
10586
|
deleteUser(userId: string, options?: any): AxiosPromise<CurrentUser>;
|
|
9707
10587
|
/**
|
|
9708
|
-
*
|
|
9709
|
-
* @summary
|
|
10588
|
+
* Disables 2FA for the currently logged in account
|
|
10589
|
+
* @summary Disable 2FA
|
|
9710
10590
|
* @param {*} [options] Override http request option.
|
|
9711
10591
|
* @throws {RequiredError}
|
|
9712
10592
|
*/
|
|
9713
|
-
|
|
10593
|
+
disable2FA(options?: any): AxiosPromise<Disable2FAResult>;
|
|
9714
10594
|
/**
|
|
9715
|
-
*
|
|
9716
|
-
* @summary
|
|
10595
|
+
* Begins the sequence for enabling time-based 2FA.
|
|
10596
|
+
* @summary Enable time-based 2FA codes
|
|
10597
|
+
* @param {*} [options] Override http request option.
|
|
10598
|
+
* @throws {RequiredError}
|
|
10599
|
+
*/
|
|
10600
|
+
enable2FA(options?: any): AxiosPromise<Pending2FAResult>;
|
|
10601
|
+
/**
|
|
10602
|
+
* 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.
|
|
10603
|
+
* @summary Login and/or Get Current User Info
|
|
10604
|
+
* @param {*} [options] Override http request option.
|
|
10605
|
+
* @throws {RequiredError}
|
|
10606
|
+
*/
|
|
10607
|
+
getCurrentUser(options?: any): AxiosPromise<CurrentUser>;
|
|
10608
|
+
/**
|
|
10609
|
+
* Gets the OTP (One Time Password) recovery codes for accounts with 2FA-protection enabled.
|
|
10610
|
+
* @summary Get 2FA Recovery codes
|
|
10611
|
+
* @param {*} [options] Override http request option.
|
|
10612
|
+
* @throws {RequiredError}
|
|
10613
|
+
*/
|
|
10614
|
+
getRecoveryCodes(options?: any): AxiosPromise<TwoFactorRecoveryCodes>;
|
|
10615
|
+
/**
|
|
10616
|
+
* Invalidates the login session.
|
|
10617
|
+
* @summary Logout
|
|
9717
10618
|
* @param {*} [options] Override http request option.
|
|
9718
10619
|
* @throws {RequiredError}
|
|
9719
10620
|
*/
|
|
9720
10621
|
logout(options?: any): AxiosPromise<Success>;
|
|
10622
|
+
/**
|
|
10623
|
+
* ~~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
|
|
10624
|
+
* @summary Register User Account
|
|
10625
|
+
* @param {RegisterUserAccountRequest} registerUserAccountRequest
|
|
10626
|
+
* @param {*} [options] Override http request option.
|
|
10627
|
+
* @deprecated
|
|
10628
|
+
* @throws {RequiredError}
|
|
10629
|
+
*/
|
|
10630
|
+
registerUserAccount(registerUserAccountRequest: RegisterUserAccountRequest, options?: any): AxiosPromise<CurrentUser>;
|
|
10631
|
+
/**
|
|
10632
|
+
* Requests a resend of pending email address confirmation email
|
|
10633
|
+
* @summary Resend Email Confirmation
|
|
10634
|
+
* @param {*} [options] Override http request option.
|
|
10635
|
+
* @throws {RequiredError}
|
|
10636
|
+
*/
|
|
10637
|
+
resendEmailConfirmation(options?: any): AxiosPromise<Success>;
|
|
9721
10638
|
/**
|
|
9722
10639
|
* Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
|
|
9723
10640
|
* @summary Verify 2FA code
|
|
@@ -9741,6 +10658,23 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
9741
10658
|
* @throws {RequiredError}
|
|
9742
10659
|
*/
|
|
9743
10660
|
verifyAuthToken(options?: any): AxiosPromise<VerifyAuthTokenResult>;
|
|
10661
|
+
/**
|
|
10662
|
+
* Verifies a login attempt for a user
|
|
10663
|
+
* @summary Verify Login Place
|
|
10664
|
+
* @param {string} token Token to verify login attempt.
|
|
10665
|
+
* @param {string} [userId] Filter by UserID.
|
|
10666
|
+
* @param {*} [options] Override http request option.
|
|
10667
|
+
* @throws {RequiredError}
|
|
10668
|
+
*/
|
|
10669
|
+
verifyLoginPlace(token: string, userId?: string, options?: any): AxiosPromise<void>;
|
|
10670
|
+
/**
|
|
10671
|
+
* Finishes sequence for enabling time-based 2FA.
|
|
10672
|
+
* @summary Verify Pending 2FA code
|
|
10673
|
+
* @param {TwoFactorAuthCode} twoFactorAuthCode
|
|
10674
|
+
* @param {*} [options] Override http request option.
|
|
10675
|
+
* @throws {RequiredError}
|
|
10676
|
+
*/
|
|
10677
|
+
verifyPending2FA(twoFactorAuthCode: TwoFactorAuthCode, options?: any): AxiosPromise<Verify2FAResult>;
|
|
9744
10678
|
/**
|
|
9745
10679
|
* Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
|
|
9746
10680
|
* @summary Verify 2FA code with Recovery code
|
|
@@ -9757,6 +10691,14 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
9757
10691
|
* @extends {BaseAPI}
|
|
9758
10692
|
*/
|
|
9759
10693
|
export declare class AuthenticationApi extends BaseAPI {
|
|
10694
|
+
/**
|
|
10695
|
+
* Cancels the sequence for enabling time-based 2FA.
|
|
10696
|
+
* @summary Cancel pending enabling of time-based 2FA codes
|
|
10697
|
+
* @param {*} [options] Override http request option.
|
|
10698
|
+
* @throws {RequiredError}
|
|
10699
|
+
* @memberof AuthenticationApi
|
|
10700
|
+
*/
|
|
10701
|
+
cancelPending2FA(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Disable2FAResult, any>>;
|
|
9760
10702
|
/**
|
|
9761
10703
|
* 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
10704
|
* @summary Check User Exists
|
|
@@ -9769,6 +10711,16 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
9769
10711
|
* @memberof AuthenticationApi
|
|
9770
10712
|
*/
|
|
9771
10713
|
checkUserExists(email?: string, displayName?: string, username?: string, excludeUserId?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserExists, any>>;
|
|
10714
|
+
/**
|
|
10715
|
+
* Confirms the email address for a user
|
|
10716
|
+
* @summary Confirm Email
|
|
10717
|
+
* @param {string} id Target user for which to verify email.
|
|
10718
|
+
* @param {string} verifyEmail Token to verify email.
|
|
10719
|
+
* @param {*} [options] Override http request option.
|
|
10720
|
+
* @throws {RequiredError}
|
|
10721
|
+
* @memberof AuthenticationApi
|
|
10722
|
+
*/
|
|
10723
|
+
confirmEmail(id: string, verifyEmail: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9772
10724
|
/**
|
|
9773
10725
|
* 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
10726
|
* @summary Delete User
|
|
@@ -9778,6 +10730,22 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
9778
10730
|
* @memberof AuthenticationApi
|
|
9779
10731
|
*/
|
|
9780
10732
|
deleteUser(userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CurrentUser, any>>;
|
|
10733
|
+
/**
|
|
10734
|
+
* Disables 2FA for the currently logged in account
|
|
10735
|
+
* @summary Disable 2FA
|
|
10736
|
+
* @param {*} [options] Override http request option.
|
|
10737
|
+
* @throws {RequiredError}
|
|
10738
|
+
* @memberof AuthenticationApi
|
|
10739
|
+
*/
|
|
10740
|
+
disable2FA(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Disable2FAResult, any>>;
|
|
10741
|
+
/**
|
|
10742
|
+
* Begins the sequence for enabling time-based 2FA.
|
|
10743
|
+
* @summary Enable time-based 2FA codes
|
|
10744
|
+
* @param {*} [options] Override http request option.
|
|
10745
|
+
* @throws {RequiredError}
|
|
10746
|
+
* @memberof AuthenticationApi
|
|
10747
|
+
*/
|
|
10748
|
+
enable2FA(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Pending2FAResult, any>>;
|
|
9781
10749
|
/**
|
|
9782
10750
|
* 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
10751
|
* @summary Login and/or Get Current User Info
|
|
@@ -9786,6 +10754,14 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
9786
10754
|
* @memberof AuthenticationApi
|
|
9787
10755
|
*/
|
|
9788
10756
|
getCurrentUser(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CurrentUser, any>>;
|
|
10757
|
+
/**
|
|
10758
|
+
* Gets the OTP (One Time Password) recovery codes for accounts with 2FA-protection enabled.
|
|
10759
|
+
* @summary Get 2FA Recovery codes
|
|
10760
|
+
* @param {*} [options] Override http request option.
|
|
10761
|
+
* @throws {RequiredError}
|
|
10762
|
+
* @memberof AuthenticationApi
|
|
10763
|
+
*/
|
|
10764
|
+
getRecoveryCodes(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TwoFactorRecoveryCodes, any>>;
|
|
9789
10765
|
/**
|
|
9790
10766
|
* Invalidates the login session.
|
|
9791
10767
|
* @summary Logout
|
|
@@ -9794,6 +10770,24 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
9794
10770
|
* @memberof AuthenticationApi
|
|
9795
10771
|
*/
|
|
9796
10772
|
logout(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
10773
|
+
/**
|
|
10774
|
+
* ~~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
|
|
10775
|
+
* @summary Register User Account
|
|
10776
|
+
* @param {RegisterUserAccountRequest} registerUserAccountRequest
|
|
10777
|
+
* @param {*} [options] Override http request option.
|
|
10778
|
+
* @deprecated
|
|
10779
|
+
* @throws {RequiredError}
|
|
10780
|
+
* @memberof AuthenticationApi
|
|
10781
|
+
*/
|
|
10782
|
+
registerUserAccount(registerUserAccountRequest: RegisterUserAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CurrentUser, any>>;
|
|
10783
|
+
/**
|
|
10784
|
+
* Requests a resend of pending email address confirmation email
|
|
10785
|
+
* @summary Resend Email Confirmation
|
|
10786
|
+
* @param {*} [options] Override http request option.
|
|
10787
|
+
* @throws {RequiredError}
|
|
10788
|
+
* @memberof AuthenticationApi
|
|
10789
|
+
*/
|
|
10790
|
+
resendEmailConfirmation(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
9797
10791
|
/**
|
|
9798
10792
|
* Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
|
|
9799
10793
|
* @summary Verify 2FA code
|
|
@@ -9820,6 +10814,25 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
9820
10814
|
* @memberof AuthenticationApi
|
|
9821
10815
|
*/
|
|
9822
10816
|
verifyAuthToken(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VerifyAuthTokenResult, any>>;
|
|
10817
|
+
/**
|
|
10818
|
+
* Verifies a login attempt for a user
|
|
10819
|
+
* @summary Verify Login Place
|
|
10820
|
+
* @param {string} token Token to verify login attempt.
|
|
10821
|
+
* @param {string} [userId] Filter by UserID.
|
|
10822
|
+
* @param {*} [options] Override http request option.
|
|
10823
|
+
* @throws {RequiredError}
|
|
10824
|
+
* @memberof AuthenticationApi
|
|
10825
|
+
*/
|
|
10826
|
+
verifyLoginPlace(token: string, userId?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
10827
|
+
/**
|
|
10828
|
+
* Finishes sequence for enabling time-based 2FA.
|
|
10829
|
+
* @summary Verify Pending 2FA code
|
|
10830
|
+
* @param {TwoFactorAuthCode} twoFactorAuthCode
|
|
10831
|
+
* @param {*} [options] Override http request option.
|
|
10832
|
+
* @throws {RequiredError}
|
|
10833
|
+
* @memberof AuthenticationApi
|
|
10834
|
+
*/
|
|
10835
|
+
verifyPending2FA(twoFactorAuthCode: TwoFactorAuthCode, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Verify2FAResult, any>>;
|
|
9823
10836
|
/**
|
|
9824
10837
|
* Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
|
|
9825
10838
|
* @summary Verify 2FA code with Recovery code
|
|
@@ -9851,6 +10864,22 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9851
10864
|
* @throws {RequiredError}
|
|
9852
10865
|
*/
|
|
9853
10866
|
deleteAvatar: (avatarId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10867
|
+
/**
|
|
10868
|
+
* Delete generated Impostor for that avatar.
|
|
10869
|
+
* @summary Delete generated Impostor
|
|
10870
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
10871
|
+
* @param {*} [options] Override http request option.
|
|
10872
|
+
* @throws {RequiredError}
|
|
10873
|
+
*/
|
|
10874
|
+
deleteImpostor: (avatarId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10875
|
+
/**
|
|
10876
|
+
* Enqueue Impostor generation for that avatar.
|
|
10877
|
+
* @summary Enqueue Impostor generation
|
|
10878
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
10879
|
+
* @param {*} [options] Override http request option.
|
|
10880
|
+
* @throws {RequiredError}
|
|
10881
|
+
*/
|
|
10882
|
+
enqueueImpostor: (avatarId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9854
10883
|
/**
|
|
9855
10884
|
* Get information about a specific Avatar.
|
|
9856
10885
|
* @summary Get Avatar
|
|
@@ -9879,6 +10908,22 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9879
10908
|
* @throws {RequiredError}
|
|
9880
10909
|
*/
|
|
9881
10910
|
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>;
|
|
10911
|
+
/**
|
|
10912
|
+
* Gets service stats for queued impostor.
|
|
10913
|
+
* @summary Get Impostor Queue Stats
|
|
10914
|
+
* @param {*} [options] Override http request option.
|
|
10915
|
+
* @throws {RequiredError}
|
|
10916
|
+
*/
|
|
10917
|
+
getImpostorQueueStats: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10918
|
+
/**
|
|
10919
|
+
* List licensed avatars.
|
|
10920
|
+
* @summary List Licensed Avatars
|
|
10921
|
+
* @param {number} [n] The number of objects to return.
|
|
10922
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
10923
|
+
* @param {*} [options] Override http request option.
|
|
10924
|
+
* @throws {RequiredError}
|
|
10925
|
+
*/
|
|
10926
|
+
getLicensedAvatars: (n?: number, offset?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9882
10927
|
/**
|
|
9883
10928
|
* Get the current avatar for the user. This will return an error for any other user than the one logged in.
|
|
9884
10929
|
* @summary Get Own Avatar
|
|
@@ -9920,6 +10965,7 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9920
10965
|
* @summary Select Fallback Avatar
|
|
9921
10966
|
* @param {string} avatarId Must be a valid avatar ID.
|
|
9922
10967
|
* @param {*} [options] Override http request option.
|
|
10968
|
+
* @deprecated
|
|
9923
10969
|
* @throws {RequiredError}
|
|
9924
10970
|
*/
|
|
9925
10971
|
selectFallbackAvatar: (avatarId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -9954,6 +11000,22 @@ export declare const AvatarsApiFp: (configuration?: Configuration) => {
|
|
|
9954
11000
|
* @throws {RequiredError}
|
|
9955
11001
|
*/
|
|
9956
11002
|
deleteAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Avatar>>;
|
|
11003
|
+
/**
|
|
11004
|
+
* Delete generated Impostor for that avatar.
|
|
11005
|
+
* @summary Delete generated Impostor
|
|
11006
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11007
|
+
* @param {*} [options] Override http request option.
|
|
11008
|
+
* @throws {RequiredError}
|
|
11009
|
+
*/
|
|
11010
|
+
deleteImpostor(avatarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
11011
|
+
/**
|
|
11012
|
+
* Enqueue Impostor generation for that avatar.
|
|
11013
|
+
* @summary Enqueue Impostor generation
|
|
11014
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11015
|
+
* @param {*} [options] Override http request option.
|
|
11016
|
+
* @throws {RequiredError}
|
|
11017
|
+
*/
|
|
11018
|
+
enqueueImpostor(avatarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceStatus>>;
|
|
9957
11019
|
/**
|
|
9958
11020
|
* Get information about a specific Avatar.
|
|
9959
11021
|
* @summary Get Avatar
|
|
@@ -9982,6 +11044,22 @@ export declare const AvatarsApiFp: (configuration?: Configuration) => {
|
|
|
9982
11044
|
* @throws {RequiredError}
|
|
9983
11045
|
*/
|
|
9984
11046
|
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>>>;
|
|
11047
|
+
/**
|
|
11048
|
+
* Gets service stats for queued impostor.
|
|
11049
|
+
* @summary Get Impostor Queue Stats
|
|
11050
|
+
* @param {*} [options] Override http request option.
|
|
11051
|
+
* @throws {RequiredError}
|
|
11052
|
+
*/
|
|
11053
|
+
getImpostorQueueStats(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceQueueStats>>;
|
|
11054
|
+
/**
|
|
11055
|
+
* List licensed avatars.
|
|
11056
|
+
* @summary List Licensed Avatars
|
|
11057
|
+
* @param {number} [n] The number of objects to return.
|
|
11058
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11059
|
+
* @param {*} [options] Override http request option.
|
|
11060
|
+
* @throws {RequiredError}
|
|
11061
|
+
*/
|
|
11062
|
+
getLicensedAvatars(n?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Avatar>>>;
|
|
9985
11063
|
/**
|
|
9986
11064
|
* Get the current avatar for the user. This will return an error for any other user than the one logged in.
|
|
9987
11065
|
* @summary Get Own Avatar
|
|
@@ -10023,6 +11101,7 @@ export declare const AvatarsApiFp: (configuration?: Configuration) => {
|
|
|
10023
11101
|
* @summary Select Fallback Avatar
|
|
10024
11102
|
* @param {string} avatarId Must be a valid avatar ID.
|
|
10025
11103
|
* @param {*} [options] Override http request option.
|
|
11104
|
+
* @deprecated
|
|
10026
11105
|
* @throws {RequiredError}
|
|
10027
11106
|
*/
|
|
10028
11107
|
selectFallbackAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>>;
|
|
@@ -10057,6 +11136,22 @@ export declare const AvatarsApiFactory: (configuration?: Configuration, basePath
|
|
|
10057
11136
|
* @throws {RequiredError}
|
|
10058
11137
|
*/
|
|
10059
11138
|
deleteAvatar(avatarId: string, options?: any): AxiosPromise<Avatar>;
|
|
11139
|
+
/**
|
|
11140
|
+
* Delete generated Impostor for that avatar.
|
|
11141
|
+
* @summary Delete generated Impostor
|
|
11142
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11143
|
+
* @param {*} [options] Override http request option.
|
|
11144
|
+
* @throws {RequiredError}
|
|
11145
|
+
*/
|
|
11146
|
+
deleteImpostor(avatarId: string, options?: any): AxiosPromise<void>;
|
|
11147
|
+
/**
|
|
11148
|
+
* Enqueue Impostor generation for that avatar.
|
|
11149
|
+
* @summary Enqueue Impostor generation
|
|
11150
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11151
|
+
* @param {*} [options] Override http request option.
|
|
11152
|
+
* @throws {RequiredError}
|
|
11153
|
+
*/
|
|
11154
|
+
enqueueImpostor(avatarId: string, options?: any): AxiosPromise<ServiceStatus>;
|
|
10060
11155
|
/**
|
|
10061
11156
|
* Get information about a specific Avatar.
|
|
10062
11157
|
* @summary Get Avatar
|
|
@@ -10085,6 +11180,22 @@ export declare const AvatarsApiFactory: (configuration?: Configuration, basePath
|
|
|
10085
11180
|
* @throws {RequiredError}
|
|
10086
11181
|
*/
|
|
10087
11182
|
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>>;
|
|
11183
|
+
/**
|
|
11184
|
+
* Gets service stats for queued impostor.
|
|
11185
|
+
* @summary Get Impostor Queue Stats
|
|
11186
|
+
* @param {*} [options] Override http request option.
|
|
11187
|
+
* @throws {RequiredError}
|
|
11188
|
+
*/
|
|
11189
|
+
getImpostorQueueStats(options?: any): AxiosPromise<ServiceQueueStats>;
|
|
11190
|
+
/**
|
|
11191
|
+
* List licensed avatars.
|
|
11192
|
+
* @summary List Licensed Avatars
|
|
11193
|
+
* @param {number} [n] The number of objects to return.
|
|
11194
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11195
|
+
* @param {*} [options] Override http request option.
|
|
11196
|
+
* @throws {RequiredError}
|
|
11197
|
+
*/
|
|
11198
|
+
getLicensedAvatars(n?: number, offset?: number, options?: any): AxiosPromise<Array<Avatar>>;
|
|
10088
11199
|
/**
|
|
10089
11200
|
* Get the current avatar for the user. This will return an error for any other user than the one logged in.
|
|
10090
11201
|
* @summary Get Own Avatar
|
|
@@ -10126,6 +11237,7 @@ export declare const AvatarsApiFactory: (configuration?: Configuration, basePath
|
|
|
10126
11237
|
* @summary Select Fallback Avatar
|
|
10127
11238
|
* @param {string} avatarId Must be a valid avatar ID.
|
|
10128
11239
|
* @param {*} [options] Override http request option.
|
|
11240
|
+
* @deprecated
|
|
10129
11241
|
* @throws {RequiredError}
|
|
10130
11242
|
*/
|
|
10131
11243
|
selectFallbackAvatar(avatarId: string, options?: any): AxiosPromise<CurrentUser>;
|
|
@@ -10164,6 +11276,24 @@ export declare class AvatarsApi extends BaseAPI {
|
|
|
10164
11276
|
* @memberof AvatarsApi
|
|
10165
11277
|
*/
|
|
10166
11278
|
deleteAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Avatar, any>>;
|
|
11279
|
+
/**
|
|
11280
|
+
* Delete generated Impostor for that avatar.
|
|
11281
|
+
* @summary Delete generated Impostor
|
|
11282
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11283
|
+
* @param {*} [options] Override http request option.
|
|
11284
|
+
* @throws {RequiredError}
|
|
11285
|
+
* @memberof AvatarsApi
|
|
11286
|
+
*/
|
|
11287
|
+
deleteImpostor(avatarId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
11288
|
+
/**
|
|
11289
|
+
* Enqueue Impostor generation for that avatar.
|
|
11290
|
+
* @summary Enqueue Impostor generation
|
|
11291
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11292
|
+
* @param {*} [options] Override http request option.
|
|
11293
|
+
* @throws {RequiredError}
|
|
11294
|
+
* @memberof AvatarsApi
|
|
11295
|
+
*/
|
|
11296
|
+
enqueueImpostor(avatarId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceStatus, any>>;
|
|
10167
11297
|
/**
|
|
10168
11298
|
* Get information about a specific Avatar.
|
|
10169
11299
|
* @summary Get Avatar
|
|
@@ -10194,6 +11324,24 @@ export declare class AvatarsApi extends BaseAPI {
|
|
|
10194
11324
|
* @memberof AvatarsApi
|
|
10195
11325
|
*/
|
|
10196
11326
|
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>>;
|
|
11327
|
+
/**
|
|
11328
|
+
* Gets service stats for queued impostor.
|
|
11329
|
+
* @summary Get Impostor Queue Stats
|
|
11330
|
+
* @param {*} [options] Override http request option.
|
|
11331
|
+
* @throws {RequiredError}
|
|
11332
|
+
* @memberof AvatarsApi
|
|
11333
|
+
*/
|
|
11334
|
+
getImpostorQueueStats(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceQueueStats, any>>;
|
|
11335
|
+
/**
|
|
11336
|
+
* List licensed avatars.
|
|
11337
|
+
* @summary List Licensed Avatars
|
|
11338
|
+
* @param {number} [n] The number of objects to return.
|
|
11339
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11340
|
+
* @param {*} [options] Override http request option.
|
|
11341
|
+
* @throws {RequiredError}
|
|
11342
|
+
* @memberof AvatarsApi
|
|
11343
|
+
*/
|
|
11344
|
+
getLicensedAvatars(n?: number, offset?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Avatar[], any>>;
|
|
10197
11345
|
/**
|
|
10198
11346
|
* Get the current avatar for the user. This will return an error for any other user than the one logged in.
|
|
10199
11347
|
* @summary Get Own Avatar
|
|
@@ -10238,6 +11386,7 @@ export declare class AvatarsApi extends BaseAPI {
|
|
|
10238
11386
|
* @summary Select Fallback Avatar
|
|
10239
11387
|
* @param {string} avatarId Must be a valid avatar ID.
|
|
10240
11388
|
* @param {*} [options] Override http request option.
|
|
11389
|
+
* @deprecated
|
|
10241
11390
|
* @throws {RequiredError}
|
|
10242
11391
|
* @memberof AvatarsApi
|
|
10243
11392
|
*/
|
|
@@ -10673,14 +11822,6 @@ export declare const FavoritesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
10673
11822
|
* @throws {RequiredError}
|
|
10674
11823
|
*/
|
|
10675
11824
|
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
11825
|
/**
|
|
10685
11826
|
* Fetch information about a specific favorite group.
|
|
10686
11827
|
* @summary Show Favorite Group
|
|
@@ -10696,11 +11837,12 @@ export declare const FavoritesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
10696
11837
|
* @summary List Favorite Groups
|
|
10697
11838
|
* @param {number} [n] The number of objects to return.
|
|
10698
11839
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11840
|
+
* @param {string} [userId] Target user to see information on, admin-only.
|
|
10699
11841
|
* @param {string} [ownerId] The owner of whoms favorite groups to return. Must be a UserID.
|
|
10700
11842
|
* @param {*} [options] Override http request option.
|
|
10701
11843
|
* @throws {RequiredError}
|
|
10702
11844
|
*/
|
|
10703
|
-
getFavoriteGroups: (n?: number, offset?: number, ownerId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11845
|
+
getFavoriteGroups: (n?: number, offset?: number, userId?: string, ownerId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10704
11846
|
/**
|
|
10705
11847
|
* Return information about a specific Favorite.
|
|
10706
11848
|
* @summary Get Favorite Limits
|
|
@@ -10762,14 +11904,6 @@ export declare const FavoritesApiFp: (configuration?: Configuration) => {
|
|
|
10762
11904
|
* @throws {RequiredError}
|
|
10763
11905
|
*/
|
|
10764
11906
|
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
11907
|
/**
|
|
10774
11908
|
* Fetch information about a specific favorite group.
|
|
10775
11909
|
* @summary Show Favorite Group
|
|
@@ -10785,11 +11919,12 @@ export declare const FavoritesApiFp: (configuration?: Configuration) => {
|
|
|
10785
11919
|
* @summary List Favorite Groups
|
|
10786
11920
|
* @param {number} [n] The number of objects to return.
|
|
10787
11921
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11922
|
+
* @param {string} [userId] Target user to see information on, admin-only.
|
|
10788
11923
|
* @param {string} [ownerId] The owner of whoms favorite groups to return. Must be a UserID.
|
|
10789
11924
|
* @param {*} [options] Override http request option.
|
|
10790
11925
|
* @throws {RequiredError}
|
|
10791
11926
|
*/
|
|
10792
|
-
getFavoriteGroups(n?: number, offset?: number, ownerId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<FavoriteGroup>>>;
|
|
11927
|
+
getFavoriteGroups(n?: number, offset?: number, userId?: string, ownerId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<FavoriteGroup>>>;
|
|
10793
11928
|
/**
|
|
10794
11929
|
* Return information about a specific Favorite.
|
|
10795
11930
|
* @summary Get Favorite Limits
|
|
@@ -10851,14 +11986,6 @@ export declare const FavoritesApiFactory: (configuration?: Configuration, basePa
|
|
|
10851
11986
|
* @throws {RequiredError}
|
|
10852
11987
|
*/
|
|
10853
11988
|
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
11989
|
/**
|
|
10863
11990
|
* Fetch information about a specific favorite group.
|
|
10864
11991
|
* @summary Show Favorite Group
|
|
@@ -10874,11 +12001,12 @@ export declare const FavoritesApiFactory: (configuration?: Configuration, basePa
|
|
|
10874
12001
|
* @summary List Favorite Groups
|
|
10875
12002
|
* @param {number} [n] The number of objects to return.
|
|
10876
12003
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
12004
|
+
* @param {string} [userId] Target user to see information on, admin-only.
|
|
10877
12005
|
* @param {string} [ownerId] The owner of whoms favorite groups to return. Must be a UserID.
|
|
10878
12006
|
* @param {*} [options] Override http request option.
|
|
10879
12007
|
* @throws {RequiredError}
|
|
10880
12008
|
*/
|
|
10881
|
-
getFavoriteGroups(n?: number, offset?: number, ownerId?: string, options?: any): AxiosPromise<Array<FavoriteGroup>>;
|
|
12009
|
+
getFavoriteGroups(n?: number, offset?: number, userId?: string, ownerId?: string, options?: any): AxiosPromise<Array<FavoriteGroup>>;
|
|
10882
12010
|
/**
|
|
10883
12011
|
* Return information about a specific Favorite.
|
|
10884
12012
|
* @summary Get Favorite Limits
|
|
@@ -10944,15 +12072,6 @@ export declare class FavoritesApi extends BaseAPI {
|
|
|
10944
12072
|
* @memberof FavoritesApi
|
|
10945
12073
|
*/
|
|
10946
12074
|
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
12075
|
/**
|
|
10957
12076
|
* Fetch information about a specific favorite group.
|
|
10958
12077
|
* @summary Show Favorite Group
|
|
@@ -10969,12 +12088,13 @@ export declare class FavoritesApi extends BaseAPI {
|
|
|
10969
12088
|
* @summary List Favorite Groups
|
|
10970
12089
|
* @param {number} [n] The number of objects to return.
|
|
10971
12090
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
12091
|
+
* @param {string} [userId] Target user to see information on, admin-only.
|
|
10972
12092
|
* @param {string} [ownerId] The owner of whoms favorite groups to return. Must be a UserID.
|
|
10973
12093
|
* @param {*} [options] Override http request option.
|
|
10974
12094
|
* @throws {RequiredError}
|
|
10975
12095
|
* @memberof FavoritesApi
|
|
10976
12096
|
*/
|
|
10977
|
-
getFavoriteGroups(n?: number, offset?: number, ownerId?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FavoriteGroup[], any>>;
|
|
12097
|
+
getFavoriteGroups(n?: number, offset?: number, userId?: string, ownerId?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FavoriteGroup[], any>>;
|
|
10978
12098
|
/**
|
|
10979
12099
|
* Return information about a specific Favorite.
|
|
10980
12100
|
* @summary Get Favorite Limits
|
|
@@ -11143,6 +12263,35 @@ export declare const FilesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
11143
12263
|
* @throws {RequiredError}
|
|
11144
12264
|
*/
|
|
11145
12265
|
startFileDataUpload: (fileId: string, versionId: number, fileType: 'file' | 'signature' | 'delta', partNumber?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
12266
|
+
/**
|
|
12267
|
+
* Upload a gallery image
|
|
12268
|
+
* @summary Upload gallery image
|
|
12269
|
+
* @param {File} file The binary blob of the png file.
|
|
12270
|
+
* @param {*} [options] Override http request option.
|
|
12271
|
+
* @throws {RequiredError}
|
|
12272
|
+
*/
|
|
12273
|
+
uploadGalleryImage: (file: File, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
12274
|
+
/**
|
|
12275
|
+
* Upload an icon
|
|
12276
|
+
* @summary Upload icon
|
|
12277
|
+
* @param {File} file The binary blob of the png file.
|
|
12278
|
+
* @param {*} [options] Override http request option.
|
|
12279
|
+
* @throws {RequiredError}
|
|
12280
|
+
*/
|
|
12281
|
+
uploadIcon: (file: File, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
12282
|
+
/**
|
|
12283
|
+
* Upload an image, which can be an icon, gallery image, sticker or emoji
|
|
12284
|
+
* @summary Upload gallery image, icon, emoji or sticker
|
|
12285
|
+
* @param {File} file The binary blob of the png file.
|
|
12286
|
+
* @param {string} tag Needs to be either icon, gallery, sticker, emoji, or emojianimated
|
|
12287
|
+
* @param {number} [frames] Required for emojianimated. Total number of frames to be animated (2-64)
|
|
12288
|
+
* @param {number} [framesOverTime] Required for emojianimated. Animation frames per second (1-64)
|
|
12289
|
+
* @param {string} [animationStyle] Animation style for sticker, required for emoji.
|
|
12290
|
+
* @param {string} [maskTag] Mask of the sticker, optional for emoji.
|
|
12291
|
+
* @param {*} [options] Override http request option.
|
|
12292
|
+
* @throws {RequiredError}
|
|
12293
|
+
*/
|
|
12294
|
+
uploadImage: (file: File, tag: string, frames?: number, framesOverTime?: number, animationStyle?: string, maskTag?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11146
12295
|
};
|
|
11147
12296
|
/**
|
|
11148
12297
|
* FilesApi - functional programming interface
|
|
@@ -11191,7 +12340,7 @@ export declare const FilesApiFp: (configuration?: Configuration) => {
|
|
|
11191
12340
|
* @param {*} [options] Override http request option.
|
|
11192
12341
|
* @throws {RequiredError}
|
|
11193
12342
|
*/
|
|
11194
|
-
downloadFileVersion(fileId: string, versionId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
12343
|
+
downloadFileVersion(fileId: string, versionId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
11195
12344
|
/**
|
|
11196
12345
|
* 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
12346
|
* @summary Finish FileData Upload
|
|
@@ -11270,6 +12419,35 @@ export declare const FilesApiFp: (configuration?: Configuration) => {
|
|
|
11270
12419
|
* @throws {RequiredError}
|
|
11271
12420
|
*/
|
|
11272
12421
|
startFileDataUpload(fileId: string, versionId: number, fileType: 'file' | 'signature' | 'delta', partNumber?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileUploadURL>>;
|
|
12422
|
+
/**
|
|
12423
|
+
* Upload a gallery image
|
|
12424
|
+
* @summary Upload gallery image
|
|
12425
|
+
* @param {File} file The binary blob of the png file.
|
|
12426
|
+
* @param {*} [options] Override http request option.
|
|
12427
|
+
* @throws {RequiredError}
|
|
12428
|
+
*/
|
|
12429
|
+
uploadGalleryImage(file: File, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
12430
|
+
/**
|
|
12431
|
+
* Upload an icon
|
|
12432
|
+
* @summary Upload icon
|
|
12433
|
+
* @param {File} file The binary blob of the png file.
|
|
12434
|
+
* @param {*} [options] Override http request option.
|
|
12435
|
+
* @throws {RequiredError}
|
|
12436
|
+
*/
|
|
12437
|
+
uploadIcon(file: File, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
12438
|
+
/**
|
|
12439
|
+
* Upload an image, which can be an icon, gallery image, sticker or emoji
|
|
12440
|
+
* @summary Upload gallery image, icon, emoji or sticker
|
|
12441
|
+
* @param {File} file The binary blob of the png file.
|
|
12442
|
+
* @param {string} tag Needs to be either icon, gallery, sticker, emoji, or emojianimated
|
|
12443
|
+
* @param {number} [frames] Required for emojianimated. Total number of frames to be animated (2-64)
|
|
12444
|
+
* @param {number} [framesOverTime] Required for emojianimated. Animation frames per second (1-64)
|
|
12445
|
+
* @param {string} [animationStyle] Animation style for sticker, required for emoji.
|
|
12446
|
+
* @param {string} [maskTag] Mask of the sticker, optional for emoji.
|
|
12447
|
+
* @param {*} [options] Override http request option.
|
|
12448
|
+
* @throws {RequiredError}
|
|
12449
|
+
*/
|
|
12450
|
+
uploadImage(file: File, tag: string, frames?: number, framesOverTime?: number, animationStyle?: string, maskTag?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
11273
12451
|
};
|
|
11274
12452
|
/**
|
|
11275
12453
|
* FilesApi - factory interface
|
|
@@ -11318,7 +12496,7 @@ export declare const FilesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
11318
12496
|
* @param {*} [options] Override http request option.
|
|
11319
12497
|
* @throws {RequiredError}
|
|
11320
12498
|
*/
|
|
11321
|
-
downloadFileVersion(fileId: string, versionId: number, options?: any): AxiosPromise<
|
|
12499
|
+
downloadFileVersion(fileId: string, versionId: number, options?: any): AxiosPromise<File>;
|
|
11322
12500
|
/**
|
|
11323
12501
|
* 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
12502
|
* @summary Finish FileData Upload
|
|
@@ -11397,6 +12575,35 @@ export declare const FilesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
11397
12575
|
* @throws {RequiredError}
|
|
11398
12576
|
*/
|
|
11399
12577
|
startFileDataUpload(fileId: string, versionId: number, fileType: 'file' | 'signature' | 'delta', partNumber?: number, options?: any): AxiosPromise<FileUploadURL>;
|
|
12578
|
+
/**
|
|
12579
|
+
* Upload a gallery image
|
|
12580
|
+
* @summary Upload gallery image
|
|
12581
|
+
* @param {File} file The binary blob of the png file.
|
|
12582
|
+
* @param {*} [options] Override http request option.
|
|
12583
|
+
* @throws {RequiredError}
|
|
12584
|
+
*/
|
|
12585
|
+
uploadGalleryImage(file: File, options?: any): AxiosPromise<any>;
|
|
12586
|
+
/**
|
|
12587
|
+
* Upload an icon
|
|
12588
|
+
* @summary Upload icon
|
|
12589
|
+
* @param {File} file The binary blob of the png file.
|
|
12590
|
+
* @param {*} [options] Override http request option.
|
|
12591
|
+
* @throws {RequiredError}
|
|
12592
|
+
*/
|
|
12593
|
+
uploadIcon(file: File, options?: any): AxiosPromise<any>;
|
|
12594
|
+
/**
|
|
12595
|
+
* Upload an image, which can be an icon, gallery image, sticker or emoji
|
|
12596
|
+
* @summary Upload gallery image, icon, emoji or sticker
|
|
12597
|
+
* @param {File} file The binary blob of the png file.
|
|
12598
|
+
* @param {string} tag Needs to be either icon, gallery, sticker, emoji, or emojianimated
|
|
12599
|
+
* @param {number} [frames] Required for emojianimated. Total number of frames to be animated (2-64)
|
|
12600
|
+
* @param {number} [framesOverTime] Required for emojianimated. Animation frames per second (1-64)
|
|
12601
|
+
* @param {string} [animationStyle] Animation style for sticker, required for emoji.
|
|
12602
|
+
* @param {string} [maskTag] Mask of the sticker, optional for emoji.
|
|
12603
|
+
* @param {*} [options] Override http request option.
|
|
12604
|
+
* @throws {RequiredError}
|
|
12605
|
+
*/
|
|
12606
|
+
uploadImage(file: File, tag: string, frames?: number, framesOverTime?: number, animationStyle?: string, maskTag?: string, options?: any): AxiosPromise<any>;
|
|
11400
12607
|
};
|
|
11401
12608
|
/**
|
|
11402
12609
|
* FilesApi - object-oriented interface
|
|
@@ -11452,7 +12659,7 @@ export declare class FilesApi extends BaseAPI {
|
|
|
11452
12659
|
* @throws {RequiredError}
|
|
11453
12660
|
* @memberof FilesApi
|
|
11454
12661
|
*/
|
|
11455
|
-
downloadFileVersion(fileId: string, versionId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
12662
|
+
downloadFileVersion(fileId: string, versionId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
11456
12663
|
/**
|
|
11457
12664
|
* 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
12665
|
* @summary Finish FileData Upload
|
|
@@ -11539,6 +12746,38 @@ export declare class FilesApi extends BaseAPI {
|
|
|
11539
12746
|
* @memberof FilesApi
|
|
11540
12747
|
*/
|
|
11541
12748
|
startFileDataUpload(fileId: string, versionId: number, fileType: 'file' | 'signature' | 'delta', partNumber?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileUploadURL, any>>;
|
|
12749
|
+
/**
|
|
12750
|
+
* Upload a gallery image
|
|
12751
|
+
* @summary Upload gallery image
|
|
12752
|
+
* @param {File} file The binary blob of the png file.
|
|
12753
|
+
* @param {*} [options] Override http request option.
|
|
12754
|
+
* @throws {RequiredError}
|
|
12755
|
+
* @memberof FilesApi
|
|
12756
|
+
*/
|
|
12757
|
+
uploadGalleryImage(file: File, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
12758
|
+
/**
|
|
12759
|
+
* Upload an icon
|
|
12760
|
+
* @summary Upload icon
|
|
12761
|
+
* @param {File} file The binary blob of the png file.
|
|
12762
|
+
* @param {*} [options] Override http request option.
|
|
12763
|
+
* @throws {RequiredError}
|
|
12764
|
+
* @memberof FilesApi
|
|
12765
|
+
*/
|
|
12766
|
+
uploadIcon(file: File, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
12767
|
+
/**
|
|
12768
|
+
* Upload an image, which can be an icon, gallery image, sticker or emoji
|
|
12769
|
+
* @summary Upload gallery image, icon, emoji or sticker
|
|
12770
|
+
* @param {File} file The binary blob of the png file.
|
|
12771
|
+
* @param {string} tag Needs to be either icon, gallery, sticker, emoji, or emojianimated
|
|
12772
|
+
* @param {number} [frames] Required for emojianimated. Total number of frames to be animated (2-64)
|
|
12773
|
+
* @param {number} [framesOverTime] Required for emojianimated. Animation frames per second (1-64)
|
|
12774
|
+
* @param {string} [animationStyle] Animation style for sticker, required for emoji.
|
|
12775
|
+
* @param {string} [maskTag] Mask of the sticker, optional for emoji.
|
|
12776
|
+
* @param {*} [options] Override http request option.
|
|
12777
|
+
* @throws {RequiredError}
|
|
12778
|
+
* @memberof FilesApi
|
|
12779
|
+
*/
|
|
12780
|
+
uploadImage(file: File, tag: string, frames?: number, framesOverTime?: number, animationStyle?: string, maskTag?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
11542
12781
|
}
|
|
11543
12782
|
/**
|
|
11544
12783
|
* FriendsApi - axios parameter creator
|
|
@@ -12007,7 +13246,7 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
12007
13246
|
* @param {*} [options] Override http request option.
|
|
12008
13247
|
* @throws {RequiredError}
|
|
12009
13248
|
*/
|
|
12010
|
-
|
|
13249
|
+
getGroupPosts: (groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
12011
13250
|
/**
|
|
12012
13251
|
* Returns a list of members that have requested to join the Group.
|
|
12013
13252
|
* @summary Get Group Join Requests
|
|
@@ -12019,6 +13258,13 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
12019
13258
|
* @throws {RequiredError}
|
|
12020
13259
|
*/
|
|
12021
13260
|
getGroupRequests: (groupId: string, n?: number, offset?: number, blocked?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13261
|
+
/**
|
|
13262
|
+
* Obtain predefined templates for group roles
|
|
13263
|
+
* @summary Get Group Role Templates
|
|
13264
|
+
* @param {*} [options] Override http request option.
|
|
13265
|
+
* @throws {RequiredError}
|
|
13266
|
+
*/
|
|
13267
|
+
getGroupRoleTemplates: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
12022
13268
|
/**
|
|
12023
13269
|
* Returns a Group Role by ID.
|
|
12024
13270
|
* @summary Get Group Roles
|
|
@@ -12130,6 +13376,15 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
12130
13376
|
* @throws {RequiredError}
|
|
12131
13377
|
*/
|
|
12132
13378
|
updateGroupPost: (groupId: string, notificationId: string, createGroupPostRequest: CreateGroupPostRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13379
|
+
/**
|
|
13380
|
+
* Updates whether the user is representing the group. When `isRepresenting` is set to `true`, this flag will be set to `false` for all other groups
|
|
13381
|
+
* @summary Update Group Representation
|
|
13382
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13383
|
+
* @param {UpdateGroupRepresentationRequest} updateGroupRepresentationRequest
|
|
13384
|
+
* @param {*} [options] Override http request option.
|
|
13385
|
+
* @throws {RequiredError}
|
|
13386
|
+
*/
|
|
13387
|
+
updateGroupRepresentation: (groupId: string, updateGroupRepresentationRequest: UpdateGroupRepresentationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
12133
13388
|
/**
|
|
12134
13389
|
* Updates a group role by ID.
|
|
12135
13390
|
* @summary Update Group Role
|
|
@@ -12409,7 +13664,7 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
|
|
|
12409
13664
|
* @param {*} [options] Override http request option.
|
|
12410
13665
|
* @throws {RequiredError}
|
|
12411
13666
|
*/
|
|
12412
|
-
|
|
13667
|
+
getGroupPosts(groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetGroupPosts200Response>>;
|
|
12413
13668
|
/**
|
|
12414
13669
|
* Returns a list of members that have requested to join the Group.
|
|
12415
13670
|
* @summary Get Group Join Requests
|
|
@@ -12421,6 +13676,15 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
|
|
|
12421
13676
|
* @throws {RequiredError}
|
|
12422
13677
|
*/
|
|
12423
13678
|
getGroupRequests(groupId: string, n?: number, offset?: number, blocked?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GroupMember>>>;
|
|
13679
|
+
/**
|
|
13680
|
+
* Obtain predefined templates for group roles
|
|
13681
|
+
* @summary Get Group Role Templates
|
|
13682
|
+
* @param {*} [options] Override http request option.
|
|
13683
|
+
* @throws {RequiredError}
|
|
13684
|
+
*/
|
|
13685
|
+
getGroupRoleTemplates(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
13686
|
+
[key: string]: GroupRoleTemplateValues;
|
|
13687
|
+
}>>;
|
|
12424
13688
|
/**
|
|
12425
13689
|
* Returns a Group Role by ID.
|
|
12426
13690
|
* @summary Get Group Roles
|
|
@@ -12532,6 +13796,15 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
|
|
|
12532
13796
|
* @throws {RequiredError}
|
|
12533
13797
|
*/
|
|
12534
13798
|
updateGroupPost(groupId: string, notificationId: string, createGroupPostRequest: CreateGroupPostRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupPost>>;
|
|
13799
|
+
/**
|
|
13800
|
+
* Updates whether the user is representing the group. When `isRepresenting` is set to `true`, this flag will be set to `false` for all other groups
|
|
13801
|
+
* @summary Update Group Representation
|
|
13802
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13803
|
+
* @param {UpdateGroupRepresentationRequest} updateGroupRepresentationRequest
|
|
13804
|
+
* @param {*} [options] Override http request option.
|
|
13805
|
+
* @throws {RequiredError}
|
|
13806
|
+
*/
|
|
13807
|
+
updateGroupRepresentation(groupId: string, updateGroupRepresentationRequest: UpdateGroupRepresentationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>>;
|
|
12535
13808
|
/**
|
|
12536
13809
|
* Updates a group role by ID.
|
|
12537
13810
|
* @summary Update Group Role
|
|
@@ -12811,7 +14084,7 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
|
|
|
12811
14084
|
* @param {*} [options] Override http request option.
|
|
12812
14085
|
* @throws {RequiredError}
|
|
12813
14086
|
*/
|
|
12814
|
-
|
|
14087
|
+
getGroupPosts(groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: any): AxiosPromise<GetGroupPosts200Response>;
|
|
12815
14088
|
/**
|
|
12816
14089
|
* Returns a list of members that have requested to join the Group.
|
|
12817
14090
|
* @summary Get Group Join Requests
|
|
@@ -12823,6 +14096,15 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
|
|
|
12823
14096
|
* @throws {RequiredError}
|
|
12824
14097
|
*/
|
|
12825
14098
|
getGroupRequests(groupId: string, n?: number, offset?: number, blocked?: boolean, options?: any): AxiosPromise<Array<GroupMember>>;
|
|
14099
|
+
/**
|
|
14100
|
+
* Obtain predefined templates for group roles
|
|
14101
|
+
* @summary Get Group Role Templates
|
|
14102
|
+
* @param {*} [options] Override http request option.
|
|
14103
|
+
* @throws {RequiredError}
|
|
14104
|
+
*/
|
|
14105
|
+
getGroupRoleTemplates(options?: any): AxiosPromise<{
|
|
14106
|
+
[key: string]: GroupRoleTemplateValues;
|
|
14107
|
+
}>;
|
|
12826
14108
|
/**
|
|
12827
14109
|
* Returns a Group Role by ID.
|
|
12828
14110
|
* @summary Get Group Roles
|
|
@@ -12934,6 +14216,15 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
|
|
|
12934
14216
|
* @throws {RequiredError}
|
|
12935
14217
|
*/
|
|
12936
14218
|
updateGroupPost(groupId: string, notificationId: string, createGroupPostRequest: CreateGroupPostRequest, options?: any): AxiosPromise<GroupPost>;
|
|
14219
|
+
/**
|
|
14220
|
+
* Updates whether the user is representing the group. When `isRepresenting` is set to `true`, this flag will be set to `false` for all other groups
|
|
14221
|
+
* @summary Update Group Representation
|
|
14222
|
+
* @param {string} groupId Must be a valid group ID.
|
|
14223
|
+
* @param {UpdateGroupRepresentationRequest} updateGroupRepresentationRequest
|
|
14224
|
+
* @param {*} [options] Override http request option.
|
|
14225
|
+
* @throws {RequiredError}
|
|
14226
|
+
*/
|
|
14227
|
+
updateGroupRepresentation(groupId: string, updateGroupRepresentationRequest: UpdateGroupRepresentationRequest, options?: any): AxiosPromise<Success>;
|
|
12937
14228
|
/**
|
|
12938
14229
|
* Updates a group role by ID.
|
|
12939
14230
|
* @summary Update Group Role
|
|
@@ -13243,7 +14534,7 @@ export declare class GroupsApi extends BaseAPI {
|
|
|
13243
14534
|
* @throws {RequiredError}
|
|
13244
14535
|
* @memberof GroupsApi
|
|
13245
14536
|
*/
|
|
13246
|
-
|
|
14537
|
+
getGroupPosts(groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetGroupPosts200Response, any>>;
|
|
13247
14538
|
/**
|
|
13248
14539
|
* Returns a list of members that have requested to join the Group.
|
|
13249
14540
|
* @summary Get Group Join Requests
|
|
@@ -13256,6 +14547,16 @@ export declare class GroupsApi extends BaseAPI {
|
|
|
13256
14547
|
* @memberof GroupsApi
|
|
13257
14548
|
*/
|
|
13258
14549
|
getGroupRequests(groupId: string, n?: number, offset?: number, blocked?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupMember[], any>>;
|
|
14550
|
+
/**
|
|
14551
|
+
* Obtain predefined templates for group roles
|
|
14552
|
+
* @summary Get Group Role Templates
|
|
14553
|
+
* @param {*} [options] Override http request option.
|
|
14554
|
+
* @throws {RequiredError}
|
|
14555
|
+
* @memberof GroupsApi
|
|
14556
|
+
*/
|
|
14557
|
+
getGroupRoleTemplates(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
14558
|
+
[key: string]: GroupRoleTemplateValues;
|
|
14559
|
+
}, any>>;
|
|
13259
14560
|
/**
|
|
13260
14561
|
* Returns a Group Role by ID.
|
|
13261
14562
|
* @summary Get Group Roles
|
|
@@ -13379,6 +14680,16 @@ export declare class GroupsApi extends BaseAPI {
|
|
|
13379
14680
|
* @memberof GroupsApi
|
|
13380
14681
|
*/
|
|
13381
14682
|
updateGroupPost(groupId: string, notificationId: string, createGroupPostRequest: CreateGroupPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupPost, any>>;
|
|
14683
|
+
/**
|
|
14684
|
+
* Updates whether the user is representing the group. When `isRepresenting` is set to `true`, this flag will be set to `false` for all other groups
|
|
14685
|
+
* @summary Update Group Representation
|
|
14686
|
+
* @param {string} groupId Must be a valid group ID.
|
|
14687
|
+
* @param {UpdateGroupRepresentationRequest} updateGroupRepresentationRequest
|
|
14688
|
+
* @param {*} [options] Override http request option.
|
|
14689
|
+
* @throws {RequiredError}
|
|
14690
|
+
* @memberof GroupsApi
|
|
14691
|
+
*/
|
|
14692
|
+
updateGroupRepresentation(groupId: string, updateGroupRepresentationRequest: UpdateGroupRepresentationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
13382
14693
|
/**
|
|
13383
14694
|
* Updates a group role by ID.
|
|
13384
14695
|
* @summary Update Group Role
|
|
@@ -13397,7 +14708,7 @@ export declare class GroupsApi extends BaseAPI {
|
|
|
13397
14708
|
*/
|
|
13398
14709
|
export declare const InstancesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
13399
14710
|
/**
|
|
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-
|
|
14711
|
+
* 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
14712
|
* @summary Close Instance
|
|
13402
14713
|
* @param {string} worldId Must be a valid world ID.
|
|
13403
14714
|
* @param {string} instanceId Must be a valid instance ID.
|
|
@@ -13448,7 +14759,7 @@ export declare const InstancesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
13448
14759
|
*/
|
|
13449
14760
|
export declare const InstancesApiFp: (configuration?: Configuration) => {
|
|
13450
14761
|
/**
|
|
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-
|
|
14762
|
+
* 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
14763
|
* @summary Close Instance
|
|
13453
14764
|
* @param {string} worldId Must be a valid world ID.
|
|
13454
14765
|
* @param {string} instanceId Must be a valid instance ID.
|
|
@@ -13499,7 +14810,7 @@ export declare const InstancesApiFp: (configuration?: Configuration) => {
|
|
|
13499
14810
|
*/
|
|
13500
14811
|
export declare const InstancesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
13501
14812
|
/**
|
|
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-
|
|
14813
|
+
* 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
14814
|
* @summary Close Instance
|
|
13504
14815
|
* @param {string} worldId Must be a valid world ID.
|
|
13505
14816
|
* @param {string} instanceId Must be a valid instance ID.
|
|
@@ -13552,7 +14863,7 @@ export declare const InstancesApiFactory: (configuration?: Configuration, basePa
|
|
|
13552
14863
|
*/
|
|
13553
14864
|
export declare class InstancesApi extends BaseAPI {
|
|
13554
14865
|
/**
|
|
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-
|
|
14866
|
+
* 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
14867
|
* @summary Close Instance
|
|
13557
14868
|
* @param {string} worldId Must be a valid world ID.
|
|
13558
14869
|
* @param {string} instanceId Must be a valid instance ID.
|
|
@@ -13644,6 +14955,16 @@ export declare const InviteApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
13644
14955
|
* @throws {RequiredError}
|
|
13645
14956
|
*/
|
|
13646
14957
|
inviteUser: (userId: string, inviteRequest: InviteRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14958
|
+
/**
|
|
14959
|
+
* Sends an photo invite to a user. Returns the Notification of type `invite` that was sent.
|
|
14960
|
+
* @summary Invite User with photo
|
|
14961
|
+
* @param {string} userId Must be a valid user ID.
|
|
14962
|
+
* @param {File} image The binary blob of the png file.
|
|
14963
|
+
* @param {InviteRequest} data
|
|
14964
|
+
* @param {*} [options] Override http request option.
|
|
14965
|
+
* @throws {RequiredError}
|
|
14966
|
+
*/
|
|
14967
|
+
inviteUserWithPhoto: (userId: string, image: File, data: InviteRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13647
14968
|
/**
|
|
13648
14969
|
* Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
13649
14970
|
* @summary Request Invite
|
|
@@ -13653,6 +14974,16 @@ export declare const InviteApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
13653
14974
|
* @throws {RequiredError}
|
|
13654
14975
|
*/
|
|
13655
14976
|
requestInvite: (userId: string, requestInviteRequest?: RequestInviteRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14977
|
+
/**
|
|
14978
|
+
* Requests with photo an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
14979
|
+
* @summary Request Invite with photo
|
|
14980
|
+
* @param {string} userId Must be a valid user ID.
|
|
14981
|
+
* @param {File} image The binary blob of the png file.
|
|
14982
|
+
* @param {RequestInviteRequest} data
|
|
14983
|
+
* @param {*} [options] Override http request option.
|
|
14984
|
+
* @throws {RequiredError}
|
|
14985
|
+
*/
|
|
14986
|
+
requestInviteWithPhoto: (userId: string, image: File, data: RequestInviteRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13656
14987
|
/**
|
|
13657
14988
|
* 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.
|
|
13658
14989
|
* @summary Reset Invite Message
|
|
@@ -13664,7 +14995,7 @@ export declare const InviteApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
13664
14995
|
*/
|
|
13665
14996
|
resetInviteMessage: (userId: string, messageType: InviteMessageType, slot: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13666
14997
|
/**
|
|
13667
|
-
* Respond to an invite
|
|
14998
|
+
* 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
14999
|
* @summary Respond Invite
|
|
13669
15000
|
* @param {string} notificationId Must be a valid notification ID.
|
|
13670
15001
|
* @param {InviteResponse} inviteResponse Slot number of the Response Message to use when responding to a user.
|
|
@@ -13672,6 +15003,16 @@ export declare const InviteApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
13672
15003
|
* @throws {RequiredError}
|
|
13673
15004
|
*/
|
|
13674
15005
|
respondInvite: (notificationId: string, inviteResponse: InviteResponse, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15006
|
+
/**
|
|
15007
|
+
* 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.\'
|
|
15008
|
+
* @summary Respond Invite with photo
|
|
15009
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15010
|
+
* @param {File} image The binary blob of the png file.
|
|
15011
|
+
* @param {InviteResponse} data
|
|
15012
|
+
* @param {*} [options] Override http request option.
|
|
15013
|
+
* @throws {RequiredError}
|
|
15014
|
+
*/
|
|
15015
|
+
respondInviteWithPhoto: (notificationId: string, image: File, data: InviteResponse, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13675
15016
|
/**
|
|
13676
15017
|
* 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
15018
|
* @summary Update Invite Message
|
|
@@ -13726,6 +15067,16 @@ export declare const InviteApiFp: (configuration?: Configuration) => {
|
|
|
13726
15067
|
* @throws {RequiredError}
|
|
13727
15068
|
*/
|
|
13728
15069
|
inviteUser(userId: string, inviteRequest: InviteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SentNotification>>;
|
|
15070
|
+
/**
|
|
15071
|
+
* Sends an photo invite to a user. Returns the Notification of type `invite` that was sent.
|
|
15072
|
+
* @summary Invite User with photo
|
|
15073
|
+
* @param {string} userId Must be a valid user ID.
|
|
15074
|
+
* @param {File} image The binary blob of the png file.
|
|
15075
|
+
* @param {InviteRequest} data
|
|
15076
|
+
* @param {*} [options] Override http request option.
|
|
15077
|
+
* @throws {RequiredError}
|
|
15078
|
+
*/
|
|
15079
|
+
inviteUserWithPhoto(userId: string, image: File, data: InviteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SentNotification>>;
|
|
13729
15080
|
/**
|
|
13730
15081
|
* Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
13731
15082
|
* @summary Request Invite
|
|
@@ -13735,6 +15086,16 @@ export declare const InviteApiFp: (configuration?: Configuration) => {
|
|
|
13735
15086
|
* @throws {RequiredError}
|
|
13736
15087
|
*/
|
|
13737
15088
|
requestInvite(userId: string, requestInviteRequest?: RequestInviteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
|
|
15089
|
+
/**
|
|
15090
|
+
* Requests with photo an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
15091
|
+
* @summary Request Invite with photo
|
|
15092
|
+
* @param {string} userId Must be a valid user ID.
|
|
15093
|
+
* @param {File} image The binary blob of the png file.
|
|
15094
|
+
* @param {RequestInviteRequest} data
|
|
15095
|
+
* @param {*} [options] Override http request option.
|
|
15096
|
+
* @throws {RequiredError}
|
|
15097
|
+
*/
|
|
15098
|
+
requestInviteWithPhoto(userId: string, image: File, data: RequestInviteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
|
|
13738
15099
|
/**
|
|
13739
15100
|
* 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
15101
|
* @summary Reset Invite Message
|
|
@@ -13746,7 +15107,7 @@ export declare const InviteApiFp: (configuration?: Configuration) => {
|
|
|
13746
15107
|
*/
|
|
13747
15108
|
resetInviteMessage(userId: string, messageType: InviteMessageType, slot: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InviteMessage>>>;
|
|
13748
15109
|
/**
|
|
13749
|
-
* Respond to an invite
|
|
15110
|
+
* 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
15111
|
* @summary Respond Invite
|
|
13751
15112
|
* @param {string} notificationId Must be a valid notification ID.
|
|
13752
15113
|
* @param {InviteResponse} inviteResponse Slot number of the Response Message to use when responding to a user.
|
|
@@ -13754,6 +15115,16 @@ export declare const InviteApiFp: (configuration?: Configuration) => {
|
|
|
13754
15115
|
* @throws {RequiredError}
|
|
13755
15116
|
*/
|
|
13756
15117
|
respondInvite(notificationId: string, inviteResponse: InviteResponse, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
|
|
15118
|
+
/**
|
|
15119
|
+
* 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.\'
|
|
15120
|
+
* @summary Respond Invite with photo
|
|
15121
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15122
|
+
* @param {File} image The binary blob of the png file.
|
|
15123
|
+
* @param {InviteResponse} data
|
|
15124
|
+
* @param {*} [options] Override http request option.
|
|
15125
|
+
* @throws {RequiredError}
|
|
15126
|
+
*/
|
|
15127
|
+
respondInviteWithPhoto(notificationId: string, image: File, data: InviteResponse, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
|
|
13757
15128
|
/**
|
|
13758
15129
|
* 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
15130
|
* @summary Update Invite Message
|
|
@@ -13808,6 +15179,16 @@ export declare const InviteApiFactory: (configuration?: Configuration, basePath?
|
|
|
13808
15179
|
* @throws {RequiredError}
|
|
13809
15180
|
*/
|
|
13810
15181
|
inviteUser(userId: string, inviteRequest: InviteRequest, options?: any): AxiosPromise<SentNotification>;
|
|
15182
|
+
/**
|
|
15183
|
+
* Sends an photo invite to a user. Returns the Notification of type `invite` that was sent.
|
|
15184
|
+
* @summary Invite User with photo
|
|
15185
|
+
* @param {string} userId Must be a valid user ID.
|
|
15186
|
+
* @param {File} image The binary blob of the png file.
|
|
15187
|
+
* @param {InviteRequest} data
|
|
15188
|
+
* @param {*} [options] Override http request option.
|
|
15189
|
+
* @throws {RequiredError}
|
|
15190
|
+
*/
|
|
15191
|
+
inviteUserWithPhoto(userId: string, image: File, data: InviteRequest, options?: any): AxiosPromise<SentNotification>;
|
|
13811
15192
|
/**
|
|
13812
15193
|
* Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
13813
15194
|
* @summary Request Invite
|
|
@@ -13817,6 +15198,16 @@ export declare const InviteApiFactory: (configuration?: Configuration, basePath?
|
|
|
13817
15198
|
* @throws {RequiredError}
|
|
13818
15199
|
*/
|
|
13819
15200
|
requestInvite(userId: string, requestInviteRequest?: RequestInviteRequest, options?: any): AxiosPromise<Notification>;
|
|
15201
|
+
/**
|
|
15202
|
+
* Requests with photo an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
15203
|
+
* @summary Request Invite with photo
|
|
15204
|
+
* @param {string} userId Must be a valid user ID.
|
|
15205
|
+
* @param {File} image The binary blob of the png file.
|
|
15206
|
+
* @param {RequestInviteRequest} data
|
|
15207
|
+
* @param {*} [options] Override http request option.
|
|
15208
|
+
* @throws {RequiredError}
|
|
15209
|
+
*/
|
|
15210
|
+
requestInviteWithPhoto(userId: string, image: File, data: RequestInviteRequest, options?: any): AxiosPromise<Notification>;
|
|
13820
15211
|
/**
|
|
13821
15212
|
* 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
15213
|
* @summary Reset Invite Message
|
|
@@ -13828,7 +15219,7 @@ export declare const InviteApiFactory: (configuration?: Configuration, basePath?
|
|
|
13828
15219
|
*/
|
|
13829
15220
|
resetInviteMessage(userId: string, messageType: InviteMessageType, slot: number, options?: any): AxiosPromise<Array<InviteMessage>>;
|
|
13830
15221
|
/**
|
|
13831
|
-
* Respond to an invite
|
|
15222
|
+
* 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
15223
|
* @summary Respond Invite
|
|
13833
15224
|
* @param {string} notificationId Must be a valid notification ID.
|
|
13834
15225
|
* @param {InviteResponse} inviteResponse Slot number of the Response Message to use when responding to a user.
|
|
@@ -13836,6 +15227,16 @@ export declare const InviteApiFactory: (configuration?: Configuration, basePath?
|
|
|
13836
15227
|
* @throws {RequiredError}
|
|
13837
15228
|
*/
|
|
13838
15229
|
respondInvite(notificationId: string, inviteResponse: InviteResponse, options?: any): AxiosPromise<Notification>;
|
|
15230
|
+
/**
|
|
15231
|
+
* 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.\'
|
|
15232
|
+
* @summary Respond Invite with photo
|
|
15233
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15234
|
+
* @param {File} image The binary blob of the png file.
|
|
15235
|
+
* @param {InviteResponse} data
|
|
15236
|
+
* @param {*} [options] Override http request option.
|
|
15237
|
+
* @throws {RequiredError}
|
|
15238
|
+
*/
|
|
15239
|
+
respondInviteWithPhoto(notificationId: string, image: File, data: InviteResponse, options?: any): AxiosPromise<Notification>;
|
|
13839
15240
|
/**
|
|
13840
15241
|
* 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
15242
|
* @summary Update Invite Message
|
|
@@ -13896,6 +15297,17 @@ export declare class InviteApi extends BaseAPI {
|
|
|
13896
15297
|
* @memberof InviteApi
|
|
13897
15298
|
*/
|
|
13898
15299
|
inviteUser(userId: string, inviteRequest: InviteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SentNotification, any>>;
|
|
15300
|
+
/**
|
|
15301
|
+
* Sends an photo invite to a user. Returns the Notification of type `invite` that was sent.
|
|
15302
|
+
* @summary Invite User with photo
|
|
15303
|
+
* @param {string} userId Must be a valid user ID.
|
|
15304
|
+
* @param {File} image The binary blob of the png file.
|
|
15305
|
+
* @param {InviteRequest} data
|
|
15306
|
+
* @param {*} [options] Override http request option.
|
|
15307
|
+
* @throws {RequiredError}
|
|
15308
|
+
* @memberof InviteApi
|
|
15309
|
+
*/
|
|
15310
|
+
inviteUserWithPhoto(userId: string, image: File, data: InviteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SentNotification, any>>;
|
|
13899
15311
|
/**
|
|
13900
15312
|
* Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
13901
15313
|
* @summary Request Invite
|
|
@@ -13906,6 +15318,17 @@ export declare class InviteApi extends BaseAPI {
|
|
|
13906
15318
|
* @memberof InviteApi
|
|
13907
15319
|
*/
|
|
13908
15320
|
requestInvite(userId: string, requestInviteRequest?: RequestInviteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification, any>>;
|
|
15321
|
+
/**
|
|
15322
|
+
* Requests with photo an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
15323
|
+
* @summary Request Invite with photo
|
|
15324
|
+
* @param {string} userId Must be a valid user ID.
|
|
15325
|
+
* @param {File} image The binary blob of the png file.
|
|
15326
|
+
* @param {RequestInviteRequest} data
|
|
15327
|
+
* @param {*} [options] Override http request option.
|
|
15328
|
+
* @throws {RequiredError}
|
|
15329
|
+
* @memberof InviteApi
|
|
15330
|
+
*/
|
|
15331
|
+
requestInviteWithPhoto(userId: string, image: File, data: RequestInviteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification, any>>;
|
|
13909
15332
|
/**
|
|
13910
15333
|
* 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
15334
|
* @summary Reset Invite Message
|
|
@@ -13918,7 +15341,7 @@ export declare class InviteApi extends BaseAPI {
|
|
|
13918
15341
|
*/
|
|
13919
15342
|
resetInviteMessage(userId: string, messageType: InviteMessageType, slot: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InviteMessage[], any>>;
|
|
13920
15343
|
/**
|
|
13921
|
-
* Respond to an invite
|
|
15344
|
+
* 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
15345
|
* @summary Respond Invite
|
|
13923
15346
|
* @param {string} notificationId Must be a valid notification ID.
|
|
13924
15347
|
* @param {InviteResponse} inviteResponse Slot number of the Response Message to use when responding to a user.
|
|
@@ -13927,6 +15350,17 @@ export declare class InviteApi extends BaseAPI {
|
|
|
13927
15350
|
* @memberof InviteApi
|
|
13928
15351
|
*/
|
|
13929
15352
|
respondInvite(notificationId: string, inviteResponse: InviteResponse, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification, any>>;
|
|
15353
|
+
/**
|
|
15354
|
+
* 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.\'
|
|
15355
|
+
* @summary Respond Invite with photo
|
|
15356
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15357
|
+
* @param {File} image The binary blob of the png file.
|
|
15358
|
+
* @param {InviteResponse} data
|
|
15359
|
+
* @param {*} [options] Override http request option.
|
|
15360
|
+
* @throws {RequiredError}
|
|
15361
|
+
* @memberof InviteApi
|
|
15362
|
+
*/
|
|
15363
|
+
respondInviteWithPhoto(notificationId: string, image: File, data: InviteResponse, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification, any>>;
|
|
13930
15364
|
/**
|
|
13931
15365
|
* 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
15366
|
* @summary Update Invite Message
|
|
@@ -14066,221 +15500,360 @@ export declare class JamsApi extends BaseAPI {
|
|
|
14066
15500
|
getJams(type?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Jam[], any>>;
|
|
14067
15501
|
}
|
|
14068
15502
|
/**
|
|
14069
|
-
*
|
|
15503
|
+
* MiscellaneousApi - axios parameter creator
|
|
14070
15504
|
* @export
|
|
14071
15505
|
*/
|
|
14072
|
-
export declare const
|
|
15506
|
+
export declare const MiscellaneousApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
14073
15507
|
/**
|
|
14074
|
-
*
|
|
14075
|
-
* @summary
|
|
14076
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15508
|
+
* Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
|
|
15509
|
+
* @summary Get Assigned Permissions
|
|
14077
15510
|
* @param {*} [options] Override http request option.
|
|
14078
15511
|
* @throws {RequiredError}
|
|
14079
15512
|
*/
|
|
14080
|
-
|
|
15513
|
+
getAssignedPermissions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14081
15514
|
/**
|
|
14082
|
-
*
|
|
14083
|
-
* @summary
|
|
15515
|
+
* Fetches the CSS code to the frontend React website.
|
|
15516
|
+
* @summary Download CSS
|
|
15517
|
+
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
15518
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
14084
15519
|
* @param {*} [options] Override http request option.
|
|
14085
15520
|
* @throws {RequiredError}
|
|
14086
15521
|
*/
|
|
14087
|
-
|
|
15522
|
+
getCSS: (variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14088
15523
|
/**
|
|
14089
|
-
*
|
|
14090
|
-
* @summary
|
|
14091
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15524
|
+
* API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
|
|
15525
|
+
* @summary Fetch API Config
|
|
14092
15526
|
* @param {*} [options] Override http request option.
|
|
14093
15527
|
* @throws {RequiredError}
|
|
14094
15528
|
*/
|
|
14095
|
-
|
|
15529
|
+
getConfig: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14096
15530
|
/**
|
|
14097
|
-
*
|
|
14098
|
-
* @summary
|
|
14099
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15531
|
+
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
15532
|
+
* @summary Current Online Users
|
|
14100
15533
|
* @param {*} [options] Override http request option.
|
|
14101
15534
|
* @throws {RequiredError}
|
|
14102
15535
|
*/
|
|
14103
|
-
|
|
15536
|
+
getCurrentOnlineUsers: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14104
15537
|
/**
|
|
14105
|
-
*
|
|
14106
|
-
* @summary
|
|
14107
|
-
* @param {string} [type] Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.
|
|
14108
|
-
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
14109
|
-
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
14110
|
-
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
14111
|
-
* @param {number} [n] The number of objects to return.
|
|
14112
|
-
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
15538
|
+
* ~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
|
|
15539
|
+
* @summary Check API Health
|
|
14113
15540
|
* @param {*} [options] Override http request option.
|
|
15541
|
+
* @deprecated
|
|
14114
15542
|
* @throws {RequiredError}
|
|
14115
15543
|
*/
|
|
14116
|
-
|
|
15544
|
+
getHealth: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14117
15545
|
/**
|
|
14118
|
-
*
|
|
14119
|
-
* @summary
|
|
14120
|
-
* @param {string}
|
|
15546
|
+
* IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an \"any of\" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an \"all of\" search.
|
|
15547
|
+
* @summary Show Information Notices
|
|
15548
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
15549
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
14121
15550
|
* @param {*} [options] Override http request option.
|
|
14122
15551
|
* @throws {RequiredError}
|
|
14123
15552
|
*/
|
|
14124
|
-
|
|
14125
|
-
};
|
|
14126
|
-
/**
|
|
14127
|
-
* NotificationsApi - functional programming interface
|
|
14128
|
-
* @export
|
|
14129
|
-
*/
|
|
14130
|
-
export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
15553
|
+
getInfoPush: (require?: string, include?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14131
15554
|
/**
|
|
14132
|
-
*
|
|
14133
|
-
* @summary
|
|
14134
|
-
* @param {
|
|
15555
|
+
* Fetches the JavaScript code to the frontend React website.
|
|
15556
|
+
* @summary Download JavaScript
|
|
15557
|
+
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
15558
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
14135
15559
|
* @param {*} [options] Override http request option.
|
|
14136
15560
|
* @throws {RequiredError}
|
|
14137
15561
|
*/
|
|
14138
|
-
|
|
15562
|
+
getJavaScript: (variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14139
15563
|
/**
|
|
14140
|
-
*
|
|
14141
|
-
* @summary
|
|
15564
|
+
* Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
|
|
15565
|
+
* @summary Get Permission
|
|
15566
|
+
* @param {string} permissionId Must be a valid permission ID.
|
|
14142
15567
|
* @param {*} [options] Override http request option.
|
|
14143
15568
|
* @throws {RequiredError}
|
|
14144
15569
|
*/
|
|
14145
|
-
|
|
15570
|
+
getPermission: (permissionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14146
15571
|
/**
|
|
14147
|
-
*
|
|
14148
|
-
* @summary
|
|
14149
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15572
|
+
* Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
|
15573
|
+
* @summary Current System Time
|
|
14150
15574
|
* @param {*} [options] Override http request option.
|
|
14151
15575
|
* @throws {RequiredError}
|
|
14152
15576
|
*/
|
|
14153
|
-
|
|
15577
|
+
getSystemTime: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15578
|
+
};
|
|
15579
|
+
/**
|
|
15580
|
+
* MiscellaneousApi - functional programming interface
|
|
15581
|
+
* @export
|
|
15582
|
+
*/
|
|
15583
|
+
export declare const MiscellaneousApiFp: (configuration?: Configuration) => {
|
|
14154
15584
|
/**
|
|
14155
|
-
*
|
|
14156
|
-
* @summary
|
|
14157
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15585
|
+
* Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
|
|
15586
|
+
* @summary Get Assigned Permissions
|
|
14158
15587
|
* @param {*} [options] Override http request option.
|
|
14159
15588
|
* @throws {RequiredError}
|
|
14160
15589
|
*/
|
|
14161
|
-
|
|
15590
|
+
getAssignedPermissions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Permission>>>;
|
|
14162
15591
|
/**
|
|
14163
|
-
*
|
|
14164
|
-
* @summary
|
|
14165
|
-
* @param {
|
|
14166
|
-
* @param {
|
|
14167
|
-
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
14168
|
-
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
14169
|
-
* @param {number} [n] The number of objects to return.
|
|
14170
|
-
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
15592
|
+
* Fetches the CSS code to the frontend React website.
|
|
15593
|
+
* @summary Download CSS
|
|
15594
|
+
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
15595
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
14171
15596
|
* @param {*} [options] Override http request option.
|
|
14172
15597
|
* @throws {RequiredError}
|
|
14173
15598
|
*/
|
|
14174
|
-
|
|
15599
|
+
getCSS(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
14175
15600
|
/**
|
|
14176
|
-
*
|
|
14177
|
-
* @summary
|
|
14178
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15601
|
+
* API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
|
|
15602
|
+
* @summary Fetch API Config
|
|
14179
15603
|
* @param {*} [options] Override http request option.
|
|
14180
15604
|
* @throws {RequiredError}
|
|
14181
15605
|
*/
|
|
14182
|
-
|
|
14183
|
-
};
|
|
14184
|
-
/**
|
|
14185
|
-
* NotificationsApi - factory interface
|
|
14186
|
-
* @export
|
|
14187
|
-
*/
|
|
14188
|
-
export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
15606
|
+
getConfig(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIConfig>>;
|
|
14189
15607
|
/**
|
|
14190
|
-
*
|
|
14191
|
-
* @summary
|
|
14192
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15608
|
+
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
15609
|
+
* @summary Current Online Users
|
|
14193
15610
|
* @param {*} [options] Override http request option.
|
|
14194
15611
|
* @throws {RequiredError}
|
|
14195
15612
|
*/
|
|
14196
|
-
|
|
15613
|
+
getCurrentOnlineUsers(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<number>>;
|
|
14197
15614
|
/**
|
|
14198
|
-
*
|
|
14199
|
-
* @summary
|
|
15615
|
+
* ~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
|
|
15616
|
+
* @summary Check API Health
|
|
14200
15617
|
* @param {*} [options] Override http request option.
|
|
15618
|
+
* @deprecated
|
|
14201
15619
|
* @throws {RequiredError}
|
|
14202
15620
|
*/
|
|
14203
|
-
|
|
15621
|
+
getHealth(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIHealth>>;
|
|
14204
15622
|
/**
|
|
14205
|
-
*
|
|
14206
|
-
* @summary
|
|
14207
|
-
* @param {string}
|
|
15623
|
+
* IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an \"any of\" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an \"all of\" search.
|
|
15624
|
+
* @summary Show Information Notices
|
|
15625
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
15626
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
14208
15627
|
* @param {*} [options] Override http request option.
|
|
14209
15628
|
* @throws {RequiredError}
|
|
14210
15629
|
*/
|
|
14211
|
-
|
|
15630
|
+
getInfoPush(require?: string, include?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InfoPush>>>;
|
|
14212
15631
|
/**
|
|
14213
|
-
*
|
|
14214
|
-
* @summary
|
|
14215
|
-
* @param {
|
|
15632
|
+
* Fetches the JavaScript code to the frontend React website.
|
|
15633
|
+
* @summary Download JavaScript
|
|
15634
|
+
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
15635
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
14216
15636
|
* @param {*} [options] Override http request option.
|
|
14217
15637
|
* @throws {RequiredError}
|
|
14218
15638
|
*/
|
|
14219
|
-
|
|
15639
|
+
getJavaScript(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
14220
15640
|
/**
|
|
14221
|
-
*
|
|
14222
|
-
* @summary
|
|
14223
|
-
* @param {string}
|
|
14224
|
-
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
14225
|
-
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
14226
|
-
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
14227
|
-
* @param {number} [n] The number of objects to return.
|
|
14228
|
-
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
15641
|
+
* Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
|
|
15642
|
+
* @summary Get Permission
|
|
15643
|
+
* @param {string} permissionId Must be a valid permission ID.
|
|
14229
15644
|
* @param {*} [options] Override http request option.
|
|
14230
15645
|
* @throws {RequiredError}
|
|
14231
15646
|
*/
|
|
14232
|
-
|
|
15647
|
+
getPermission(permissionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Permission>>;
|
|
14233
15648
|
/**
|
|
14234
|
-
*
|
|
14235
|
-
* @summary
|
|
14236
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15649
|
+
* Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
|
15650
|
+
* @summary Current System Time
|
|
14237
15651
|
* @param {*} [options] Override http request option.
|
|
14238
15652
|
* @throws {RequiredError}
|
|
14239
15653
|
*/
|
|
14240
|
-
|
|
15654
|
+
getSystemTime(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
14241
15655
|
};
|
|
14242
15656
|
/**
|
|
14243
|
-
*
|
|
15657
|
+
* MiscellaneousApi - factory interface
|
|
14244
15658
|
* @export
|
|
14245
|
-
|
|
15659
|
+
*/
|
|
15660
|
+
export declare const MiscellaneousApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
15661
|
+
/**
|
|
15662
|
+
* Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
|
|
15663
|
+
* @summary Get Assigned Permissions
|
|
15664
|
+
* @param {*} [options] Override http request option.
|
|
15665
|
+
* @throws {RequiredError}
|
|
15666
|
+
*/
|
|
15667
|
+
getAssignedPermissions(options?: any): AxiosPromise<Array<Permission>>;
|
|
15668
|
+
/**
|
|
15669
|
+
* Fetches the CSS code to the frontend React website.
|
|
15670
|
+
* @summary Download CSS
|
|
15671
|
+
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
15672
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
15673
|
+
* @param {*} [options] Override http request option.
|
|
15674
|
+
* @throws {RequiredError}
|
|
15675
|
+
*/
|
|
15676
|
+
getCSS(variant?: 'public' | 'internal', branch?: string, options?: any): AxiosPromise<string>;
|
|
15677
|
+
/**
|
|
15678
|
+
* API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
|
|
15679
|
+
* @summary Fetch API Config
|
|
15680
|
+
* @param {*} [options] Override http request option.
|
|
15681
|
+
* @throws {RequiredError}
|
|
15682
|
+
*/
|
|
15683
|
+
getConfig(options?: any): AxiosPromise<APIConfig>;
|
|
15684
|
+
/**
|
|
15685
|
+
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
15686
|
+
* @summary Current Online Users
|
|
15687
|
+
* @param {*} [options] Override http request option.
|
|
15688
|
+
* @throws {RequiredError}
|
|
15689
|
+
*/
|
|
15690
|
+
getCurrentOnlineUsers(options?: any): AxiosPromise<number>;
|
|
15691
|
+
/**
|
|
15692
|
+
* ~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
|
|
15693
|
+
* @summary Check API Health
|
|
15694
|
+
* @param {*} [options] Override http request option.
|
|
15695
|
+
* @deprecated
|
|
15696
|
+
* @throws {RequiredError}
|
|
15697
|
+
*/
|
|
15698
|
+
getHealth(options?: any): AxiosPromise<APIHealth>;
|
|
15699
|
+
/**
|
|
15700
|
+
* IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an \"any of\" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an \"all of\" search.
|
|
15701
|
+
* @summary Show Information Notices
|
|
15702
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
15703
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
15704
|
+
* @param {*} [options] Override http request option.
|
|
15705
|
+
* @throws {RequiredError}
|
|
15706
|
+
*/
|
|
15707
|
+
getInfoPush(require?: string, include?: string, options?: any): AxiosPromise<Array<InfoPush>>;
|
|
15708
|
+
/**
|
|
15709
|
+
* Fetches the JavaScript code to the frontend React website.
|
|
15710
|
+
* @summary Download JavaScript
|
|
15711
|
+
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
15712
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
15713
|
+
* @param {*} [options] Override http request option.
|
|
15714
|
+
* @throws {RequiredError}
|
|
15715
|
+
*/
|
|
15716
|
+
getJavaScript(variant?: 'public' | 'internal', branch?: string, options?: any): AxiosPromise<string>;
|
|
15717
|
+
/**
|
|
15718
|
+
* Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
|
|
15719
|
+
* @summary Get Permission
|
|
15720
|
+
* @param {string} permissionId Must be a valid permission ID.
|
|
15721
|
+
* @param {*} [options] Override http request option.
|
|
15722
|
+
* @throws {RequiredError}
|
|
15723
|
+
*/
|
|
15724
|
+
getPermission(permissionId: string, options?: any): AxiosPromise<Permission>;
|
|
15725
|
+
/**
|
|
15726
|
+
* Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
|
15727
|
+
* @summary Current System Time
|
|
15728
|
+
* @param {*} [options] Override http request option.
|
|
15729
|
+
* @throws {RequiredError}
|
|
15730
|
+
*/
|
|
15731
|
+
getSystemTime(options?: any): AxiosPromise<string>;
|
|
15732
|
+
};
|
|
15733
|
+
/**
|
|
15734
|
+
* MiscellaneousApi - object-oriented interface
|
|
15735
|
+
* @export
|
|
15736
|
+
* @class MiscellaneousApi
|
|
14246
15737
|
* @extends {BaseAPI}
|
|
14247
15738
|
*/
|
|
14248
|
-
export declare class
|
|
15739
|
+
export declare class MiscellaneousApi extends BaseAPI {
|
|
15740
|
+
/**
|
|
15741
|
+
* Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
|
|
15742
|
+
* @summary Get Assigned Permissions
|
|
15743
|
+
* @param {*} [options] Override http request option.
|
|
15744
|
+
* @throws {RequiredError}
|
|
15745
|
+
* @memberof MiscellaneousApi
|
|
15746
|
+
*/
|
|
15747
|
+
getAssignedPermissions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Permission[], any>>;
|
|
15748
|
+
/**
|
|
15749
|
+
* Fetches the CSS code to the frontend React website.
|
|
15750
|
+
* @summary Download CSS
|
|
15751
|
+
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
15752
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
15753
|
+
* @param {*} [options] Override http request option.
|
|
15754
|
+
* @throws {RequiredError}
|
|
15755
|
+
* @memberof MiscellaneousApi
|
|
15756
|
+
*/
|
|
15757
|
+
getCSS(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
15758
|
+
/**
|
|
15759
|
+
* API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
|
|
15760
|
+
* @summary Fetch API Config
|
|
15761
|
+
* @param {*} [options] Override http request option.
|
|
15762
|
+
* @throws {RequiredError}
|
|
15763
|
+
* @memberof MiscellaneousApi
|
|
15764
|
+
*/
|
|
15765
|
+
getConfig(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<APIConfig, any>>;
|
|
15766
|
+
/**
|
|
15767
|
+
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
15768
|
+
* @summary Current Online Users
|
|
15769
|
+
* @param {*} [options] Override http request option.
|
|
15770
|
+
* @throws {RequiredError}
|
|
15771
|
+
* @memberof MiscellaneousApi
|
|
15772
|
+
*/
|
|
15773
|
+
getCurrentOnlineUsers(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<number, any>>;
|
|
15774
|
+
/**
|
|
15775
|
+
* ~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
|
|
15776
|
+
* @summary Check API Health
|
|
15777
|
+
* @param {*} [options] Override http request option.
|
|
15778
|
+
* @deprecated
|
|
15779
|
+
* @throws {RequiredError}
|
|
15780
|
+
* @memberof MiscellaneousApi
|
|
15781
|
+
*/
|
|
15782
|
+
getHealth(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<APIHealth, any>>;
|
|
15783
|
+
/**
|
|
15784
|
+
* IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an \"any of\" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an \"all of\" search.
|
|
15785
|
+
* @summary Show Information Notices
|
|
15786
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
15787
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
15788
|
+
* @param {*} [options] Override http request option.
|
|
15789
|
+
* @throws {RequiredError}
|
|
15790
|
+
* @memberof MiscellaneousApi
|
|
15791
|
+
*/
|
|
15792
|
+
getInfoPush(require?: string, include?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InfoPush[], any>>;
|
|
15793
|
+
/**
|
|
15794
|
+
* Fetches the JavaScript code to the frontend React website.
|
|
15795
|
+
* @summary Download JavaScript
|
|
15796
|
+
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
15797
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
15798
|
+
* @param {*} [options] Override http request option.
|
|
15799
|
+
* @throws {RequiredError}
|
|
15800
|
+
* @memberof MiscellaneousApi
|
|
15801
|
+
*/
|
|
15802
|
+
getJavaScript(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
15803
|
+
/**
|
|
15804
|
+
* Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
|
|
15805
|
+
* @summary Get Permission
|
|
15806
|
+
* @param {string} permissionId Must be a valid permission ID.
|
|
15807
|
+
* @param {*} [options] Override http request option.
|
|
15808
|
+
* @throws {RequiredError}
|
|
15809
|
+
* @memberof MiscellaneousApi
|
|
15810
|
+
*/
|
|
15811
|
+
getPermission(permissionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Permission, any>>;
|
|
15812
|
+
/**
|
|
15813
|
+
* Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
|
15814
|
+
* @summary Current System Time
|
|
15815
|
+
* @param {*} [options] Override http request option.
|
|
15816
|
+
* @throws {RequiredError}
|
|
15817
|
+
* @memberof MiscellaneousApi
|
|
15818
|
+
*/
|
|
15819
|
+
getSystemTime(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
15820
|
+
}
|
|
15821
|
+
/**
|
|
15822
|
+
* NotificationsApi - axios parameter creator
|
|
15823
|
+
* @export
|
|
15824
|
+
*/
|
|
15825
|
+
export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
14249
15826
|
/**
|
|
14250
15827
|
* Accept a friend request by notification `frq_` ID. Friend requests can be found using the NotificationsAPI `getNotifications` by filtering of type `friendRequest`.
|
|
14251
15828
|
* @summary Accept Friend Request
|
|
14252
15829
|
* @param {string} notificationId Must be a valid notification ID.
|
|
14253
15830
|
* @param {*} [options] Override http request option.
|
|
14254
15831
|
* @throws {RequiredError}
|
|
14255
|
-
* @memberof NotificationsApi
|
|
14256
15832
|
*/
|
|
14257
|
-
acceptFriendRequest(notificationId: string, options?: AxiosRequestConfig)
|
|
15833
|
+
acceptFriendRequest: (notificationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14258
15834
|
/**
|
|
14259
15835
|
* Clear **all** notifications.
|
|
14260
15836
|
* @summary Clear All Notifications
|
|
14261
15837
|
* @param {*} [options] Override http request option.
|
|
14262
15838
|
* @throws {RequiredError}
|
|
14263
|
-
* @memberof NotificationsApi
|
|
14264
15839
|
*/
|
|
14265
|
-
clearNotifications(options?: AxiosRequestConfig)
|
|
15840
|
+
clearNotifications: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14266
15841
|
/**
|
|
14267
15842
|
* Delete a notification.
|
|
14268
15843
|
* @summary Delete Notification
|
|
14269
15844
|
* @param {string} notificationId Must be a valid notification ID.
|
|
14270
15845
|
* @param {*} [options] Override http request option.
|
|
14271
15846
|
* @throws {RequiredError}
|
|
14272
|
-
* @memberof NotificationsApi
|
|
14273
15847
|
*/
|
|
14274
|
-
deleteNotification(notificationId: string, options?: AxiosRequestConfig)
|
|
15848
|
+
deleteNotification: (notificationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14275
15849
|
/**
|
|
14276
15850
|
* Get a notification by notification `not_` ID.
|
|
14277
15851
|
* @summary Show notification
|
|
14278
15852
|
* @param {string} notificationId Must be a valid notification ID.
|
|
14279
15853
|
* @param {*} [options] Override http request option.
|
|
14280
15854
|
* @throws {RequiredError}
|
|
14281
|
-
* @memberof NotificationsApi
|
|
14282
15855
|
*/
|
|
14283
|
-
getNotification(notificationId: string, options?: AxiosRequestConfig)
|
|
15856
|
+
getNotification: (notificationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14284
15857
|
/**
|
|
14285
15858
|
* Retrieve all of the current user\'s notifications.
|
|
14286
15859
|
* @summary List Notifications
|
|
@@ -14292,106 +15865,198 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
14292
15865
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
14293
15866
|
* @param {*} [options] Override http request option.
|
|
14294
15867
|
* @throws {RequiredError}
|
|
14295
|
-
* @memberof NotificationsApi
|
|
14296
15868
|
*/
|
|
14297
|
-
getNotifications(type?: string, sent?: boolean, hidden?: boolean, after?: string, n?: number, offset?: number, options?: AxiosRequestConfig)
|
|
15869
|
+
getNotifications: (type?: string, sent?: boolean, hidden?: boolean, after?: string, n?: number, offset?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14298
15870
|
/**
|
|
14299
15871
|
* Mark a notification as seen.
|
|
14300
15872
|
* @summary Mark Notification As Read
|
|
14301
15873
|
* @param {string} notificationId Must be a valid notification ID.
|
|
14302
15874
|
* @param {*} [options] Override http request option.
|
|
14303
15875
|
* @throws {RequiredError}
|
|
14304
|
-
* @memberof NotificationsApi
|
|
14305
15876
|
*/
|
|
14306
|
-
markNotificationAsRead(notificationId: string, options?: AxiosRequestConfig)
|
|
14307
|
-
}
|
|
15877
|
+
markNotificationAsRead: (notificationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15878
|
+
};
|
|
14308
15879
|
/**
|
|
14309
|
-
*
|
|
15880
|
+
* NotificationsApi - functional programming interface
|
|
14310
15881
|
* @export
|
|
14311
15882
|
*/
|
|
14312
|
-
export declare const
|
|
15883
|
+
export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
14313
15884
|
/**
|
|
14314
|
-
*
|
|
14315
|
-
* @summary
|
|
15885
|
+
* Accept a friend request by notification `frq_` ID. Friend requests can be found using the NotificationsAPI `getNotifications` by filtering of type `friendRequest`.
|
|
15886
|
+
* @summary Accept Friend Request
|
|
15887
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
14316
15888
|
* @param {*} [options] Override http request option.
|
|
14317
15889
|
* @throws {RequiredError}
|
|
14318
15890
|
*/
|
|
14319
|
-
|
|
15891
|
+
acceptFriendRequest(notificationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>>;
|
|
14320
15892
|
/**
|
|
14321
|
-
*
|
|
14322
|
-
* @summary
|
|
14323
|
-
* @param {string} permissionId Must be a valid permission ID.
|
|
15893
|
+
* Clear **all** notifications.
|
|
15894
|
+
* @summary Clear All Notifications
|
|
14324
15895
|
* @param {*} [options] Override http request option.
|
|
14325
15896
|
* @throws {RequiredError}
|
|
14326
15897
|
*/
|
|
14327
|
-
|
|
14328
|
-
};
|
|
14329
|
-
/**
|
|
14330
|
-
* PermissionsApi - functional programming interface
|
|
14331
|
-
* @export
|
|
14332
|
-
*/
|
|
14333
|
-
export declare const PermissionsApiFp: (configuration?: Configuration) => {
|
|
15898
|
+
clearNotifications(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>>;
|
|
14334
15899
|
/**
|
|
14335
|
-
*
|
|
14336
|
-
* @summary
|
|
15900
|
+
* Delete a notification.
|
|
15901
|
+
* @summary Delete Notification
|
|
15902
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
14337
15903
|
* @param {*} [options] Override http request option.
|
|
14338
15904
|
* @throws {RequiredError}
|
|
14339
15905
|
*/
|
|
14340
|
-
|
|
15906
|
+
deleteNotification(notificationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
|
|
14341
15907
|
/**
|
|
14342
|
-
*
|
|
14343
|
-
* @summary
|
|
14344
|
-
* @param {string}
|
|
15908
|
+
* Get a notification by notification `not_` ID.
|
|
15909
|
+
* @summary Show notification
|
|
15910
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
14345
15911
|
* @param {*} [options] Override http request option.
|
|
14346
15912
|
* @throws {RequiredError}
|
|
14347
15913
|
*/
|
|
14348
|
-
|
|
15914
|
+
getNotification(notificationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
|
|
15915
|
+
/**
|
|
15916
|
+
* Retrieve all of the current user\'s notifications.
|
|
15917
|
+
* @summary List Notifications
|
|
15918
|
+
* @param {string} [type] Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.
|
|
15919
|
+
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
15920
|
+
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
15921
|
+
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
15922
|
+
* @param {number} [n] The number of objects to return.
|
|
15923
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
15924
|
+
* @param {*} [options] Override http request option.
|
|
15925
|
+
* @throws {RequiredError}
|
|
15926
|
+
*/
|
|
15927
|
+
getNotifications(type?: string, sent?: boolean, hidden?: boolean, after?: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Notification>>>;
|
|
15928
|
+
/**
|
|
15929
|
+
* Mark a notification as seen.
|
|
15930
|
+
* @summary Mark Notification As Read
|
|
15931
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15932
|
+
* @param {*} [options] Override http request option.
|
|
15933
|
+
* @throws {RequiredError}
|
|
15934
|
+
*/
|
|
15935
|
+
markNotificationAsRead(notificationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
|
|
14349
15936
|
};
|
|
14350
15937
|
/**
|
|
14351
|
-
*
|
|
15938
|
+
* NotificationsApi - factory interface
|
|
14352
15939
|
* @export
|
|
14353
15940
|
*/
|
|
14354
|
-
export declare const
|
|
15941
|
+
export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
14355
15942
|
/**
|
|
14356
|
-
*
|
|
14357
|
-
* @summary
|
|
15943
|
+
* Accept a friend request by notification `frq_` ID. Friend requests can be found using the NotificationsAPI `getNotifications` by filtering of type `friendRequest`.
|
|
15944
|
+
* @summary Accept Friend Request
|
|
15945
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
14358
15946
|
* @param {*} [options] Override http request option.
|
|
14359
15947
|
* @throws {RequiredError}
|
|
14360
15948
|
*/
|
|
14361
|
-
|
|
15949
|
+
acceptFriendRequest(notificationId: string, options?: any): AxiosPromise<Success>;
|
|
14362
15950
|
/**
|
|
14363
|
-
*
|
|
14364
|
-
* @summary
|
|
14365
|
-
* @param {string} permissionId Must be a valid permission ID.
|
|
15951
|
+
* Clear **all** notifications.
|
|
15952
|
+
* @summary Clear All Notifications
|
|
14366
15953
|
* @param {*} [options] Override http request option.
|
|
14367
15954
|
* @throws {RequiredError}
|
|
14368
15955
|
*/
|
|
14369
|
-
|
|
15956
|
+
clearNotifications(options?: any): AxiosPromise<Success>;
|
|
15957
|
+
/**
|
|
15958
|
+
* Delete a notification.
|
|
15959
|
+
* @summary Delete Notification
|
|
15960
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15961
|
+
* @param {*} [options] Override http request option.
|
|
15962
|
+
* @throws {RequiredError}
|
|
15963
|
+
*/
|
|
15964
|
+
deleteNotification(notificationId: string, options?: any): AxiosPromise<Notification>;
|
|
15965
|
+
/**
|
|
15966
|
+
* Get a notification by notification `not_` ID.
|
|
15967
|
+
* @summary Show notification
|
|
15968
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15969
|
+
* @param {*} [options] Override http request option.
|
|
15970
|
+
* @throws {RequiredError}
|
|
15971
|
+
*/
|
|
15972
|
+
getNotification(notificationId: string, options?: any): AxiosPromise<Notification>;
|
|
15973
|
+
/**
|
|
15974
|
+
* Retrieve all of the current user\'s notifications.
|
|
15975
|
+
* @summary List Notifications
|
|
15976
|
+
* @param {string} [type] Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.
|
|
15977
|
+
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
15978
|
+
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
15979
|
+
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
15980
|
+
* @param {number} [n] The number of objects to return.
|
|
15981
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
15982
|
+
* @param {*} [options] Override http request option.
|
|
15983
|
+
* @throws {RequiredError}
|
|
15984
|
+
*/
|
|
15985
|
+
getNotifications(type?: string, sent?: boolean, hidden?: boolean, after?: string, n?: number, offset?: number, options?: any): AxiosPromise<Array<Notification>>;
|
|
15986
|
+
/**
|
|
15987
|
+
* Mark a notification as seen.
|
|
15988
|
+
* @summary Mark Notification As Read
|
|
15989
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15990
|
+
* @param {*} [options] Override http request option.
|
|
15991
|
+
* @throws {RequiredError}
|
|
15992
|
+
*/
|
|
15993
|
+
markNotificationAsRead(notificationId: string, options?: any): AxiosPromise<Notification>;
|
|
14370
15994
|
};
|
|
14371
15995
|
/**
|
|
14372
|
-
*
|
|
15996
|
+
* NotificationsApi - object-oriented interface
|
|
14373
15997
|
* @export
|
|
14374
|
-
* @class
|
|
15998
|
+
* @class NotificationsApi
|
|
14375
15999
|
* @extends {BaseAPI}
|
|
14376
16000
|
*/
|
|
14377
|
-
export declare class
|
|
16001
|
+
export declare class NotificationsApi extends BaseAPI {
|
|
14378
16002
|
/**
|
|
14379
|
-
*
|
|
14380
|
-
* @summary
|
|
16003
|
+
* Accept a friend request by notification `frq_` ID. Friend requests can be found using the NotificationsAPI `getNotifications` by filtering of type `friendRequest`.
|
|
16004
|
+
* @summary Accept Friend Request
|
|
16005
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
14381
16006
|
* @param {*} [options] Override http request option.
|
|
14382
16007
|
* @throws {RequiredError}
|
|
14383
|
-
* @memberof
|
|
16008
|
+
* @memberof NotificationsApi
|
|
14384
16009
|
*/
|
|
14385
|
-
|
|
16010
|
+
acceptFriendRequest(notificationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
14386
16011
|
/**
|
|
14387
|
-
*
|
|
14388
|
-
* @summary
|
|
14389
|
-
* @param {string} permissionId Must be a valid permission ID.
|
|
16012
|
+
* Clear **all** notifications.
|
|
16013
|
+
* @summary Clear All Notifications
|
|
14390
16014
|
* @param {*} [options] Override http request option.
|
|
14391
16015
|
* @throws {RequiredError}
|
|
14392
|
-
* @memberof
|
|
16016
|
+
* @memberof NotificationsApi
|
|
14393
16017
|
*/
|
|
14394
|
-
|
|
16018
|
+
clearNotifications(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
16019
|
+
/**
|
|
16020
|
+
* Delete a notification.
|
|
16021
|
+
* @summary Delete Notification
|
|
16022
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
16023
|
+
* @param {*} [options] Override http request option.
|
|
16024
|
+
* @throws {RequiredError}
|
|
16025
|
+
* @memberof NotificationsApi
|
|
16026
|
+
*/
|
|
16027
|
+
deleteNotification(notificationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification, any>>;
|
|
16028
|
+
/**
|
|
16029
|
+
* Get a notification by notification `not_` ID.
|
|
16030
|
+
* @summary Show notification
|
|
16031
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
16032
|
+
* @param {*} [options] Override http request option.
|
|
16033
|
+
* @throws {RequiredError}
|
|
16034
|
+
* @memberof NotificationsApi
|
|
16035
|
+
*/
|
|
16036
|
+
getNotification(notificationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification, any>>;
|
|
16037
|
+
/**
|
|
16038
|
+
* Retrieve all of the current user\'s notifications.
|
|
16039
|
+
* @summary List Notifications
|
|
16040
|
+
* @param {string} [type] Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.
|
|
16041
|
+
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
16042
|
+
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
16043
|
+
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
16044
|
+
* @param {number} [n] The number of objects to return.
|
|
16045
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
16046
|
+
* @param {*} [options] Override http request option.
|
|
16047
|
+
* @throws {RequiredError}
|
|
16048
|
+
* @memberof NotificationsApi
|
|
16049
|
+
*/
|
|
16050
|
+
getNotifications(type?: string, sent?: boolean, hidden?: boolean, after?: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification[], any>>;
|
|
16051
|
+
/**
|
|
16052
|
+
* Mark a notification as seen.
|
|
16053
|
+
* @summary Mark Notification As Read
|
|
16054
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
16055
|
+
* @param {*} [options] Override http request option.
|
|
16056
|
+
* @throws {RequiredError}
|
|
16057
|
+
* @memberof NotificationsApi
|
|
16058
|
+
*/
|
|
16059
|
+
markNotificationAsRead(notificationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification, any>>;
|
|
14395
16060
|
}
|
|
14396
16061
|
/**
|
|
14397
16062
|
* PlayermoderationApi - axios parameter creator
|
|
@@ -14552,267 +16217,252 @@ export declare class PlayermoderationApi extends BaseAPI {
|
|
|
14552
16217
|
unmoderateUser(moderateUserRequest: ModerateUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
14553
16218
|
}
|
|
14554
16219
|
/**
|
|
14555
|
-
*
|
|
16220
|
+
* PrintsApi - axios parameter creator
|
|
14556
16221
|
* @export
|
|
14557
16222
|
*/
|
|
14558
|
-
export declare const
|
|
16223
|
+
export declare const PrintsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
14559
16224
|
/**
|
|
14560
|
-
*
|
|
14561
|
-
* @summary
|
|
14562
|
-
* @param {
|
|
14563
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
14564
|
-
* @param {*} [options] Override http request option.
|
|
14565
|
-
* @throws {RequiredError}
|
|
14566
|
-
*/
|
|
14567
|
-
getCSS: (variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14568
|
-
/**
|
|
14569
|
-
* API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
|
|
14570
|
-
* @summary Fetch API Config
|
|
16225
|
+
* Returns a print.
|
|
16226
|
+
* @summary Delete Print
|
|
16227
|
+
* @param {string} printId Print ID.
|
|
14571
16228
|
* @param {*} [options] Override http request option.
|
|
14572
16229
|
* @throws {RequiredError}
|
|
14573
16230
|
*/
|
|
14574
|
-
|
|
14575
|
-
/**
|
|
14576
|
-
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
14577
|
-
* @summary Current Online Users
|
|
14578
|
-
* @param {*} [options] Override http request option.
|
|
14579
|
-
* @throws {RequiredError}
|
|
14580
|
-
*/
|
|
14581
|
-
getCurrentOnlineUsers: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14582
|
-
/**
|
|
14583
|
-
* ~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
|
|
14584
|
-
* @summary Check API Health
|
|
14585
|
-
* @param {*} [options] Override http request option.
|
|
14586
|
-
* @deprecated
|
|
14587
|
-
* @throws {RequiredError}
|
|
14588
|
-
*/
|
|
14589
|
-
getHealth: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16231
|
+
deletePrint: (printId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14590
16232
|
/**
|
|
14591
|
-
*
|
|
14592
|
-
* @summary
|
|
14593
|
-
* @param {string}
|
|
14594
|
-
* @param {
|
|
14595
|
-
* @param {
|
|
14596
|
-
* @throws {RequiredError}
|
|
14597
|
-
*/
|
|
14598
|
-
getInfoPush: (require?: string, include?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14599
|
-
/**
|
|
14600
|
-
* Fetches the JavaScript code to the frontend React website.
|
|
14601
|
-
* @summary Download JavaScript
|
|
14602
|
-
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
14603
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
14604
|
-
* @param {*} [options] Override http request option.
|
|
14605
|
-
* @throws {RequiredError}
|
|
14606
|
-
*/
|
|
14607
|
-
getJavaScript: (variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14608
|
-
/**
|
|
14609
|
-
* Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
|
14610
|
-
* @summary Current System Time
|
|
14611
|
-
* @param {*} [options] Override http request option.
|
|
14612
|
-
* @throws {RequiredError}
|
|
14613
|
-
*/
|
|
14614
|
-
getSystemTime: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14615
|
-
};
|
|
14616
|
-
/**
|
|
14617
|
-
* SystemApi - functional programming interface
|
|
14618
|
-
* @export
|
|
14619
|
-
*/
|
|
14620
|
-
export declare const SystemApiFp: (configuration?: Configuration) => {
|
|
14621
|
-
/**
|
|
14622
|
-
* Fetches the CSS code to the frontend React website.
|
|
14623
|
-
* @summary Download CSS
|
|
14624
|
-
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
14625
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
14626
|
-
* @param {*} [options] Override http request option.
|
|
14627
|
-
* @throws {RequiredError}
|
|
14628
|
-
*/
|
|
14629
|
-
getCSS(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
14630
|
-
/**
|
|
14631
|
-
* API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
|
|
14632
|
-
* @summary Fetch API Config
|
|
14633
|
-
* @param {*} [options] Override http request option.
|
|
14634
|
-
* @throws {RequiredError}
|
|
14635
|
-
*/
|
|
14636
|
-
getConfig(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIConfig>>;
|
|
14637
|
-
/**
|
|
14638
|
-
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
14639
|
-
* @summary Current Online Users
|
|
14640
|
-
* @param {*} [options] Override http request option.
|
|
14641
|
-
* @throws {RequiredError}
|
|
14642
|
-
*/
|
|
14643
|
-
getCurrentOnlineUsers(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<number>>;
|
|
14644
|
-
/**
|
|
14645
|
-
* ~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
|
|
14646
|
-
* @summary Check API Health
|
|
16233
|
+
* Edits a print.
|
|
16234
|
+
* @summary Edit Print
|
|
16235
|
+
* @param {string} printId Print ID.
|
|
16236
|
+
* @param {File} image The binary blob of the png file.
|
|
16237
|
+
* @param {string} [note] The caption for the image.
|
|
14647
16238
|
* @param {*} [options] Override http request option.
|
|
14648
|
-
* @deprecated
|
|
14649
16239
|
* @throws {RequiredError}
|
|
14650
16240
|
*/
|
|
14651
|
-
|
|
16241
|
+
editPrint: (printId: string, image: File, note?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14652
16242
|
/**
|
|
14653
|
-
*
|
|
14654
|
-
* @summary
|
|
14655
|
-
* @param {string}
|
|
14656
|
-
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
16243
|
+
* Returns a print.
|
|
16244
|
+
* @summary Get Print
|
|
16245
|
+
* @param {string} printId Print ID.
|
|
14657
16246
|
* @param {*} [options] Override http request option.
|
|
14658
16247
|
* @throws {RequiredError}
|
|
14659
16248
|
*/
|
|
14660
|
-
|
|
16249
|
+
getPrint: (printId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14661
16250
|
/**
|
|
14662
|
-
*
|
|
14663
|
-
* @summary
|
|
14664
|
-
* @param {
|
|
14665
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
16251
|
+
* 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.
|
|
16252
|
+
* @summary Get Own Prints
|
|
16253
|
+
* @param {string} userId Must be a valid user ID.
|
|
14666
16254
|
* @param {*} [options] Override http request option.
|
|
14667
16255
|
* @throws {RequiredError}
|
|
14668
16256
|
*/
|
|
14669
|
-
|
|
16257
|
+
getUserPrints: (userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14670
16258
|
/**
|
|
14671
|
-
*
|
|
14672
|
-
* @summary
|
|
16259
|
+
* Uploads and creates a print.
|
|
16260
|
+
* @summary Upload Print
|
|
16261
|
+
* @param {File} image The binary blob of the png file.
|
|
16262
|
+
* @param {string} timestamp The time the image was captured.
|
|
16263
|
+
* @param {string} [note] The caption for the image.
|
|
16264
|
+
* @param {string} [worldId] The id of the world in which the image was captured.
|
|
16265
|
+
* @param {string} [worldName] The name of the world in which the image was captured.
|
|
14673
16266
|
* @param {*} [options] Override http request option.
|
|
14674
16267
|
* @throws {RequiredError}
|
|
14675
16268
|
*/
|
|
14676
|
-
|
|
16269
|
+
uploadPrint: (image: File, timestamp: string, note?: string, worldId?: string, worldName?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14677
16270
|
};
|
|
14678
16271
|
/**
|
|
14679
|
-
*
|
|
16272
|
+
* PrintsApi - functional programming interface
|
|
14680
16273
|
* @export
|
|
14681
16274
|
*/
|
|
14682
|
-
export declare const
|
|
16275
|
+
export declare const PrintsApiFp: (configuration?: Configuration) => {
|
|
14683
16276
|
/**
|
|
14684
|
-
*
|
|
14685
|
-
* @summary
|
|
14686
|
-
* @param {
|
|
14687
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
16277
|
+
* Returns a print.
|
|
16278
|
+
* @summary Delete Print
|
|
16279
|
+
* @param {string} printId Print ID.
|
|
14688
16280
|
* @param {*} [options] Override http request option.
|
|
14689
16281
|
* @throws {RequiredError}
|
|
14690
16282
|
*/
|
|
14691
|
-
|
|
16283
|
+
deletePrint(printId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
14692
16284
|
/**
|
|
14693
|
-
*
|
|
14694
|
-
* @summary
|
|
16285
|
+
* Edits a print.
|
|
16286
|
+
* @summary Edit Print
|
|
16287
|
+
* @param {string} printId Print ID.
|
|
16288
|
+
* @param {File} image The binary blob of the png file.
|
|
16289
|
+
* @param {string} [note] The caption for the image.
|
|
14695
16290
|
* @param {*} [options] Override http request option.
|
|
14696
16291
|
* @throws {RequiredError}
|
|
14697
16292
|
*/
|
|
14698
|
-
|
|
16293
|
+
editPrint(printId: string, image: File, note?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Print>>;
|
|
14699
16294
|
/**
|
|
14700
|
-
* Returns
|
|
14701
|
-
* @summary
|
|
16295
|
+
* Returns a print.
|
|
16296
|
+
* @summary Get Print
|
|
16297
|
+
* @param {string} printId Print ID.
|
|
14702
16298
|
* @param {*} [options] Override http request option.
|
|
14703
16299
|
* @throws {RequiredError}
|
|
14704
16300
|
*/
|
|
14705
|
-
|
|
16301
|
+
getPrint(printId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Print>>;
|
|
14706
16302
|
/**
|
|
14707
|
-
*
|
|
14708
|
-
* @summary
|
|
16303
|
+
* 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.
|
|
16304
|
+
* @summary Get Own Prints
|
|
16305
|
+
* @param {string} userId Must be a valid user ID.
|
|
14709
16306
|
* @param {*} [options] Override http request option.
|
|
14710
|
-
* @deprecated
|
|
14711
16307
|
* @throws {RequiredError}
|
|
14712
16308
|
*/
|
|
14713
|
-
|
|
16309
|
+
getUserPrints(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Print>>>;
|
|
14714
16310
|
/**
|
|
14715
|
-
*
|
|
14716
|
-
* @summary
|
|
14717
|
-
* @param {
|
|
14718
|
-
* @param {string}
|
|
16311
|
+
* Uploads and creates a print.
|
|
16312
|
+
* @summary Upload Print
|
|
16313
|
+
* @param {File} image The binary blob of the png file.
|
|
16314
|
+
* @param {string} timestamp The time the image was captured.
|
|
16315
|
+
* @param {string} [note] The caption for the image.
|
|
16316
|
+
* @param {string} [worldId] The id of the world in which the image was captured.
|
|
16317
|
+
* @param {string} [worldName] The name of the world in which the image was captured.
|
|
14719
16318
|
* @param {*} [options] Override http request option.
|
|
14720
16319
|
* @throws {RequiredError}
|
|
14721
16320
|
*/
|
|
14722
|
-
|
|
16321
|
+
uploadPrint(image: File, timestamp: string, note?: string, worldId?: string, worldName?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Print>>;
|
|
16322
|
+
};
|
|
16323
|
+
/**
|
|
16324
|
+
* PrintsApi - factory interface
|
|
16325
|
+
* @export
|
|
16326
|
+
*/
|
|
16327
|
+
export declare const PrintsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
14723
16328
|
/**
|
|
14724
|
-
*
|
|
14725
|
-
* @summary
|
|
14726
|
-
* @param {
|
|
14727
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
16329
|
+
* Returns a print.
|
|
16330
|
+
* @summary Delete Print
|
|
16331
|
+
* @param {string} printId Print ID.
|
|
14728
16332
|
* @param {*} [options] Override http request option.
|
|
14729
16333
|
* @throws {RequiredError}
|
|
14730
16334
|
*/
|
|
14731
|
-
|
|
16335
|
+
deletePrint(printId: string, options?: any): AxiosPromise<void>;
|
|
14732
16336
|
/**
|
|
14733
|
-
*
|
|
14734
|
-
* @summary
|
|
16337
|
+
* Edits a print.
|
|
16338
|
+
* @summary Edit Print
|
|
16339
|
+
* @param {string} printId Print ID.
|
|
16340
|
+
* @param {File} image The binary blob of the png file.
|
|
16341
|
+
* @param {string} [note] The caption for the image.
|
|
14735
16342
|
* @param {*} [options] Override http request option.
|
|
14736
16343
|
* @throws {RequiredError}
|
|
14737
16344
|
*/
|
|
14738
|
-
|
|
14739
|
-
};
|
|
14740
|
-
/**
|
|
14741
|
-
* SystemApi - object-oriented interface
|
|
14742
|
-
* @export
|
|
14743
|
-
* @class SystemApi
|
|
14744
|
-
* @extends {BaseAPI}
|
|
14745
|
-
*/
|
|
14746
|
-
export declare class SystemApi extends BaseAPI {
|
|
16345
|
+
editPrint(printId: string, image: File, note?: string, options?: any): AxiosPromise<Print>;
|
|
14747
16346
|
/**
|
|
14748
|
-
*
|
|
14749
|
-
* @summary
|
|
14750
|
-
* @param {
|
|
14751
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
16347
|
+
* Returns a print.
|
|
16348
|
+
* @summary Get Print
|
|
16349
|
+
* @param {string} printId Print ID.
|
|
14752
16350
|
* @param {*} [options] Override http request option.
|
|
14753
16351
|
* @throws {RequiredError}
|
|
14754
|
-
* @memberof SystemApi
|
|
14755
16352
|
*/
|
|
14756
|
-
|
|
16353
|
+
getPrint(printId: string, options?: any): AxiosPromise<Print>;
|
|
14757
16354
|
/**
|
|
14758
|
-
*
|
|
14759
|
-
* @summary
|
|
16355
|
+
* 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.
|
|
16356
|
+
* @summary Get Own Prints
|
|
16357
|
+
* @param {string} userId Must be a valid user ID.
|
|
14760
16358
|
* @param {*} [options] Override http request option.
|
|
14761
16359
|
* @throws {RequiredError}
|
|
14762
|
-
* @memberof SystemApi
|
|
14763
16360
|
*/
|
|
14764
|
-
|
|
16361
|
+
getUserPrints(userId: string, options?: any): AxiosPromise<Array<Print>>;
|
|
14765
16362
|
/**
|
|
14766
|
-
*
|
|
14767
|
-
* @summary
|
|
16363
|
+
* Uploads and creates a print.
|
|
16364
|
+
* @summary Upload Print
|
|
16365
|
+
* @param {File} image The binary blob of the png file.
|
|
16366
|
+
* @param {string} timestamp The time the image was captured.
|
|
16367
|
+
* @param {string} [note] The caption for the image.
|
|
16368
|
+
* @param {string} [worldId] The id of the world in which the image was captured.
|
|
16369
|
+
* @param {string} [worldName] The name of the world in which the image was captured.
|
|
14768
16370
|
* @param {*} [options] Override http request option.
|
|
14769
16371
|
* @throws {RequiredError}
|
|
14770
|
-
* @memberof SystemApi
|
|
14771
16372
|
*/
|
|
14772
|
-
|
|
16373
|
+
uploadPrint(image: File, timestamp: string, note?: string, worldId?: string, worldName?: string, options?: any): AxiosPromise<Print>;
|
|
16374
|
+
};
|
|
16375
|
+
/**
|
|
16376
|
+
* PrintsApi - object-oriented interface
|
|
16377
|
+
* @export
|
|
16378
|
+
* @class PrintsApi
|
|
16379
|
+
* @extends {BaseAPI}
|
|
16380
|
+
*/
|
|
16381
|
+
export declare class PrintsApi extends BaseAPI {
|
|
14773
16382
|
/**
|
|
14774
|
-
*
|
|
14775
|
-
* @summary
|
|
16383
|
+
* Returns a print.
|
|
16384
|
+
* @summary Delete Print
|
|
16385
|
+
* @param {string} printId Print ID.
|
|
14776
16386
|
* @param {*} [options] Override http request option.
|
|
14777
|
-
* @deprecated
|
|
14778
16387
|
* @throws {RequiredError}
|
|
14779
|
-
* @memberof
|
|
16388
|
+
* @memberof PrintsApi
|
|
14780
16389
|
*/
|
|
14781
|
-
|
|
16390
|
+
deletePrint(printId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
14782
16391
|
/**
|
|
14783
|
-
*
|
|
14784
|
-
* @summary
|
|
14785
|
-
* @param {string}
|
|
14786
|
-
* @param {
|
|
16392
|
+
* Edits a print.
|
|
16393
|
+
* @summary Edit Print
|
|
16394
|
+
* @param {string} printId Print ID.
|
|
16395
|
+
* @param {File} image The binary blob of the png file.
|
|
16396
|
+
* @param {string} [note] The caption for the image.
|
|
14787
16397
|
* @param {*} [options] Override http request option.
|
|
14788
16398
|
* @throws {RequiredError}
|
|
14789
|
-
* @memberof
|
|
16399
|
+
* @memberof PrintsApi
|
|
14790
16400
|
*/
|
|
14791
|
-
|
|
16401
|
+
editPrint(printId: string, image: File, note?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Print, any>>;
|
|
14792
16402
|
/**
|
|
14793
|
-
*
|
|
14794
|
-
* @summary
|
|
14795
|
-
* @param {
|
|
14796
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
16403
|
+
* Returns a print.
|
|
16404
|
+
* @summary Get Print
|
|
16405
|
+
* @param {string} printId Print ID.
|
|
14797
16406
|
* @param {*} [options] Override http request option.
|
|
14798
16407
|
* @throws {RequiredError}
|
|
14799
|
-
* @memberof
|
|
16408
|
+
* @memberof PrintsApi
|
|
14800
16409
|
*/
|
|
14801
|
-
|
|
16410
|
+
getPrint(printId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Print, any>>;
|
|
14802
16411
|
/**
|
|
14803
|
-
* Returns
|
|
14804
|
-
* @summary
|
|
16412
|
+
* 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.
|
|
16413
|
+
* @summary Get Own Prints
|
|
16414
|
+
* @param {string} userId Must be a valid user ID.
|
|
14805
16415
|
* @param {*} [options] Override http request option.
|
|
14806
16416
|
* @throws {RequiredError}
|
|
14807
|
-
* @memberof
|
|
16417
|
+
* @memberof PrintsApi
|
|
14808
16418
|
*/
|
|
14809
|
-
|
|
16419
|
+
getUserPrints(userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Print[], any>>;
|
|
16420
|
+
/**
|
|
16421
|
+
* Uploads and creates a print.
|
|
16422
|
+
* @summary Upload Print
|
|
16423
|
+
* @param {File} image The binary blob of the png file.
|
|
16424
|
+
* @param {string} timestamp The time the image was captured.
|
|
16425
|
+
* @param {string} [note] The caption for the image.
|
|
16426
|
+
* @param {string} [worldId] The id of the world in which the image was captured.
|
|
16427
|
+
* @param {string} [worldName] The name of the world in which the image was captured.
|
|
16428
|
+
* @param {*} [options] Override http request option.
|
|
16429
|
+
* @throws {RequiredError}
|
|
16430
|
+
* @memberof PrintsApi
|
|
16431
|
+
*/
|
|
16432
|
+
uploadPrint(image: File, timestamp: string, note?: string, worldId?: string, worldName?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Print, any>>;
|
|
14810
16433
|
}
|
|
14811
16434
|
/**
|
|
14812
16435
|
* UsersApi - axios parameter creator
|
|
14813
16436
|
* @export
|
|
14814
16437
|
*/
|
|
14815
16438
|
export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
16439
|
+
/**
|
|
16440
|
+
* Adds tags to the user\'s profile
|
|
16441
|
+
* @summary Add User Tags
|
|
16442
|
+
* @param {string} userId Must be a valid user ID.
|
|
16443
|
+
* @param {ChangeUserTagsRequest} changeUserTagsRequest
|
|
16444
|
+
* @param {*} [options] Override http request option.
|
|
16445
|
+
* @throws {RequiredError}
|
|
16446
|
+
*/
|
|
16447
|
+
addTags: (userId: string, changeUserTagsRequest: ChangeUserTagsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16448
|
+
/**
|
|
16449
|
+
* Checks whether the user has persistence data for a given world
|
|
16450
|
+
* @summary Check User Persistence Exists
|
|
16451
|
+
* @param {string} userId Must be a valid user ID.
|
|
16452
|
+
* @param {string} worldId Must be a valid world ID.
|
|
16453
|
+
* @param {*} [options] Override http request option.
|
|
16454
|
+
* @throws {RequiredError}
|
|
16455
|
+
*/
|
|
16456
|
+
checkUserPersistenceExists: (userId: string, worldId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16457
|
+
/**
|
|
16458
|
+
* Deletes the user\'s persistence data for a given world
|
|
16459
|
+
* @summary Delete User Persistence
|
|
16460
|
+
* @param {string} userId Must be a valid user ID.
|
|
16461
|
+
* @param {string} worldId Must be a valid world ID.
|
|
16462
|
+
* @param {*} [options] Override http request option.
|
|
16463
|
+
* @throws {RequiredError}
|
|
16464
|
+
*/
|
|
16465
|
+
deleteUserPersistence: (userId: string, worldId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14816
16466
|
/**
|
|
14817
16467
|
* Get public user information about a specific user using their ID.
|
|
14818
16468
|
* @summary Get User by ID
|
|
@@ -14891,6 +16541,15 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
14891
16541
|
* @throws {RequiredError}
|
|
14892
16542
|
*/
|
|
14893
16543
|
getUserRepresentedGroup: (userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16544
|
+
/**
|
|
16545
|
+
* Removes tags from the user\'s profile
|
|
16546
|
+
* @summary Remove User Tags
|
|
16547
|
+
* @param {string} userId Must be a valid user ID.
|
|
16548
|
+
* @param {ChangeUserTagsRequest} changeUserTagsRequest
|
|
16549
|
+
* @param {*} [options] Override http request option.
|
|
16550
|
+
* @throws {RequiredError}
|
|
16551
|
+
*/
|
|
16552
|
+
removeTags: (userId: string, changeUserTagsRequest: ChangeUserTagsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14894
16553
|
/**
|
|
14895
16554
|
* Search and list any users by text query
|
|
14896
16555
|
* @summary Search All Users
|
|
@@ -14902,6 +16561,16 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
14902
16561
|
* @throws {RequiredError}
|
|
14903
16562
|
*/
|
|
14904
16563
|
searchUsers: (search?: string, developerType?: string, n?: number, offset?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16564
|
+
/**
|
|
16565
|
+
* Updates a user\'s badge
|
|
16566
|
+
* @summary Update User Badge
|
|
16567
|
+
* @param {string} userId Must be a valid user ID.
|
|
16568
|
+
* @param {string} badgeId Must be a valid badge ID.
|
|
16569
|
+
* @param {UpdateUserBadgeRequest} updateUserBadgeRequest
|
|
16570
|
+
* @param {*} [options] Override http request option.
|
|
16571
|
+
* @throws {RequiredError}
|
|
16572
|
+
*/
|
|
16573
|
+
updateBadge: (userId: string, badgeId: string, updateUserBadgeRequest: UpdateUserBadgeRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14905
16574
|
/**
|
|
14906
16575
|
* Update a users information such as the email and birthday.
|
|
14907
16576
|
* @summary Update User Info
|
|
@@ -14925,6 +16594,33 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
14925
16594
|
* @export
|
|
14926
16595
|
*/
|
|
14927
16596
|
export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
16597
|
+
/**
|
|
16598
|
+
* Adds tags to the user\'s profile
|
|
16599
|
+
* @summary Add User Tags
|
|
16600
|
+
* @param {string} userId Must be a valid user ID.
|
|
16601
|
+
* @param {ChangeUserTagsRequest} changeUserTagsRequest
|
|
16602
|
+
* @param {*} [options] Override http request option.
|
|
16603
|
+
* @throws {RequiredError}
|
|
16604
|
+
*/
|
|
16605
|
+
addTags(userId: string, changeUserTagsRequest: ChangeUserTagsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>>;
|
|
16606
|
+
/**
|
|
16607
|
+
* Checks whether the user has persistence data for a given world
|
|
16608
|
+
* @summary Check User Persistence Exists
|
|
16609
|
+
* @param {string} userId Must be a valid user ID.
|
|
16610
|
+
* @param {string} worldId Must be a valid world ID.
|
|
16611
|
+
* @param {*} [options] Override http request option.
|
|
16612
|
+
* @throws {RequiredError}
|
|
16613
|
+
*/
|
|
16614
|
+
checkUserPersistenceExists(userId: string, worldId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
16615
|
+
/**
|
|
16616
|
+
* Deletes the user\'s persistence data for a given world
|
|
16617
|
+
* @summary Delete User Persistence
|
|
16618
|
+
* @param {string} userId Must be a valid user ID.
|
|
16619
|
+
* @param {string} worldId Must be a valid world ID.
|
|
16620
|
+
* @param {*} [options] Override http request option.
|
|
16621
|
+
* @throws {RequiredError}
|
|
16622
|
+
*/
|
|
16623
|
+
deleteUserPersistence(userId: string, worldId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
14928
16624
|
/**
|
|
14929
16625
|
* Get public user information about a specific user using their ID.
|
|
14930
16626
|
* @summary Get User by ID
|
|
@@ -15003,6 +16699,15 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
15003
16699
|
* @throws {RequiredError}
|
|
15004
16700
|
*/
|
|
15005
16701
|
getUserRepresentedGroup(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RepresentedGroup>>;
|
|
16702
|
+
/**
|
|
16703
|
+
* Removes tags from the user\'s profile
|
|
16704
|
+
* @summary Remove User Tags
|
|
16705
|
+
* @param {string} userId Must be a valid user ID.
|
|
16706
|
+
* @param {ChangeUserTagsRequest} changeUserTagsRequest
|
|
16707
|
+
* @param {*} [options] Override http request option.
|
|
16708
|
+
* @throws {RequiredError}
|
|
16709
|
+
*/
|
|
16710
|
+
removeTags(userId: string, changeUserTagsRequest: ChangeUserTagsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>>;
|
|
15006
16711
|
/**
|
|
15007
16712
|
* Search and list any users by text query
|
|
15008
16713
|
* @summary Search All Users
|
|
@@ -15014,6 +16719,16 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
15014
16719
|
* @throws {RequiredError}
|
|
15015
16720
|
*/
|
|
15016
16721
|
searchUsers(search?: string, developerType?: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<LimitedUser>>>;
|
|
16722
|
+
/**
|
|
16723
|
+
* Updates a user\'s badge
|
|
16724
|
+
* @summary Update User Badge
|
|
16725
|
+
* @param {string} userId Must be a valid user ID.
|
|
16726
|
+
* @param {string} badgeId Must be a valid badge ID.
|
|
16727
|
+
* @param {UpdateUserBadgeRequest} updateUserBadgeRequest
|
|
16728
|
+
* @param {*} [options] Override http request option.
|
|
16729
|
+
* @throws {RequiredError}
|
|
16730
|
+
*/
|
|
16731
|
+
updateBadge(userId: string, badgeId: string, updateUserBadgeRequest: UpdateUserBadgeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
15017
16732
|
/**
|
|
15018
16733
|
* Update a users information such as the email and birthday.
|
|
15019
16734
|
* @summary Update User Info
|
|
@@ -15037,6 +16752,33 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
15037
16752
|
* @export
|
|
15038
16753
|
*/
|
|
15039
16754
|
export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
16755
|
+
/**
|
|
16756
|
+
* Adds tags to the user\'s profile
|
|
16757
|
+
* @summary Add User Tags
|
|
16758
|
+
* @param {string} userId Must be a valid user ID.
|
|
16759
|
+
* @param {ChangeUserTagsRequest} changeUserTagsRequest
|
|
16760
|
+
* @param {*} [options] Override http request option.
|
|
16761
|
+
* @throws {RequiredError}
|
|
16762
|
+
*/
|
|
16763
|
+
addTags(userId: string, changeUserTagsRequest: ChangeUserTagsRequest, options?: any): AxiosPromise<CurrentUser>;
|
|
16764
|
+
/**
|
|
16765
|
+
* Checks whether the user has persistence data for a given world
|
|
16766
|
+
* @summary Check User Persistence Exists
|
|
16767
|
+
* @param {string} userId Must be a valid user ID.
|
|
16768
|
+
* @param {string} worldId Must be a valid world ID.
|
|
16769
|
+
* @param {*} [options] Override http request option.
|
|
16770
|
+
* @throws {RequiredError}
|
|
16771
|
+
*/
|
|
16772
|
+
checkUserPersistenceExists(userId: string, worldId: string, options?: any): AxiosPromise<void>;
|
|
16773
|
+
/**
|
|
16774
|
+
* Deletes the user\'s persistence data for a given world
|
|
16775
|
+
* @summary Delete User Persistence
|
|
16776
|
+
* @param {string} userId Must be a valid user ID.
|
|
16777
|
+
* @param {string} worldId Must be a valid world ID.
|
|
16778
|
+
* @param {*} [options] Override http request option.
|
|
16779
|
+
* @throws {RequiredError}
|
|
16780
|
+
*/
|
|
16781
|
+
deleteUserPersistence(userId: string, worldId: string, options?: any): AxiosPromise<void>;
|
|
15040
16782
|
/**
|
|
15041
16783
|
* Get public user information about a specific user using their ID.
|
|
15042
16784
|
* @summary Get User by ID
|
|
@@ -15115,6 +16857,15 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
15115
16857
|
* @throws {RequiredError}
|
|
15116
16858
|
*/
|
|
15117
16859
|
getUserRepresentedGroup(userId: string, options?: any): AxiosPromise<RepresentedGroup>;
|
|
16860
|
+
/**
|
|
16861
|
+
* Removes tags from the user\'s profile
|
|
16862
|
+
* @summary Remove User Tags
|
|
16863
|
+
* @param {string} userId Must be a valid user ID.
|
|
16864
|
+
* @param {ChangeUserTagsRequest} changeUserTagsRequest
|
|
16865
|
+
* @param {*} [options] Override http request option.
|
|
16866
|
+
* @throws {RequiredError}
|
|
16867
|
+
*/
|
|
16868
|
+
removeTags(userId: string, changeUserTagsRequest: ChangeUserTagsRequest, options?: any): AxiosPromise<CurrentUser>;
|
|
15118
16869
|
/**
|
|
15119
16870
|
* Search and list any users by text query
|
|
15120
16871
|
* @summary Search All Users
|
|
@@ -15126,6 +16877,16 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
15126
16877
|
* @throws {RequiredError}
|
|
15127
16878
|
*/
|
|
15128
16879
|
searchUsers(search?: string, developerType?: string, n?: number, offset?: number, options?: any): AxiosPromise<Array<LimitedUser>>;
|
|
16880
|
+
/**
|
|
16881
|
+
* Updates a user\'s badge
|
|
16882
|
+
* @summary Update User Badge
|
|
16883
|
+
* @param {string} userId Must be a valid user ID.
|
|
16884
|
+
* @param {string} badgeId Must be a valid badge ID.
|
|
16885
|
+
* @param {UpdateUserBadgeRequest} updateUserBadgeRequest
|
|
16886
|
+
* @param {*} [options] Override http request option.
|
|
16887
|
+
* @throws {RequiredError}
|
|
16888
|
+
*/
|
|
16889
|
+
updateBadge(userId: string, badgeId: string, updateUserBadgeRequest: UpdateUserBadgeRequest, options?: any): AxiosPromise<void>;
|
|
15129
16890
|
/**
|
|
15130
16891
|
* Update a users information such as the email and birthday.
|
|
15131
16892
|
* @summary Update User Info
|
|
@@ -15151,6 +16912,36 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
15151
16912
|
* @extends {BaseAPI}
|
|
15152
16913
|
*/
|
|
15153
16914
|
export declare class UsersApi extends BaseAPI {
|
|
16915
|
+
/**
|
|
16916
|
+
* Adds tags to the user\'s profile
|
|
16917
|
+
* @summary Add User Tags
|
|
16918
|
+
* @param {string} userId Must be a valid user ID.
|
|
16919
|
+
* @param {ChangeUserTagsRequest} changeUserTagsRequest
|
|
16920
|
+
* @param {*} [options] Override http request option.
|
|
16921
|
+
* @throws {RequiredError}
|
|
16922
|
+
* @memberof UsersApi
|
|
16923
|
+
*/
|
|
16924
|
+
addTags(userId: string, changeUserTagsRequest: ChangeUserTagsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CurrentUser, any>>;
|
|
16925
|
+
/**
|
|
16926
|
+
* Checks whether the user has persistence data for a given world
|
|
16927
|
+
* @summary Check User Persistence Exists
|
|
16928
|
+
* @param {string} userId Must be a valid user ID.
|
|
16929
|
+
* @param {string} worldId Must be a valid world ID.
|
|
16930
|
+
* @param {*} [options] Override http request option.
|
|
16931
|
+
* @throws {RequiredError}
|
|
16932
|
+
* @memberof UsersApi
|
|
16933
|
+
*/
|
|
16934
|
+
checkUserPersistenceExists(userId: string, worldId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
16935
|
+
/**
|
|
16936
|
+
* Deletes the user\'s persistence data for a given world
|
|
16937
|
+
* @summary Delete User Persistence
|
|
16938
|
+
* @param {string} userId Must be a valid user ID.
|
|
16939
|
+
* @param {string} worldId Must be a valid world ID.
|
|
16940
|
+
* @param {*} [options] Override http request option.
|
|
16941
|
+
* @throws {RequiredError}
|
|
16942
|
+
* @memberof UsersApi
|
|
16943
|
+
*/
|
|
16944
|
+
deleteUserPersistence(userId: string, worldId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
15154
16945
|
/**
|
|
15155
16946
|
* Get public user information about a specific user using their ID.
|
|
15156
16947
|
* @summary Get User by ID
|
|
@@ -15238,6 +17029,16 @@ export declare class UsersApi extends BaseAPI {
|
|
|
15238
17029
|
* @memberof UsersApi
|
|
15239
17030
|
*/
|
|
15240
17031
|
getUserRepresentedGroup(userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RepresentedGroup, any>>;
|
|
17032
|
+
/**
|
|
17033
|
+
* Removes tags from the user\'s profile
|
|
17034
|
+
* @summary Remove User Tags
|
|
17035
|
+
* @param {string} userId Must be a valid user ID.
|
|
17036
|
+
* @param {ChangeUserTagsRequest} changeUserTagsRequest
|
|
17037
|
+
* @param {*} [options] Override http request option.
|
|
17038
|
+
* @throws {RequiredError}
|
|
17039
|
+
* @memberof UsersApi
|
|
17040
|
+
*/
|
|
17041
|
+
removeTags(userId: string, changeUserTagsRequest: ChangeUserTagsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CurrentUser, any>>;
|
|
15241
17042
|
/**
|
|
15242
17043
|
* Search and list any users by text query
|
|
15243
17044
|
* @summary Search All Users
|
|
@@ -15250,6 +17051,17 @@ export declare class UsersApi extends BaseAPI {
|
|
|
15250
17051
|
* @memberof UsersApi
|
|
15251
17052
|
*/
|
|
15252
17053
|
searchUsers(search?: string, developerType?: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LimitedUser[], any>>;
|
|
17054
|
+
/**
|
|
17055
|
+
* Updates a user\'s badge
|
|
17056
|
+
* @summary Update User Badge
|
|
17057
|
+
* @param {string} userId Must be a valid user ID.
|
|
17058
|
+
* @param {string} badgeId Must be a valid badge ID.
|
|
17059
|
+
* @param {UpdateUserBadgeRequest} updateUserBadgeRequest
|
|
17060
|
+
* @param {*} [options] Override http request option.
|
|
17061
|
+
* @throws {RequiredError}
|
|
17062
|
+
* @memberof UsersApi
|
|
17063
|
+
*/
|
|
17064
|
+
updateBadge(userId: string, badgeId: string, updateUserBadgeRequest: UpdateUserBadgeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
15253
17065
|
/**
|
|
15254
17066
|
* Update a users information such as the email and birthday.
|
|
15255
17067
|
* @summary Update User Info
|
|
@@ -15275,6 +17087,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
15275
17087
|
* @export
|
|
15276
17088
|
*/
|
|
15277
17089
|
export declare const WorldsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
17090
|
+
/**
|
|
17091
|
+
* Checks whether the user has persistence data for a given world
|
|
17092
|
+
* @summary Check User Persistence Exists
|
|
17093
|
+
* @param {string} userId Must be a valid user ID.
|
|
17094
|
+
* @param {string} worldId Must be a valid world ID.
|
|
17095
|
+
* @param {*} [options] Override http request option.
|
|
17096
|
+
* @throws {RequiredError}
|
|
17097
|
+
*/
|
|
17098
|
+
checkUserPersistenceExists: (userId: string, worldId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15278
17099
|
/**
|
|
15279
17100
|
* 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
17101
|
* @summary Create World
|
|
@@ -15283,6 +17104,15 @@ export declare const WorldsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15283
17104
|
* @throws {RequiredError}
|
|
15284
17105
|
*/
|
|
15285
17106
|
createWorld: (createWorldRequest?: CreateWorldRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
17107
|
+
/**
|
|
17108
|
+
* Deletes the user\'s persistence data for a given world
|
|
17109
|
+
* @summary Delete User Persistence
|
|
17110
|
+
* @param {string} userId Must be a valid user ID.
|
|
17111
|
+
* @param {string} worldId Must be a valid world ID.
|
|
17112
|
+
* @param {*} [options] Override http request option.
|
|
17113
|
+
* @throws {RequiredError}
|
|
17114
|
+
*/
|
|
17115
|
+
deleteUserPersistence: (userId: string, worldId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15286
17116
|
/**
|
|
15287
17117
|
* 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
17118
|
* @summary Delete World
|
|
@@ -15437,6 +17267,15 @@ export declare const WorldsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15437
17267
|
* @export
|
|
15438
17268
|
*/
|
|
15439
17269
|
export declare const WorldsApiFp: (configuration?: Configuration) => {
|
|
17270
|
+
/**
|
|
17271
|
+
* Checks whether the user has persistence data for a given world
|
|
17272
|
+
* @summary Check User Persistence Exists
|
|
17273
|
+
* @param {string} userId Must be a valid user ID.
|
|
17274
|
+
* @param {string} worldId Must be a valid world ID.
|
|
17275
|
+
* @param {*} [options] Override http request option.
|
|
17276
|
+
* @throws {RequiredError}
|
|
17277
|
+
*/
|
|
17278
|
+
checkUserPersistenceExists(userId: string, worldId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
15440
17279
|
/**
|
|
15441
17280
|
* 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
17281
|
* @summary Create World
|
|
@@ -15445,6 +17284,15 @@ export declare const WorldsApiFp: (configuration?: Configuration) => {
|
|
|
15445
17284
|
* @throws {RequiredError}
|
|
15446
17285
|
*/
|
|
15447
17286
|
createWorld(createWorldRequest?: CreateWorldRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<World>>;
|
|
17287
|
+
/**
|
|
17288
|
+
* Deletes the user\'s persistence data for a given world
|
|
17289
|
+
* @summary Delete User Persistence
|
|
17290
|
+
* @param {string} userId Must be a valid user ID.
|
|
17291
|
+
* @param {string} worldId Must be a valid world ID.
|
|
17292
|
+
* @param {*} [options] Override http request option.
|
|
17293
|
+
* @throws {RequiredError}
|
|
17294
|
+
*/
|
|
17295
|
+
deleteUserPersistence(userId: string, worldId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
15448
17296
|
/**
|
|
15449
17297
|
* 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
17298
|
* @summary Delete World
|
|
@@ -15599,6 +17447,15 @@ export declare const WorldsApiFp: (configuration?: Configuration) => {
|
|
|
15599
17447
|
* @export
|
|
15600
17448
|
*/
|
|
15601
17449
|
export declare const WorldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
17450
|
+
/**
|
|
17451
|
+
* Checks whether the user has persistence data for a given world
|
|
17452
|
+
* @summary Check User Persistence Exists
|
|
17453
|
+
* @param {string} userId Must be a valid user ID.
|
|
17454
|
+
* @param {string} worldId Must be a valid world ID.
|
|
17455
|
+
* @param {*} [options] Override http request option.
|
|
17456
|
+
* @throws {RequiredError}
|
|
17457
|
+
*/
|
|
17458
|
+
checkUserPersistenceExists(userId: string, worldId: string, options?: any): AxiosPromise<void>;
|
|
15602
17459
|
/**
|
|
15603
17460
|
* 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
17461
|
* @summary Create World
|
|
@@ -15607,6 +17464,15 @@ export declare const WorldsApiFactory: (configuration?: Configuration, basePath?
|
|
|
15607
17464
|
* @throws {RequiredError}
|
|
15608
17465
|
*/
|
|
15609
17466
|
createWorld(createWorldRequest?: CreateWorldRequest, options?: any): AxiosPromise<World>;
|
|
17467
|
+
/**
|
|
17468
|
+
* Deletes the user\'s persistence data for a given world
|
|
17469
|
+
* @summary Delete User Persistence
|
|
17470
|
+
* @param {string} userId Must be a valid user ID.
|
|
17471
|
+
* @param {string} worldId Must be a valid world ID.
|
|
17472
|
+
* @param {*} [options] Override http request option.
|
|
17473
|
+
* @throws {RequiredError}
|
|
17474
|
+
*/
|
|
17475
|
+
deleteUserPersistence(userId: string, worldId: string, options?: any): AxiosPromise<void>;
|
|
15610
17476
|
/**
|
|
15611
17477
|
* 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
17478
|
* @summary Delete World
|
|
@@ -15763,6 +17629,16 @@ export declare const WorldsApiFactory: (configuration?: Configuration, basePath?
|
|
|
15763
17629
|
* @extends {BaseAPI}
|
|
15764
17630
|
*/
|
|
15765
17631
|
export declare class WorldsApi extends BaseAPI {
|
|
17632
|
+
/**
|
|
17633
|
+
* Checks whether the user has persistence data for a given world
|
|
17634
|
+
* @summary Check User Persistence Exists
|
|
17635
|
+
* @param {string} userId Must be a valid user ID.
|
|
17636
|
+
* @param {string} worldId Must be a valid world ID.
|
|
17637
|
+
* @param {*} [options] Override http request option.
|
|
17638
|
+
* @throws {RequiredError}
|
|
17639
|
+
* @memberof WorldsApi
|
|
17640
|
+
*/
|
|
17641
|
+
checkUserPersistenceExists(userId: string, worldId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
15766
17642
|
/**
|
|
15767
17643
|
* 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
17644
|
* @summary Create World
|
|
@@ -15772,6 +17648,16 @@ export declare class WorldsApi extends BaseAPI {
|
|
|
15772
17648
|
* @memberof WorldsApi
|
|
15773
17649
|
*/
|
|
15774
17650
|
createWorld(createWorldRequest?: CreateWorldRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<World, any>>;
|
|
17651
|
+
/**
|
|
17652
|
+
* Deletes the user\'s persistence data for a given world
|
|
17653
|
+
* @summary Delete User Persistence
|
|
17654
|
+
* @param {string} userId Must be a valid user ID.
|
|
17655
|
+
* @param {string} worldId Must be a valid world ID.
|
|
17656
|
+
* @param {*} [options] Override http request option.
|
|
17657
|
+
* @throws {RequiredError}
|
|
17658
|
+
* @memberof WorldsApi
|
|
17659
|
+
*/
|
|
17660
|
+
deleteUserPersistence(userId: string, worldId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
15775
17661
|
/**
|
|
15776
17662
|
* 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
17663
|
* @summary Delete World
|