vrchat 1.5.1 → 1.6.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api.ts +1525 -367
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +1061 -149
- package/dist/api.js +611 -38
- 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.
|
|
4
|
+
* The version of the OpenAPI document: 1.6.3
|
|
5
5
|
* Contact: me@ruby.js.org
|
|
6
6
|
*
|
|
7
7
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -266,10 +266,10 @@ export interface APIConfig {
|
|
|
266
266
|
'downloadUrls': DownloadURLList;
|
|
267
267
|
/**
|
|
268
268
|
* Array of DynamicWorldRow objects, used by the game to display the list of world rows
|
|
269
|
-
* @type {Set<
|
|
269
|
+
* @type {Set<DynamicContentRow>}
|
|
270
270
|
* @memberof APIConfig
|
|
271
271
|
*/
|
|
272
|
-
'dynamicWorldRows': Set<
|
|
272
|
+
'dynamicWorldRows': Set<DynamicContentRow>;
|
|
273
273
|
/**
|
|
274
274
|
*
|
|
275
275
|
* @type {APIEventConfig}
|
|
@@ -284,7 +284,7 @@ export interface APIConfig {
|
|
|
284
284
|
*/
|
|
285
285
|
'gearDemoRoomId': string;
|
|
286
286
|
/**
|
|
287
|
-
*
|
|
287
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
288
288
|
* @type {string}
|
|
289
289
|
* @memberof APIConfig
|
|
290
290
|
*/
|
|
@@ -296,7 +296,7 @@ export interface APIConfig {
|
|
|
296
296
|
*/
|
|
297
297
|
'homepageRedirectTarget': string;
|
|
298
298
|
/**
|
|
299
|
-
*
|
|
299
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
300
300
|
* @type {string}
|
|
301
301
|
* @memberof APIConfig
|
|
302
302
|
*/
|
|
@@ -403,13 +403,13 @@ export interface APIConfig {
|
|
|
403
403
|
*/
|
|
404
404
|
'supportEmail': string;
|
|
405
405
|
/**
|
|
406
|
-
*
|
|
406
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
407
407
|
* @type {string}
|
|
408
408
|
* @memberof APIConfig
|
|
409
409
|
*/
|
|
410
410
|
'timeOutWorldId': string;
|
|
411
411
|
/**
|
|
412
|
-
*
|
|
412
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
413
413
|
* @type {string}
|
|
414
414
|
* @memberof APIConfig
|
|
415
415
|
*/
|
|
@@ -647,7 +647,7 @@ export interface Avatar {
|
|
|
647
647
|
*/
|
|
648
648
|
'assetUrlObject'?: object;
|
|
649
649
|
/**
|
|
650
|
-
*
|
|
650
|
+
* 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.
|
|
651
651
|
* @type {string}
|
|
652
652
|
* @memberof Avatar
|
|
653
653
|
*/
|
|
@@ -899,7 +899,7 @@ export interface CreateWorldRequest {
|
|
|
899
899
|
*/
|
|
900
900
|
'assetVersion'?: number;
|
|
901
901
|
/**
|
|
902
|
-
*
|
|
902
|
+
* 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.
|
|
903
903
|
* @type {string}
|
|
904
904
|
* @memberof CreateWorldRequest
|
|
905
905
|
*/
|
|
@@ -923,7 +923,7 @@ export interface CreateWorldRequest {
|
|
|
923
923
|
*/
|
|
924
924
|
'description'?: string;
|
|
925
925
|
/**
|
|
926
|
-
*
|
|
926
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
927
927
|
* @type {string}
|
|
928
928
|
* @memberof CreateWorldRequest
|
|
929
929
|
*/
|
|
@@ -1026,13 +1026,13 @@ export interface CurrentUser {
|
|
|
1026
1026
|
*/
|
|
1027
1027
|
'currentAvatarAssetUrl': string;
|
|
1028
1028
|
/**
|
|
1029
|
-
*
|
|
1029
|
+
* When profilePicOverride is not empty, use it instead.
|
|
1030
1030
|
* @type {string}
|
|
1031
1031
|
* @memberof CurrentUser
|
|
1032
1032
|
*/
|
|
1033
1033
|
'currentAvatarImageUrl': string;
|
|
1034
1034
|
/**
|
|
1035
|
-
*
|
|
1035
|
+
* When profilePicOverride is not empty, use it instead.
|
|
1036
1036
|
* @type {string}
|
|
1037
1037
|
* @memberof CurrentUser
|
|
1038
1038
|
*/
|
|
@@ -1111,13 +1111,13 @@ export interface CurrentUser {
|
|
|
1111
1111
|
*/
|
|
1112
1112
|
'hasPendingEmail': boolean;
|
|
1113
1113
|
/**
|
|
1114
|
-
*
|
|
1114
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
1115
1115
|
* @type {string}
|
|
1116
1116
|
* @memberof CurrentUser
|
|
1117
1117
|
*/
|
|
1118
1118
|
'homeLocation': string;
|
|
1119
1119
|
/**
|
|
1120
|
-
*
|
|
1120
|
+
* 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.
|
|
1121
1121
|
* @type {string}
|
|
1122
1122
|
* @memberof CurrentUser
|
|
1123
1123
|
*/
|
|
@@ -1306,51 +1306,57 @@ export interface DownloadURLList {
|
|
|
1306
1306
|
/**
|
|
1307
1307
|
*
|
|
1308
1308
|
* @export
|
|
1309
|
-
* @interface
|
|
1309
|
+
* @interface DynamicContentRow
|
|
1310
1310
|
*/
|
|
1311
|
-
export interface
|
|
1311
|
+
export interface DynamicContentRow {
|
|
1312
1312
|
/**
|
|
1313
1313
|
*
|
|
1314
1314
|
* @type {number}
|
|
1315
|
-
* @memberof
|
|
1315
|
+
* @memberof DynamicContentRow
|
|
1316
1316
|
*/
|
|
1317
|
-
'index'
|
|
1317
|
+
'index'?: number;
|
|
1318
1318
|
/**
|
|
1319
1319
|
*
|
|
1320
1320
|
* @type {string}
|
|
1321
|
-
* @memberof
|
|
1321
|
+
* @memberof DynamicContentRow
|
|
1322
1322
|
*/
|
|
1323
1323
|
'name': string;
|
|
1324
1324
|
/**
|
|
1325
|
-
*
|
|
1325
|
+
* Usually \"ThisPlatformSupported\", but can also be other values such as \"all\" or platform specific identifiers.
|
|
1326
1326
|
* @type {string}
|
|
1327
|
-
* @memberof
|
|
1327
|
+
* @memberof DynamicContentRow
|
|
1328
1328
|
*/
|
|
1329
1329
|
'platform': string;
|
|
1330
1330
|
/**
|
|
1331
1331
|
*
|
|
1332
1332
|
* @type {string}
|
|
1333
|
-
* @memberof
|
|
1333
|
+
* @memberof DynamicContentRow
|
|
1334
1334
|
*/
|
|
1335
1335
|
'sortHeading': string;
|
|
1336
1336
|
/**
|
|
1337
1337
|
*
|
|
1338
1338
|
* @type {string}
|
|
1339
|
-
* @memberof
|
|
1339
|
+
* @memberof DynamicContentRow
|
|
1340
1340
|
*/
|
|
1341
1341
|
'sortOrder': string;
|
|
1342
1342
|
/**
|
|
1343
1343
|
*
|
|
1344
1344
|
* @type {string}
|
|
1345
|
-
* @memberof
|
|
1345
|
+
* @memberof DynamicContentRow
|
|
1346
1346
|
*/
|
|
1347
1347
|
'sortOwnership': string;
|
|
1348
1348
|
/**
|
|
1349
|
-
* Tag to filter
|
|
1349
|
+
* Tag to filter content for this row.
|
|
1350
1350
|
* @type {string}
|
|
1351
|
-
* @memberof
|
|
1351
|
+
* @memberof DynamicContentRow
|
|
1352
1352
|
*/
|
|
1353
1353
|
'tag'?: string;
|
|
1354
|
+
/**
|
|
1355
|
+
* Type is not present if it is a world.
|
|
1356
|
+
* @type {string}
|
|
1357
|
+
* @memberof DynamicContentRow
|
|
1358
|
+
*/
|
|
1359
|
+
'type'?: string;
|
|
1354
1360
|
}
|
|
1355
1361
|
/**
|
|
1356
1362
|
*
|
|
@@ -1414,7 +1420,7 @@ export interface FavoriteGroup {
|
|
|
1414
1420
|
*/
|
|
1415
1421
|
'ownerDisplayName': string;
|
|
1416
1422
|
/**
|
|
1417
|
-
*
|
|
1423
|
+
* 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.
|
|
1418
1424
|
* @type {string}
|
|
1419
1425
|
* @memberof FavoriteGroup
|
|
1420
1426
|
*/
|
|
@@ -1686,19 +1692,201 @@ export interface FriendStatus {
|
|
|
1686
1692
|
/**
|
|
1687
1693
|
*
|
|
1688
1694
|
* @export
|
|
1689
|
-
* @interface
|
|
1695
|
+
* @interface InfoPush
|
|
1696
|
+
*/
|
|
1697
|
+
export interface InfoPush {
|
|
1698
|
+
/**
|
|
1699
|
+
*
|
|
1700
|
+
* @type {string}
|
|
1701
|
+
* @memberof InfoPush
|
|
1702
|
+
*/
|
|
1703
|
+
'id': string;
|
|
1704
|
+
/**
|
|
1705
|
+
*
|
|
1706
|
+
* @type {boolean}
|
|
1707
|
+
* @memberof InfoPush
|
|
1708
|
+
*/
|
|
1709
|
+
'isEnabled': boolean;
|
|
1710
|
+
/**
|
|
1711
|
+
*
|
|
1712
|
+
* @type {ReleaseStatus}
|
|
1713
|
+
* @memberof InfoPush
|
|
1714
|
+
*/
|
|
1715
|
+
'releaseStatus': ReleaseStatus;
|
|
1716
|
+
/**
|
|
1717
|
+
*
|
|
1718
|
+
* @type {number}
|
|
1719
|
+
* @memberof InfoPush
|
|
1720
|
+
*/
|
|
1721
|
+
'priority': number;
|
|
1722
|
+
/**
|
|
1723
|
+
*
|
|
1724
|
+
* @type {Array<string>}
|
|
1725
|
+
* @memberof InfoPush
|
|
1726
|
+
*/
|
|
1727
|
+
'tags': Array<string>;
|
|
1728
|
+
/**
|
|
1729
|
+
*
|
|
1730
|
+
* @type {InfoPushData}
|
|
1731
|
+
* @memberof InfoPush
|
|
1732
|
+
*/
|
|
1733
|
+
'data': InfoPushData;
|
|
1734
|
+
/**
|
|
1735
|
+
* Unknown usage, MD5
|
|
1736
|
+
* @type {string}
|
|
1737
|
+
* @memberof InfoPush
|
|
1738
|
+
*/
|
|
1739
|
+
'hash': string;
|
|
1740
|
+
/**
|
|
1741
|
+
*
|
|
1742
|
+
* @type {string}
|
|
1743
|
+
* @memberof InfoPush
|
|
1744
|
+
*/
|
|
1745
|
+
'createdAt': string;
|
|
1746
|
+
/**
|
|
1747
|
+
*
|
|
1748
|
+
* @type {string}
|
|
1749
|
+
* @memberof InfoPush
|
|
1750
|
+
*/
|
|
1751
|
+
'updatedAt': string;
|
|
1752
|
+
/**
|
|
1753
|
+
*
|
|
1754
|
+
* @type {string}
|
|
1755
|
+
* @memberof InfoPush
|
|
1756
|
+
*/
|
|
1757
|
+
'startDate'?: string;
|
|
1758
|
+
/**
|
|
1759
|
+
*
|
|
1760
|
+
* @type {string}
|
|
1761
|
+
* @memberof InfoPush
|
|
1762
|
+
*/
|
|
1763
|
+
'endDate'?: string;
|
|
1764
|
+
}
|
|
1765
|
+
/**
|
|
1766
|
+
*
|
|
1767
|
+
* @export
|
|
1768
|
+
* @interface InfoPushData
|
|
1769
|
+
*/
|
|
1770
|
+
export interface InfoPushData {
|
|
1771
|
+
/**
|
|
1772
|
+
*
|
|
1773
|
+
* @type {DynamicContentRow}
|
|
1774
|
+
* @memberof InfoPushData
|
|
1775
|
+
*/
|
|
1776
|
+
'contentList'?: DynamicContentRow;
|
|
1777
|
+
/**
|
|
1778
|
+
*
|
|
1779
|
+
* @type {string}
|
|
1780
|
+
* @memberof InfoPushData
|
|
1781
|
+
*/
|
|
1782
|
+
'description'?: string;
|
|
1783
|
+
/**
|
|
1784
|
+
*
|
|
1785
|
+
* @type {string}
|
|
1786
|
+
* @memberof InfoPushData
|
|
1787
|
+
*/
|
|
1788
|
+
'imageUrl'?: string;
|
|
1789
|
+
/**
|
|
1790
|
+
*
|
|
1791
|
+
* @type {string}
|
|
1792
|
+
* @memberof InfoPushData
|
|
1793
|
+
*/
|
|
1794
|
+
'name'?: string;
|
|
1795
|
+
/**
|
|
1796
|
+
*
|
|
1797
|
+
* @type {InfoPushDataClickable}
|
|
1798
|
+
* @memberof InfoPushData
|
|
1799
|
+
*/
|
|
1800
|
+
'onPressed'?: InfoPushDataClickable;
|
|
1801
|
+
/**
|
|
1802
|
+
*
|
|
1803
|
+
* @type {string}
|
|
1804
|
+
* @memberof InfoPushData
|
|
1805
|
+
*/
|
|
1806
|
+
'template'?: string;
|
|
1807
|
+
/**
|
|
1808
|
+
*
|
|
1809
|
+
* @type {string}
|
|
1810
|
+
* @memberof InfoPushData
|
|
1811
|
+
*/
|
|
1812
|
+
'version'?: string;
|
|
1813
|
+
/**
|
|
1814
|
+
*
|
|
1815
|
+
* @type {InfoPushDataArticle}
|
|
1816
|
+
* @memberof InfoPushData
|
|
1817
|
+
*/
|
|
1818
|
+
'article'?: InfoPushDataArticle;
|
|
1819
|
+
}
|
|
1820
|
+
/**
|
|
1821
|
+
*
|
|
1822
|
+
* @export
|
|
1823
|
+
* @interface InfoPushDataArticle
|
|
1824
|
+
*/
|
|
1825
|
+
export interface InfoPushDataArticle {
|
|
1826
|
+
/**
|
|
1827
|
+
*
|
|
1828
|
+
* @type {InfoPushDataArticleContent}
|
|
1829
|
+
* @memberof InfoPushDataArticle
|
|
1830
|
+
*/
|
|
1831
|
+
'content'?: InfoPushDataArticleContent;
|
|
1832
|
+
}
|
|
1833
|
+
/**
|
|
1834
|
+
*
|
|
1835
|
+
* @export
|
|
1836
|
+
* @interface InfoPushDataArticleContent
|
|
1690
1837
|
*/
|
|
1691
|
-
export interface
|
|
1838
|
+
export interface InfoPushDataArticleContent {
|
|
1839
|
+
/**
|
|
1840
|
+
*
|
|
1841
|
+
* @type {string}
|
|
1842
|
+
* @memberof InfoPushDataArticleContent
|
|
1843
|
+
*/
|
|
1844
|
+
'text'?: string;
|
|
1692
1845
|
/**
|
|
1693
1846
|
*
|
|
1694
|
-
* @type {
|
|
1695
|
-
* @memberof
|
|
1847
|
+
* @type {string}
|
|
1848
|
+
* @memberof InfoPushDataArticleContent
|
|
1696
1849
|
*/
|
|
1697
|
-
'
|
|
1850
|
+
'imageUrl'?: string;
|
|
1851
|
+
/**
|
|
1852
|
+
*
|
|
1853
|
+
* @type {InfoPushDataClickable}
|
|
1854
|
+
* @memberof InfoPushDataArticleContent
|
|
1855
|
+
*/
|
|
1856
|
+
'onPressed'?: InfoPushDataClickable;
|
|
1698
1857
|
}
|
|
1699
1858
|
/**
|
|
1700
1859
|
*
|
|
1701
1860
|
* @export
|
|
1861
|
+
* @interface InfoPushDataClickable
|
|
1862
|
+
*/
|
|
1863
|
+
export interface InfoPushDataClickable {
|
|
1864
|
+
/**
|
|
1865
|
+
*
|
|
1866
|
+
* @type {string}
|
|
1867
|
+
* @memberof InfoPushDataClickable
|
|
1868
|
+
*/
|
|
1869
|
+
'command': InfoPushDataClickableCommandEnum;
|
|
1870
|
+
/**
|
|
1871
|
+
* In case of OpenURL, this would contain the link.
|
|
1872
|
+
* @type {Array<string>}
|
|
1873
|
+
* @memberof InfoPushDataClickable
|
|
1874
|
+
*/
|
|
1875
|
+
'parameters'?: Array<string>;
|
|
1876
|
+
}
|
|
1877
|
+
/**
|
|
1878
|
+
* @export
|
|
1879
|
+
* @enum {string}
|
|
1880
|
+
*/
|
|
1881
|
+
export declare enum InfoPushDataClickableCommandEnum {
|
|
1882
|
+
OpenUrl = "OpenURL",
|
|
1883
|
+
OpenVrcPlusMenu = "OpenVRCPlusMenu",
|
|
1884
|
+
OpenSafetyMenu = "OpenSafetyMenu",
|
|
1885
|
+
CannedWorldSearch = "CannedWorldSearch"
|
|
1886
|
+
}
|
|
1887
|
+
/**
|
|
1888
|
+
* * `hidden` field is only present if InstanceType is `hidden` aka \"Friends+\", and is instance creator. * `friends` field is only present if InstanceType is `friends` aka \"Friends\", and is instance creator. * `private` field is only present if InstanceType is `private` aka \"Invite\" or \"Invite+\", and is instance creator.
|
|
1889
|
+
* @export
|
|
1702
1890
|
* @interface Instance
|
|
1703
1891
|
*/
|
|
1704
1892
|
export interface Instance {
|
|
@@ -1721,9 +1909,10 @@ export interface Instance {
|
|
|
1721
1909
|
*/
|
|
1722
1910
|
'capacity': number;
|
|
1723
1911
|
/**
|
|
1724
|
-
*
|
|
1912
|
+
* Always returns \"unknown\".
|
|
1725
1913
|
* @type {string}
|
|
1726
1914
|
* @memberof Instance
|
|
1915
|
+
* @deprecated
|
|
1727
1916
|
*/
|
|
1728
1917
|
'clientNumber': string;
|
|
1729
1918
|
/**
|
|
@@ -1733,7 +1922,7 @@ export interface Instance {
|
|
|
1733
1922
|
*/
|
|
1734
1923
|
'full': boolean;
|
|
1735
1924
|
/**
|
|
1736
|
-
*
|
|
1925
|
+
* InstanceID be \"offline\" on User profiles if you are not friends with that user.
|
|
1737
1926
|
* @type {string}
|
|
1738
1927
|
* @memberof Instance
|
|
1739
1928
|
*/
|
|
@@ -1745,7 +1934,7 @@ export interface Instance {
|
|
|
1745
1934
|
*/
|
|
1746
1935
|
'instanceId': string;
|
|
1747
1936
|
/**
|
|
1748
|
-
*
|
|
1937
|
+
* InstanceID be \"offline\" on User profiles if you are not friends with that user.
|
|
1749
1938
|
* @type {string}
|
|
1750
1939
|
* @memberof Instance
|
|
1751
1940
|
*/
|
|
@@ -1763,13 +1952,7 @@ export interface Instance {
|
|
|
1763
1952
|
*/
|
|
1764
1953
|
'name': string;
|
|
1765
1954
|
/**
|
|
1766
|
-
*
|
|
1767
|
-
* @type {string}
|
|
1768
|
-
* @memberof Instance
|
|
1769
|
-
*/
|
|
1770
|
-
'nonce'?: string;
|
|
1771
|
-
/**
|
|
1772
|
-
*
|
|
1955
|
+
* 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.
|
|
1773
1956
|
* @type {string}
|
|
1774
1957
|
* @memberof Instance
|
|
1775
1958
|
*/
|
|
@@ -1782,10 +1965,10 @@ export interface Instance {
|
|
|
1782
1965
|
'permanent': boolean;
|
|
1783
1966
|
/**
|
|
1784
1967
|
*
|
|
1785
|
-
* @type {
|
|
1968
|
+
* @type {Region}
|
|
1786
1969
|
* @memberof Instance
|
|
1787
1970
|
*/
|
|
1788
|
-
'photonRegion':
|
|
1971
|
+
'photonRegion': Region;
|
|
1789
1972
|
/**
|
|
1790
1973
|
*
|
|
1791
1974
|
* @type {InstancePlatforms}
|
|
@@ -1794,10 +1977,10 @@ export interface Instance {
|
|
|
1794
1977
|
'platforms': InstancePlatforms;
|
|
1795
1978
|
/**
|
|
1796
1979
|
*
|
|
1797
|
-
* @type {
|
|
1980
|
+
* @type {Region}
|
|
1798
1981
|
* @memberof Instance
|
|
1799
1982
|
*/
|
|
1800
|
-
'region':
|
|
1983
|
+
'region': Region;
|
|
1801
1984
|
/**
|
|
1802
1985
|
*
|
|
1803
1986
|
* @type {string}
|
|
@@ -1805,37 +1988,41 @@ export interface Instance {
|
|
|
1805
1988
|
*/
|
|
1806
1989
|
'shortName': string;
|
|
1807
1990
|
/**
|
|
1808
|
-
*
|
|
1991
|
+
* The tags array on Instances usually contain the language tags of the people in the instance.
|
|
1809
1992
|
* @type {Array<string>}
|
|
1810
1993
|
* @memberof Instance
|
|
1811
1994
|
*/
|
|
1812
1995
|
'tags': Array<string>;
|
|
1813
1996
|
/**
|
|
1814
1997
|
*
|
|
1998
|
+
* @type {InstanceType}
|
|
1999
|
+
* @memberof Instance
|
|
2000
|
+
*/
|
|
2001
|
+
'type': InstanceType;
|
|
2002
|
+
/**
|
|
2003
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
1815
2004
|
* @type {string}
|
|
1816
2005
|
* @memberof Instance
|
|
1817
2006
|
*/
|
|
1818
|
-
'
|
|
2007
|
+
'worldId': string;
|
|
1819
2008
|
/**
|
|
1820
|
-
*
|
|
1821
|
-
* @type {
|
|
2009
|
+
* 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.
|
|
2010
|
+
* @type {string}
|
|
1822
2011
|
* @memberof Instance
|
|
1823
|
-
* @deprecated
|
|
1824
2012
|
*/
|
|
1825
|
-
'
|
|
2013
|
+
'hidden'?: string;
|
|
1826
2014
|
/**
|
|
1827
|
-
*
|
|
1828
|
-
* @type {
|
|
2015
|
+
* 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.
|
|
2016
|
+
* @type {string}
|
|
1829
2017
|
* @memberof Instance
|
|
1830
|
-
* @deprecated
|
|
1831
2018
|
*/
|
|
1832
|
-
'
|
|
2019
|
+
'friends'?: string;
|
|
1833
2020
|
/**
|
|
1834
|
-
*
|
|
2021
|
+
* 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.
|
|
1835
2022
|
* @type {string}
|
|
1836
2023
|
* @memberof Instance
|
|
1837
2024
|
*/
|
|
1838
|
-
'
|
|
2025
|
+
'private'?: string;
|
|
1839
2026
|
}
|
|
1840
2027
|
/**
|
|
1841
2028
|
*
|
|
@@ -1856,6 +2043,17 @@ export interface InstancePlatforms {
|
|
|
1856
2043
|
*/
|
|
1857
2044
|
'standalonewindows': number;
|
|
1858
2045
|
}
|
|
2046
|
+
/**
|
|
2047
|
+
*
|
|
2048
|
+
* @export
|
|
2049
|
+
* @enum {string}
|
|
2050
|
+
*/
|
|
2051
|
+
export declare enum InstanceType {
|
|
2052
|
+
Public = "public",
|
|
2053
|
+
Hidden = "hidden",
|
|
2054
|
+
Friends = "friends",
|
|
2055
|
+
Private = "private"
|
|
2056
|
+
}
|
|
1859
2057
|
/**
|
|
1860
2058
|
*
|
|
1861
2059
|
* @export
|
|
@@ -1923,7 +2121,7 @@ export declare enum InviteMessageType {
|
|
|
1923
2121
|
*/
|
|
1924
2122
|
export interface InviteRequest {
|
|
1925
2123
|
/**
|
|
1926
|
-
*
|
|
2124
|
+
* InstanceID be \"offline\" on User profiles if you are not friends with that user.
|
|
1927
2125
|
* @type {string}
|
|
1928
2126
|
* @memberof InviteRequest
|
|
1929
2127
|
*/
|
|
@@ -1942,6 +2140,88 @@ export interface InviteResponse {
|
|
|
1942
2140
|
*/
|
|
1943
2141
|
'responseSlot': number;
|
|
1944
2142
|
}
|
|
2143
|
+
/**
|
|
2144
|
+
*
|
|
2145
|
+
* @export
|
|
2146
|
+
* @interface License
|
|
2147
|
+
*/
|
|
2148
|
+
export interface License {
|
|
2149
|
+
/**
|
|
2150
|
+
* Either a AvatarID, LicenseGroupID, PermissionID or ProductID. This depends on the `forType` field.
|
|
2151
|
+
* @type {string}
|
|
2152
|
+
* @memberof License
|
|
2153
|
+
*/
|
|
2154
|
+
'forId': string;
|
|
2155
|
+
/**
|
|
2156
|
+
*
|
|
2157
|
+
* @type {LicenseType}
|
|
2158
|
+
* @memberof License
|
|
2159
|
+
*/
|
|
2160
|
+
'forType': LicenseType;
|
|
2161
|
+
/**
|
|
2162
|
+
*
|
|
2163
|
+
* @type {string}
|
|
2164
|
+
* @memberof License
|
|
2165
|
+
*/
|
|
2166
|
+
'forName': string;
|
|
2167
|
+
/**
|
|
2168
|
+
*
|
|
2169
|
+
* @type {LicenseAction}
|
|
2170
|
+
* @memberof License
|
|
2171
|
+
*/
|
|
2172
|
+
'forAction': LicenseAction;
|
|
2173
|
+
}
|
|
2174
|
+
/**
|
|
2175
|
+
*
|
|
2176
|
+
* @export
|
|
2177
|
+
* @enum {string}
|
|
2178
|
+
*/
|
|
2179
|
+
export declare enum LicenseAction {
|
|
2180
|
+
Wear = "wear",
|
|
2181
|
+
Have = "have"
|
|
2182
|
+
}
|
|
2183
|
+
/**
|
|
2184
|
+
*
|
|
2185
|
+
* @export
|
|
2186
|
+
* @interface LicenseGroup
|
|
2187
|
+
*/
|
|
2188
|
+
export interface LicenseGroup {
|
|
2189
|
+
/**
|
|
2190
|
+
*
|
|
2191
|
+
* @type {string}
|
|
2192
|
+
* @memberof LicenseGroup
|
|
2193
|
+
*/
|
|
2194
|
+
'id': string;
|
|
2195
|
+
/**
|
|
2196
|
+
*
|
|
2197
|
+
* @type {string}
|
|
2198
|
+
* @memberof LicenseGroup
|
|
2199
|
+
*/
|
|
2200
|
+
'name': string;
|
|
2201
|
+
/**
|
|
2202
|
+
*
|
|
2203
|
+
* @type {string}
|
|
2204
|
+
* @memberof LicenseGroup
|
|
2205
|
+
*/
|
|
2206
|
+
'description': string;
|
|
2207
|
+
/**
|
|
2208
|
+
*
|
|
2209
|
+
* @type {Array<License>}
|
|
2210
|
+
* @memberof LicenseGroup
|
|
2211
|
+
*/
|
|
2212
|
+
'licenses': Array<License>;
|
|
2213
|
+
}
|
|
2214
|
+
/**
|
|
2215
|
+
*
|
|
2216
|
+
* @export
|
|
2217
|
+
* @enum {string}
|
|
2218
|
+
*/
|
|
2219
|
+
export declare enum LicenseType {
|
|
2220
|
+
Avatar = "avatar",
|
|
2221
|
+
LicenseGroup = "licenseGroup",
|
|
2222
|
+
Permission = "permission",
|
|
2223
|
+
Product = "product"
|
|
2224
|
+
}
|
|
1945
2225
|
/**
|
|
1946
2226
|
*
|
|
1947
2227
|
* @export
|
|
@@ -1974,13 +2254,13 @@ export interface LimitedUser {
|
|
|
1974
2254
|
*/
|
|
1975
2255
|
'bio'?: string;
|
|
1976
2256
|
/**
|
|
1977
|
-
*
|
|
2257
|
+
* When profilePicOverride is not empty, use it instead.
|
|
1978
2258
|
* @type {string}
|
|
1979
2259
|
* @memberof LimitedUser
|
|
1980
2260
|
*/
|
|
1981
2261
|
'currentAvatarImageUrl': string;
|
|
1982
2262
|
/**
|
|
1983
|
-
*
|
|
2263
|
+
* When profilePicOverride is not empty, use it instead.
|
|
1984
2264
|
* @type {string}
|
|
1985
2265
|
* @memberof LimitedUser
|
|
1986
2266
|
*/
|
|
@@ -2004,7 +2284,7 @@ export interface LimitedUser {
|
|
|
2004
2284
|
*/
|
|
2005
2285
|
'fallbackAvatar': string;
|
|
2006
2286
|
/**
|
|
2007
|
-
*
|
|
2287
|
+
* 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.
|
|
2008
2288
|
* @type {string}
|
|
2009
2289
|
* @memberof LimitedUser
|
|
2010
2290
|
*/
|
|
@@ -2077,7 +2357,7 @@ export interface LimitedUser {
|
|
|
2077
2357
|
*/
|
|
2078
2358
|
export interface LimitedWorld {
|
|
2079
2359
|
/**
|
|
2080
|
-
*
|
|
2360
|
+
* 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.
|
|
2081
2361
|
* @type {string}
|
|
2082
2362
|
* @memberof LimitedWorld
|
|
2083
2363
|
*/
|
|
@@ -2113,7 +2393,7 @@ export interface LimitedWorld {
|
|
|
2113
2393
|
*/
|
|
2114
2394
|
'heat': number;
|
|
2115
2395
|
/**
|
|
2116
|
-
*
|
|
2396
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
2117
2397
|
* @type {string}
|
|
2118
2398
|
* @memberof LimitedWorld
|
|
2119
2399
|
*/
|
|
@@ -2256,7 +2536,7 @@ export interface ModelFile {
|
|
|
2256
2536
|
*/
|
|
2257
2537
|
'name': string;
|
|
2258
2538
|
/**
|
|
2259
|
-
*
|
|
2539
|
+
* 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.
|
|
2260
2540
|
* @type {string}
|
|
2261
2541
|
* @memberof ModelFile
|
|
2262
2542
|
*/
|
|
@@ -2281,7 +2561,7 @@ export interface ModelFile {
|
|
|
2281
2561
|
*/
|
|
2282
2562
|
export interface ModerateUserRequest {
|
|
2283
2563
|
/**
|
|
2284
|
-
*
|
|
2564
|
+
* 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.
|
|
2285
2565
|
* @type {string}
|
|
2286
2566
|
* @memberof ModerateUserRequest
|
|
2287
2567
|
*/
|
|
@@ -2330,7 +2610,7 @@ export interface Notification {
|
|
|
2330
2610
|
*/
|
|
2331
2611
|
'seen': boolean;
|
|
2332
2612
|
/**
|
|
2333
|
-
*
|
|
2613
|
+
* 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.
|
|
2334
2614
|
* @type {string}
|
|
2335
2615
|
* @memberof Notification
|
|
2336
2616
|
*/
|
|
@@ -2399,7 +2679,7 @@ export interface Permission {
|
|
|
2399
2679
|
*/
|
|
2400
2680
|
'name': string;
|
|
2401
2681
|
/**
|
|
2402
|
-
*
|
|
2682
|
+
* 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.
|
|
2403
2683
|
* @type {string}
|
|
2404
2684
|
* @memberof Permission
|
|
2405
2685
|
*/
|
|
@@ -2436,7 +2716,7 @@ export interface PlayerModeration {
|
|
|
2436
2716
|
*/
|
|
2437
2717
|
'sourceDisplayName': string;
|
|
2438
2718
|
/**
|
|
2439
|
-
*
|
|
2719
|
+
* 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.
|
|
2440
2720
|
* @type {string}
|
|
2441
2721
|
* @memberof PlayerModeration
|
|
2442
2722
|
*/
|
|
@@ -2448,7 +2728,7 @@ export interface PlayerModeration {
|
|
|
2448
2728
|
*/
|
|
2449
2729
|
'targetDisplayName': string;
|
|
2450
2730
|
/**
|
|
2451
|
-
*
|
|
2731
|
+
* 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.
|
|
2452
2732
|
* @type {string}
|
|
2453
2733
|
* @memberof PlayerModeration
|
|
2454
2734
|
*/
|
|
@@ -2480,59 +2760,374 @@ export declare enum PlayerModerationType {
|
|
|
2480
2760
|
*/
|
|
2481
2761
|
export interface PublicAnnouncement {
|
|
2482
2762
|
/**
|
|
2483
|
-
* Announcement name
|
|
2484
|
-
* @type {string}
|
|
2485
|
-
* @memberof PublicAnnouncement
|
|
2763
|
+
* Announcement name
|
|
2764
|
+
* @type {string}
|
|
2765
|
+
* @memberof PublicAnnouncement
|
|
2766
|
+
*/
|
|
2767
|
+
'name': string;
|
|
2768
|
+
/**
|
|
2769
|
+
* Announcement text
|
|
2770
|
+
* @type {string}
|
|
2771
|
+
* @memberof PublicAnnouncement
|
|
2772
|
+
*/
|
|
2773
|
+
'text': string;
|
|
2774
|
+
}
|
|
2775
|
+
/**
|
|
2776
|
+
* API/Photon region.
|
|
2777
|
+
* @export
|
|
2778
|
+
* @enum {string}
|
|
2779
|
+
*/
|
|
2780
|
+
export declare enum Region {
|
|
2781
|
+
Us = "us",
|
|
2782
|
+
Use = "use",
|
|
2783
|
+
Eu = "eu",
|
|
2784
|
+
Jp = "jp"
|
|
2785
|
+
}
|
|
2786
|
+
/**
|
|
2787
|
+
*
|
|
2788
|
+
* @export
|
|
2789
|
+
* @enum {string}
|
|
2790
|
+
*/
|
|
2791
|
+
export declare enum ReleaseStatus {
|
|
2792
|
+
Public = "public",
|
|
2793
|
+
Private = "private",
|
|
2794
|
+
Hidden = "hidden"
|
|
2795
|
+
}
|
|
2796
|
+
/**
|
|
2797
|
+
*
|
|
2798
|
+
* @export
|
|
2799
|
+
* @interface Response
|
|
2800
|
+
*/
|
|
2801
|
+
export interface Response {
|
|
2802
|
+
/**
|
|
2803
|
+
*
|
|
2804
|
+
* @type {string}
|
|
2805
|
+
* @memberof Response
|
|
2806
|
+
*/
|
|
2807
|
+
'message'?: string;
|
|
2808
|
+
/**
|
|
2809
|
+
*
|
|
2810
|
+
* @type {number}
|
|
2811
|
+
* @memberof Response
|
|
2812
|
+
*/
|
|
2813
|
+
'status_code': number;
|
|
2814
|
+
}
|
|
2815
|
+
/**
|
|
2816
|
+
*
|
|
2817
|
+
* @export
|
|
2818
|
+
* @interface Subscription
|
|
2819
|
+
*/
|
|
2820
|
+
export interface Subscription {
|
|
2821
|
+
/**
|
|
2822
|
+
*
|
|
2823
|
+
* @type {string}
|
|
2824
|
+
* @memberof Subscription
|
|
2825
|
+
*/
|
|
2826
|
+
'id': string;
|
|
2827
|
+
/**
|
|
2828
|
+
*
|
|
2829
|
+
* @type {string}
|
|
2830
|
+
* @memberof Subscription
|
|
2831
|
+
*/
|
|
2832
|
+
'steamItemId': string;
|
|
2833
|
+
/**
|
|
2834
|
+
*
|
|
2835
|
+
* @type {number}
|
|
2836
|
+
* @memberof Subscription
|
|
2837
|
+
*/
|
|
2838
|
+
'amount': number;
|
|
2839
|
+
/**
|
|
2840
|
+
*
|
|
2841
|
+
* @type {string}
|
|
2842
|
+
* @memberof Subscription
|
|
2843
|
+
*/
|
|
2844
|
+
'description': string;
|
|
2845
|
+
/**
|
|
2846
|
+
*
|
|
2847
|
+
* @type {SubscriptionPeriod}
|
|
2848
|
+
* @memberof Subscription
|
|
2849
|
+
*/
|
|
2850
|
+
'period': SubscriptionPeriod;
|
|
2851
|
+
/**
|
|
2852
|
+
*
|
|
2853
|
+
* @type {number}
|
|
2854
|
+
* @memberof Subscription
|
|
2855
|
+
*/
|
|
2856
|
+
'tier': number;
|
|
2857
|
+
}
|
|
2858
|
+
/**
|
|
2859
|
+
*
|
|
2860
|
+
* @export
|
|
2861
|
+
* @enum {string}
|
|
2862
|
+
*/
|
|
2863
|
+
export declare enum SubscriptionPeriod {
|
|
2864
|
+
Hour = "hour",
|
|
2865
|
+
Day = "day",
|
|
2866
|
+
Week = "week",
|
|
2867
|
+
Month = "month",
|
|
2868
|
+
Year = "year"
|
|
2869
|
+
}
|
|
2870
|
+
/**
|
|
2871
|
+
*
|
|
2872
|
+
* @export
|
|
2873
|
+
* @interface Success
|
|
2874
|
+
*/
|
|
2875
|
+
export interface Success {
|
|
2876
|
+
/**
|
|
2877
|
+
*
|
|
2878
|
+
* @type {Response}
|
|
2879
|
+
* @memberof Success
|
|
2880
|
+
*/
|
|
2881
|
+
'success'?: Response;
|
|
2882
|
+
}
|
|
2883
|
+
/**
|
|
2884
|
+
*
|
|
2885
|
+
* @export
|
|
2886
|
+
* @interface Transaction
|
|
2887
|
+
*/
|
|
2888
|
+
export interface Transaction {
|
|
2889
|
+
/**
|
|
2890
|
+
*
|
|
2891
|
+
* @type {string}
|
|
2892
|
+
* @memberof Transaction
|
|
2893
|
+
*/
|
|
2894
|
+
'id': string;
|
|
2895
|
+
/**
|
|
2896
|
+
*
|
|
2897
|
+
* @type {TransactionStatus}
|
|
2898
|
+
* @memberof Transaction
|
|
2899
|
+
*/
|
|
2900
|
+
'status': TransactionStatus;
|
|
2901
|
+
/**
|
|
2902
|
+
*
|
|
2903
|
+
* @type {Subscription}
|
|
2904
|
+
* @memberof Transaction
|
|
2905
|
+
*/
|
|
2906
|
+
'subscription': Subscription;
|
|
2907
|
+
/**
|
|
2908
|
+
*
|
|
2909
|
+
* @type {boolean}
|
|
2910
|
+
* @memberof Transaction
|
|
2911
|
+
*/
|
|
2912
|
+
'sandbox': boolean;
|
|
2913
|
+
/**
|
|
2914
|
+
*
|
|
2915
|
+
* @type {string}
|
|
2916
|
+
* @memberof Transaction
|
|
2917
|
+
*/
|
|
2918
|
+
'created_at': string;
|
|
2919
|
+
/**
|
|
2920
|
+
*
|
|
2921
|
+
* @type {string}
|
|
2922
|
+
* @memberof Transaction
|
|
2923
|
+
*/
|
|
2924
|
+
'updated_at': string;
|
|
2925
|
+
/**
|
|
2926
|
+
*
|
|
2927
|
+
* @type {TransactionSteamInfo}
|
|
2928
|
+
* @memberof Transaction
|
|
2929
|
+
*/
|
|
2930
|
+
'steam'?: TransactionSteamInfo;
|
|
2931
|
+
/**
|
|
2932
|
+
*
|
|
2933
|
+
* @type {TransactionAgreement}
|
|
2934
|
+
* @memberof Transaction
|
|
2935
|
+
*/
|
|
2936
|
+
'agreement'?: TransactionAgreement;
|
|
2937
|
+
/**
|
|
2938
|
+
*
|
|
2939
|
+
* @type {string}
|
|
2940
|
+
* @memberof Transaction
|
|
2941
|
+
*/
|
|
2942
|
+
'error': string;
|
|
2943
|
+
}
|
|
2944
|
+
/**
|
|
2945
|
+
*
|
|
2946
|
+
* @export
|
|
2947
|
+
* @interface TransactionAgreement
|
|
2948
|
+
*/
|
|
2949
|
+
export interface TransactionAgreement {
|
|
2950
|
+
/**
|
|
2951
|
+
*
|
|
2952
|
+
* @type {string}
|
|
2953
|
+
* @memberof TransactionAgreement
|
|
2954
|
+
*/
|
|
2955
|
+
'agreementId': string;
|
|
2956
|
+
/**
|
|
2957
|
+
*
|
|
2958
|
+
* @type {number}
|
|
2959
|
+
* @memberof TransactionAgreement
|
|
2960
|
+
*/
|
|
2961
|
+
'itemId': number;
|
|
2962
|
+
/**
|
|
2963
|
+
* This is NOT TransactionStatus, but whatever Steam return.
|
|
2964
|
+
* @type {string}
|
|
2965
|
+
* @memberof TransactionAgreement
|
|
2966
|
+
*/
|
|
2967
|
+
'status': string;
|
|
2968
|
+
/**
|
|
2969
|
+
*
|
|
2970
|
+
* @type {string}
|
|
2971
|
+
* @memberof TransactionAgreement
|
|
2972
|
+
*/
|
|
2973
|
+
'period': string;
|
|
2974
|
+
/**
|
|
2975
|
+
*
|
|
2976
|
+
* @type {number}
|
|
2977
|
+
* @memberof TransactionAgreement
|
|
2978
|
+
*/
|
|
2979
|
+
'frequency': number;
|
|
2980
|
+
/**
|
|
2981
|
+
*
|
|
2982
|
+
* @type {string}
|
|
2983
|
+
* @memberof TransactionAgreement
|
|
2984
|
+
*/
|
|
2985
|
+
'billingType': string;
|
|
2986
|
+
/**
|
|
2987
|
+
*
|
|
2988
|
+
* @type {string}
|
|
2989
|
+
* @memberof TransactionAgreement
|
|
2990
|
+
*/
|
|
2991
|
+
'startDate': string;
|
|
2992
|
+
/**
|
|
2993
|
+
*
|
|
2994
|
+
* @type {string}
|
|
2995
|
+
* @memberof TransactionAgreement
|
|
2996
|
+
*/
|
|
2997
|
+
'endDate': string;
|
|
2998
|
+
/**
|
|
2999
|
+
*
|
|
3000
|
+
* @type {number}
|
|
3001
|
+
* @memberof TransactionAgreement
|
|
3002
|
+
*/
|
|
3003
|
+
'recurringAmt': number;
|
|
3004
|
+
/**
|
|
3005
|
+
*
|
|
3006
|
+
* @type {string}
|
|
3007
|
+
* @memberof TransactionAgreement
|
|
3008
|
+
*/
|
|
3009
|
+
'currency': string;
|
|
3010
|
+
/**
|
|
3011
|
+
*
|
|
3012
|
+
* @type {string}
|
|
3013
|
+
* @memberof TransactionAgreement
|
|
3014
|
+
*/
|
|
3015
|
+
'timeCreated': string;
|
|
3016
|
+
/**
|
|
3017
|
+
*
|
|
3018
|
+
* @type {string}
|
|
3019
|
+
* @memberof TransactionAgreement
|
|
3020
|
+
*/
|
|
3021
|
+
'nextPayment': string;
|
|
3022
|
+
/**
|
|
3023
|
+
*
|
|
3024
|
+
* @type {string}
|
|
3025
|
+
* @memberof TransactionAgreement
|
|
3026
|
+
*/
|
|
3027
|
+
'lastPayment': string;
|
|
3028
|
+
/**
|
|
3029
|
+
*
|
|
3030
|
+
* @type {number}
|
|
3031
|
+
* @memberof TransactionAgreement
|
|
3032
|
+
*/
|
|
3033
|
+
'lastAmount': number;
|
|
3034
|
+
/**
|
|
3035
|
+
*
|
|
3036
|
+
* @type {number}
|
|
3037
|
+
* @memberof TransactionAgreement
|
|
3038
|
+
*/
|
|
3039
|
+
'lastAmountVat': number;
|
|
3040
|
+
/**
|
|
3041
|
+
*
|
|
3042
|
+
* @type {number}
|
|
3043
|
+
* @memberof TransactionAgreement
|
|
2486
3044
|
*/
|
|
2487
|
-
'
|
|
3045
|
+
'outstanding': number;
|
|
2488
3046
|
/**
|
|
2489
|
-
*
|
|
2490
|
-
* @type {
|
|
2491
|
-
* @memberof
|
|
3047
|
+
*
|
|
3048
|
+
* @type {number}
|
|
3049
|
+
* @memberof TransactionAgreement
|
|
2492
3050
|
*/
|
|
2493
|
-
'
|
|
3051
|
+
'failedAttempts': number;
|
|
2494
3052
|
}
|
|
2495
3053
|
/**
|
|
2496
3054
|
*
|
|
2497
3055
|
* @export
|
|
2498
3056
|
* @enum {string}
|
|
2499
3057
|
*/
|
|
2500
|
-
export declare enum
|
|
2501
|
-
|
|
2502
|
-
|
|
2503
|
-
|
|
3058
|
+
export declare enum TransactionStatus {
|
|
3059
|
+
Active = "active",
|
|
3060
|
+
Failed = "failed",
|
|
3061
|
+
Expired = "expired",
|
|
3062
|
+
Chargeback = "chargeback"
|
|
2504
3063
|
}
|
|
2505
3064
|
/**
|
|
2506
3065
|
*
|
|
2507
3066
|
* @export
|
|
2508
|
-
* @interface
|
|
3067
|
+
* @interface TransactionSteamInfo
|
|
2509
3068
|
*/
|
|
2510
|
-
export interface
|
|
3069
|
+
export interface TransactionSteamInfo {
|
|
2511
3070
|
/**
|
|
2512
3071
|
*
|
|
3072
|
+
* @type {TransactionSteamWalletInfo}
|
|
3073
|
+
* @memberof TransactionSteamInfo
|
|
3074
|
+
*/
|
|
3075
|
+
'walletInfo': TransactionSteamWalletInfo;
|
|
3076
|
+
/**
|
|
3077
|
+
* Steam User ID
|
|
2513
3078
|
* @type {string}
|
|
2514
|
-
* @memberof
|
|
3079
|
+
* @memberof TransactionSteamInfo
|
|
2515
3080
|
*/
|
|
2516
|
-
'
|
|
3081
|
+
'steamId': string;
|
|
2517
3082
|
/**
|
|
2518
|
-
*
|
|
2519
|
-
* @type {
|
|
2520
|
-
* @memberof
|
|
3083
|
+
* Steam Order ID
|
|
3084
|
+
* @type {string}
|
|
3085
|
+
* @memberof TransactionSteamInfo
|
|
2521
3086
|
*/
|
|
2522
|
-
'
|
|
3087
|
+
'orderId': string;
|
|
3088
|
+
/**
|
|
3089
|
+
* Empty
|
|
3090
|
+
* @type {string}
|
|
3091
|
+
* @memberof TransactionSteamInfo
|
|
3092
|
+
*/
|
|
3093
|
+
'steamUrl': string;
|
|
3094
|
+
/**
|
|
3095
|
+
* Steam Transaction ID, NOT the same as VRChat TransactionID
|
|
3096
|
+
* @type {string}
|
|
3097
|
+
* @memberof TransactionSteamInfo
|
|
3098
|
+
*/
|
|
3099
|
+
'transId': string;
|
|
2523
3100
|
}
|
|
2524
3101
|
/**
|
|
2525
3102
|
*
|
|
2526
3103
|
* @export
|
|
2527
|
-
* @interface
|
|
3104
|
+
* @interface TransactionSteamWalletInfo
|
|
2528
3105
|
*/
|
|
2529
|
-
export interface
|
|
3106
|
+
export interface TransactionSteamWalletInfo {
|
|
2530
3107
|
/**
|
|
2531
3108
|
*
|
|
2532
|
-
* @type {
|
|
2533
|
-
* @memberof
|
|
3109
|
+
* @type {string}
|
|
3110
|
+
* @memberof TransactionSteamWalletInfo
|
|
2534
3111
|
*/
|
|
2535
|
-
'
|
|
3112
|
+
'state': string;
|
|
3113
|
+
/**
|
|
3114
|
+
*
|
|
3115
|
+
* @type {string}
|
|
3116
|
+
* @memberof TransactionSteamWalletInfo
|
|
3117
|
+
*/
|
|
3118
|
+
'country': string;
|
|
3119
|
+
/**
|
|
3120
|
+
*
|
|
3121
|
+
* @type {string}
|
|
3122
|
+
* @memberof TransactionSteamWalletInfo
|
|
3123
|
+
*/
|
|
3124
|
+
'currency': string;
|
|
3125
|
+
/**
|
|
3126
|
+
*
|
|
3127
|
+
* @type {string}
|
|
3128
|
+
* @memberof TransactionSteamWalletInfo
|
|
3129
|
+
*/
|
|
3130
|
+
'status': string;
|
|
2536
3131
|
}
|
|
2537
3132
|
/**
|
|
2538
3133
|
*
|
|
@@ -2793,7 +3388,7 @@ export interface UpdateWorldRequest {
|
|
|
2793
3388
|
*/
|
|
2794
3389
|
'assetVersion'?: string;
|
|
2795
3390
|
/**
|
|
2796
|
-
*
|
|
3391
|
+
* 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.
|
|
2797
3392
|
* @type {string}
|
|
2798
3393
|
* @memberof UpdateWorldRequest
|
|
2799
3394
|
*/
|
|
@@ -2884,13 +3479,13 @@ export interface User {
|
|
|
2884
3479
|
*/
|
|
2885
3480
|
'bioLinks': Array<string>;
|
|
2886
3481
|
/**
|
|
2887
|
-
*
|
|
3482
|
+
* When profilePicOverride is not empty, use it instead.
|
|
2888
3483
|
* @type {string}
|
|
2889
3484
|
* @memberof User
|
|
2890
3485
|
*/
|
|
2891
3486
|
'currentAvatarImageUrl': string;
|
|
2892
3487
|
/**
|
|
2893
|
-
*
|
|
3488
|
+
* When profilePicOverride is not empty, use it instead.
|
|
2894
3489
|
* @type {string}
|
|
2895
3490
|
* @memberof User
|
|
2896
3491
|
*/
|
|
@@ -2908,7 +3503,7 @@ export interface User {
|
|
|
2908
3503
|
*/
|
|
2909
3504
|
'developerType': DeveloperType;
|
|
2910
3505
|
/**
|
|
2911
|
-
*
|
|
3506
|
+
* A users visual display name. This is what shows up in-game, and can different from their `username`. Changing display name is restricted to a cooldown period.
|
|
2912
3507
|
* @type {string}
|
|
2913
3508
|
* @memberof User
|
|
2914
3509
|
*/
|
|
@@ -2920,25 +3515,25 @@ export interface User {
|
|
|
2920
3515
|
*/
|
|
2921
3516
|
'friendKey': string;
|
|
2922
3517
|
/**
|
|
2923
|
-
*
|
|
3518
|
+
* 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.
|
|
2924
3519
|
* @type {string}
|
|
2925
3520
|
* @memberof User
|
|
2926
3521
|
*/
|
|
2927
3522
|
'id': string;
|
|
2928
3523
|
/**
|
|
2929
|
-
*
|
|
3524
|
+
* InstanceID be \"offline\" on User profiles if you are not friends with that user.
|
|
2930
3525
|
* @type {string}
|
|
2931
3526
|
* @memberof User
|
|
2932
3527
|
*/
|
|
2933
3528
|
'instanceId'?: string;
|
|
2934
3529
|
/**
|
|
2935
|
-
*
|
|
3530
|
+
* Either their `friendKey`, or empty string if you are not friends. Unknown usage.
|
|
2936
3531
|
* @type {boolean}
|
|
2937
3532
|
* @memberof User
|
|
2938
3533
|
*/
|
|
2939
3534
|
'isFriend': boolean;
|
|
2940
3535
|
/**
|
|
2941
|
-
*
|
|
3536
|
+
* Either a date-time or empty string.
|
|
2942
3537
|
* @type {string}
|
|
2943
3538
|
* @memberof User
|
|
2944
3539
|
*/
|
|
@@ -2950,7 +3545,7 @@ export interface User {
|
|
|
2950
3545
|
*/
|
|
2951
3546
|
'last_platform': string;
|
|
2952
3547
|
/**
|
|
2953
|
-
*
|
|
3548
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
2954
3549
|
* @type {string}
|
|
2955
3550
|
* @memberof User
|
|
2956
3551
|
*/
|
|
@@ -2992,13 +3587,13 @@ export interface User {
|
|
|
2992
3587
|
*/
|
|
2993
3588
|
'userIcon': string;
|
|
2994
3589
|
/**
|
|
2995
|
-
*
|
|
3590
|
+
* A users unique name, used during login. This is different from `displayName` which is what shows up in-game. A users `username` can never be changed.
|
|
2996
3591
|
* @type {string}
|
|
2997
3592
|
* @memberof User
|
|
2998
3593
|
*/
|
|
2999
3594
|
'username': string;
|
|
3000
3595
|
/**
|
|
3001
|
-
*
|
|
3596
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
3002
3597
|
* @type {string}
|
|
3003
3598
|
* @memberof User
|
|
3004
3599
|
*/
|
|
@@ -3039,6 +3634,103 @@ export declare enum UserStatus {
|
|
|
3039
3634
|
Busy = "busy",
|
|
3040
3635
|
Offline = "offline"
|
|
3041
3636
|
}
|
|
3637
|
+
/**
|
|
3638
|
+
*
|
|
3639
|
+
* @export
|
|
3640
|
+
* @interface UserSubscription
|
|
3641
|
+
*/
|
|
3642
|
+
export interface UserSubscription {
|
|
3643
|
+
/**
|
|
3644
|
+
*
|
|
3645
|
+
* @type {string}
|
|
3646
|
+
* @memberof UserSubscription
|
|
3647
|
+
*/
|
|
3648
|
+
'id': string;
|
|
3649
|
+
/**
|
|
3650
|
+
*
|
|
3651
|
+
* @type {string}
|
|
3652
|
+
* @memberof UserSubscription
|
|
3653
|
+
*/
|
|
3654
|
+
'transactionId': string;
|
|
3655
|
+
/**
|
|
3656
|
+
* Which \"Store\" it came from. Right now only Stores are \"Steam\" and \"Admin\".
|
|
3657
|
+
* @type {string}
|
|
3658
|
+
* @memberof UserSubscription
|
|
3659
|
+
*/
|
|
3660
|
+
'store': string;
|
|
3661
|
+
/**
|
|
3662
|
+
*
|
|
3663
|
+
* @type {string}
|
|
3664
|
+
* @memberof UserSubscription
|
|
3665
|
+
*/
|
|
3666
|
+
'steamItemId'?: string;
|
|
3667
|
+
/**
|
|
3668
|
+
*
|
|
3669
|
+
* @type {number}
|
|
3670
|
+
* @memberof UserSubscription
|
|
3671
|
+
*/
|
|
3672
|
+
'amount': number;
|
|
3673
|
+
/**
|
|
3674
|
+
*
|
|
3675
|
+
* @type {string}
|
|
3676
|
+
* @memberof UserSubscription
|
|
3677
|
+
*/
|
|
3678
|
+
'description': string;
|
|
3679
|
+
/**
|
|
3680
|
+
*
|
|
3681
|
+
* @type {SubscriptionPeriod}
|
|
3682
|
+
* @memberof UserSubscription
|
|
3683
|
+
*/
|
|
3684
|
+
'period': SubscriptionPeriod;
|
|
3685
|
+
/**
|
|
3686
|
+
*
|
|
3687
|
+
* @type {number}
|
|
3688
|
+
* @memberof UserSubscription
|
|
3689
|
+
*/
|
|
3690
|
+
'tier': number;
|
|
3691
|
+
/**
|
|
3692
|
+
*
|
|
3693
|
+
* @type {boolean}
|
|
3694
|
+
* @memberof UserSubscription
|
|
3695
|
+
*/
|
|
3696
|
+
'active': boolean;
|
|
3697
|
+
/**
|
|
3698
|
+
*
|
|
3699
|
+
* @type {TransactionStatus}
|
|
3700
|
+
* @memberof UserSubscription
|
|
3701
|
+
*/
|
|
3702
|
+
'status': TransactionStatus;
|
|
3703
|
+
/**
|
|
3704
|
+
*
|
|
3705
|
+
* @type {string}
|
|
3706
|
+
* @memberof UserSubscription
|
|
3707
|
+
*/
|
|
3708
|
+
'expires': string;
|
|
3709
|
+
/**
|
|
3710
|
+
*
|
|
3711
|
+
* @type {string}
|
|
3712
|
+
* @memberof UserSubscription
|
|
3713
|
+
*/
|
|
3714
|
+
'created_at': string;
|
|
3715
|
+
/**
|
|
3716
|
+
*
|
|
3717
|
+
* @type {string}
|
|
3718
|
+
* @memberof UserSubscription
|
|
3719
|
+
*/
|
|
3720
|
+
'updated_at': string;
|
|
3721
|
+
/**
|
|
3722
|
+
*
|
|
3723
|
+
* @type {Array<string>}
|
|
3724
|
+
* @memberof UserSubscription
|
|
3725
|
+
*/
|
|
3726
|
+
'licenseGroups': Array<string>;
|
|
3727
|
+
/**
|
|
3728
|
+
*
|
|
3729
|
+
* @type {boolean}
|
|
3730
|
+
* @memberof UserSubscription
|
|
3731
|
+
*/
|
|
3732
|
+
'isGift': boolean;
|
|
3733
|
+
}
|
|
3042
3734
|
/**
|
|
3043
3735
|
*
|
|
3044
3736
|
* @export
|
|
@@ -3078,7 +3770,7 @@ export interface VerifyAuthTokenResult {
|
|
|
3078
3770
|
*/
|
|
3079
3771
|
export interface World {
|
|
3080
3772
|
/**
|
|
3081
|
-
*
|
|
3773
|
+
* Empty if unauthenticated.
|
|
3082
3774
|
* @type {string}
|
|
3083
3775
|
* @memberof World
|
|
3084
3776
|
*/
|
|
@@ -3090,7 +3782,7 @@ export interface World {
|
|
|
3090
3782
|
*/
|
|
3091
3783
|
'assetUrlObject': object;
|
|
3092
3784
|
/**
|
|
3093
|
-
*
|
|
3785
|
+
* 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.
|
|
3094
3786
|
* @type {string}
|
|
3095
3787
|
* @memberof World
|
|
3096
3788
|
*/
|
|
@@ -3138,7 +3830,7 @@ export interface World {
|
|
|
3138
3830
|
*/
|
|
3139
3831
|
'heat': number;
|
|
3140
3832
|
/**
|
|
3141
|
-
*
|
|
3833
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
3142
3834
|
* @type {string}
|
|
3143
3835
|
* @memberof World
|
|
3144
3836
|
*/
|
|
@@ -3151,10 +3843,10 @@ export interface World {
|
|
|
3151
3843
|
'imageUrl': string;
|
|
3152
3844
|
/**
|
|
3153
3845
|
*
|
|
3154
|
-
* @type {Array<Array<
|
|
3846
|
+
* @type {Array<Array<any>>}
|
|
3155
3847
|
* @memberof World
|
|
3156
3848
|
*/
|
|
3157
|
-
'instances'?: Array<Array<
|
|
3849
|
+
'instances'?: Array<Array<any>>;
|
|
3158
3850
|
/**
|
|
3159
3851
|
*
|
|
3160
3852
|
* @type {string}
|
|
@@ -3246,7 +3938,7 @@ export interface World {
|
|
|
3246
3938
|
*/
|
|
3247
3939
|
'unityPackageUrlObject': object;
|
|
3248
3940
|
/**
|
|
3249
|
-
*
|
|
3941
|
+
* Empty if unauthenticated.
|
|
3250
3942
|
* @type {Array<UnityPackage>}
|
|
3251
3943
|
* @memberof World
|
|
3252
3944
|
*/
|
|
@@ -3277,7 +3969,7 @@ export interface World {
|
|
|
3277
3969
|
*/
|
|
3278
3970
|
export interface WorldMetadata {
|
|
3279
3971
|
/**
|
|
3280
|
-
*
|
|
3972
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
3281
3973
|
* @type {string}
|
|
3282
3974
|
* @memberof WorldMetadata
|
|
3283
3975
|
*/
|
|
@@ -3597,7 +4289,7 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
3597
4289
|
* @param {'ascending' | 'descending'} [order]
|
|
3598
4290
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
3599
4291
|
* @param {string} [search] Filters by world name.
|
|
3600
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
4292
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
3601
4293
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
3602
4294
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
3603
4295
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -3618,7 +4310,7 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
3618
4310
|
* @param {number} [n] The number of objects to return.
|
|
3619
4311
|
* @param {'ascending' | 'descending'} [order]
|
|
3620
4312
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
3621
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
4313
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
3622
4314
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
3623
4315
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
3624
4316
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -3692,7 +4384,7 @@ export declare const AvatarsApiFp: (configuration?: Configuration) => {
|
|
|
3692
4384
|
* @param {'ascending' | 'descending'} [order]
|
|
3693
4385
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
3694
4386
|
* @param {string} [search] Filters by world name.
|
|
3695
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
4387
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
3696
4388
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
3697
4389
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
3698
4390
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -3713,7 +4405,7 @@ export declare const AvatarsApiFp: (configuration?: Configuration) => {
|
|
|
3713
4405
|
* @param {number} [n] The number of objects to return.
|
|
3714
4406
|
* @param {'ascending' | 'descending'} [order]
|
|
3715
4407
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
3716
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
4408
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
3717
4409
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
3718
4410
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
3719
4411
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -3787,7 +4479,7 @@ export declare const AvatarsApiFactory: (configuration?: Configuration, basePath
|
|
|
3787
4479
|
* @param {'ascending' | 'descending'} [order]
|
|
3788
4480
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
3789
4481
|
* @param {string} [search] Filters by world name.
|
|
3790
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
4482
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
3791
4483
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
3792
4484
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
3793
4485
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -3808,7 +4500,7 @@ export declare const AvatarsApiFactory: (configuration?: Configuration, basePath
|
|
|
3808
4500
|
* @param {number} [n] The number of objects to return.
|
|
3809
4501
|
* @param {'ascending' | 'descending'} [order]
|
|
3810
4502
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
3811
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
4503
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
3812
4504
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
3813
4505
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
3814
4506
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -3887,7 +4579,7 @@ export declare class AvatarsApi extends BaseAPI {
|
|
|
3887
4579
|
* @param {'ascending' | 'descending'} [order]
|
|
3888
4580
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
3889
4581
|
* @param {string} [search] Filters by world name.
|
|
3890
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
4582
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
3891
4583
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
3892
4584
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
3893
4585
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -3909,7 +4601,7 @@ export declare class AvatarsApi extends BaseAPI {
|
|
|
3909
4601
|
* @param {number} [n] The number of objects to return.
|
|
3910
4602
|
* @param {'ascending' | 'descending'} [order]
|
|
3911
4603
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
3912
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
4604
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
3913
4605
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
3914
4606
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
3915
4607
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -3949,6 +4641,189 @@ export declare class AvatarsApi extends BaseAPI {
|
|
|
3949
4641
|
*/
|
|
3950
4642
|
updateAvatar(avatarId: string, updateAvatarRequest?: UpdateAvatarRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Avatar>>;
|
|
3951
4643
|
}
|
|
4644
|
+
/**
|
|
4645
|
+
* EconomyApi - axios parameter creator
|
|
4646
|
+
* @export
|
|
4647
|
+
*/
|
|
4648
|
+
export declare const EconomyApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4649
|
+
/**
|
|
4650
|
+
* Get a list of all current user subscriptions.
|
|
4651
|
+
* @summary Get Current Subscriptions
|
|
4652
|
+
* @param {*} [options] Override http request option.
|
|
4653
|
+
* @throws {RequiredError}
|
|
4654
|
+
*/
|
|
4655
|
+
getCurrentSubscriptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4656
|
+
/**
|
|
4657
|
+
* Get a single License Group by given ID.
|
|
4658
|
+
* @summary Get License Group
|
|
4659
|
+
* @param {string} licenseGroupId
|
|
4660
|
+
* @param {*} [options] Override http request option.
|
|
4661
|
+
* @throws {RequiredError}
|
|
4662
|
+
*/
|
|
4663
|
+
getLicenseGroup: (licenseGroupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4664
|
+
/**
|
|
4665
|
+
* Get a single Steam transactions by ID. This returns the exact same information as `getSteamTransactions`, so no point in using this endpoint.
|
|
4666
|
+
* @summary Get Steam Transaction
|
|
4667
|
+
* @param {string} transactionId
|
|
4668
|
+
* @param {*} [options] Override http request option.
|
|
4669
|
+
* @deprecated
|
|
4670
|
+
* @throws {RequiredError}
|
|
4671
|
+
*/
|
|
4672
|
+
getSteamTransaction: (transactionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4673
|
+
/**
|
|
4674
|
+
* Get all own Steam transactions.
|
|
4675
|
+
* @summary List Steam Transactions
|
|
4676
|
+
* @param {*} [options] Override http request option.
|
|
4677
|
+
* @throws {RequiredError}
|
|
4678
|
+
*/
|
|
4679
|
+
getSteamTransactions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4680
|
+
/**
|
|
4681
|
+
* List all existing Subscriptions. For example, \"vrchatplus-monthly\" and \"vrchatplus-yearly\".
|
|
4682
|
+
* @summary List Subscriptions
|
|
4683
|
+
* @param {*} [options] Override http request option.
|
|
4684
|
+
* @throws {RequiredError}
|
|
4685
|
+
*/
|
|
4686
|
+
getSubscriptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4687
|
+
};
|
|
4688
|
+
/**
|
|
4689
|
+
* EconomyApi - functional programming interface
|
|
4690
|
+
* @export
|
|
4691
|
+
*/
|
|
4692
|
+
export declare const EconomyApiFp: (configuration?: Configuration) => {
|
|
4693
|
+
/**
|
|
4694
|
+
* Get a list of all current user subscriptions.
|
|
4695
|
+
* @summary Get Current Subscriptions
|
|
4696
|
+
* @param {*} [options] Override http request option.
|
|
4697
|
+
* @throws {RequiredError}
|
|
4698
|
+
*/
|
|
4699
|
+
getCurrentSubscriptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserSubscription>>>;
|
|
4700
|
+
/**
|
|
4701
|
+
* Get a single License Group by given ID.
|
|
4702
|
+
* @summary Get License Group
|
|
4703
|
+
* @param {string} licenseGroupId
|
|
4704
|
+
* @param {*} [options] Override http request option.
|
|
4705
|
+
* @throws {RequiredError}
|
|
4706
|
+
*/
|
|
4707
|
+
getLicenseGroup(licenseGroupId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LicenseGroup>>;
|
|
4708
|
+
/**
|
|
4709
|
+
* Get a single Steam transactions by ID. This returns the exact same information as `getSteamTransactions`, so no point in using this endpoint.
|
|
4710
|
+
* @summary Get Steam Transaction
|
|
4711
|
+
* @param {string} transactionId
|
|
4712
|
+
* @param {*} [options] Override http request option.
|
|
4713
|
+
* @deprecated
|
|
4714
|
+
* @throws {RequiredError}
|
|
4715
|
+
*/
|
|
4716
|
+
getSteamTransaction(transactionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Transaction>>;
|
|
4717
|
+
/**
|
|
4718
|
+
* Get all own Steam transactions.
|
|
4719
|
+
* @summary List Steam Transactions
|
|
4720
|
+
* @param {*} [options] Override http request option.
|
|
4721
|
+
* @throws {RequiredError}
|
|
4722
|
+
*/
|
|
4723
|
+
getSteamTransactions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Transaction>>>;
|
|
4724
|
+
/**
|
|
4725
|
+
* List all existing Subscriptions. For example, \"vrchatplus-monthly\" and \"vrchatplus-yearly\".
|
|
4726
|
+
* @summary List Subscriptions
|
|
4727
|
+
* @param {*} [options] Override http request option.
|
|
4728
|
+
* @throws {RequiredError}
|
|
4729
|
+
*/
|
|
4730
|
+
getSubscriptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Subscription>>>;
|
|
4731
|
+
};
|
|
4732
|
+
/**
|
|
4733
|
+
* EconomyApi - factory interface
|
|
4734
|
+
* @export
|
|
4735
|
+
*/
|
|
4736
|
+
export declare const EconomyApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4737
|
+
/**
|
|
4738
|
+
* Get a list of all current user subscriptions.
|
|
4739
|
+
* @summary Get Current Subscriptions
|
|
4740
|
+
* @param {*} [options] Override http request option.
|
|
4741
|
+
* @throws {RequiredError}
|
|
4742
|
+
*/
|
|
4743
|
+
getCurrentSubscriptions(options?: any): AxiosPromise<Array<UserSubscription>>;
|
|
4744
|
+
/**
|
|
4745
|
+
* Get a single License Group by given ID.
|
|
4746
|
+
* @summary Get License Group
|
|
4747
|
+
* @param {string} licenseGroupId
|
|
4748
|
+
* @param {*} [options] Override http request option.
|
|
4749
|
+
* @throws {RequiredError}
|
|
4750
|
+
*/
|
|
4751
|
+
getLicenseGroup(licenseGroupId: string, options?: any): AxiosPromise<LicenseGroup>;
|
|
4752
|
+
/**
|
|
4753
|
+
* Get a single Steam transactions by ID. This returns the exact same information as `getSteamTransactions`, so no point in using this endpoint.
|
|
4754
|
+
* @summary Get Steam Transaction
|
|
4755
|
+
* @param {string} transactionId
|
|
4756
|
+
* @param {*} [options] Override http request option.
|
|
4757
|
+
* @deprecated
|
|
4758
|
+
* @throws {RequiredError}
|
|
4759
|
+
*/
|
|
4760
|
+
getSteamTransaction(transactionId: string, options?: any): AxiosPromise<Transaction>;
|
|
4761
|
+
/**
|
|
4762
|
+
* Get all own Steam transactions.
|
|
4763
|
+
* @summary List Steam Transactions
|
|
4764
|
+
* @param {*} [options] Override http request option.
|
|
4765
|
+
* @throws {RequiredError}
|
|
4766
|
+
*/
|
|
4767
|
+
getSteamTransactions(options?: any): AxiosPromise<Array<Transaction>>;
|
|
4768
|
+
/**
|
|
4769
|
+
* List all existing Subscriptions. For example, \"vrchatplus-monthly\" and \"vrchatplus-yearly\".
|
|
4770
|
+
* @summary List Subscriptions
|
|
4771
|
+
* @param {*} [options] Override http request option.
|
|
4772
|
+
* @throws {RequiredError}
|
|
4773
|
+
*/
|
|
4774
|
+
getSubscriptions(options?: any): AxiosPromise<Array<Subscription>>;
|
|
4775
|
+
};
|
|
4776
|
+
/**
|
|
4777
|
+
* EconomyApi - object-oriented interface
|
|
4778
|
+
* @export
|
|
4779
|
+
* @class EconomyApi
|
|
4780
|
+
* @extends {BaseAPI}
|
|
4781
|
+
*/
|
|
4782
|
+
export declare class EconomyApi extends BaseAPI {
|
|
4783
|
+
/**
|
|
4784
|
+
* Get a list of all current user subscriptions.
|
|
4785
|
+
* @summary Get Current Subscriptions
|
|
4786
|
+
* @param {*} [options] Override http request option.
|
|
4787
|
+
* @throws {RequiredError}
|
|
4788
|
+
* @memberof EconomyApi
|
|
4789
|
+
*/
|
|
4790
|
+
getCurrentSubscriptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserSubscription[]>>;
|
|
4791
|
+
/**
|
|
4792
|
+
* Get a single License Group by given ID.
|
|
4793
|
+
* @summary Get License Group
|
|
4794
|
+
* @param {string} licenseGroupId
|
|
4795
|
+
* @param {*} [options] Override http request option.
|
|
4796
|
+
* @throws {RequiredError}
|
|
4797
|
+
* @memberof EconomyApi
|
|
4798
|
+
*/
|
|
4799
|
+
getLicenseGroup(licenseGroupId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LicenseGroup>>;
|
|
4800
|
+
/**
|
|
4801
|
+
* Get a single Steam transactions by ID. This returns the exact same information as `getSteamTransactions`, so no point in using this endpoint.
|
|
4802
|
+
* @summary Get Steam Transaction
|
|
4803
|
+
* @param {string} transactionId
|
|
4804
|
+
* @param {*} [options] Override http request option.
|
|
4805
|
+
* @deprecated
|
|
4806
|
+
* @throws {RequiredError}
|
|
4807
|
+
* @memberof EconomyApi
|
|
4808
|
+
*/
|
|
4809
|
+
getSteamTransaction(transactionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Transaction>>;
|
|
4810
|
+
/**
|
|
4811
|
+
* Get all own Steam transactions.
|
|
4812
|
+
* @summary List Steam Transactions
|
|
4813
|
+
* @param {*} [options] Override http request option.
|
|
4814
|
+
* @throws {RequiredError}
|
|
4815
|
+
* @memberof EconomyApi
|
|
4816
|
+
*/
|
|
4817
|
+
getSteamTransactions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Transaction[]>>;
|
|
4818
|
+
/**
|
|
4819
|
+
* List all existing Subscriptions. For example, \"vrchatplus-monthly\" and \"vrchatplus-yearly\".
|
|
4820
|
+
* @summary List Subscriptions
|
|
4821
|
+
* @param {*} [options] Override http request option.
|
|
4822
|
+
* @throws {RequiredError}
|
|
4823
|
+
* @memberof EconomyApi
|
|
4824
|
+
*/
|
|
4825
|
+
getSubscriptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Subscription[]>>;
|
|
4826
|
+
}
|
|
3952
4827
|
/**
|
|
3953
4828
|
* FavoritesApi - axios parameter creator
|
|
3954
4829
|
* @export
|
|
@@ -4006,7 +4881,7 @@ export declare const FavoritesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
4006
4881
|
* @param {number} [n] The number of objects to return.
|
|
4007
4882
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
4008
4883
|
* @param {string} [type] The type of favorites to return, FavoriteType.
|
|
4009
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
4884
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
4010
4885
|
* @param {*} [options] Override http request option.
|
|
4011
4886
|
* @throws {RequiredError}
|
|
4012
4887
|
*/
|
|
@@ -4088,7 +4963,7 @@ export declare const FavoritesApiFp: (configuration?: Configuration) => {
|
|
|
4088
4963
|
* @param {number} [n] The number of objects to return.
|
|
4089
4964
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
4090
4965
|
* @param {string} [type] The type of favorites to return, FavoriteType.
|
|
4091
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
4966
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
4092
4967
|
* @param {*} [options] Override http request option.
|
|
4093
4968
|
* @throws {RequiredError}
|
|
4094
4969
|
*/
|
|
@@ -4170,7 +5045,7 @@ export declare const FavoritesApiFactory: (configuration?: Configuration, basePa
|
|
|
4170
5045
|
* @param {number} [n] The number of objects to return.
|
|
4171
5046
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
4172
5047
|
* @param {string} [type] The type of favorites to return, FavoriteType.
|
|
4173
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
5048
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
4174
5049
|
* @param {*} [options] Override http request option.
|
|
4175
5050
|
* @throws {RequiredError}
|
|
4176
5051
|
*/
|
|
@@ -4259,7 +5134,7 @@ export declare class FavoritesApi extends BaseAPI {
|
|
|
4259
5134
|
* @param {number} [n] The number of objects to return.
|
|
4260
5135
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
4261
5136
|
* @param {string} [type] The type of favorites to return, FavoriteType.
|
|
4262
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
5137
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
4263
5138
|
* @param {*} [options] Override http request option.
|
|
4264
5139
|
* @throws {RequiredError}
|
|
4265
5140
|
* @memberof FavoritesApi
|
|
@@ -4904,7 +5779,7 @@ export declare class FriendsApi extends BaseAPI {
|
|
|
4904
5779
|
*/
|
|
4905
5780
|
export declare const InstancesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4906
5781
|
/**
|
|
4907
|
-
* Returns an instance.
|
|
5782
|
+
* Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return \"null\"!
|
|
4908
5783
|
* @summary Get Instance
|
|
4909
5784
|
* @param {string} worldId
|
|
4910
5785
|
* @param {string} instanceId
|
|
@@ -4937,7 +5812,7 @@ export declare const InstancesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
4937
5812
|
*/
|
|
4938
5813
|
export declare const InstancesApiFp: (configuration?: Configuration) => {
|
|
4939
5814
|
/**
|
|
4940
|
-
* Returns an instance.
|
|
5815
|
+
* Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return \"null\"!
|
|
4941
5816
|
* @summary Get Instance
|
|
4942
5817
|
* @param {string} worldId
|
|
4943
5818
|
* @param {string} instanceId
|
|
@@ -4970,7 +5845,7 @@ export declare const InstancesApiFp: (configuration?: Configuration) => {
|
|
|
4970
5845
|
*/
|
|
4971
5846
|
export declare const InstancesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4972
5847
|
/**
|
|
4973
|
-
* Returns an instance.
|
|
5848
|
+
* Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return \"null\"!
|
|
4974
5849
|
* @summary Get Instance
|
|
4975
5850
|
* @param {string} worldId
|
|
4976
5851
|
* @param {string} instanceId
|
|
@@ -5005,7 +5880,7 @@ export declare const InstancesApiFactory: (configuration?: Configuration, basePa
|
|
|
5005
5880
|
*/
|
|
5006
5881
|
export declare class InstancesApi extends BaseAPI {
|
|
5007
5882
|
/**
|
|
5008
|
-
* Returns an instance.
|
|
5883
|
+
* Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return \"null\"!
|
|
5009
5884
|
* @summary Get Instance
|
|
5010
5885
|
* @param {string} worldId
|
|
5011
5886
|
* @param {string} instanceId
|
|
@@ -5077,7 +5952,7 @@ export declare const InviteApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5077
5952
|
*/
|
|
5078
5953
|
requestInvite: (userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5079
5954
|
/**
|
|
5080
|
-
* Resets a single Invite Message back to
|
|
5955
|
+
* 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.
|
|
5081
5956
|
* @summary Reset Invite Message
|
|
5082
5957
|
* @param {string} userId
|
|
5083
5958
|
* @param {'message' | 'response' | 'request' | 'requestResponse'} messageType
|
|
@@ -5149,7 +6024,7 @@ export declare const InviteApiFp: (configuration?: Configuration) => {
|
|
|
5149
6024
|
*/
|
|
5150
6025
|
requestInvite(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
|
|
5151
6026
|
/**
|
|
5152
|
-
* Resets a single Invite Message back to
|
|
6027
|
+
* 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.
|
|
5153
6028
|
* @summary Reset Invite Message
|
|
5154
6029
|
* @param {string} userId
|
|
5155
6030
|
* @param {'message' | 'response' | 'request' | 'requestResponse'} messageType
|
|
@@ -5221,7 +6096,7 @@ export declare const InviteApiFactory: (configuration?: Configuration, basePath?
|
|
|
5221
6096
|
*/
|
|
5222
6097
|
requestInvite(userId: string, options?: any): AxiosPromise<Notification>;
|
|
5223
6098
|
/**
|
|
5224
|
-
* Resets a single Invite Message back to
|
|
6099
|
+
* 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.
|
|
5225
6100
|
* @summary Reset Invite Message
|
|
5226
6101
|
* @param {string} userId
|
|
5227
6102
|
* @param {'message' | 'response' | 'request' | 'requestResponse'} messageType
|
|
@@ -5299,7 +6174,7 @@ export declare class InviteApi extends BaseAPI {
|
|
|
5299
6174
|
*/
|
|
5300
6175
|
requestInvite(userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification>>;
|
|
5301
6176
|
/**
|
|
5302
|
-
* Resets a single Invite Message back to
|
|
6177
|
+
* 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.
|
|
5303
6178
|
* @summary Reset Invite Message
|
|
5304
6179
|
* @param {string} userId
|
|
5305
6180
|
* @param {'message' | 'response' | 'request' | 'requestResponse'} messageType
|
|
@@ -5887,6 +6762,15 @@ export declare const SystemApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5887
6762
|
* @throws {RequiredError}
|
|
5888
6763
|
*/
|
|
5889
6764
|
getHealth: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6765
|
+
/**
|
|
6766
|
+
* 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.
|
|
6767
|
+
* @summary Show Information Notices
|
|
6768
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
6769
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6770
|
+
* @param {*} [options] Override http request option.
|
|
6771
|
+
* @throws {RequiredError}
|
|
6772
|
+
*/
|
|
6773
|
+
getInfoPush: (require?: string, include?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5890
6774
|
/**
|
|
5891
6775
|
* Fetches the JavaScript code to the frontend React website.
|
|
5892
6776
|
* @summary Download JavaScript
|
|
@@ -5940,6 +6824,15 @@ export declare const SystemApiFp: (configuration?: Configuration) => {
|
|
|
5940
6824
|
* @throws {RequiredError}
|
|
5941
6825
|
*/
|
|
5942
6826
|
getHealth(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIHealth>>;
|
|
6827
|
+
/**
|
|
6828
|
+
* 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.
|
|
6829
|
+
* @summary Show Information Notices
|
|
6830
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
6831
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6832
|
+
* @param {*} [options] Override http request option.
|
|
6833
|
+
* @throws {RequiredError}
|
|
6834
|
+
*/
|
|
6835
|
+
getInfoPush(require?: string, include?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InfoPush>>>;
|
|
5943
6836
|
/**
|
|
5944
6837
|
* Fetches the JavaScript code to the frontend React website.
|
|
5945
6838
|
* @summary Download JavaScript
|
|
@@ -5993,6 +6886,15 @@ export declare const SystemApiFactory: (configuration?: Configuration, basePath?
|
|
|
5993
6886
|
* @throws {RequiredError}
|
|
5994
6887
|
*/
|
|
5995
6888
|
getHealth(options?: any): AxiosPromise<APIHealth>;
|
|
6889
|
+
/**
|
|
6890
|
+
* 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.
|
|
6891
|
+
* @summary Show Information Notices
|
|
6892
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
6893
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6894
|
+
* @param {*} [options] Override http request option.
|
|
6895
|
+
* @throws {RequiredError}
|
|
6896
|
+
*/
|
|
6897
|
+
getInfoPush(require?: string, include?: string, options?: any): AxiosPromise<Array<InfoPush>>;
|
|
5996
6898
|
/**
|
|
5997
6899
|
* Fetches the JavaScript code to the frontend React website.
|
|
5998
6900
|
* @summary Download JavaScript
|
|
@@ -6052,6 +6954,16 @@ export declare class SystemApi extends BaseAPI {
|
|
|
6052
6954
|
* @memberof SystemApi
|
|
6053
6955
|
*/
|
|
6054
6956
|
getHealth(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<APIHealth>>;
|
|
6957
|
+
/**
|
|
6958
|
+
* 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.
|
|
6959
|
+
* @summary Show Information Notices
|
|
6960
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
6961
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6962
|
+
* @param {*} [options] Override http request option.
|
|
6963
|
+
* @throws {RequiredError}
|
|
6964
|
+
* @memberof SystemApi
|
|
6965
|
+
*/
|
|
6966
|
+
getInfoPush(require?: string, include?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InfoPush[]>>;
|
|
6055
6967
|
/**
|
|
6056
6968
|
* Fetches the JavaScript code to the frontend React website.
|
|
6057
6969
|
* @summary Download JavaScript
|
|
@@ -6275,7 +7187,7 @@ export declare const WorldsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
6275
7187
|
* @param {'ascending' | 'descending'} [order]
|
|
6276
7188
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
6277
7189
|
* @param {string} [search] Filters by world name.
|
|
6278
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
7190
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6279
7191
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
6280
7192
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
6281
7193
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -6294,7 +7206,7 @@ export declare const WorldsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
6294
7206
|
* @param {'ascending' | 'descending'} [order]
|
|
6295
7207
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
6296
7208
|
* @param {string} [search] Filters by world name.
|
|
6297
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
7209
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6298
7210
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
6299
7211
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
6300
7212
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -6314,7 +7226,7 @@ export declare const WorldsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
6314
7226
|
* @param {'ascending' | 'descending'} [order]
|
|
6315
7227
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
6316
7228
|
* @param {string} [search] Filters by world name.
|
|
6317
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
7229
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6318
7230
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
6319
7231
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
6320
7232
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -6378,7 +7290,7 @@ export declare const WorldsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
6378
7290
|
* @param {'ascending' | 'descending'} [order]
|
|
6379
7291
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
6380
7292
|
* @param {string} [search] Filters by world name.
|
|
6381
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
7293
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6382
7294
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
6383
7295
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
6384
7296
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -6436,7 +7348,7 @@ export declare const WorldsApiFp: (configuration?: Configuration) => {
|
|
|
6436
7348
|
* @param {'ascending' | 'descending'} [order]
|
|
6437
7349
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
6438
7350
|
* @param {string} [search] Filters by world name.
|
|
6439
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
7351
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6440
7352
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
6441
7353
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
6442
7354
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -6455,7 +7367,7 @@ export declare const WorldsApiFp: (configuration?: Configuration) => {
|
|
|
6455
7367
|
* @param {'ascending' | 'descending'} [order]
|
|
6456
7368
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
6457
7369
|
* @param {string} [search] Filters by world name.
|
|
6458
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
7370
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6459
7371
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
6460
7372
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
6461
7373
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -6475,7 +7387,7 @@ export declare const WorldsApiFp: (configuration?: Configuration) => {
|
|
|
6475
7387
|
* @param {'ascending' | 'descending'} [order]
|
|
6476
7388
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
6477
7389
|
* @param {string} [search] Filters by world name.
|
|
6478
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
7390
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6479
7391
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
6480
7392
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
6481
7393
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -6539,7 +7451,7 @@ export declare const WorldsApiFp: (configuration?: Configuration) => {
|
|
|
6539
7451
|
* @param {'ascending' | 'descending'} [order]
|
|
6540
7452
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
6541
7453
|
* @param {string} [search] Filters by world name.
|
|
6542
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
7454
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6543
7455
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
6544
7456
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
6545
7457
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -6597,7 +7509,7 @@ export declare const WorldsApiFactory: (configuration?: Configuration, basePath?
|
|
|
6597
7509
|
* @param {'ascending' | 'descending'} [order]
|
|
6598
7510
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
6599
7511
|
* @param {string} [search] Filters by world name.
|
|
6600
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
7512
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6601
7513
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
6602
7514
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
6603
7515
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -6616,7 +7528,7 @@ export declare const WorldsApiFactory: (configuration?: Configuration, basePath?
|
|
|
6616
7528
|
* @param {'ascending' | 'descending'} [order]
|
|
6617
7529
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
6618
7530
|
* @param {string} [search] Filters by world name.
|
|
6619
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
7531
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6620
7532
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
6621
7533
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
6622
7534
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -6636,7 +7548,7 @@ export declare const WorldsApiFactory: (configuration?: Configuration, basePath?
|
|
|
6636
7548
|
* @param {'ascending' | 'descending'} [order]
|
|
6637
7549
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
6638
7550
|
* @param {string} [search] Filters by world name.
|
|
6639
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
7551
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6640
7552
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
6641
7553
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
6642
7554
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -6700,7 +7612,7 @@ export declare const WorldsApiFactory: (configuration?: Configuration, basePath?
|
|
|
6700
7612
|
* @param {'ascending' | 'descending'} [order]
|
|
6701
7613
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
6702
7614
|
* @param {string} [search] Filters by world name.
|
|
6703
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
7615
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6704
7616
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
6705
7617
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
6706
7618
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -6762,7 +7674,7 @@ export declare class WorldsApi extends BaseAPI {
|
|
|
6762
7674
|
* @param {'ascending' | 'descending'} [order]
|
|
6763
7675
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
6764
7676
|
* @param {string} [search] Filters by world name.
|
|
6765
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
7677
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6766
7678
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
6767
7679
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
6768
7680
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -6782,7 +7694,7 @@ export declare class WorldsApi extends BaseAPI {
|
|
|
6782
7694
|
* @param {'ascending' | 'descending'} [order]
|
|
6783
7695
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
6784
7696
|
* @param {string} [search] Filters by world name.
|
|
6785
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
7697
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6786
7698
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
6787
7699
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
6788
7700
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -6803,7 +7715,7 @@ export declare class WorldsApi extends BaseAPI {
|
|
|
6803
7715
|
* @param {'ascending' | 'descending'} [order]
|
|
6804
7716
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
6805
7717
|
* @param {string} [search] Filters by world name.
|
|
6806
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
7718
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6807
7719
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
6808
7720
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
6809
7721
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -6873,7 +7785,7 @@ export declare class WorldsApi extends BaseAPI {
|
|
|
6873
7785
|
* @param {'ascending' | 'descending'} [order]
|
|
6874
7786
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
6875
7787
|
* @param {string} [search] Filters by world name.
|
|
6876
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
7788
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
6877
7789
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
6878
7790
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
6879
7791
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|