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/api.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* VRChat API Documentation
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 1.
|
|
6
|
+
* The version of the OpenAPI document: 1.6.3
|
|
7
7
|
* Contact: me@ruby.js.org
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -276,10 +276,10 @@ export interface APIConfig {
|
|
|
276
276
|
'downloadUrls': DownloadURLList;
|
|
277
277
|
/**
|
|
278
278
|
* Array of DynamicWorldRow objects, used by the game to display the list of world rows
|
|
279
|
-
* @type {Set<
|
|
279
|
+
* @type {Set<DynamicContentRow>}
|
|
280
280
|
* @memberof APIConfig
|
|
281
281
|
*/
|
|
282
|
-
'dynamicWorldRows': Set<
|
|
282
|
+
'dynamicWorldRows': Set<DynamicContentRow>;
|
|
283
283
|
/**
|
|
284
284
|
*
|
|
285
285
|
* @type {APIEventConfig}
|
|
@@ -294,7 +294,7 @@ export interface APIConfig {
|
|
|
294
294
|
*/
|
|
295
295
|
'gearDemoRoomId': string;
|
|
296
296
|
/**
|
|
297
|
-
*
|
|
297
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
298
298
|
* @type {string}
|
|
299
299
|
* @memberof APIConfig
|
|
300
300
|
*/
|
|
@@ -306,7 +306,7 @@ export interface APIConfig {
|
|
|
306
306
|
*/
|
|
307
307
|
'homepageRedirectTarget': string;
|
|
308
308
|
/**
|
|
309
|
-
*
|
|
309
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
310
310
|
* @type {string}
|
|
311
311
|
* @memberof APIConfig
|
|
312
312
|
*/
|
|
@@ -413,13 +413,13 @@ export interface APIConfig {
|
|
|
413
413
|
*/
|
|
414
414
|
'supportEmail': string;
|
|
415
415
|
/**
|
|
416
|
-
*
|
|
416
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
417
417
|
* @type {string}
|
|
418
418
|
* @memberof APIConfig
|
|
419
419
|
*/
|
|
420
420
|
'timeOutWorldId': string;
|
|
421
421
|
/**
|
|
422
|
-
*
|
|
422
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
423
423
|
* @type {string}
|
|
424
424
|
* @memberof APIConfig
|
|
425
425
|
*/
|
|
@@ -657,7 +657,7 @@ export interface Avatar {
|
|
|
657
657
|
*/
|
|
658
658
|
'assetUrlObject'?: object;
|
|
659
659
|
/**
|
|
660
|
-
*
|
|
660
|
+
* 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.
|
|
661
661
|
* @type {string}
|
|
662
662
|
* @memberof Avatar
|
|
663
663
|
*/
|
|
@@ -909,7 +909,7 @@ export interface CreateWorldRequest {
|
|
|
909
909
|
*/
|
|
910
910
|
'assetVersion'?: number;
|
|
911
911
|
/**
|
|
912
|
-
*
|
|
912
|
+
* 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.
|
|
913
913
|
* @type {string}
|
|
914
914
|
* @memberof CreateWorldRequest
|
|
915
915
|
*/
|
|
@@ -933,7 +933,7 @@ export interface CreateWorldRequest {
|
|
|
933
933
|
*/
|
|
934
934
|
'description'?: string;
|
|
935
935
|
/**
|
|
936
|
-
*
|
|
936
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
937
937
|
* @type {string}
|
|
938
938
|
* @memberof CreateWorldRequest
|
|
939
939
|
*/
|
|
@@ -1036,13 +1036,13 @@ export interface CurrentUser {
|
|
|
1036
1036
|
*/
|
|
1037
1037
|
'currentAvatarAssetUrl': string;
|
|
1038
1038
|
/**
|
|
1039
|
-
*
|
|
1039
|
+
* When profilePicOverride is not empty, use it instead.
|
|
1040
1040
|
* @type {string}
|
|
1041
1041
|
* @memberof CurrentUser
|
|
1042
1042
|
*/
|
|
1043
1043
|
'currentAvatarImageUrl': string;
|
|
1044
1044
|
/**
|
|
1045
|
-
*
|
|
1045
|
+
* When profilePicOverride is not empty, use it instead.
|
|
1046
1046
|
* @type {string}
|
|
1047
1047
|
* @memberof CurrentUser
|
|
1048
1048
|
*/
|
|
@@ -1121,13 +1121,13 @@ export interface CurrentUser {
|
|
|
1121
1121
|
*/
|
|
1122
1122
|
'hasPendingEmail': boolean;
|
|
1123
1123
|
/**
|
|
1124
|
-
*
|
|
1124
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
1125
1125
|
* @type {string}
|
|
1126
1126
|
* @memberof CurrentUser
|
|
1127
1127
|
*/
|
|
1128
1128
|
'homeLocation': string;
|
|
1129
1129
|
/**
|
|
1130
|
-
*
|
|
1130
|
+
* 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.
|
|
1131
1131
|
* @type {string}
|
|
1132
1132
|
* @memberof CurrentUser
|
|
1133
1133
|
*/
|
|
@@ -1320,51 +1320,57 @@ export interface DownloadURLList {
|
|
|
1320
1320
|
/**
|
|
1321
1321
|
*
|
|
1322
1322
|
* @export
|
|
1323
|
-
* @interface
|
|
1323
|
+
* @interface DynamicContentRow
|
|
1324
1324
|
*/
|
|
1325
|
-
export interface
|
|
1325
|
+
export interface DynamicContentRow {
|
|
1326
1326
|
/**
|
|
1327
1327
|
*
|
|
1328
1328
|
* @type {number}
|
|
1329
|
-
* @memberof
|
|
1329
|
+
* @memberof DynamicContentRow
|
|
1330
1330
|
*/
|
|
1331
|
-
'index'
|
|
1331
|
+
'index'?: number;
|
|
1332
1332
|
/**
|
|
1333
1333
|
*
|
|
1334
1334
|
* @type {string}
|
|
1335
|
-
* @memberof
|
|
1335
|
+
* @memberof DynamicContentRow
|
|
1336
1336
|
*/
|
|
1337
1337
|
'name': string;
|
|
1338
1338
|
/**
|
|
1339
|
-
*
|
|
1339
|
+
* Usually \"ThisPlatformSupported\", but can also be other values such as \"all\" or platform specific identifiers.
|
|
1340
1340
|
* @type {string}
|
|
1341
|
-
* @memberof
|
|
1341
|
+
* @memberof DynamicContentRow
|
|
1342
1342
|
*/
|
|
1343
1343
|
'platform': string;
|
|
1344
1344
|
/**
|
|
1345
1345
|
*
|
|
1346
1346
|
* @type {string}
|
|
1347
|
-
* @memberof
|
|
1347
|
+
* @memberof DynamicContentRow
|
|
1348
1348
|
*/
|
|
1349
1349
|
'sortHeading': string;
|
|
1350
1350
|
/**
|
|
1351
1351
|
*
|
|
1352
1352
|
* @type {string}
|
|
1353
|
-
* @memberof
|
|
1353
|
+
* @memberof DynamicContentRow
|
|
1354
1354
|
*/
|
|
1355
1355
|
'sortOrder': string;
|
|
1356
1356
|
/**
|
|
1357
1357
|
*
|
|
1358
1358
|
* @type {string}
|
|
1359
|
-
* @memberof
|
|
1359
|
+
* @memberof DynamicContentRow
|
|
1360
1360
|
*/
|
|
1361
1361
|
'sortOwnership': string;
|
|
1362
1362
|
/**
|
|
1363
|
-
* Tag to filter
|
|
1363
|
+
* Tag to filter content for this row.
|
|
1364
1364
|
* @type {string}
|
|
1365
|
-
* @memberof
|
|
1365
|
+
* @memberof DynamicContentRow
|
|
1366
1366
|
*/
|
|
1367
1367
|
'tag'?: string;
|
|
1368
|
+
/**
|
|
1369
|
+
* Type is not present if it is a world.
|
|
1370
|
+
* @type {string}
|
|
1371
|
+
* @memberof DynamicContentRow
|
|
1372
|
+
*/
|
|
1373
|
+
'type'?: string;
|
|
1368
1374
|
}
|
|
1369
1375
|
/**
|
|
1370
1376
|
*
|
|
@@ -1428,7 +1434,7 @@ export interface FavoriteGroup {
|
|
|
1428
1434
|
*/
|
|
1429
1435
|
'ownerDisplayName': string;
|
|
1430
1436
|
/**
|
|
1431
|
-
*
|
|
1437
|
+
* 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.
|
|
1432
1438
|
* @type {string}
|
|
1433
1439
|
* @memberof FavoriteGroup
|
|
1434
1440
|
*/
|
|
@@ -1708,19 +1714,203 @@ export interface FriendStatus {
|
|
|
1708
1714
|
/**
|
|
1709
1715
|
*
|
|
1710
1716
|
* @export
|
|
1711
|
-
* @interface
|
|
1717
|
+
* @interface InfoPush
|
|
1718
|
+
*/
|
|
1719
|
+
export interface InfoPush {
|
|
1720
|
+
/**
|
|
1721
|
+
*
|
|
1722
|
+
* @type {string}
|
|
1723
|
+
* @memberof InfoPush
|
|
1724
|
+
*/
|
|
1725
|
+
'id': string;
|
|
1726
|
+
/**
|
|
1727
|
+
*
|
|
1728
|
+
* @type {boolean}
|
|
1729
|
+
* @memberof InfoPush
|
|
1730
|
+
*/
|
|
1731
|
+
'isEnabled': boolean;
|
|
1732
|
+
/**
|
|
1733
|
+
*
|
|
1734
|
+
* @type {ReleaseStatus}
|
|
1735
|
+
* @memberof InfoPush
|
|
1736
|
+
*/
|
|
1737
|
+
'releaseStatus': ReleaseStatus;
|
|
1738
|
+
/**
|
|
1739
|
+
*
|
|
1740
|
+
* @type {number}
|
|
1741
|
+
* @memberof InfoPush
|
|
1742
|
+
*/
|
|
1743
|
+
'priority': number;
|
|
1744
|
+
/**
|
|
1745
|
+
*
|
|
1746
|
+
* @type {Array<string>}
|
|
1747
|
+
* @memberof InfoPush
|
|
1748
|
+
*/
|
|
1749
|
+
'tags': Array<string>;
|
|
1750
|
+
/**
|
|
1751
|
+
*
|
|
1752
|
+
* @type {InfoPushData}
|
|
1753
|
+
* @memberof InfoPush
|
|
1754
|
+
*/
|
|
1755
|
+
'data': InfoPushData;
|
|
1756
|
+
/**
|
|
1757
|
+
* Unknown usage, MD5
|
|
1758
|
+
* @type {string}
|
|
1759
|
+
* @memberof InfoPush
|
|
1760
|
+
*/
|
|
1761
|
+
'hash': string;
|
|
1762
|
+
/**
|
|
1763
|
+
*
|
|
1764
|
+
* @type {string}
|
|
1765
|
+
* @memberof InfoPush
|
|
1766
|
+
*/
|
|
1767
|
+
'createdAt': string;
|
|
1768
|
+
/**
|
|
1769
|
+
*
|
|
1770
|
+
* @type {string}
|
|
1771
|
+
* @memberof InfoPush
|
|
1772
|
+
*/
|
|
1773
|
+
'updatedAt': string;
|
|
1774
|
+
/**
|
|
1775
|
+
*
|
|
1776
|
+
* @type {string}
|
|
1777
|
+
* @memberof InfoPush
|
|
1778
|
+
*/
|
|
1779
|
+
'startDate'?: string;
|
|
1780
|
+
/**
|
|
1781
|
+
*
|
|
1782
|
+
* @type {string}
|
|
1783
|
+
* @memberof InfoPush
|
|
1784
|
+
*/
|
|
1785
|
+
'endDate'?: string;
|
|
1786
|
+
}
|
|
1787
|
+
/**
|
|
1788
|
+
*
|
|
1789
|
+
* @export
|
|
1790
|
+
* @interface InfoPushData
|
|
1791
|
+
*/
|
|
1792
|
+
export interface InfoPushData {
|
|
1793
|
+
/**
|
|
1794
|
+
*
|
|
1795
|
+
* @type {DynamicContentRow}
|
|
1796
|
+
* @memberof InfoPushData
|
|
1797
|
+
*/
|
|
1798
|
+
'contentList'?: DynamicContentRow;
|
|
1799
|
+
/**
|
|
1800
|
+
*
|
|
1801
|
+
* @type {string}
|
|
1802
|
+
* @memberof InfoPushData
|
|
1803
|
+
*/
|
|
1804
|
+
'description'?: string;
|
|
1805
|
+
/**
|
|
1806
|
+
*
|
|
1807
|
+
* @type {string}
|
|
1808
|
+
* @memberof InfoPushData
|
|
1809
|
+
*/
|
|
1810
|
+
'imageUrl'?: string;
|
|
1811
|
+
/**
|
|
1812
|
+
*
|
|
1813
|
+
* @type {string}
|
|
1814
|
+
* @memberof InfoPushData
|
|
1815
|
+
*/
|
|
1816
|
+
'name'?: string;
|
|
1817
|
+
/**
|
|
1818
|
+
*
|
|
1819
|
+
* @type {InfoPushDataClickable}
|
|
1820
|
+
* @memberof InfoPushData
|
|
1821
|
+
*/
|
|
1822
|
+
'onPressed'?: InfoPushDataClickable;
|
|
1823
|
+
/**
|
|
1824
|
+
*
|
|
1825
|
+
* @type {string}
|
|
1826
|
+
* @memberof InfoPushData
|
|
1827
|
+
*/
|
|
1828
|
+
'template'?: string;
|
|
1829
|
+
/**
|
|
1830
|
+
*
|
|
1831
|
+
* @type {string}
|
|
1832
|
+
* @memberof InfoPushData
|
|
1833
|
+
*/
|
|
1834
|
+
'version'?: string;
|
|
1835
|
+
/**
|
|
1836
|
+
*
|
|
1837
|
+
* @type {InfoPushDataArticle}
|
|
1838
|
+
* @memberof InfoPushData
|
|
1839
|
+
*/
|
|
1840
|
+
'article'?: InfoPushDataArticle;
|
|
1841
|
+
}
|
|
1842
|
+
/**
|
|
1843
|
+
*
|
|
1844
|
+
* @export
|
|
1845
|
+
* @interface InfoPushDataArticle
|
|
1846
|
+
*/
|
|
1847
|
+
export interface InfoPushDataArticle {
|
|
1848
|
+
/**
|
|
1849
|
+
*
|
|
1850
|
+
* @type {InfoPushDataArticleContent}
|
|
1851
|
+
* @memberof InfoPushDataArticle
|
|
1852
|
+
*/
|
|
1853
|
+
'content'?: InfoPushDataArticleContent;
|
|
1854
|
+
}
|
|
1855
|
+
/**
|
|
1856
|
+
*
|
|
1857
|
+
* @export
|
|
1858
|
+
* @interface InfoPushDataArticleContent
|
|
1712
1859
|
*/
|
|
1713
|
-
export interface
|
|
1860
|
+
export interface InfoPushDataArticleContent {
|
|
1714
1861
|
/**
|
|
1715
1862
|
*
|
|
1716
|
-
* @type {
|
|
1717
|
-
* @memberof
|
|
1863
|
+
* @type {string}
|
|
1864
|
+
* @memberof InfoPushDataArticleContent
|
|
1865
|
+
*/
|
|
1866
|
+
'text'?: string;
|
|
1867
|
+
/**
|
|
1868
|
+
*
|
|
1869
|
+
* @type {string}
|
|
1870
|
+
* @memberof InfoPushDataArticleContent
|
|
1871
|
+
*/
|
|
1872
|
+
'imageUrl'?: string;
|
|
1873
|
+
/**
|
|
1874
|
+
*
|
|
1875
|
+
* @type {InfoPushDataClickable}
|
|
1876
|
+
* @memberof InfoPushDataArticleContent
|
|
1718
1877
|
*/
|
|
1719
|
-
'
|
|
1878
|
+
'onPressed'?: InfoPushDataClickable;
|
|
1720
1879
|
}
|
|
1721
1880
|
/**
|
|
1722
1881
|
*
|
|
1723
1882
|
* @export
|
|
1883
|
+
* @interface InfoPushDataClickable
|
|
1884
|
+
*/
|
|
1885
|
+
export interface InfoPushDataClickable {
|
|
1886
|
+
/**
|
|
1887
|
+
*
|
|
1888
|
+
* @type {string}
|
|
1889
|
+
* @memberof InfoPushDataClickable
|
|
1890
|
+
*/
|
|
1891
|
+
'command': InfoPushDataClickableCommandEnum;
|
|
1892
|
+
/**
|
|
1893
|
+
* In case of OpenURL, this would contain the link.
|
|
1894
|
+
* @type {Array<string>}
|
|
1895
|
+
* @memberof InfoPushDataClickable
|
|
1896
|
+
*/
|
|
1897
|
+
'parameters'?: Array<string>;
|
|
1898
|
+
}
|
|
1899
|
+
|
|
1900
|
+
/**
|
|
1901
|
+
* @export
|
|
1902
|
+
* @enum {string}
|
|
1903
|
+
*/
|
|
1904
|
+
export enum InfoPushDataClickableCommandEnum {
|
|
1905
|
+
OpenUrl = 'OpenURL',
|
|
1906
|
+
OpenVrcPlusMenu = 'OpenVRCPlusMenu',
|
|
1907
|
+
OpenSafetyMenu = 'OpenSafetyMenu',
|
|
1908
|
+
CannedWorldSearch = 'CannedWorldSearch'
|
|
1909
|
+
}
|
|
1910
|
+
|
|
1911
|
+
/**
|
|
1912
|
+
* * `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.
|
|
1913
|
+
* @export
|
|
1724
1914
|
* @interface Instance
|
|
1725
1915
|
*/
|
|
1726
1916
|
export interface Instance {
|
|
@@ -1743,9 +1933,10 @@ export interface Instance {
|
|
|
1743
1933
|
*/
|
|
1744
1934
|
'capacity': number;
|
|
1745
1935
|
/**
|
|
1746
|
-
*
|
|
1936
|
+
* Always returns \"unknown\".
|
|
1747
1937
|
* @type {string}
|
|
1748
1938
|
* @memberof Instance
|
|
1939
|
+
* @deprecated
|
|
1749
1940
|
*/
|
|
1750
1941
|
'clientNumber': string;
|
|
1751
1942
|
/**
|
|
@@ -1755,7 +1946,7 @@ export interface Instance {
|
|
|
1755
1946
|
*/
|
|
1756
1947
|
'full': boolean;
|
|
1757
1948
|
/**
|
|
1758
|
-
*
|
|
1949
|
+
* InstanceID be \"offline\" on User profiles if you are not friends with that user.
|
|
1759
1950
|
* @type {string}
|
|
1760
1951
|
* @memberof Instance
|
|
1761
1952
|
*/
|
|
@@ -1767,7 +1958,7 @@ export interface Instance {
|
|
|
1767
1958
|
*/
|
|
1768
1959
|
'instanceId': string;
|
|
1769
1960
|
/**
|
|
1770
|
-
*
|
|
1961
|
+
* InstanceID be \"offline\" on User profiles if you are not friends with that user.
|
|
1771
1962
|
* @type {string}
|
|
1772
1963
|
* @memberof Instance
|
|
1773
1964
|
*/
|
|
@@ -1785,13 +1976,7 @@ export interface Instance {
|
|
|
1785
1976
|
*/
|
|
1786
1977
|
'name': string;
|
|
1787
1978
|
/**
|
|
1788
|
-
*
|
|
1789
|
-
* @type {string}
|
|
1790
|
-
* @memberof Instance
|
|
1791
|
-
*/
|
|
1792
|
-
'nonce'?: string;
|
|
1793
|
-
/**
|
|
1794
|
-
*
|
|
1979
|
+
* 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.
|
|
1795
1980
|
* @type {string}
|
|
1796
1981
|
* @memberof Instance
|
|
1797
1982
|
*/
|
|
@@ -1804,10 +1989,10 @@ export interface Instance {
|
|
|
1804
1989
|
'permanent': boolean;
|
|
1805
1990
|
/**
|
|
1806
1991
|
*
|
|
1807
|
-
* @type {
|
|
1992
|
+
* @type {Region}
|
|
1808
1993
|
* @memberof Instance
|
|
1809
1994
|
*/
|
|
1810
|
-
'photonRegion':
|
|
1995
|
+
'photonRegion': Region;
|
|
1811
1996
|
/**
|
|
1812
1997
|
*
|
|
1813
1998
|
* @type {InstancePlatforms}
|
|
@@ -1816,10 +2001,10 @@ export interface Instance {
|
|
|
1816
2001
|
'platforms': InstancePlatforms;
|
|
1817
2002
|
/**
|
|
1818
2003
|
*
|
|
1819
|
-
* @type {
|
|
2004
|
+
* @type {Region}
|
|
1820
2005
|
* @memberof Instance
|
|
1821
2006
|
*/
|
|
1822
|
-
'region':
|
|
2007
|
+
'region': Region;
|
|
1823
2008
|
/**
|
|
1824
2009
|
*
|
|
1825
2010
|
* @type {string}
|
|
@@ -1827,37 +2012,41 @@ export interface Instance {
|
|
|
1827
2012
|
*/
|
|
1828
2013
|
'shortName': string;
|
|
1829
2014
|
/**
|
|
1830
|
-
*
|
|
2015
|
+
* The tags array on Instances usually contain the language tags of the people in the instance.
|
|
1831
2016
|
* @type {Array<string>}
|
|
1832
2017
|
* @memberof Instance
|
|
1833
2018
|
*/
|
|
1834
2019
|
'tags': Array<string>;
|
|
1835
2020
|
/**
|
|
1836
2021
|
*
|
|
2022
|
+
* @type {InstanceType}
|
|
2023
|
+
* @memberof Instance
|
|
2024
|
+
*/
|
|
2025
|
+
'type': InstanceType;
|
|
2026
|
+
/**
|
|
2027
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
1837
2028
|
* @type {string}
|
|
1838
2029
|
* @memberof Instance
|
|
1839
2030
|
*/
|
|
1840
|
-
'
|
|
2031
|
+
'worldId': string;
|
|
1841
2032
|
/**
|
|
1842
|
-
*
|
|
1843
|
-
* @type {
|
|
2033
|
+
* 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.
|
|
2034
|
+
* @type {string}
|
|
1844
2035
|
* @memberof Instance
|
|
1845
|
-
* @deprecated
|
|
1846
2036
|
*/
|
|
1847
|
-
'
|
|
2037
|
+
'hidden'?: string;
|
|
1848
2038
|
/**
|
|
1849
|
-
*
|
|
1850
|
-
* @type {
|
|
2039
|
+
* 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.
|
|
2040
|
+
* @type {string}
|
|
1851
2041
|
* @memberof Instance
|
|
1852
|
-
* @deprecated
|
|
1853
2042
|
*/
|
|
1854
|
-
'
|
|
2043
|
+
'friends'?: string;
|
|
1855
2044
|
/**
|
|
1856
|
-
*
|
|
2045
|
+
* 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.
|
|
1857
2046
|
* @type {string}
|
|
1858
2047
|
* @memberof Instance
|
|
1859
2048
|
*/
|
|
1860
|
-
'
|
|
2049
|
+
'private'?: string;
|
|
1861
2050
|
}
|
|
1862
2051
|
/**
|
|
1863
2052
|
*
|
|
@@ -1878,6 +2067,19 @@ export interface InstancePlatforms {
|
|
|
1878
2067
|
*/
|
|
1879
2068
|
'standalonewindows': number;
|
|
1880
2069
|
}
|
|
2070
|
+
/**
|
|
2071
|
+
*
|
|
2072
|
+
* @export
|
|
2073
|
+
* @enum {string}
|
|
2074
|
+
*/
|
|
2075
|
+
|
|
2076
|
+
export enum InstanceType {
|
|
2077
|
+
Public = 'public',
|
|
2078
|
+
Hidden = 'hidden',
|
|
2079
|
+
Friends = 'friends',
|
|
2080
|
+
Private = 'private'
|
|
2081
|
+
}
|
|
2082
|
+
|
|
1881
2083
|
/**
|
|
1882
2084
|
*
|
|
1883
2085
|
* @export
|
|
@@ -1947,7 +2149,7 @@ export enum InviteMessageType {
|
|
|
1947
2149
|
*/
|
|
1948
2150
|
export interface InviteRequest {
|
|
1949
2151
|
/**
|
|
1950
|
-
*
|
|
2152
|
+
* InstanceID be \"offline\" on User profiles if you are not friends with that user.
|
|
1951
2153
|
* @type {string}
|
|
1952
2154
|
* @memberof InviteRequest
|
|
1953
2155
|
*/
|
|
@@ -1966,6 +2168,92 @@ export interface InviteResponse {
|
|
|
1966
2168
|
*/
|
|
1967
2169
|
'responseSlot': number;
|
|
1968
2170
|
}
|
|
2171
|
+
/**
|
|
2172
|
+
*
|
|
2173
|
+
* @export
|
|
2174
|
+
* @interface License
|
|
2175
|
+
*/
|
|
2176
|
+
export interface License {
|
|
2177
|
+
/**
|
|
2178
|
+
* Either a AvatarID, LicenseGroupID, PermissionID or ProductID. This depends on the `forType` field.
|
|
2179
|
+
* @type {string}
|
|
2180
|
+
* @memberof License
|
|
2181
|
+
*/
|
|
2182
|
+
'forId': string;
|
|
2183
|
+
/**
|
|
2184
|
+
*
|
|
2185
|
+
* @type {LicenseType}
|
|
2186
|
+
* @memberof License
|
|
2187
|
+
*/
|
|
2188
|
+
'forType': LicenseType;
|
|
2189
|
+
/**
|
|
2190
|
+
*
|
|
2191
|
+
* @type {string}
|
|
2192
|
+
* @memberof License
|
|
2193
|
+
*/
|
|
2194
|
+
'forName': string;
|
|
2195
|
+
/**
|
|
2196
|
+
*
|
|
2197
|
+
* @type {LicenseAction}
|
|
2198
|
+
* @memberof License
|
|
2199
|
+
*/
|
|
2200
|
+
'forAction': LicenseAction;
|
|
2201
|
+
}
|
|
2202
|
+
/**
|
|
2203
|
+
*
|
|
2204
|
+
* @export
|
|
2205
|
+
* @enum {string}
|
|
2206
|
+
*/
|
|
2207
|
+
|
|
2208
|
+
export enum LicenseAction {
|
|
2209
|
+
Wear = 'wear',
|
|
2210
|
+
Have = 'have'
|
|
2211
|
+
}
|
|
2212
|
+
|
|
2213
|
+
/**
|
|
2214
|
+
*
|
|
2215
|
+
* @export
|
|
2216
|
+
* @interface LicenseGroup
|
|
2217
|
+
*/
|
|
2218
|
+
export interface LicenseGroup {
|
|
2219
|
+
/**
|
|
2220
|
+
*
|
|
2221
|
+
* @type {string}
|
|
2222
|
+
* @memberof LicenseGroup
|
|
2223
|
+
*/
|
|
2224
|
+
'id': string;
|
|
2225
|
+
/**
|
|
2226
|
+
*
|
|
2227
|
+
* @type {string}
|
|
2228
|
+
* @memberof LicenseGroup
|
|
2229
|
+
*/
|
|
2230
|
+
'name': string;
|
|
2231
|
+
/**
|
|
2232
|
+
*
|
|
2233
|
+
* @type {string}
|
|
2234
|
+
* @memberof LicenseGroup
|
|
2235
|
+
*/
|
|
2236
|
+
'description': string;
|
|
2237
|
+
/**
|
|
2238
|
+
*
|
|
2239
|
+
* @type {Array<License>}
|
|
2240
|
+
* @memberof LicenseGroup
|
|
2241
|
+
*/
|
|
2242
|
+
'licenses': Array<License>;
|
|
2243
|
+
}
|
|
2244
|
+
/**
|
|
2245
|
+
*
|
|
2246
|
+
* @export
|
|
2247
|
+
* @enum {string}
|
|
2248
|
+
*/
|
|
2249
|
+
|
|
2250
|
+
export enum LicenseType {
|
|
2251
|
+
Avatar = 'avatar',
|
|
2252
|
+
LicenseGroup = 'licenseGroup',
|
|
2253
|
+
Permission = 'permission',
|
|
2254
|
+
Product = 'product'
|
|
2255
|
+
}
|
|
2256
|
+
|
|
1969
2257
|
/**
|
|
1970
2258
|
*
|
|
1971
2259
|
* @export
|
|
@@ -1998,13 +2286,13 @@ export interface LimitedUser {
|
|
|
1998
2286
|
*/
|
|
1999
2287
|
'bio'?: string;
|
|
2000
2288
|
/**
|
|
2001
|
-
*
|
|
2289
|
+
* When profilePicOverride is not empty, use it instead.
|
|
2002
2290
|
* @type {string}
|
|
2003
2291
|
* @memberof LimitedUser
|
|
2004
2292
|
*/
|
|
2005
2293
|
'currentAvatarImageUrl': string;
|
|
2006
2294
|
/**
|
|
2007
|
-
*
|
|
2295
|
+
* When profilePicOverride is not empty, use it instead.
|
|
2008
2296
|
* @type {string}
|
|
2009
2297
|
* @memberof LimitedUser
|
|
2010
2298
|
*/
|
|
@@ -2028,7 +2316,7 @@ export interface LimitedUser {
|
|
|
2028
2316
|
*/
|
|
2029
2317
|
'fallbackAvatar': string;
|
|
2030
2318
|
/**
|
|
2031
|
-
*
|
|
2319
|
+
* 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.
|
|
2032
2320
|
* @type {string}
|
|
2033
2321
|
* @memberof LimitedUser
|
|
2034
2322
|
*/
|
|
@@ -2101,7 +2389,7 @@ export interface LimitedUser {
|
|
|
2101
2389
|
*/
|
|
2102
2390
|
export interface LimitedWorld {
|
|
2103
2391
|
/**
|
|
2104
|
-
*
|
|
2392
|
+
* 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.
|
|
2105
2393
|
* @type {string}
|
|
2106
2394
|
* @memberof LimitedWorld
|
|
2107
2395
|
*/
|
|
@@ -2137,7 +2425,7 @@ export interface LimitedWorld {
|
|
|
2137
2425
|
*/
|
|
2138
2426
|
'heat': number;
|
|
2139
2427
|
/**
|
|
2140
|
-
*
|
|
2428
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
2141
2429
|
* @type {string}
|
|
2142
2430
|
* @memberof LimitedWorld
|
|
2143
2431
|
*/
|
|
@@ -2282,7 +2570,7 @@ export interface ModelFile {
|
|
|
2282
2570
|
*/
|
|
2283
2571
|
'name': string;
|
|
2284
2572
|
/**
|
|
2285
|
-
*
|
|
2573
|
+
* 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.
|
|
2286
2574
|
* @type {string}
|
|
2287
2575
|
* @memberof ModelFile
|
|
2288
2576
|
*/
|
|
@@ -2307,7 +2595,7 @@ export interface ModelFile {
|
|
|
2307
2595
|
*/
|
|
2308
2596
|
export interface ModerateUserRequest {
|
|
2309
2597
|
/**
|
|
2310
|
-
*
|
|
2598
|
+
* 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.
|
|
2311
2599
|
* @type {string}
|
|
2312
2600
|
* @memberof ModerateUserRequest
|
|
2313
2601
|
*/
|
|
@@ -2356,7 +2644,7 @@ export interface Notification {
|
|
|
2356
2644
|
*/
|
|
2357
2645
|
'seen': boolean;
|
|
2358
2646
|
/**
|
|
2359
|
-
*
|
|
2647
|
+
* 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.
|
|
2360
2648
|
* @type {string}
|
|
2361
2649
|
* @memberof Notification
|
|
2362
2650
|
*/
|
|
@@ -2427,7 +2715,7 @@ export interface Permission {
|
|
|
2427
2715
|
*/
|
|
2428
2716
|
'name': string;
|
|
2429
2717
|
/**
|
|
2430
|
-
*
|
|
2718
|
+
* 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.
|
|
2431
2719
|
* @type {string}
|
|
2432
2720
|
* @memberof Permission
|
|
2433
2721
|
*/
|
|
@@ -2464,7 +2752,7 @@ export interface PlayerModeration {
|
|
|
2464
2752
|
*/
|
|
2465
2753
|
'sourceDisplayName': string;
|
|
2466
2754
|
/**
|
|
2467
|
-
*
|
|
2755
|
+
* 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.
|
|
2468
2756
|
* @type {string}
|
|
2469
2757
|
* @memberof PlayerModeration
|
|
2470
2758
|
*/
|
|
@@ -2476,7 +2764,7 @@ export interface PlayerModeration {
|
|
|
2476
2764
|
*/
|
|
2477
2765
|
'targetDisplayName': string;
|
|
2478
2766
|
/**
|
|
2479
|
-
*
|
|
2767
|
+
* 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.
|
|
2480
2768
|
* @type {string}
|
|
2481
2769
|
* @memberof PlayerModeration
|
|
2482
2770
|
*/
|
|
@@ -2522,6 +2810,19 @@ export interface PublicAnnouncement {
|
|
|
2522
2810
|
*/
|
|
2523
2811
|
'text': string;
|
|
2524
2812
|
}
|
|
2813
|
+
/**
|
|
2814
|
+
* API/Photon region.
|
|
2815
|
+
* @export
|
|
2816
|
+
* @enum {string}
|
|
2817
|
+
*/
|
|
2818
|
+
|
|
2819
|
+
export enum Region {
|
|
2820
|
+
Us = 'us',
|
|
2821
|
+
Use = 'use',
|
|
2822
|
+
Eu = 'eu',
|
|
2823
|
+
Jp = 'jp'
|
|
2824
|
+
}
|
|
2825
|
+
|
|
2525
2826
|
/**
|
|
2526
2827
|
*
|
|
2527
2828
|
* @export
|
|
@@ -2556,15 +2857,323 @@ export interface Response {
|
|
|
2556
2857
|
/**
|
|
2557
2858
|
*
|
|
2558
2859
|
* @export
|
|
2559
|
-
* @interface
|
|
2860
|
+
* @interface Subscription
|
|
2560
2861
|
*/
|
|
2561
|
-
export interface
|
|
2862
|
+
export interface Subscription {
|
|
2562
2863
|
/**
|
|
2563
2864
|
*
|
|
2564
|
-
* @type {
|
|
2565
|
-
* @memberof
|
|
2865
|
+
* @type {string}
|
|
2866
|
+
* @memberof Subscription
|
|
2566
2867
|
*/
|
|
2567
|
-
'
|
|
2868
|
+
'id': string;
|
|
2869
|
+
/**
|
|
2870
|
+
*
|
|
2871
|
+
* @type {string}
|
|
2872
|
+
* @memberof Subscription
|
|
2873
|
+
*/
|
|
2874
|
+
'steamItemId': string;
|
|
2875
|
+
/**
|
|
2876
|
+
*
|
|
2877
|
+
* @type {number}
|
|
2878
|
+
* @memberof Subscription
|
|
2879
|
+
*/
|
|
2880
|
+
'amount': number;
|
|
2881
|
+
/**
|
|
2882
|
+
*
|
|
2883
|
+
* @type {string}
|
|
2884
|
+
* @memberof Subscription
|
|
2885
|
+
*/
|
|
2886
|
+
'description': string;
|
|
2887
|
+
/**
|
|
2888
|
+
*
|
|
2889
|
+
* @type {SubscriptionPeriod}
|
|
2890
|
+
* @memberof Subscription
|
|
2891
|
+
*/
|
|
2892
|
+
'period': SubscriptionPeriod;
|
|
2893
|
+
/**
|
|
2894
|
+
*
|
|
2895
|
+
* @type {number}
|
|
2896
|
+
* @memberof Subscription
|
|
2897
|
+
*/
|
|
2898
|
+
'tier': number;
|
|
2899
|
+
}
|
|
2900
|
+
/**
|
|
2901
|
+
*
|
|
2902
|
+
* @export
|
|
2903
|
+
* @enum {string}
|
|
2904
|
+
*/
|
|
2905
|
+
|
|
2906
|
+
export enum SubscriptionPeriod {
|
|
2907
|
+
Hour = 'hour',
|
|
2908
|
+
Day = 'day',
|
|
2909
|
+
Week = 'week',
|
|
2910
|
+
Month = 'month',
|
|
2911
|
+
Year = 'year'
|
|
2912
|
+
}
|
|
2913
|
+
|
|
2914
|
+
/**
|
|
2915
|
+
*
|
|
2916
|
+
* @export
|
|
2917
|
+
* @interface Success
|
|
2918
|
+
*/
|
|
2919
|
+
export interface Success {
|
|
2920
|
+
/**
|
|
2921
|
+
*
|
|
2922
|
+
* @type {Response}
|
|
2923
|
+
* @memberof Success
|
|
2924
|
+
*/
|
|
2925
|
+
'success'?: Response;
|
|
2926
|
+
}
|
|
2927
|
+
/**
|
|
2928
|
+
*
|
|
2929
|
+
* @export
|
|
2930
|
+
* @interface Transaction
|
|
2931
|
+
*/
|
|
2932
|
+
export interface Transaction {
|
|
2933
|
+
/**
|
|
2934
|
+
*
|
|
2935
|
+
* @type {string}
|
|
2936
|
+
* @memberof Transaction
|
|
2937
|
+
*/
|
|
2938
|
+
'id': string;
|
|
2939
|
+
/**
|
|
2940
|
+
*
|
|
2941
|
+
* @type {TransactionStatus}
|
|
2942
|
+
* @memberof Transaction
|
|
2943
|
+
*/
|
|
2944
|
+
'status': TransactionStatus;
|
|
2945
|
+
/**
|
|
2946
|
+
*
|
|
2947
|
+
* @type {Subscription}
|
|
2948
|
+
* @memberof Transaction
|
|
2949
|
+
*/
|
|
2950
|
+
'subscription': Subscription;
|
|
2951
|
+
/**
|
|
2952
|
+
*
|
|
2953
|
+
* @type {boolean}
|
|
2954
|
+
* @memberof Transaction
|
|
2955
|
+
*/
|
|
2956
|
+
'sandbox': boolean;
|
|
2957
|
+
/**
|
|
2958
|
+
*
|
|
2959
|
+
* @type {string}
|
|
2960
|
+
* @memberof Transaction
|
|
2961
|
+
*/
|
|
2962
|
+
'created_at': string;
|
|
2963
|
+
/**
|
|
2964
|
+
*
|
|
2965
|
+
* @type {string}
|
|
2966
|
+
* @memberof Transaction
|
|
2967
|
+
*/
|
|
2968
|
+
'updated_at': string;
|
|
2969
|
+
/**
|
|
2970
|
+
*
|
|
2971
|
+
* @type {TransactionSteamInfo}
|
|
2972
|
+
* @memberof Transaction
|
|
2973
|
+
*/
|
|
2974
|
+
'steam'?: TransactionSteamInfo;
|
|
2975
|
+
/**
|
|
2976
|
+
*
|
|
2977
|
+
* @type {TransactionAgreement}
|
|
2978
|
+
* @memberof Transaction
|
|
2979
|
+
*/
|
|
2980
|
+
'agreement'?: TransactionAgreement;
|
|
2981
|
+
/**
|
|
2982
|
+
*
|
|
2983
|
+
* @type {string}
|
|
2984
|
+
* @memberof Transaction
|
|
2985
|
+
*/
|
|
2986
|
+
'error': string;
|
|
2987
|
+
}
|
|
2988
|
+
/**
|
|
2989
|
+
*
|
|
2990
|
+
* @export
|
|
2991
|
+
* @interface TransactionAgreement
|
|
2992
|
+
*/
|
|
2993
|
+
export interface TransactionAgreement {
|
|
2994
|
+
/**
|
|
2995
|
+
*
|
|
2996
|
+
* @type {string}
|
|
2997
|
+
* @memberof TransactionAgreement
|
|
2998
|
+
*/
|
|
2999
|
+
'agreementId': string;
|
|
3000
|
+
/**
|
|
3001
|
+
*
|
|
3002
|
+
* @type {number}
|
|
3003
|
+
* @memberof TransactionAgreement
|
|
3004
|
+
*/
|
|
3005
|
+
'itemId': number;
|
|
3006
|
+
/**
|
|
3007
|
+
* This is NOT TransactionStatus, but whatever Steam return.
|
|
3008
|
+
* @type {string}
|
|
3009
|
+
* @memberof TransactionAgreement
|
|
3010
|
+
*/
|
|
3011
|
+
'status': string;
|
|
3012
|
+
/**
|
|
3013
|
+
*
|
|
3014
|
+
* @type {string}
|
|
3015
|
+
* @memberof TransactionAgreement
|
|
3016
|
+
*/
|
|
3017
|
+
'period': string;
|
|
3018
|
+
/**
|
|
3019
|
+
*
|
|
3020
|
+
* @type {number}
|
|
3021
|
+
* @memberof TransactionAgreement
|
|
3022
|
+
*/
|
|
3023
|
+
'frequency': number;
|
|
3024
|
+
/**
|
|
3025
|
+
*
|
|
3026
|
+
* @type {string}
|
|
3027
|
+
* @memberof TransactionAgreement
|
|
3028
|
+
*/
|
|
3029
|
+
'billingType': string;
|
|
3030
|
+
/**
|
|
3031
|
+
*
|
|
3032
|
+
* @type {string}
|
|
3033
|
+
* @memberof TransactionAgreement
|
|
3034
|
+
*/
|
|
3035
|
+
'startDate': string;
|
|
3036
|
+
/**
|
|
3037
|
+
*
|
|
3038
|
+
* @type {string}
|
|
3039
|
+
* @memberof TransactionAgreement
|
|
3040
|
+
*/
|
|
3041
|
+
'endDate': string;
|
|
3042
|
+
/**
|
|
3043
|
+
*
|
|
3044
|
+
* @type {number}
|
|
3045
|
+
* @memberof TransactionAgreement
|
|
3046
|
+
*/
|
|
3047
|
+
'recurringAmt': number;
|
|
3048
|
+
/**
|
|
3049
|
+
*
|
|
3050
|
+
* @type {string}
|
|
3051
|
+
* @memberof TransactionAgreement
|
|
3052
|
+
*/
|
|
3053
|
+
'currency': string;
|
|
3054
|
+
/**
|
|
3055
|
+
*
|
|
3056
|
+
* @type {string}
|
|
3057
|
+
* @memberof TransactionAgreement
|
|
3058
|
+
*/
|
|
3059
|
+
'timeCreated': string;
|
|
3060
|
+
/**
|
|
3061
|
+
*
|
|
3062
|
+
* @type {string}
|
|
3063
|
+
* @memberof TransactionAgreement
|
|
3064
|
+
*/
|
|
3065
|
+
'nextPayment': string;
|
|
3066
|
+
/**
|
|
3067
|
+
*
|
|
3068
|
+
* @type {string}
|
|
3069
|
+
* @memberof TransactionAgreement
|
|
3070
|
+
*/
|
|
3071
|
+
'lastPayment': string;
|
|
3072
|
+
/**
|
|
3073
|
+
*
|
|
3074
|
+
* @type {number}
|
|
3075
|
+
* @memberof TransactionAgreement
|
|
3076
|
+
*/
|
|
3077
|
+
'lastAmount': number;
|
|
3078
|
+
/**
|
|
3079
|
+
*
|
|
3080
|
+
* @type {number}
|
|
3081
|
+
* @memberof TransactionAgreement
|
|
3082
|
+
*/
|
|
3083
|
+
'lastAmountVat': number;
|
|
3084
|
+
/**
|
|
3085
|
+
*
|
|
3086
|
+
* @type {number}
|
|
3087
|
+
* @memberof TransactionAgreement
|
|
3088
|
+
*/
|
|
3089
|
+
'outstanding': number;
|
|
3090
|
+
/**
|
|
3091
|
+
*
|
|
3092
|
+
* @type {number}
|
|
3093
|
+
* @memberof TransactionAgreement
|
|
3094
|
+
*/
|
|
3095
|
+
'failedAttempts': number;
|
|
3096
|
+
}
|
|
3097
|
+
/**
|
|
3098
|
+
*
|
|
3099
|
+
* @export
|
|
3100
|
+
* @enum {string}
|
|
3101
|
+
*/
|
|
3102
|
+
|
|
3103
|
+
export enum TransactionStatus {
|
|
3104
|
+
Active = 'active',
|
|
3105
|
+
Failed = 'failed',
|
|
3106
|
+
Expired = 'expired',
|
|
3107
|
+
Chargeback = 'chargeback'
|
|
3108
|
+
}
|
|
3109
|
+
|
|
3110
|
+
/**
|
|
3111
|
+
*
|
|
3112
|
+
* @export
|
|
3113
|
+
* @interface TransactionSteamInfo
|
|
3114
|
+
*/
|
|
3115
|
+
export interface TransactionSteamInfo {
|
|
3116
|
+
/**
|
|
3117
|
+
*
|
|
3118
|
+
* @type {TransactionSteamWalletInfo}
|
|
3119
|
+
* @memberof TransactionSteamInfo
|
|
3120
|
+
*/
|
|
3121
|
+
'walletInfo': TransactionSteamWalletInfo;
|
|
3122
|
+
/**
|
|
3123
|
+
* Steam User ID
|
|
3124
|
+
* @type {string}
|
|
3125
|
+
* @memberof TransactionSteamInfo
|
|
3126
|
+
*/
|
|
3127
|
+
'steamId': string;
|
|
3128
|
+
/**
|
|
3129
|
+
* Steam Order ID
|
|
3130
|
+
* @type {string}
|
|
3131
|
+
* @memberof TransactionSteamInfo
|
|
3132
|
+
*/
|
|
3133
|
+
'orderId': string;
|
|
3134
|
+
/**
|
|
3135
|
+
* Empty
|
|
3136
|
+
* @type {string}
|
|
3137
|
+
* @memberof TransactionSteamInfo
|
|
3138
|
+
*/
|
|
3139
|
+
'steamUrl': string;
|
|
3140
|
+
/**
|
|
3141
|
+
* Steam Transaction ID, NOT the same as VRChat TransactionID
|
|
3142
|
+
* @type {string}
|
|
3143
|
+
* @memberof TransactionSteamInfo
|
|
3144
|
+
*/
|
|
3145
|
+
'transId': string;
|
|
3146
|
+
}
|
|
3147
|
+
/**
|
|
3148
|
+
*
|
|
3149
|
+
* @export
|
|
3150
|
+
* @interface TransactionSteamWalletInfo
|
|
3151
|
+
*/
|
|
3152
|
+
export interface TransactionSteamWalletInfo {
|
|
3153
|
+
/**
|
|
3154
|
+
*
|
|
3155
|
+
* @type {string}
|
|
3156
|
+
* @memberof TransactionSteamWalletInfo
|
|
3157
|
+
*/
|
|
3158
|
+
'state': string;
|
|
3159
|
+
/**
|
|
3160
|
+
*
|
|
3161
|
+
* @type {string}
|
|
3162
|
+
* @memberof TransactionSteamWalletInfo
|
|
3163
|
+
*/
|
|
3164
|
+
'country': string;
|
|
3165
|
+
/**
|
|
3166
|
+
*
|
|
3167
|
+
* @type {string}
|
|
3168
|
+
* @memberof TransactionSteamWalletInfo
|
|
3169
|
+
*/
|
|
3170
|
+
'currency': string;
|
|
3171
|
+
/**
|
|
3172
|
+
*
|
|
3173
|
+
* @type {string}
|
|
3174
|
+
* @memberof TransactionSteamWalletInfo
|
|
3175
|
+
*/
|
|
3176
|
+
'status': string;
|
|
2568
3177
|
}
|
|
2569
3178
|
/**
|
|
2570
3179
|
*
|
|
@@ -2825,7 +3434,7 @@ export interface UpdateWorldRequest {
|
|
|
2825
3434
|
*/
|
|
2826
3435
|
'assetVersion'?: string;
|
|
2827
3436
|
/**
|
|
2828
|
-
*
|
|
3437
|
+
* 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.
|
|
2829
3438
|
* @type {string}
|
|
2830
3439
|
* @memberof UpdateWorldRequest
|
|
2831
3440
|
*/
|
|
@@ -2916,13 +3525,13 @@ export interface User {
|
|
|
2916
3525
|
*/
|
|
2917
3526
|
'bioLinks': Array<string>;
|
|
2918
3527
|
/**
|
|
2919
|
-
*
|
|
3528
|
+
* When profilePicOverride is not empty, use it instead.
|
|
2920
3529
|
* @type {string}
|
|
2921
3530
|
* @memberof User
|
|
2922
3531
|
*/
|
|
2923
3532
|
'currentAvatarImageUrl': string;
|
|
2924
3533
|
/**
|
|
2925
|
-
*
|
|
3534
|
+
* When profilePicOverride is not empty, use it instead.
|
|
2926
3535
|
* @type {string}
|
|
2927
3536
|
* @memberof User
|
|
2928
3537
|
*/
|
|
@@ -2940,7 +3549,7 @@ export interface User {
|
|
|
2940
3549
|
*/
|
|
2941
3550
|
'developerType': DeveloperType;
|
|
2942
3551
|
/**
|
|
2943
|
-
*
|
|
3552
|
+
* 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.
|
|
2944
3553
|
* @type {string}
|
|
2945
3554
|
* @memberof User
|
|
2946
3555
|
*/
|
|
@@ -2952,25 +3561,25 @@ export interface User {
|
|
|
2952
3561
|
*/
|
|
2953
3562
|
'friendKey': string;
|
|
2954
3563
|
/**
|
|
2955
|
-
*
|
|
3564
|
+
* 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.
|
|
2956
3565
|
* @type {string}
|
|
2957
3566
|
* @memberof User
|
|
2958
3567
|
*/
|
|
2959
3568
|
'id': string;
|
|
2960
3569
|
/**
|
|
2961
|
-
*
|
|
3570
|
+
* InstanceID be \"offline\" on User profiles if you are not friends with that user.
|
|
2962
3571
|
* @type {string}
|
|
2963
3572
|
* @memberof User
|
|
2964
3573
|
*/
|
|
2965
3574
|
'instanceId'?: string;
|
|
2966
3575
|
/**
|
|
2967
|
-
*
|
|
3576
|
+
* Either their `friendKey`, or empty string if you are not friends. Unknown usage.
|
|
2968
3577
|
* @type {boolean}
|
|
2969
3578
|
* @memberof User
|
|
2970
3579
|
*/
|
|
2971
3580
|
'isFriend': boolean;
|
|
2972
3581
|
/**
|
|
2973
|
-
*
|
|
3582
|
+
* Either a date-time or empty string.
|
|
2974
3583
|
* @type {string}
|
|
2975
3584
|
* @memberof User
|
|
2976
3585
|
*/
|
|
@@ -2982,7 +3591,7 @@ export interface User {
|
|
|
2982
3591
|
*/
|
|
2983
3592
|
'last_platform': string;
|
|
2984
3593
|
/**
|
|
2985
|
-
*
|
|
3594
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
2986
3595
|
* @type {string}
|
|
2987
3596
|
* @memberof User
|
|
2988
3597
|
*/
|
|
@@ -3024,13 +3633,13 @@ export interface User {
|
|
|
3024
3633
|
*/
|
|
3025
3634
|
'userIcon': string;
|
|
3026
3635
|
/**
|
|
3027
|
-
*
|
|
3636
|
+
* 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.
|
|
3028
3637
|
* @type {string}
|
|
3029
3638
|
* @memberof User
|
|
3030
3639
|
*/
|
|
3031
3640
|
'username': string;
|
|
3032
3641
|
/**
|
|
3033
|
-
*
|
|
3642
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
3034
3643
|
* @type {string}
|
|
3035
3644
|
* @memberof User
|
|
3036
3645
|
*/
|
|
@@ -3078,65 +3687,162 @@ export enum UserStatus {
|
|
|
3078
3687
|
/**
|
|
3079
3688
|
*
|
|
3080
3689
|
* @export
|
|
3081
|
-
* @interface
|
|
3690
|
+
* @interface UserSubscription
|
|
3082
3691
|
*/
|
|
3083
|
-
export interface
|
|
3692
|
+
export interface UserSubscription {
|
|
3084
3693
|
/**
|
|
3085
3694
|
*
|
|
3086
|
-
* @type {
|
|
3087
|
-
* @memberof
|
|
3695
|
+
* @type {string}
|
|
3696
|
+
* @memberof UserSubscription
|
|
3088
3697
|
*/
|
|
3089
|
-
'
|
|
3090
|
-
}
|
|
3091
|
-
/**
|
|
3092
|
-
*
|
|
3093
|
-
* @export
|
|
3094
|
-
* @interface VerifyAuthTokenResult
|
|
3095
|
-
*/
|
|
3096
|
-
export interface VerifyAuthTokenResult {
|
|
3698
|
+
'id': string;
|
|
3097
3699
|
/**
|
|
3098
3700
|
*
|
|
3099
|
-
* @type {
|
|
3100
|
-
* @memberof
|
|
3701
|
+
* @type {string}
|
|
3702
|
+
* @memberof UserSubscription
|
|
3101
3703
|
*/
|
|
3102
|
-
'
|
|
3704
|
+
'transactionId': string;
|
|
3103
3705
|
/**
|
|
3104
|
-
*
|
|
3706
|
+
* Which \"Store\" it came from. Right now only Stores are \"Steam\" and \"Admin\".
|
|
3105
3707
|
* @type {string}
|
|
3106
|
-
* @memberof
|
|
3708
|
+
* @memberof UserSubscription
|
|
3107
3709
|
*/
|
|
3108
|
-
'
|
|
3109
|
-
}
|
|
3110
|
-
/**
|
|
3111
|
-
*
|
|
3112
|
-
* @export
|
|
3113
|
-
* @interface World
|
|
3114
|
-
*/
|
|
3115
|
-
export interface World {
|
|
3710
|
+
'store': string;
|
|
3116
3711
|
/**
|
|
3117
3712
|
*
|
|
3118
3713
|
* @type {string}
|
|
3119
|
-
* @memberof
|
|
3714
|
+
* @memberof UserSubscription
|
|
3120
3715
|
*/
|
|
3121
|
-
'
|
|
3716
|
+
'steamItemId'?: string;
|
|
3122
3717
|
/**
|
|
3123
3718
|
*
|
|
3124
|
-
* @type {
|
|
3125
|
-
* @memberof
|
|
3719
|
+
* @type {number}
|
|
3720
|
+
* @memberof UserSubscription
|
|
3126
3721
|
*/
|
|
3127
|
-
'
|
|
3722
|
+
'amount': number;
|
|
3128
3723
|
/**
|
|
3129
3724
|
*
|
|
3130
3725
|
* @type {string}
|
|
3131
|
-
* @memberof
|
|
3726
|
+
* @memberof UserSubscription
|
|
3132
3727
|
*/
|
|
3133
|
-
'
|
|
3728
|
+
'description': string;
|
|
3134
3729
|
/**
|
|
3135
3730
|
*
|
|
3136
|
-
* @type {
|
|
3137
|
-
* @memberof
|
|
3731
|
+
* @type {SubscriptionPeriod}
|
|
3732
|
+
* @memberof UserSubscription
|
|
3138
3733
|
*/
|
|
3139
|
-
'
|
|
3734
|
+
'period': SubscriptionPeriod;
|
|
3735
|
+
/**
|
|
3736
|
+
*
|
|
3737
|
+
* @type {number}
|
|
3738
|
+
* @memberof UserSubscription
|
|
3739
|
+
*/
|
|
3740
|
+
'tier': number;
|
|
3741
|
+
/**
|
|
3742
|
+
*
|
|
3743
|
+
* @type {boolean}
|
|
3744
|
+
* @memberof UserSubscription
|
|
3745
|
+
*/
|
|
3746
|
+
'active': boolean;
|
|
3747
|
+
/**
|
|
3748
|
+
*
|
|
3749
|
+
* @type {TransactionStatus}
|
|
3750
|
+
* @memberof UserSubscription
|
|
3751
|
+
*/
|
|
3752
|
+
'status': TransactionStatus;
|
|
3753
|
+
/**
|
|
3754
|
+
*
|
|
3755
|
+
* @type {string}
|
|
3756
|
+
* @memberof UserSubscription
|
|
3757
|
+
*/
|
|
3758
|
+
'expires': string;
|
|
3759
|
+
/**
|
|
3760
|
+
*
|
|
3761
|
+
* @type {string}
|
|
3762
|
+
* @memberof UserSubscription
|
|
3763
|
+
*/
|
|
3764
|
+
'created_at': string;
|
|
3765
|
+
/**
|
|
3766
|
+
*
|
|
3767
|
+
* @type {string}
|
|
3768
|
+
* @memberof UserSubscription
|
|
3769
|
+
*/
|
|
3770
|
+
'updated_at': string;
|
|
3771
|
+
/**
|
|
3772
|
+
*
|
|
3773
|
+
* @type {Array<string>}
|
|
3774
|
+
* @memberof UserSubscription
|
|
3775
|
+
*/
|
|
3776
|
+
'licenseGroups': Array<string>;
|
|
3777
|
+
/**
|
|
3778
|
+
*
|
|
3779
|
+
* @type {boolean}
|
|
3780
|
+
* @memberof UserSubscription
|
|
3781
|
+
*/
|
|
3782
|
+
'isGift': boolean;
|
|
3783
|
+
}
|
|
3784
|
+
/**
|
|
3785
|
+
*
|
|
3786
|
+
* @export
|
|
3787
|
+
* @interface Verify2FAResult
|
|
3788
|
+
*/
|
|
3789
|
+
export interface Verify2FAResult {
|
|
3790
|
+
/**
|
|
3791
|
+
*
|
|
3792
|
+
* @type {boolean}
|
|
3793
|
+
* @memberof Verify2FAResult
|
|
3794
|
+
*/
|
|
3795
|
+
'verified': boolean;
|
|
3796
|
+
}
|
|
3797
|
+
/**
|
|
3798
|
+
*
|
|
3799
|
+
* @export
|
|
3800
|
+
* @interface VerifyAuthTokenResult
|
|
3801
|
+
*/
|
|
3802
|
+
export interface VerifyAuthTokenResult {
|
|
3803
|
+
/**
|
|
3804
|
+
*
|
|
3805
|
+
* @type {boolean}
|
|
3806
|
+
* @memberof VerifyAuthTokenResult
|
|
3807
|
+
*/
|
|
3808
|
+
'ok': boolean;
|
|
3809
|
+
/**
|
|
3810
|
+
*
|
|
3811
|
+
* @type {string}
|
|
3812
|
+
* @memberof VerifyAuthTokenResult
|
|
3813
|
+
*/
|
|
3814
|
+
'token': string;
|
|
3815
|
+
}
|
|
3816
|
+
/**
|
|
3817
|
+
*
|
|
3818
|
+
* @export
|
|
3819
|
+
* @interface World
|
|
3820
|
+
*/
|
|
3821
|
+
export interface World {
|
|
3822
|
+
/**
|
|
3823
|
+
* Empty if unauthenticated.
|
|
3824
|
+
* @type {string}
|
|
3825
|
+
* @memberof World
|
|
3826
|
+
*/
|
|
3827
|
+
'assetUrl': string;
|
|
3828
|
+
/**
|
|
3829
|
+
*
|
|
3830
|
+
* @type {object}
|
|
3831
|
+
* @memberof World
|
|
3832
|
+
*/
|
|
3833
|
+
'assetUrlObject': object;
|
|
3834
|
+
/**
|
|
3835
|
+
* 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.
|
|
3836
|
+
* @type {string}
|
|
3837
|
+
* @memberof World
|
|
3838
|
+
*/
|
|
3839
|
+
'authorId': string;
|
|
3840
|
+
/**
|
|
3841
|
+
*
|
|
3842
|
+
* @type {string}
|
|
3843
|
+
* @memberof World
|
|
3844
|
+
*/
|
|
3845
|
+
'authorName': string;
|
|
3140
3846
|
/**
|
|
3141
3847
|
*
|
|
3142
3848
|
* @type {number}
|
|
@@ -3174,7 +3880,7 @@ export interface World {
|
|
|
3174
3880
|
*/
|
|
3175
3881
|
'heat': number;
|
|
3176
3882
|
/**
|
|
3177
|
-
*
|
|
3883
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
3178
3884
|
* @type {string}
|
|
3179
3885
|
* @memberof World
|
|
3180
3886
|
*/
|
|
@@ -3187,10 +3893,10 @@ export interface World {
|
|
|
3187
3893
|
'imageUrl': string;
|
|
3188
3894
|
/**
|
|
3189
3895
|
*
|
|
3190
|
-
* @type {Array<Array<
|
|
3896
|
+
* @type {Array<Array<any>>}
|
|
3191
3897
|
* @memberof World
|
|
3192
3898
|
*/
|
|
3193
|
-
'instances'?: Array<Array<
|
|
3899
|
+
'instances'?: Array<Array<any>>;
|
|
3194
3900
|
/**
|
|
3195
3901
|
*
|
|
3196
3902
|
* @type {string}
|
|
@@ -3282,7 +3988,7 @@ export interface World {
|
|
|
3282
3988
|
*/
|
|
3283
3989
|
'unityPackageUrlObject': object;
|
|
3284
3990
|
/**
|
|
3285
|
-
*
|
|
3991
|
+
* Empty if unauthenticated.
|
|
3286
3992
|
* @type {Array<UnityPackage>}
|
|
3287
3993
|
* @memberof World
|
|
3288
3994
|
*/
|
|
@@ -3313,7 +4019,7 @@ export interface World {
|
|
|
3313
4019
|
*/
|
|
3314
4020
|
export interface WorldMetadata {
|
|
3315
4021
|
/**
|
|
3316
|
-
*
|
|
4022
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
3317
4023
|
* @type {string}
|
|
3318
4024
|
* @memberof WorldMetadata
|
|
3319
4025
|
*/
|
|
@@ -4001,7 +4707,7 @@ export const AvatarsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
4001
4707
|
* @param {'ascending' | 'descending'} [order]
|
|
4002
4708
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
4003
4709
|
* @param {string} [search] Filters by world name.
|
|
4004
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
4710
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
4005
4711
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
4006
4712
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
4007
4713
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -4101,7 +4807,7 @@ export const AvatarsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
4101
4807
|
* @param {number} [n] The number of objects to return.
|
|
4102
4808
|
* @param {'ascending' | 'descending'} [order]
|
|
4103
4809
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
4104
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
4810
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
4105
4811
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
4106
4812
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
4107
4813
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -4360,7 +5066,7 @@ export const AvatarsApiFp = function(configuration?: Configuration) {
|
|
|
4360
5066
|
* @param {'ascending' | 'descending'} [order]
|
|
4361
5067
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
4362
5068
|
* @param {string} [search] Filters by world name.
|
|
4363
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
5069
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
4364
5070
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
4365
5071
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
4366
5072
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -4375,306 +5081,682 @@ export const AvatarsApiFp = function(configuration?: Configuration) {
|
|
|
4375
5081
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
4376
5082
|
},
|
|
4377
5083
|
/**
|
|
4378
|
-
* Search and list avatars by query filters. You can only search your own or featured avatars. It is not possible as a normal user to search other peoples avatars.
|
|
4379
|
-
* @summary Search Avatars
|
|
4380
|
-
* @param {string} [featured] Filters on featured results.
|
|
4381
|
-
* @param {'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name'} [sort]
|
|
4382
|
-
* @param {'me'} [user] Set to `me` for searching own avatars.
|
|
4383
|
-
* @param {string} [userId] Filter by UserID.
|
|
4384
|
-
* @param {number} [n] The number of objects to return.
|
|
4385
|
-
* @param {'ascending' | 'descending'} [order]
|
|
4386
|
-
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
4387
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
4388
|
-
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
4389
|
-
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
4390
|
-
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
4391
|
-
* @param {string} [minUnityVersion] The minimum Unity version supported by the asset.
|
|
4392
|
-
* @param {string} [platform] The platform the asset supports.
|
|
5084
|
+
* Search and list avatars by query filters. You can only search your own or featured avatars. It is not possible as a normal user to search other peoples avatars.
|
|
5085
|
+
* @summary Search Avatars
|
|
5086
|
+
* @param {string} [featured] Filters on featured results.
|
|
5087
|
+
* @param {'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name'} [sort]
|
|
5088
|
+
* @param {'me'} [user] Set to `me` for searching own avatars.
|
|
5089
|
+
* @param {string} [userId] Filter by UserID.
|
|
5090
|
+
* @param {number} [n] The number of objects to return.
|
|
5091
|
+
* @param {'ascending' | 'descending'} [order]
|
|
5092
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
5093
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
5094
|
+
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
5095
|
+
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
5096
|
+
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
5097
|
+
* @param {string} [minUnityVersion] The minimum Unity version supported by the asset.
|
|
5098
|
+
* @param {string} [platform] The platform the asset supports.
|
|
5099
|
+
* @param {*} [options] Override http request option.
|
|
5100
|
+
* @throws {RequiredError}
|
|
5101
|
+
*/
|
|
5102
|
+
async searchAvatars(featured?: string, sort?: 'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name', user?: 'me', userId?: string, n?: number, order?: 'ascending' | 'descending', offset?: number, tag?: string, notag?: string, releaseStatus?: 'public' | 'private' | 'hidden' | 'all', maxUnityVersion?: string, minUnityVersion?: string, platform?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Avatar>>> {
|
|
5103
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.searchAvatars(featured, sort, user, userId, n, order, offset, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, options);
|
|
5104
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
5105
|
+
},
|
|
5106
|
+
/**
|
|
5107
|
+
* Switches into that avatar.
|
|
5108
|
+
* @summary Select Avatar
|
|
5109
|
+
* @param {string} avatarId
|
|
5110
|
+
* @param {*} [options] Override http request option.
|
|
5111
|
+
* @throws {RequiredError}
|
|
5112
|
+
*/
|
|
5113
|
+
async selectAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>> {
|
|
5114
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.selectAvatar(avatarId, options);
|
|
5115
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
5116
|
+
},
|
|
5117
|
+
/**
|
|
5118
|
+
* Switches into that avatar as your fallback avatar.
|
|
5119
|
+
* @summary Select Fallback Avatar
|
|
5120
|
+
* @param {string} avatarId
|
|
5121
|
+
* @param {*} [options] Override http request option.
|
|
5122
|
+
* @throws {RequiredError}
|
|
5123
|
+
*/
|
|
5124
|
+
async selectFallbackAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>> {
|
|
5125
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.selectFallbackAvatar(avatarId, options);
|
|
5126
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
5127
|
+
},
|
|
5128
|
+
/**
|
|
5129
|
+
* Update information about a specific avatar.
|
|
5130
|
+
* @summary Update Avatar
|
|
5131
|
+
* @param {string} avatarId
|
|
5132
|
+
* @param {UpdateAvatarRequest} [updateAvatarRequest]
|
|
5133
|
+
* @param {*} [options] Override http request option.
|
|
5134
|
+
* @throws {RequiredError}
|
|
5135
|
+
*/
|
|
5136
|
+
async updateAvatar(avatarId: string, updateAvatarRequest?: UpdateAvatarRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Avatar>> {
|
|
5137
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateAvatar(avatarId, updateAvatarRequest, options);
|
|
5138
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
5139
|
+
},
|
|
5140
|
+
}
|
|
5141
|
+
};
|
|
5142
|
+
|
|
5143
|
+
/**
|
|
5144
|
+
* AvatarsApi - factory interface
|
|
5145
|
+
* @export
|
|
5146
|
+
*/
|
|
5147
|
+
export const AvatarsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
5148
|
+
const localVarFp = AvatarsApiFp(configuration)
|
|
5149
|
+
return {
|
|
5150
|
+
/**
|
|
5151
|
+
* Create an avatar. It\'s possible to optionally specify a ID if you want a custom one. Attempting to create an Avatar with an already claimed ID will result in a DB error.
|
|
5152
|
+
* @summary Create Avatar
|
|
5153
|
+
* @param {CreateAvatarRequest} [createAvatarRequest]
|
|
5154
|
+
* @param {*} [options] Override http request option.
|
|
5155
|
+
* @throws {RequiredError}
|
|
5156
|
+
*/
|
|
5157
|
+
createAvatar(createAvatarRequest?: CreateAvatarRequest, options?: any): AxiosPromise<Avatar> {
|
|
5158
|
+
return localVarFp.createAvatar(createAvatarRequest, options).then((request) => request(axios, basePath));
|
|
5159
|
+
},
|
|
5160
|
+
/**
|
|
5161
|
+
* Delete an avatar. Notice an avatar is never fully \"deleted\", only its ReleaseStatus is set to \"hidden\" and the linked Files are deleted. The AvatarID is permanently reserved.
|
|
5162
|
+
* @summary Delete Avatar
|
|
5163
|
+
* @param {string} avatarId
|
|
5164
|
+
* @param {*} [options] Override http request option.
|
|
5165
|
+
* @throws {RequiredError}
|
|
5166
|
+
*/
|
|
5167
|
+
deleteAvatar(avatarId: string, options?: any): AxiosPromise<Avatar> {
|
|
5168
|
+
return localVarFp.deleteAvatar(avatarId, options).then((request) => request(axios, basePath));
|
|
5169
|
+
},
|
|
5170
|
+
/**
|
|
5171
|
+
* Get information about a specific Avatar.
|
|
5172
|
+
* @summary Get Avatar
|
|
5173
|
+
* @param {string} avatarId
|
|
5174
|
+
* @param {*} [options] Override http request option.
|
|
5175
|
+
* @throws {RequiredError}
|
|
5176
|
+
*/
|
|
5177
|
+
getAvatar(avatarId: string, options?: any): AxiosPromise<Avatar> {
|
|
5178
|
+
return localVarFp.getAvatar(avatarId, options).then((request) => request(axios, basePath));
|
|
5179
|
+
},
|
|
5180
|
+
/**
|
|
5181
|
+
* Search and list favorited avatars by query filters.
|
|
5182
|
+
* @summary List Favorited Avatars
|
|
5183
|
+
* @param {string} [featured] Filters on featured results.
|
|
5184
|
+
* @param {'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name'} [sort]
|
|
5185
|
+
* @param {number} [n] The number of objects to return.
|
|
5186
|
+
* @param {'ascending' | 'descending'} [order]
|
|
5187
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
5188
|
+
* @param {string} [search] Filters by world name.
|
|
5189
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
5190
|
+
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
5191
|
+
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
5192
|
+
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
5193
|
+
* @param {string} [minUnityVersion] The minimum Unity version supported by the asset.
|
|
5194
|
+
* @param {string} [platform] The platform the asset supports.
|
|
5195
|
+
* @param {string} [userId] Target user to see information on, admin-only.
|
|
5196
|
+
* @param {*} [options] Override http request option.
|
|
5197
|
+
* @throws {RequiredError}
|
|
5198
|
+
*/
|
|
5199
|
+
getFavoritedAvatars(featured?: string, sort?: 'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name', n?: number, order?: 'ascending' | 'descending', offset?: number, search?: string, tag?: string, notag?: string, releaseStatus?: 'public' | 'private' | 'hidden' | 'all', maxUnityVersion?: string, minUnityVersion?: string, platform?: string, userId?: string, options?: any): AxiosPromise<Array<Avatar>> {
|
|
5200
|
+
return localVarFp.getFavoritedAvatars(featured, sort, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, userId, options).then((request) => request(axios, basePath));
|
|
5201
|
+
},
|
|
5202
|
+
/**
|
|
5203
|
+
* Search and list avatars by query filters. You can only search your own or featured avatars. It is not possible as a normal user to search other peoples avatars.
|
|
5204
|
+
* @summary Search Avatars
|
|
5205
|
+
* @param {string} [featured] Filters on featured results.
|
|
5206
|
+
* @param {'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name'} [sort]
|
|
5207
|
+
* @param {'me'} [user] Set to `me` for searching own avatars.
|
|
5208
|
+
* @param {string} [userId] Filter by UserID.
|
|
5209
|
+
* @param {number} [n] The number of objects to return.
|
|
5210
|
+
* @param {'ascending' | 'descending'} [order]
|
|
5211
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
5212
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
5213
|
+
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
5214
|
+
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
5215
|
+
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
5216
|
+
* @param {string} [minUnityVersion] The minimum Unity version supported by the asset.
|
|
5217
|
+
* @param {string} [platform] The platform the asset supports.
|
|
5218
|
+
* @param {*} [options] Override http request option.
|
|
5219
|
+
* @throws {RequiredError}
|
|
5220
|
+
*/
|
|
5221
|
+
searchAvatars(featured?: string, sort?: 'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name', user?: 'me', userId?: string, n?: number, order?: 'ascending' | 'descending', offset?: number, tag?: string, notag?: string, releaseStatus?: 'public' | 'private' | 'hidden' | 'all', maxUnityVersion?: string, minUnityVersion?: string, platform?: string, options?: any): AxiosPromise<Array<Avatar>> {
|
|
5222
|
+
return localVarFp.searchAvatars(featured, sort, user, userId, n, order, offset, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, options).then((request) => request(axios, basePath));
|
|
5223
|
+
},
|
|
5224
|
+
/**
|
|
5225
|
+
* Switches into that avatar.
|
|
5226
|
+
* @summary Select Avatar
|
|
5227
|
+
* @param {string} avatarId
|
|
5228
|
+
* @param {*} [options] Override http request option.
|
|
5229
|
+
* @throws {RequiredError}
|
|
5230
|
+
*/
|
|
5231
|
+
selectAvatar(avatarId: string, options?: any): AxiosPromise<CurrentUser> {
|
|
5232
|
+
return localVarFp.selectAvatar(avatarId, options).then((request) => request(axios, basePath));
|
|
5233
|
+
},
|
|
5234
|
+
/**
|
|
5235
|
+
* Switches into that avatar as your fallback avatar.
|
|
5236
|
+
* @summary Select Fallback Avatar
|
|
5237
|
+
* @param {string} avatarId
|
|
5238
|
+
* @param {*} [options] Override http request option.
|
|
5239
|
+
* @throws {RequiredError}
|
|
5240
|
+
*/
|
|
5241
|
+
selectFallbackAvatar(avatarId: string, options?: any): AxiosPromise<CurrentUser> {
|
|
5242
|
+
return localVarFp.selectFallbackAvatar(avatarId, options).then((request) => request(axios, basePath));
|
|
5243
|
+
},
|
|
5244
|
+
/**
|
|
5245
|
+
* Update information about a specific avatar.
|
|
5246
|
+
* @summary Update Avatar
|
|
5247
|
+
* @param {string} avatarId
|
|
5248
|
+
* @param {UpdateAvatarRequest} [updateAvatarRequest]
|
|
5249
|
+
* @param {*} [options] Override http request option.
|
|
5250
|
+
* @throws {RequiredError}
|
|
5251
|
+
*/
|
|
5252
|
+
updateAvatar(avatarId: string, updateAvatarRequest?: UpdateAvatarRequest, options?: any): AxiosPromise<Avatar> {
|
|
5253
|
+
return localVarFp.updateAvatar(avatarId, updateAvatarRequest, options).then((request) => request(axios, basePath));
|
|
5254
|
+
},
|
|
5255
|
+
};
|
|
5256
|
+
};
|
|
5257
|
+
|
|
5258
|
+
/**
|
|
5259
|
+
* AvatarsApi - object-oriented interface
|
|
5260
|
+
* @export
|
|
5261
|
+
* @class AvatarsApi
|
|
5262
|
+
* @extends {BaseAPI}
|
|
5263
|
+
*/
|
|
5264
|
+
export class AvatarsApi extends BaseAPI {
|
|
5265
|
+
/**
|
|
5266
|
+
* Create an avatar. It\'s possible to optionally specify a ID if you want a custom one. Attempting to create an Avatar with an already claimed ID will result in a DB error.
|
|
5267
|
+
* @summary Create Avatar
|
|
5268
|
+
* @param {CreateAvatarRequest} [createAvatarRequest]
|
|
5269
|
+
* @param {*} [options] Override http request option.
|
|
5270
|
+
* @throws {RequiredError}
|
|
5271
|
+
* @memberof AvatarsApi
|
|
5272
|
+
*/
|
|
5273
|
+
public createAvatar(createAvatarRequest?: CreateAvatarRequest, options?: AxiosRequestConfig) {
|
|
5274
|
+
return AvatarsApiFp(this.configuration).createAvatar(createAvatarRequest, options).then((request) => request(this.axios, this.basePath));
|
|
5275
|
+
}
|
|
5276
|
+
|
|
5277
|
+
/**
|
|
5278
|
+
* Delete an avatar. Notice an avatar is never fully \"deleted\", only its ReleaseStatus is set to \"hidden\" and the linked Files are deleted. The AvatarID is permanently reserved.
|
|
5279
|
+
* @summary Delete Avatar
|
|
5280
|
+
* @param {string} avatarId
|
|
5281
|
+
* @param {*} [options] Override http request option.
|
|
5282
|
+
* @throws {RequiredError}
|
|
5283
|
+
* @memberof AvatarsApi
|
|
5284
|
+
*/
|
|
5285
|
+
public deleteAvatar(avatarId: string, options?: AxiosRequestConfig) {
|
|
5286
|
+
return AvatarsApiFp(this.configuration).deleteAvatar(avatarId, options).then((request) => request(this.axios, this.basePath));
|
|
5287
|
+
}
|
|
5288
|
+
|
|
5289
|
+
/**
|
|
5290
|
+
* Get information about a specific Avatar.
|
|
5291
|
+
* @summary Get Avatar
|
|
5292
|
+
* @param {string} avatarId
|
|
5293
|
+
* @param {*} [options] Override http request option.
|
|
5294
|
+
* @throws {RequiredError}
|
|
5295
|
+
* @memberof AvatarsApi
|
|
5296
|
+
*/
|
|
5297
|
+
public getAvatar(avatarId: string, options?: AxiosRequestConfig) {
|
|
5298
|
+
return AvatarsApiFp(this.configuration).getAvatar(avatarId, options).then((request) => request(this.axios, this.basePath));
|
|
5299
|
+
}
|
|
5300
|
+
|
|
5301
|
+
/**
|
|
5302
|
+
* Search and list favorited avatars by query filters.
|
|
5303
|
+
* @summary List Favorited Avatars
|
|
5304
|
+
* @param {string} [featured] Filters on featured results.
|
|
5305
|
+
* @param {'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name'} [sort]
|
|
5306
|
+
* @param {number} [n] The number of objects to return.
|
|
5307
|
+
* @param {'ascending' | 'descending'} [order]
|
|
5308
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
5309
|
+
* @param {string} [search] Filters by world name.
|
|
5310
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
5311
|
+
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
5312
|
+
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
5313
|
+
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
5314
|
+
* @param {string} [minUnityVersion] The minimum Unity version supported by the asset.
|
|
5315
|
+
* @param {string} [platform] The platform the asset supports.
|
|
5316
|
+
* @param {string} [userId] Target user to see information on, admin-only.
|
|
5317
|
+
* @param {*} [options] Override http request option.
|
|
5318
|
+
* @throws {RequiredError}
|
|
5319
|
+
* @memberof AvatarsApi
|
|
5320
|
+
*/
|
|
5321
|
+
public getFavoritedAvatars(featured?: string, sort?: 'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name', n?: number, order?: 'ascending' | 'descending', offset?: number, search?: string, tag?: string, notag?: string, releaseStatus?: 'public' | 'private' | 'hidden' | 'all', maxUnityVersion?: string, minUnityVersion?: string, platform?: string, userId?: string, options?: AxiosRequestConfig) {
|
|
5322
|
+
return AvatarsApiFp(this.configuration).getFavoritedAvatars(featured, sort, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, userId, options).then((request) => request(this.axios, this.basePath));
|
|
5323
|
+
}
|
|
5324
|
+
|
|
5325
|
+
/**
|
|
5326
|
+
* Search and list avatars by query filters. You can only search your own or featured avatars. It is not possible as a normal user to search other peoples avatars.
|
|
5327
|
+
* @summary Search Avatars
|
|
5328
|
+
* @param {string} [featured] Filters on featured results.
|
|
5329
|
+
* @param {'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name'} [sort]
|
|
5330
|
+
* @param {'me'} [user] Set to `me` for searching own avatars.
|
|
5331
|
+
* @param {string} [userId] Filter by UserID.
|
|
5332
|
+
* @param {number} [n] The number of objects to return.
|
|
5333
|
+
* @param {'ascending' | 'descending'} [order]
|
|
5334
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
5335
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
5336
|
+
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
5337
|
+
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
5338
|
+
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
5339
|
+
* @param {string} [minUnityVersion] The minimum Unity version supported by the asset.
|
|
5340
|
+
* @param {string} [platform] The platform the asset supports.
|
|
5341
|
+
* @param {*} [options] Override http request option.
|
|
5342
|
+
* @throws {RequiredError}
|
|
5343
|
+
* @memberof AvatarsApi
|
|
5344
|
+
*/
|
|
5345
|
+
public searchAvatars(featured?: string, sort?: 'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name', user?: 'me', userId?: string, n?: number, order?: 'ascending' | 'descending', offset?: number, tag?: string, notag?: string, releaseStatus?: 'public' | 'private' | 'hidden' | 'all', maxUnityVersion?: string, minUnityVersion?: string, platform?: string, options?: AxiosRequestConfig) {
|
|
5346
|
+
return AvatarsApiFp(this.configuration).searchAvatars(featured, sort, user, userId, n, order, offset, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, options).then((request) => request(this.axios, this.basePath));
|
|
5347
|
+
}
|
|
5348
|
+
|
|
5349
|
+
/**
|
|
5350
|
+
* Switches into that avatar.
|
|
5351
|
+
* @summary Select Avatar
|
|
5352
|
+
* @param {string} avatarId
|
|
5353
|
+
* @param {*} [options] Override http request option.
|
|
5354
|
+
* @throws {RequiredError}
|
|
5355
|
+
* @memberof AvatarsApi
|
|
5356
|
+
*/
|
|
5357
|
+
public selectAvatar(avatarId: string, options?: AxiosRequestConfig) {
|
|
5358
|
+
return AvatarsApiFp(this.configuration).selectAvatar(avatarId, options).then((request) => request(this.axios, this.basePath));
|
|
5359
|
+
}
|
|
5360
|
+
|
|
5361
|
+
/**
|
|
5362
|
+
* Switches into that avatar as your fallback avatar.
|
|
5363
|
+
* @summary Select Fallback Avatar
|
|
5364
|
+
* @param {string} avatarId
|
|
5365
|
+
* @param {*} [options] Override http request option.
|
|
5366
|
+
* @throws {RequiredError}
|
|
5367
|
+
* @memberof AvatarsApi
|
|
5368
|
+
*/
|
|
5369
|
+
public selectFallbackAvatar(avatarId: string, options?: AxiosRequestConfig) {
|
|
5370
|
+
return AvatarsApiFp(this.configuration).selectFallbackAvatar(avatarId, options).then((request) => request(this.axios, this.basePath));
|
|
5371
|
+
}
|
|
5372
|
+
|
|
5373
|
+
/**
|
|
5374
|
+
* Update information about a specific avatar.
|
|
5375
|
+
* @summary Update Avatar
|
|
5376
|
+
* @param {string} avatarId
|
|
5377
|
+
* @param {UpdateAvatarRequest} [updateAvatarRequest]
|
|
5378
|
+
* @param {*} [options] Override http request option.
|
|
5379
|
+
* @throws {RequiredError}
|
|
5380
|
+
* @memberof AvatarsApi
|
|
5381
|
+
*/
|
|
5382
|
+
public updateAvatar(avatarId: string, updateAvatarRequest?: UpdateAvatarRequest, options?: AxiosRequestConfig) {
|
|
5383
|
+
return AvatarsApiFp(this.configuration).updateAvatar(avatarId, updateAvatarRequest, options).then((request) => request(this.axios, this.basePath));
|
|
5384
|
+
}
|
|
5385
|
+
}
|
|
5386
|
+
|
|
5387
|
+
|
|
5388
|
+
/**
|
|
5389
|
+
* EconomyApi - axios parameter creator
|
|
5390
|
+
* @export
|
|
5391
|
+
*/
|
|
5392
|
+
export const EconomyApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
5393
|
+
return {
|
|
5394
|
+
/**
|
|
5395
|
+
* Get a list of all current user subscriptions.
|
|
5396
|
+
* @summary Get Current Subscriptions
|
|
5397
|
+
* @param {*} [options] Override http request option.
|
|
5398
|
+
* @throws {RequiredError}
|
|
5399
|
+
*/
|
|
5400
|
+
getCurrentSubscriptions: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5401
|
+
const localVarPath = `/auth/user/subscription`;
|
|
5402
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5403
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5404
|
+
let baseOptions;
|
|
5405
|
+
if (configuration) {
|
|
5406
|
+
baseOptions = configuration.baseOptions;
|
|
5407
|
+
}
|
|
5408
|
+
|
|
5409
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
5410
|
+
const localVarHeaderParameter = {} as any;
|
|
5411
|
+
const localVarQueryParameter = {} as any;
|
|
5412
|
+
|
|
5413
|
+
// authentication apiKeyCookie required
|
|
5414
|
+
|
|
5415
|
+
// authentication authCookie required
|
|
5416
|
+
|
|
5417
|
+
|
|
5418
|
+
|
|
5419
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5420
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5421
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
5422
|
+
|
|
5423
|
+
return {
|
|
5424
|
+
url: toPathString(localVarUrlObj),
|
|
5425
|
+
options: localVarRequestOptions,
|
|
5426
|
+
};
|
|
5427
|
+
},
|
|
5428
|
+
/**
|
|
5429
|
+
* Get a single License Group by given ID.
|
|
5430
|
+
* @summary Get License Group
|
|
5431
|
+
* @param {string} licenseGroupId
|
|
5432
|
+
* @param {*} [options] Override http request option.
|
|
5433
|
+
* @throws {RequiredError}
|
|
5434
|
+
*/
|
|
5435
|
+
getLicenseGroup: async (licenseGroupId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5436
|
+
// verify required parameter 'licenseGroupId' is not null or undefined
|
|
5437
|
+
assertParamExists('getLicenseGroup', 'licenseGroupId', licenseGroupId)
|
|
5438
|
+
const localVarPath = `/licenseGroups/{licenseGroupId}`
|
|
5439
|
+
.replace(`{${"licenseGroupId"}}`, encodeURIComponent(String(licenseGroupId)));
|
|
5440
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5441
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5442
|
+
let baseOptions;
|
|
5443
|
+
if (configuration) {
|
|
5444
|
+
baseOptions = configuration.baseOptions;
|
|
5445
|
+
}
|
|
5446
|
+
|
|
5447
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
5448
|
+
const localVarHeaderParameter = {} as any;
|
|
5449
|
+
const localVarQueryParameter = {} as any;
|
|
5450
|
+
|
|
5451
|
+
// authentication apiKeyCookie required
|
|
5452
|
+
|
|
5453
|
+
// authentication authCookie required
|
|
5454
|
+
|
|
5455
|
+
|
|
5456
|
+
|
|
5457
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5458
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5459
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
5460
|
+
|
|
5461
|
+
return {
|
|
5462
|
+
url: toPathString(localVarUrlObj),
|
|
5463
|
+
options: localVarRequestOptions,
|
|
5464
|
+
};
|
|
5465
|
+
},
|
|
5466
|
+
/**
|
|
5467
|
+
* Get a single Steam transactions by ID. This returns the exact same information as `getSteamTransactions`, so no point in using this endpoint.
|
|
5468
|
+
* @summary Get Steam Transaction
|
|
5469
|
+
* @param {string} transactionId
|
|
5470
|
+
* @param {*} [options] Override http request option.
|
|
5471
|
+
* @deprecated
|
|
5472
|
+
* @throws {RequiredError}
|
|
5473
|
+
*/
|
|
5474
|
+
getSteamTransaction: async (transactionId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5475
|
+
// verify required parameter 'transactionId' is not null or undefined
|
|
5476
|
+
assertParamExists('getSteamTransaction', 'transactionId', transactionId)
|
|
5477
|
+
const localVarPath = `/Steam/transactions/{transactionId}`
|
|
5478
|
+
.replace(`{${"transactionId"}}`, encodeURIComponent(String(transactionId)));
|
|
5479
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5480
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5481
|
+
let baseOptions;
|
|
5482
|
+
if (configuration) {
|
|
5483
|
+
baseOptions = configuration.baseOptions;
|
|
5484
|
+
}
|
|
5485
|
+
|
|
5486
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
5487
|
+
const localVarHeaderParameter = {} as any;
|
|
5488
|
+
const localVarQueryParameter = {} as any;
|
|
5489
|
+
|
|
5490
|
+
// authentication apiKeyCookie required
|
|
5491
|
+
|
|
5492
|
+
// authentication authCookie required
|
|
5493
|
+
|
|
5494
|
+
|
|
5495
|
+
|
|
5496
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5497
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5498
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
5499
|
+
|
|
5500
|
+
return {
|
|
5501
|
+
url: toPathString(localVarUrlObj),
|
|
5502
|
+
options: localVarRequestOptions,
|
|
5503
|
+
};
|
|
5504
|
+
},
|
|
5505
|
+
/**
|
|
5506
|
+
* Get all own Steam transactions.
|
|
5507
|
+
* @summary List Steam Transactions
|
|
5508
|
+
* @param {*} [options] Override http request option.
|
|
5509
|
+
* @throws {RequiredError}
|
|
5510
|
+
*/
|
|
5511
|
+
getSteamTransactions: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5512
|
+
const localVarPath = `/Steam/transactions`;
|
|
5513
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5514
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5515
|
+
let baseOptions;
|
|
5516
|
+
if (configuration) {
|
|
5517
|
+
baseOptions = configuration.baseOptions;
|
|
5518
|
+
}
|
|
5519
|
+
|
|
5520
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
5521
|
+
const localVarHeaderParameter = {} as any;
|
|
5522
|
+
const localVarQueryParameter = {} as any;
|
|
5523
|
+
|
|
5524
|
+
// authentication apiKeyCookie required
|
|
5525
|
+
|
|
5526
|
+
// authentication authCookie required
|
|
5527
|
+
|
|
5528
|
+
|
|
5529
|
+
|
|
5530
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5531
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5532
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
5533
|
+
|
|
5534
|
+
return {
|
|
5535
|
+
url: toPathString(localVarUrlObj),
|
|
5536
|
+
options: localVarRequestOptions,
|
|
5537
|
+
};
|
|
5538
|
+
},
|
|
5539
|
+
/**
|
|
5540
|
+
* List all existing Subscriptions. For example, \"vrchatplus-monthly\" and \"vrchatplus-yearly\".
|
|
5541
|
+
* @summary List Subscriptions
|
|
5542
|
+
* @param {*} [options] Override http request option.
|
|
5543
|
+
* @throws {RequiredError}
|
|
5544
|
+
*/
|
|
5545
|
+
getSubscriptions: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5546
|
+
const localVarPath = `/subscriptions`;
|
|
5547
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5548
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5549
|
+
let baseOptions;
|
|
5550
|
+
if (configuration) {
|
|
5551
|
+
baseOptions = configuration.baseOptions;
|
|
5552
|
+
}
|
|
5553
|
+
|
|
5554
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
5555
|
+
const localVarHeaderParameter = {} as any;
|
|
5556
|
+
const localVarQueryParameter = {} as any;
|
|
5557
|
+
|
|
5558
|
+
// authentication apiKeyCookie required
|
|
5559
|
+
|
|
5560
|
+
// authentication authCookie required
|
|
5561
|
+
|
|
5562
|
+
|
|
5563
|
+
|
|
5564
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5565
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5566
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
5567
|
+
|
|
5568
|
+
return {
|
|
5569
|
+
url: toPathString(localVarUrlObj),
|
|
5570
|
+
options: localVarRequestOptions,
|
|
5571
|
+
};
|
|
5572
|
+
},
|
|
5573
|
+
}
|
|
5574
|
+
};
|
|
5575
|
+
|
|
5576
|
+
/**
|
|
5577
|
+
* EconomyApi - functional programming interface
|
|
5578
|
+
* @export
|
|
5579
|
+
*/
|
|
5580
|
+
export const EconomyApiFp = function(configuration?: Configuration) {
|
|
5581
|
+
const localVarAxiosParamCreator = EconomyApiAxiosParamCreator(configuration)
|
|
5582
|
+
return {
|
|
5583
|
+
/**
|
|
5584
|
+
* Get a list of all current user subscriptions.
|
|
5585
|
+
* @summary Get Current Subscriptions
|
|
5586
|
+
* @param {*} [options] Override http request option.
|
|
5587
|
+
* @throws {RequiredError}
|
|
5588
|
+
*/
|
|
5589
|
+
async getCurrentSubscriptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserSubscription>>> {
|
|
5590
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCurrentSubscriptions(options);
|
|
5591
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
5592
|
+
},
|
|
5593
|
+
/**
|
|
5594
|
+
* Get a single License Group by given ID.
|
|
5595
|
+
* @summary Get License Group
|
|
5596
|
+
* @param {string} licenseGroupId
|
|
4393
5597
|
* @param {*} [options] Override http request option.
|
|
4394
5598
|
* @throws {RequiredError}
|
|
4395
5599
|
*/
|
|
4396
|
-
async
|
|
4397
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
5600
|
+
async getLicenseGroup(licenseGroupId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LicenseGroup>> {
|
|
5601
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getLicenseGroup(licenseGroupId, options);
|
|
4398
5602
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
4399
5603
|
},
|
|
4400
5604
|
/**
|
|
4401
|
-
*
|
|
4402
|
-
* @summary
|
|
4403
|
-
* @param {string}
|
|
5605
|
+
* Get a single Steam transactions by ID. This returns the exact same information as `getSteamTransactions`, so no point in using this endpoint.
|
|
5606
|
+
* @summary Get Steam Transaction
|
|
5607
|
+
* @param {string} transactionId
|
|
4404
5608
|
* @param {*} [options] Override http request option.
|
|
5609
|
+
* @deprecated
|
|
4405
5610
|
* @throws {RequiredError}
|
|
4406
5611
|
*/
|
|
4407
|
-
async
|
|
4408
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
5612
|
+
async getSteamTransaction(transactionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Transaction>> {
|
|
5613
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSteamTransaction(transactionId, options);
|
|
4409
5614
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
4410
5615
|
},
|
|
4411
5616
|
/**
|
|
4412
|
-
*
|
|
4413
|
-
* @summary
|
|
4414
|
-
* @param {string} avatarId
|
|
5617
|
+
* Get all own Steam transactions.
|
|
5618
|
+
* @summary List Steam Transactions
|
|
4415
5619
|
* @param {*} [options] Override http request option.
|
|
4416
5620
|
* @throws {RequiredError}
|
|
4417
5621
|
*/
|
|
4418
|
-
async
|
|
4419
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
5622
|
+
async getSteamTransactions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Transaction>>> {
|
|
5623
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSteamTransactions(options);
|
|
4420
5624
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
4421
5625
|
},
|
|
4422
5626
|
/**
|
|
4423
|
-
*
|
|
4424
|
-
* @summary
|
|
4425
|
-
* @param {string} avatarId
|
|
4426
|
-
* @param {UpdateAvatarRequest} [updateAvatarRequest]
|
|
5627
|
+
* List all existing Subscriptions. For example, \"vrchatplus-monthly\" and \"vrchatplus-yearly\".
|
|
5628
|
+
* @summary List Subscriptions
|
|
4427
5629
|
* @param {*} [options] Override http request option.
|
|
4428
5630
|
* @throws {RequiredError}
|
|
4429
5631
|
*/
|
|
4430
|
-
async
|
|
4431
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
5632
|
+
async getSubscriptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Subscription>>> {
|
|
5633
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSubscriptions(options);
|
|
4432
5634
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
4433
5635
|
},
|
|
4434
5636
|
}
|
|
4435
5637
|
};
|
|
4436
5638
|
|
|
4437
5639
|
/**
|
|
4438
|
-
*
|
|
5640
|
+
* EconomyApi - factory interface
|
|
4439
5641
|
* @export
|
|
4440
5642
|
*/
|
|
4441
|
-
export const
|
|
4442
|
-
const localVarFp =
|
|
5643
|
+
export const EconomyApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
5644
|
+
const localVarFp = EconomyApiFp(configuration)
|
|
4443
5645
|
return {
|
|
4444
5646
|
/**
|
|
4445
|
-
*
|
|
4446
|
-
* @summary
|
|
4447
|
-
* @param {CreateAvatarRequest} [createAvatarRequest]
|
|
4448
|
-
* @param {*} [options] Override http request option.
|
|
4449
|
-
* @throws {RequiredError}
|
|
4450
|
-
*/
|
|
4451
|
-
createAvatar(createAvatarRequest?: CreateAvatarRequest, options?: any): AxiosPromise<Avatar> {
|
|
4452
|
-
return localVarFp.createAvatar(createAvatarRequest, options).then((request) => request(axios, basePath));
|
|
4453
|
-
},
|
|
4454
|
-
/**
|
|
4455
|
-
* Delete an avatar. Notice an avatar is never fully \"deleted\", only its ReleaseStatus is set to \"hidden\" and the linked Files are deleted. The AvatarID is permanently reserved.
|
|
4456
|
-
* @summary Delete Avatar
|
|
4457
|
-
* @param {string} avatarId
|
|
4458
|
-
* @param {*} [options] Override http request option.
|
|
4459
|
-
* @throws {RequiredError}
|
|
4460
|
-
*/
|
|
4461
|
-
deleteAvatar(avatarId: string, options?: any): AxiosPromise<Avatar> {
|
|
4462
|
-
return localVarFp.deleteAvatar(avatarId, options).then((request) => request(axios, basePath));
|
|
4463
|
-
},
|
|
4464
|
-
/**
|
|
4465
|
-
* Get information about a specific Avatar.
|
|
4466
|
-
* @summary Get Avatar
|
|
4467
|
-
* @param {string} avatarId
|
|
4468
|
-
* @param {*} [options] Override http request option.
|
|
4469
|
-
* @throws {RequiredError}
|
|
4470
|
-
*/
|
|
4471
|
-
getAvatar(avatarId: string, options?: any): AxiosPromise<Avatar> {
|
|
4472
|
-
return localVarFp.getAvatar(avatarId, options).then((request) => request(axios, basePath));
|
|
4473
|
-
},
|
|
4474
|
-
/**
|
|
4475
|
-
* Search and list favorited avatars by query filters.
|
|
4476
|
-
* @summary List Favorited Avatars
|
|
4477
|
-
* @param {string} [featured] Filters on featured results.
|
|
4478
|
-
* @param {'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name'} [sort]
|
|
4479
|
-
* @param {number} [n] The number of objects to return.
|
|
4480
|
-
* @param {'ascending' | 'descending'} [order]
|
|
4481
|
-
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
4482
|
-
* @param {string} [search] Filters by world name.
|
|
4483
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
4484
|
-
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
4485
|
-
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
4486
|
-
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
4487
|
-
* @param {string} [minUnityVersion] The minimum Unity version supported by the asset.
|
|
4488
|
-
* @param {string} [platform] The platform the asset supports.
|
|
4489
|
-
* @param {string} [userId] Target user to see information on, admin-only.
|
|
5647
|
+
* Get a list of all current user subscriptions.
|
|
5648
|
+
* @summary Get Current Subscriptions
|
|
4490
5649
|
* @param {*} [options] Override http request option.
|
|
4491
5650
|
* @throws {RequiredError}
|
|
4492
5651
|
*/
|
|
4493
|
-
|
|
4494
|
-
return localVarFp.
|
|
5652
|
+
getCurrentSubscriptions(options?: any): AxiosPromise<Array<UserSubscription>> {
|
|
5653
|
+
return localVarFp.getCurrentSubscriptions(options).then((request) => request(axios, basePath));
|
|
4495
5654
|
},
|
|
4496
5655
|
/**
|
|
4497
|
-
*
|
|
4498
|
-
* @summary
|
|
4499
|
-
* @param {string}
|
|
4500
|
-
* @param {'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name'} [sort]
|
|
4501
|
-
* @param {'me'} [user] Set to `me` for searching own avatars.
|
|
4502
|
-
* @param {string} [userId] Filter by UserID.
|
|
4503
|
-
* @param {number} [n] The number of objects to return.
|
|
4504
|
-
* @param {'ascending' | 'descending'} [order]
|
|
4505
|
-
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
4506
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
4507
|
-
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
4508
|
-
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
4509
|
-
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
4510
|
-
* @param {string} [minUnityVersion] The minimum Unity version supported by the asset.
|
|
4511
|
-
* @param {string} [platform] The platform the asset supports.
|
|
5656
|
+
* Get a single License Group by given ID.
|
|
5657
|
+
* @summary Get License Group
|
|
5658
|
+
* @param {string} licenseGroupId
|
|
4512
5659
|
* @param {*} [options] Override http request option.
|
|
4513
5660
|
* @throws {RequiredError}
|
|
4514
5661
|
*/
|
|
4515
|
-
|
|
4516
|
-
return localVarFp.
|
|
5662
|
+
getLicenseGroup(licenseGroupId: string, options?: any): AxiosPromise<LicenseGroup> {
|
|
5663
|
+
return localVarFp.getLicenseGroup(licenseGroupId, options).then((request) => request(axios, basePath));
|
|
4517
5664
|
},
|
|
4518
5665
|
/**
|
|
4519
|
-
*
|
|
4520
|
-
* @summary
|
|
4521
|
-
* @param {string}
|
|
5666
|
+
* Get a single Steam transactions by ID. This returns the exact same information as `getSteamTransactions`, so no point in using this endpoint.
|
|
5667
|
+
* @summary Get Steam Transaction
|
|
5668
|
+
* @param {string} transactionId
|
|
4522
5669
|
* @param {*} [options] Override http request option.
|
|
5670
|
+
* @deprecated
|
|
4523
5671
|
* @throws {RequiredError}
|
|
4524
5672
|
*/
|
|
4525
|
-
|
|
4526
|
-
return localVarFp.
|
|
5673
|
+
getSteamTransaction(transactionId: string, options?: any): AxiosPromise<Transaction> {
|
|
5674
|
+
return localVarFp.getSteamTransaction(transactionId, options).then((request) => request(axios, basePath));
|
|
4527
5675
|
},
|
|
4528
5676
|
/**
|
|
4529
|
-
*
|
|
4530
|
-
* @summary
|
|
4531
|
-
* @param {string} avatarId
|
|
5677
|
+
* Get all own Steam transactions.
|
|
5678
|
+
* @summary List Steam Transactions
|
|
4532
5679
|
* @param {*} [options] Override http request option.
|
|
4533
5680
|
* @throws {RequiredError}
|
|
4534
5681
|
*/
|
|
4535
|
-
|
|
4536
|
-
return localVarFp.
|
|
5682
|
+
getSteamTransactions(options?: any): AxiosPromise<Array<Transaction>> {
|
|
5683
|
+
return localVarFp.getSteamTransactions(options).then((request) => request(axios, basePath));
|
|
4537
5684
|
},
|
|
4538
5685
|
/**
|
|
4539
|
-
*
|
|
4540
|
-
* @summary
|
|
4541
|
-
* @param {string} avatarId
|
|
4542
|
-
* @param {UpdateAvatarRequest} [updateAvatarRequest]
|
|
5686
|
+
* List all existing Subscriptions. For example, \"vrchatplus-monthly\" and \"vrchatplus-yearly\".
|
|
5687
|
+
* @summary List Subscriptions
|
|
4543
5688
|
* @param {*} [options] Override http request option.
|
|
4544
5689
|
* @throws {RequiredError}
|
|
4545
5690
|
*/
|
|
4546
|
-
|
|
4547
|
-
return localVarFp.
|
|
5691
|
+
getSubscriptions(options?: any): AxiosPromise<Array<Subscription>> {
|
|
5692
|
+
return localVarFp.getSubscriptions(options).then((request) => request(axios, basePath));
|
|
4548
5693
|
},
|
|
4549
5694
|
};
|
|
4550
5695
|
};
|
|
4551
5696
|
|
|
4552
5697
|
/**
|
|
4553
|
-
*
|
|
5698
|
+
* EconomyApi - object-oriented interface
|
|
4554
5699
|
* @export
|
|
4555
|
-
* @class
|
|
5700
|
+
* @class EconomyApi
|
|
4556
5701
|
* @extends {BaseAPI}
|
|
4557
5702
|
*/
|
|
4558
|
-
export class
|
|
4559
|
-
/**
|
|
4560
|
-
* Create an avatar. It\'s possible to optionally specify a ID if you want a custom one. Attempting to create an Avatar with an already claimed ID will result in a DB error.
|
|
4561
|
-
* @summary Create Avatar
|
|
4562
|
-
* @param {CreateAvatarRequest} [createAvatarRequest]
|
|
4563
|
-
* @param {*} [options] Override http request option.
|
|
4564
|
-
* @throws {RequiredError}
|
|
4565
|
-
* @memberof AvatarsApi
|
|
4566
|
-
*/
|
|
4567
|
-
public createAvatar(createAvatarRequest?: CreateAvatarRequest, options?: AxiosRequestConfig) {
|
|
4568
|
-
return AvatarsApiFp(this.configuration).createAvatar(createAvatarRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4569
|
-
}
|
|
4570
|
-
|
|
4571
|
-
/**
|
|
4572
|
-
* Delete an avatar. Notice an avatar is never fully \"deleted\", only its ReleaseStatus is set to \"hidden\" and the linked Files are deleted. The AvatarID is permanently reserved.
|
|
4573
|
-
* @summary Delete Avatar
|
|
4574
|
-
* @param {string} avatarId
|
|
4575
|
-
* @param {*} [options] Override http request option.
|
|
4576
|
-
* @throws {RequiredError}
|
|
4577
|
-
* @memberof AvatarsApi
|
|
4578
|
-
*/
|
|
4579
|
-
public deleteAvatar(avatarId: string, options?: AxiosRequestConfig) {
|
|
4580
|
-
return AvatarsApiFp(this.configuration).deleteAvatar(avatarId, options).then((request) => request(this.axios, this.basePath));
|
|
4581
|
-
}
|
|
4582
|
-
|
|
4583
|
-
/**
|
|
4584
|
-
* Get information about a specific Avatar.
|
|
4585
|
-
* @summary Get Avatar
|
|
4586
|
-
* @param {string} avatarId
|
|
4587
|
-
* @param {*} [options] Override http request option.
|
|
4588
|
-
* @throws {RequiredError}
|
|
4589
|
-
* @memberof AvatarsApi
|
|
4590
|
-
*/
|
|
4591
|
-
public getAvatar(avatarId: string, options?: AxiosRequestConfig) {
|
|
4592
|
-
return AvatarsApiFp(this.configuration).getAvatar(avatarId, options).then((request) => request(this.axios, this.basePath));
|
|
4593
|
-
}
|
|
4594
|
-
|
|
5703
|
+
export class EconomyApi extends BaseAPI {
|
|
4595
5704
|
/**
|
|
4596
|
-
*
|
|
4597
|
-
* @summary
|
|
4598
|
-
* @param {string} [featured] Filters on featured results.
|
|
4599
|
-
* @param {'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name'} [sort]
|
|
4600
|
-
* @param {number} [n] The number of objects to return.
|
|
4601
|
-
* @param {'ascending' | 'descending'} [order]
|
|
4602
|
-
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
4603
|
-
* @param {string} [search] Filters by world name.
|
|
4604
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
4605
|
-
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
4606
|
-
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
4607
|
-
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
4608
|
-
* @param {string} [minUnityVersion] The minimum Unity version supported by the asset.
|
|
4609
|
-
* @param {string} [platform] The platform the asset supports.
|
|
4610
|
-
* @param {string} [userId] Target user to see information on, admin-only.
|
|
5705
|
+
* Get a list of all current user subscriptions.
|
|
5706
|
+
* @summary Get Current Subscriptions
|
|
4611
5707
|
* @param {*} [options] Override http request option.
|
|
4612
5708
|
* @throws {RequiredError}
|
|
4613
|
-
* @memberof
|
|
5709
|
+
* @memberof EconomyApi
|
|
4614
5710
|
*/
|
|
4615
|
-
public
|
|
4616
|
-
return
|
|
5711
|
+
public getCurrentSubscriptions(options?: AxiosRequestConfig) {
|
|
5712
|
+
return EconomyApiFp(this.configuration).getCurrentSubscriptions(options).then((request) => request(this.axios, this.basePath));
|
|
4617
5713
|
}
|
|
4618
5714
|
|
|
4619
5715
|
/**
|
|
4620
|
-
*
|
|
4621
|
-
* @summary
|
|
4622
|
-
* @param {string}
|
|
4623
|
-
* @param {'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name'} [sort]
|
|
4624
|
-
* @param {'me'} [user] Set to `me` for searching own avatars.
|
|
4625
|
-
* @param {string} [userId] Filter by UserID.
|
|
4626
|
-
* @param {number} [n] The number of objects to return.
|
|
4627
|
-
* @param {'ascending' | 'descending'} [order]
|
|
4628
|
-
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
4629
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
4630
|
-
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
4631
|
-
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
4632
|
-
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
4633
|
-
* @param {string} [minUnityVersion] The minimum Unity version supported by the asset.
|
|
4634
|
-
* @param {string} [platform] The platform the asset supports.
|
|
5716
|
+
* Get a single License Group by given ID.
|
|
5717
|
+
* @summary Get License Group
|
|
5718
|
+
* @param {string} licenseGroupId
|
|
4635
5719
|
* @param {*} [options] Override http request option.
|
|
4636
5720
|
* @throws {RequiredError}
|
|
4637
|
-
* @memberof
|
|
5721
|
+
* @memberof EconomyApi
|
|
4638
5722
|
*/
|
|
4639
|
-
public
|
|
4640
|
-
return
|
|
5723
|
+
public getLicenseGroup(licenseGroupId: string, options?: AxiosRequestConfig) {
|
|
5724
|
+
return EconomyApiFp(this.configuration).getLicenseGroup(licenseGroupId, options).then((request) => request(this.axios, this.basePath));
|
|
4641
5725
|
}
|
|
4642
5726
|
|
|
4643
5727
|
/**
|
|
4644
|
-
*
|
|
4645
|
-
* @summary
|
|
4646
|
-
* @param {string}
|
|
5728
|
+
* Get a single Steam transactions by ID. This returns the exact same information as `getSteamTransactions`, so no point in using this endpoint.
|
|
5729
|
+
* @summary Get Steam Transaction
|
|
5730
|
+
* @param {string} transactionId
|
|
4647
5731
|
* @param {*} [options] Override http request option.
|
|
5732
|
+
* @deprecated
|
|
4648
5733
|
* @throws {RequiredError}
|
|
4649
|
-
* @memberof
|
|
5734
|
+
* @memberof EconomyApi
|
|
4650
5735
|
*/
|
|
4651
|
-
public
|
|
4652
|
-
return
|
|
5736
|
+
public getSteamTransaction(transactionId: string, options?: AxiosRequestConfig) {
|
|
5737
|
+
return EconomyApiFp(this.configuration).getSteamTransaction(transactionId, options).then((request) => request(this.axios, this.basePath));
|
|
4653
5738
|
}
|
|
4654
5739
|
|
|
4655
5740
|
/**
|
|
4656
|
-
*
|
|
4657
|
-
* @summary
|
|
4658
|
-
* @param {string} avatarId
|
|
5741
|
+
* Get all own Steam transactions.
|
|
5742
|
+
* @summary List Steam Transactions
|
|
4659
5743
|
* @param {*} [options] Override http request option.
|
|
4660
5744
|
* @throws {RequiredError}
|
|
4661
|
-
* @memberof
|
|
5745
|
+
* @memberof EconomyApi
|
|
4662
5746
|
*/
|
|
4663
|
-
public
|
|
4664
|
-
return
|
|
5747
|
+
public getSteamTransactions(options?: AxiosRequestConfig) {
|
|
5748
|
+
return EconomyApiFp(this.configuration).getSteamTransactions(options).then((request) => request(this.axios, this.basePath));
|
|
4665
5749
|
}
|
|
4666
5750
|
|
|
4667
5751
|
/**
|
|
4668
|
-
*
|
|
4669
|
-
* @summary
|
|
4670
|
-
* @param {string} avatarId
|
|
4671
|
-
* @param {UpdateAvatarRequest} [updateAvatarRequest]
|
|
5752
|
+
* List all existing Subscriptions. For example, \"vrchatplus-monthly\" and \"vrchatplus-yearly\".
|
|
5753
|
+
* @summary List Subscriptions
|
|
4672
5754
|
* @param {*} [options] Override http request option.
|
|
4673
5755
|
* @throws {RequiredError}
|
|
4674
|
-
* @memberof
|
|
5756
|
+
* @memberof EconomyApi
|
|
4675
5757
|
*/
|
|
4676
|
-
public
|
|
4677
|
-
return
|
|
5758
|
+
public getSubscriptions(options?: AxiosRequestConfig) {
|
|
5759
|
+
return EconomyApiFp(this.configuration).getSubscriptions(options).then((request) => request(this.axios, this.basePath));
|
|
4678
5760
|
}
|
|
4679
5761
|
}
|
|
4680
5762
|
|
|
@@ -4908,7 +5990,7 @@ export const FavoritesApiAxiosParamCreator = function (configuration?: Configura
|
|
|
4908
5990
|
* @param {number} [n] The number of objects to return.
|
|
4909
5991
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
4910
5992
|
* @param {string} [type] The type of favorites to return, FavoriteType.
|
|
4911
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
5993
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
4912
5994
|
* @param {*} [options] Override http request option.
|
|
4913
5995
|
* @throws {RequiredError}
|
|
4914
5996
|
*/
|
|
@@ -5121,7 +6203,7 @@ export const FavoritesApiFp = function(configuration?: Configuration) {
|
|
|
5121
6203
|
* @param {number} [n] The number of objects to return.
|
|
5122
6204
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
5123
6205
|
* @param {string} [type] The type of favorites to return, FavoriteType.
|
|
5124
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
6206
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
5125
6207
|
* @param {*} [options] Override http request option.
|
|
5126
6208
|
* @throws {RequiredError}
|
|
5127
6209
|
*/
|
|
@@ -5226,7 +6308,7 @@ export const FavoritesApiFactory = function (configuration?: Configuration, base
|
|
|
5226
6308
|
* @param {number} [n] The number of objects to return.
|
|
5227
6309
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
5228
6310
|
* @param {string} [type] The type of favorites to return, FavoriteType.
|
|
5229
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
6311
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
5230
6312
|
* @param {*} [options] Override http request option.
|
|
5231
6313
|
* @throws {RequiredError}
|
|
5232
6314
|
*/
|
|
@@ -5338,7 +6420,7 @@ export class FavoritesApi extends BaseAPI {
|
|
|
5338
6420
|
* @param {number} [n] The number of objects to return.
|
|
5339
6421
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
5340
6422
|
* @param {string} [type] The type of favorites to return, FavoriteType.
|
|
5341
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
6423
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
5342
6424
|
* @param {*} [options] Override http request option.
|
|
5343
6425
|
* @throws {RequiredError}
|
|
5344
6426
|
* @memberof FavoritesApi
|
|
@@ -6646,7 +7728,7 @@ export class FriendsApi extends BaseAPI {
|
|
|
6646
7728
|
export const InstancesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
6647
7729
|
return {
|
|
6648
7730
|
/**
|
|
6649
|
-
* Returns an instance.
|
|
7731
|
+
* 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\"!
|
|
6650
7732
|
* @summary Get Instance
|
|
6651
7733
|
* @param {string} worldId
|
|
6652
7734
|
* @param {string} instanceId
|
|
@@ -6782,7 +7864,7 @@ export const InstancesApiFp = function(configuration?: Configuration) {
|
|
|
6782
7864
|
const localVarAxiosParamCreator = InstancesApiAxiosParamCreator(configuration)
|
|
6783
7865
|
return {
|
|
6784
7866
|
/**
|
|
6785
|
-
* Returns an instance.
|
|
7867
|
+
* 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\"!
|
|
6786
7868
|
* @summary Get Instance
|
|
6787
7869
|
* @param {string} worldId
|
|
6788
7870
|
* @param {string} instanceId
|
|
@@ -6828,7 +7910,7 @@ export const InstancesApiFactory = function (configuration?: Configuration, base
|
|
|
6828
7910
|
const localVarFp = InstancesApiFp(configuration)
|
|
6829
7911
|
return {
|
|
6830
7912
|
/**
|
|
6831
|
-
* Returns an instance.
|
|
7913
|
+
* 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\"!
|
|
6832
7914
|
* @summary Get Instance
|
|
6833
7915
|
* @param {string} worldId
|
|
6834
7916
|
* @param {string} instanceId
|
|
@@ -6871,7 +7953,7 @@ export const InstancesApiFactory = function (configuration?: Configuration, base
|
|
|
6871
7953
|
*/
|
|
6872
7954
|
export class InstancesApi extends BaseAPI {
|
|
6873
7955
|
/**
|
|
6874
|
-
* Returns an instance.
|
|
7956
|
+
* 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\"!
|
|
6875
7957
|
* @summary Get Instance
|
|
6876
7958
|
* @param {string} worldId
|
|
6877
7959
|
* @param {string} instanceId
|
|
@@ -7086,7 +8168,7 @@ export const InviteApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
7086
8168
|
};
|
|
7087
8169
|
},
|
|
7088
8170
|
/**
|
|
7089
|
-
* Resets a single Invite Message back to
|
|
8171
|
+
* 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.
|
|
7090
8172
|
* @summary Reset Invite Message
|
|
7091
8173
|
* @param {string} userId
|
|
7092
8174
|
* @param {'message' | 'response' | 'request' | 'requestResponse'} messageType
|
|
@@ -7282,7 +8364,7 @@ export const InviteApiFp = function(configuration?: Configuration) {
|
|
|
7282
8364
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
7283
8365
|
},
|
|
7284
8366
|
/**
|
|
7285
|
-
* Resets a single Invite Message back to
|
|
8367
|
+
* 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.
|
|
7286
8368
|
* @summary Reset Invite Message
|
|
7287
8369
|
* @param {string} userId
|
|
7288
8370
|
* @param {'message' | 'response' | 'request' | 'requestResponse'} messageType
|
|
@@ -7375,7 +8457,7 @@ export const InviteApiFactory = function (configuration?: Configuration, basePat
|
|
|
7375
8457
|
return localVarFp.requestInvite(userId, options).then((request) => request(axios, basePath));
|
|
7376
8458
|
},
|
|
7377
8459
|
/**
|
|
7378
|
-
* Resets a single Invite Message back to
|
|
8460
|
+
* 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.
|
|
7379
8461
|
* @summary Reset Invite Message
|
|
7380
8462
|
* @param {string} userId
|
|
7381
8463
|
* @param {'message' | 'response' | 'request' | 'requestResponse'} messageType
|
|
@@ -7473,7 +8555,7 @@ export class InviteApi extends BaseAPI {
|
|
|
7473
8555
|
}
|
|
7474
8556
|
|
|
7475
8557
|
/**
|
|
7476
|
-
* Resets a single Invite Message back to
|
|
8558
|
+
* 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.
|
|
7477
8559
|
* @summary Reset Invite Message
|
|
7478
8560
|
* @param {string} userId
|
|
7479
8561
|
* @param {'message' | 'response' | 'request' | 'requestResponse'} messageType
|
|
@@ -8710,6 +9792,46 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
8710
9792
|
|
|
8711
9793
|
|
|
8712
9794
|
|
|
9795
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
9796
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9797
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
9798
|
+
|
|
9799
|
+
return {
|
|
9800
|
+
url: toPathString(localVarUrlObj),
|
|
9801
|
+
options: localVarRequestOptions,
|
|
9802
|
+
};
|
|
9803
|
+
},
|
|
9804
|
+
/**
|
|
9805
|
+
* 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.
|
|
9806
|
+
* @summary Show Information Notices
|
|
9807
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
9808
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
9809
|
+
* @param {*} [options] Override http request option.
|
|
9810
|
+
* @throws {RequiredError}
|
|
9811
|
+
*/
|
|
9812
|
+
getInfoPush: async (require?: string, include?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
9813
|
+
const localVarPath = `/infoPush`;
|
|
9814
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9815
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
9816
|
+
let baseOptions;
|
|
9817
|
+
if (configuration) {
|
|
9818
|
+
baseOptions = configuration.baseOptions;
|
|
9819
|
+
}
|
|
9820
|
+
|
|
9821
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
9822
|
+
const localVarHeaderParameter = {} as any;
|
|
9823
|
+
const localVarQueryParameter = {} as any;
|
|
9824
|
+
|
|
9825
|
+
if (require !== undefined) {
|
|
9826
|
+
localVarQueryParameter['require'] = require;
|
|
9827
|
+
}
|
|
9828
|
+
|
|
9829
|
+
if (include !== undefined) {
|
|
9830
|
+
localVarQueryParameter['include'] = include;
|
|
9831
|
+
}
|
|
9832
|
+
|
|
9833
|
+
|
|
9834
|
+
|
|
8713
9835
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8714
9836
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8715
9837
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -8842,6 +9964,18 @@ export const SystemApiFp = function(configuration?: Configuration) {
|
|
|
8842
9964
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getHealth(options);
|
|
8843
9965
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
8844
9966
|
},
|
|
9967
|
+
/**
|
|
9968
|
+
* 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.
|
|
9969
|
+
* @summary Show Information Notices
|
|
9970
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
9971
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
9972
|
+
* @param {*} [options] Override http request option.
|
|
9973
|
+
* @throws {RequiredError}
|
|
9974
|
+
*/
|
|
9975
|
+
async getInfoPush(require?: string, include?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InfoPush>>> {
|
|
9976
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getInfoPush(require, include, options);
|
|
9977
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
9978
|
+
},
|
|
8845
9979
|
/**
|
|
8846
9980
|
* Fetches the JavaScript code to the frontend React website.
|
|
8847
9981
|
* @summary Download JavaScript
|
|
@@ -8913,6 +10047,17 @@ export const SystemApiFactory = function (configuration?: Configuration, basePat
|
|
|
8913
10047
|
getHealth(options?: any): AxiosPromise<APIHealth> {
|
|
8914
10048
|
return localVarFp.getHealth(options).then((request) => request(axios, basePath));
|
|
8915
10049
|
},
|
|
10050
|
+
/**
|
|
10051
|
+
* 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.
|
|
10052
|
+
* @summary Show Information Notices
|
|
10053
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
10054
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
10055
|
+
* @param {*} [options] Override http request option.
|
|
10056
|
+
* @throws {RequiredError}
|
|
10057
|
+
*/
|
|
10058
|
+
getInfoPush(require?: string, include?: string, options?: any): AxiosPromise<Array<InfoPush>> {
|
|
10059
|
+
return localVarFp.getInfoPush(require, include, options).then((request) => request(axios, basePath));
|
|
10060
|
+
},
|
|
8916
10061
|
/**
|
|
8917
10062
|
* Fetches the JavaScript code to the frontend React website.
|
|
8918
10063
|
* @summary Download JavaScript
|
|
@@ -8990,6 +10135,19 @@ export class SystemApi extends BaseAPI {
|
|
|
8990
10135
|
return SystemApiFp(this.configuration).getHealth(options).then((request) => request(this.axios, this.basePath));
|
|
8991
10136
|
}
|
|
8992
10137
|
|
|
10138
|
+
/**
|
|
10139
|
+
* 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.
|
|
10140
|
+
* @summary Show Information Notices
|
|
10141
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
10142
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
10143
|
+
* @param {*} [options] Override http request option.
|
|
10144
|
+
* @throws {RequiredError}
|
|
10145
|
+
* @memberof SystemApi
|
|
10146
|
+
*/
|
|
10147
|
+
public getInfoPush(require?: string, include?: string, options?: AxiosRequestConfig) {
|
|
10148
|
+
return SystemApiFp(this.configuration).getInfoPush(require, include, options).then((request) => request(this.axios, this.basePath));
|
|
10149
|
+
}
|
|
10150
|
+
|
|
8993
10151
|
/**
|
|
8994
10152
|
* Fetches the JavaScript code to the frontend React website.
|
|
8995
10153
|
* @summary Download JavaScript
|
|
@@ -9457,7 +10615,7 @@ export const WorldsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
9457
10615
|
* @param {'ascending' | 'descending'} [order]
|
|
9458
10616
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
9459
10617
|
* @param {string} [search] Filters by world name.
|
|
9460
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
10618
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
9461
10619
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
9462
10620
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
9463
10621
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -9551,7 +10709,7 @@ export const WorldsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
9551
10709
|
* @param {'ascending' | 'descending'} [order]
|
|
9552
10710
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
9553
10711
|
* @param {string} [search] Filters by world name.
|
|
9554
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
10712
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
9555
10713
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
9556
10714
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
9557
10715
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -9650,7 +10808,7 @@ export const WorldsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
9650
10808
|
* @param {'ascending' | 'descending'} [order]
|
|
9651
10809
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
9652
10810
|
* @param {string} [search] Filters by world name.
|
|
9653
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
10811
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
9654
10812
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
9655
10813
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
9656
10814
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -9944,7 +11102,7 @@ export const WorldsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
9944
11102
|
* @param {'ascending' | 'descending'} [order]
|
|
9945
11103
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
9946
11104
|
* @param {string} [search] Filters by world name.
|
|
9947
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
11105
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
9948
11106
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
9949
11107
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
9950
11108
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -10158,7 +11316,7 @@ export const WorldsApiFp = function(configuration?: Configuration) {
|
|
|
10158
11316
|
* @param {'ascending' | 'descending'} [order]
|
|
10159
11317
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
10160
11318
|
* @param {string} [search] Filters by world name.
|
|
10161
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
11319
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
10162
11320
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
10163
11321
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
10164
11322
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -10180,7 +11338,7 @@ export const WorldsApiFp = function(configuration?: Configuration) {
|
|
|
10180
11338
|
* @param {'ascending' | 'descending'} [order]
|
|
10181
11339
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
10182
11340
|
* @param {string} [search] Filters by world name.
|
|
10183
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
11341
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
10184
11342
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
10185
11343
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
10186
11344
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -10203,7 +11361,7 @@ export const WorldsApiFp = function(configuration?: Configuration) {
|
|
|
10203
11361
|
* @param {'ascending' | 'descending'} [order]
|
|
10204
11362
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
10205
11363
|
* @param {string} [search] Filters by world name.
|
|
10206
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
11364
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
10207
11365
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
10208
11366
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
10209
11367
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -10285,7 +11443,7 @@ export const WorldsApiFp = function(configuration?: Configuration) {
|
|
|
10285
11443
|
* @param {'ascending' | 'descending'} [order]
|
|
10286
11444
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
10287
11445
|
* @param {string} [search] Filters by world name.
|
|
10288
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
11446
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
10289
11447
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
10290
11448
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
10291
11449
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -10360,7 +11518,7 @@ export const WorldsApiFactory = function (configuration?: Configuration, basePat
|
|
|
10360
11518
|
* @param {'ascending' | 'descending'} [order]
|
|
10361
11519
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
10362
11520
|
* @param {string} [search] Filters by world name.
|
|
10363
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
11521
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
10364
11522
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
10365
11523
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
10366
11524
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -10381,7 +11539,7 @@ export const WorldsApiFactory = function (configuration?: Configuration, basePat
|
|
|
10381
11539
|
* @param {'ascending' | 'descending'} [order]
|
|
10382
11540
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
10383
11541
|
* @param {string} [search] Filters by world name.
|
|
10384
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
11542
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
10385
11543
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
10386
11544
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
10387
11545
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -10403,7 +11561,7 @@ export const WorldsApiFactory = function (configuration?: Configuration, basePat
|
|
|
10403
11561
|
* @param {'ascending' | 'descending'} [order]
|
|
10404
11562
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
10405
11563
|
* @param {string} [search] Filters by world name.
|
|
10406
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
11564
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
10407
11565
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
10408
11566
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
10409
11567
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -10479,7 +11637,7 @@ export const WorldsApiFactory = function (configuration?: Configuration, basePat
|
|
|
10479
11637
|
* @param {'ascending' | 'descending'} [order]
|
|
10480
11638
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
10481
11639
|
* @param {string} [search] Filters by world name.
|
|
10482
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
11640
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
10483
11641
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
10484
11642
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
10485
11643
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -10555,7 +11713,7 @@ export class WorldsApi extends BaseAPI {
|
|
|
10555
11713
|
* @param {'ascending' | 'descending'} [order]
|
|
10556
11714
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
10557
11715
|
* @param {string} [search] Filters by world name.
|
|
10558
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
11716
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
10559
11717
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
10560
11718
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
10561
11719
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -10578,7 +11736,7 @@ export class WorldsApi extends BaseAPI {
|
|
|
10578
11736
|
* @param {'ascending' | 'descending'} [order]
|
|
10579
11737
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
10580
11738
|
* @param {string} [search] Filters by world name.
|
|
10581
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
11739
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
10582
11740
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
10583
11741
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
10584
11742
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -10602,7 +11760,7 @@ export class WorldsApi extends BaseAPI {
|
|
|
10602
11760
|
* @param {'ascending' | 'descending'} [order]
|
|
10603
11761
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
10604
11762
|
* @param {string} [search] Filters by world name.
|
|
10605
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
11763
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
10606
11764
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
10607
11765
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
10608
11766
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
@@ -10690,7 +11848,7 @@ export class WorldsApi extends BaseAPI {
|
|
|
10690
11848
|
* @param {'ascending' | 'descending'} [order]
|
|
10691
11849
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
10692
11850
|
* @param {string} [search] Filters by world name.
|
|
10693
|
-
* @param {string} [tag] Tags to include (comma-separated).
|
|
11851
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
10694
11852
|
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
10695
11853
|
* @param {'public' | 'private' | 'hidden' | 'all'} [releaseStatus] Filter by ReleaseStatus.
|
|
10696
11854
|
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|