vrchat 1.20.0 → 1.20.2
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 +6770 -4054
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +2659 -722
- package/dist/api.js +4458 -2797
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* VRChat API Documentation
|
|
3
3
|
*
|
|
4
|
-
* The version of the OpenAPI document: 1.20.
|
|
4
|
+
* The version of the OpenAPI document: 1.20.2
|
|
5
5
|
* Contact: vrchatapi.lpv0t@aries.fyi
|
|
6
6
|
*
|
|
7
7
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1664,6 +1664,128 @@ export interface AddGroupGalleryImageRequest {
|
|
|
1664
1664
|
*/
|
|
1665
1665
|
'fileId': string;
|
|
1666
1666
|
}
|
|
1667
|
+
/**
|
|
1668
|
+
*
|
|
1669
|
+
* @export
|
|
1670
|
+
* @interface AdminAssetBundle
|
|
1671
|
+
*/
|
|
1672
|
+
export interface AdminAssetBundle {
|
|
1673
|
+
/**
|
|
1674
|
+
*
|
|
1675
|
+
* @type {string}
|
|
1676
|
+
* @memberof AdminAssetBundle
|
|
1677
|
+
*/
|
|
1678
|
+
'_created_at': string;
|
|
1679
|
+
/**
|
|
1680
|
+
*
|
|
1681
|
+
* @type {string}
|
|
1682
|
+
* @memberof AdminAssetBundle
|
|
1683
|
+
*/
|
|
1684
|
+
'_updated_at': string;
|
|
1685
|
+
/**
|
|
1686
|
+
*
|
|
1687
|
+
* @type {string}
|
|
1688
|
+
* @memberof AdminAssetBundle
|
|
1689
|
+
*/
|
|
1690
|
+
'assetType': string;
|
|
1691
|
+
/**
|
|
1692
|
+
* 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.
|
|
1693
|
+
* @type {string}
|
|
1694
|
+
* @memberof AdminAssetBundle
|
|
1695
|
+
*/
|
|
1696
|
+
'authorId': string;
|
|
1697
|
+
/**
|
|
1698
|
+
*
|
|
1699
|
+
* @type {string}
|
|
1700
|
+
* @memberof AdminAssetBundle
|
|
1701
|
+
*/
|
|
1702
|
+
'authorName': string;
|
|
1703
|
+
/**
|
|
1704
|
+
*
|
|
1705
|
+
* @type {string}
|
|
1706
|
+
* @memberof AdminAssetBundle
|
|
1707
|
+
*/
|
|
1708
|
+
'description': string;
|
|
1709
|
+
/**
|
|
1710
|
+
*
|
|
1711
|
+
* @type {string}
|
|
1712
|
+
* @memberof AdminAssetBundle
|
|
1713
|
+
*/
|
|
1714
|
+
'imageUrl': string;
|
|
1715
|
+
/**
|
|
1716
|
+
*
|
|
1717
|
+
* @type {string}
|
|
1718
|
+
* @memberof AdminAssetBundle
|
|
1719
|
+
*/
|
|
1720
|
+
'name': string;
|
|
1721
|
+
/**
|
|
1722
|
+
*
|
|
1723
|
+
* @type {ReleaseStatus}
|
|
1724
|
+
* @memberof AdminAssetBundle
|
|
1725
|
+
*/
|
|
1726
|
+
'releaseStatus': ReleaseStatus;
|
|
1727
|
+
/**
|
|
1728
|
+
*
|
|
1729
|
+
* @type {Array<string>}
|
|
1730
|
+
* @memberof AdminAssetBundle
|
|
1731
|
+
*/
|
|
1732
|
+
'tags': Array<string>;
|
|
1733
|
+
/**
|
|
1734
|
+
*
|
|
1735
|
+
* @type {string}
|
|
1736
|
+
* @memberof AdminAssetBundle
|
|
1737
|
+
*/
|
|
1738
|
+
'thumbnailImageUrl': string;
|
|
1739
|
+
/**
|
|
1740
|
+
*
|
|
1741
|
+
* @type {string}
|
|
1742
|
+
* @memberof AdminAssetBundle
|
|
1743
|
+
*/
|
|
1744
|
+
'unityPackageUrl': string | null;
|
|
1745
|
+
/**
|
|
1746
|
+
*
|
|
1747
|
+
* @type {Set<AdminUnityPackage>}
|
|
1748
|
+
* @memberof AdminAssetBundle
|
|
1749
|
+
*/
|
|
1750
|
+
'unityPackages': Set<AdminUnityPackage>;
|
|
1751
|
+
}
|
|
1752
|
+
/**
|
|
1753
|
+
*
|
|
1754
|
+
* @export
|
|
1755
|
+
* @interface AdminUnityPackage
|
|
1756
|
+
*/
|
|
1757
|
+
export interface AdminUnityPackage {
|
|
1758
|
+
/**
|
|
1759
|
+
*
|
|
1760
|
+
* @type {string}
|
|
1761
|
+
* @memberof AdminUnityPackage
|
|
1762
|
+
*/
|
|
1763
|
+
'assetUrl': string;
|
|
1764
|
+
/**
|
|
1765
|
+
*
|
|
1766
|
+
* @type {number}
|
|
1767
|
+
* @memberof AdminUnityPackage
|
|
1768
|
+
*/
|
|
1769
|
+
'assetVersion': number;
|
|
1770
|
+
/**
|
|
1771
|
+
* This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`.
|
|
1772
|
+
* @type {string}
|
|
1773
|
+
* @memberof AdminUnityPackage
|
|
1774
|
+
*/
|
|
1775
|
+
'platform': string;
|
|
1776
|
+
/**
|
|
1777
|
+
*
|
|
1778
|
+
* @type {string}
|
|
1779
|
+
* @memberof AdminUnityPackage
|
|
1780
|
+
*/
|
|
1781
|
+
'unityVersion': string;
|
|
1782
|
+
/**
|
|
1783
|
+
*
|
|
1784
|
+
* @type {string}
|
|
1785
|
+
* @memberof AdminUnityPackage
|
|
1786
|
+
*/
|
|
1787
|
+
'variant': string;
|
|
1788
|
+
}
|
|
1667
1789
|
/**
|
|
1668
1790
|
* `verified` is obsolete. User who have verified and are 18+ can switch to `plus18` status.
|
|
1669
1791
|
* @export
|
|
@@ -1931,6 +2053,25 @@ export interface AvatarPublishedListingsInner {
|
|
|
1931
2053
|
*/
|
|
1932
2054
|
'priceTokens'?: number;
|
|
1933
2055
|
}
|
|
2056
|
+
/**
|
|
2057
|
+
*
|
|
2058
|
+
* @export
|
|
2059
|
+
* @interface AvatarStyle
|
|
2060
|
+
*/
|
|
2061
|
+
export interface AvatarStyle {
|
|
2062
|
+
/**
|
|
2063
|
+
*
|
|
2064
|
+
* @type {string}
|
|
2065
|
+
* @memberof AvatarStyle
|
|
2066
|
+
*/
|
|
2067
|
+
'id': string;
|
|
2068
|
+
/**
|
|
2069
|
+
*
|
|
2070
|
+
* @type {string}
|
|
2071
|
+
* @memberof AvatarStyle
|
|
2072
|
+
*/
|
|
2073
|
+
'styleName': string;
|
|
2074
|
+
}
|
|
1934
2075
|
/**
|
|
1935
2076
|
*
|
|
1936
2077
|
* @export
|
|
@@ -2062,6 +2203,194 @@ export interface BanGroupMemberRequest {
|
|
|
2062
2203
|
*/
|
|
2063
2204
|
'userId': string;
|
|
2064
2205
|
}
|
|
2206
|
+
/**
|
|
2207
|
+
*
|
|
2208
|
+
* @export
|
|
2209
|
+
* @interface CalendarEvent
|
|
2210
|
+
*/
|
|
2211
|
+
export interface CalendarEvent {
|
|
2212
|
+
/**
|
|
2213
|
+
*
|
|
2214
|
+
* @type {string}
|
|
2215
|
+
* @memberof CalendarEvent
|
|
2216
|
+
*/
|
|
2217
|
+
'accessType': string;
|
|
2218
|
+
/**
|
|
2219
|
+
*
|
|
2220
|
+
* @type {string}
|
|
2221
|
+
* @memberof CalendarEvent
|
|
2222
|
+
*/
|
|
2223
|
+
'category'?: string;
|
|
2224
|
+
/**
|
|
2225
|
+
*
|
|
2226
|
+
* @type {number}
|
|
2227
|
+
* @memberof CalendarEvent
|
|
2228
|
+
*/
|
|
2229
|
+
'closeInstanceAfterEndMinutes'?: number;
|
|
2230
|
+
/**
|
|
2231
|
+
*
|
|
2232
|
+
* @type {string}
|
|
2233
|
+
* @memberof CalendarEvent
|
|
2234
|
+
*/
|
|
2235
|
+
'createdAt': string;
|
|
2236
|
+
/**
|
|
2237
|
+
*
|
|
2238
|
+
* @type {string}
|
|
2239
|
+
* @memberof CalendarEvent
|
|
2240
|
+
*/
|
|
2241
|
+
'deletedAt'?: string | null;
|
|
2242
|
+
/**
|
|
2243
|
+
*
|
|
2244
|
+
* @type {string}
|
|
2245
|
+
* @memberof CalendarEvent
|
|
2246
|
+
*/
|
|
2247
|
+
'description'?: string;
|
|
2248
|
+
/**
|
|
2249
|
+
*
|
|
2250
|
+
* @type {string}
|
|
2251
|
+
* @memberof CalendarEvent
|
|
2252
|
+
*/
|
|
2253
|
+
'endsAt'?: string;
|
|
2254
|
+
/**
|
|
2255
|
+
*
|
|
2256
|
+
* @type {boolean}
|
|
2257
|
+
* @memberof CalendarEvent
|
|
2258
|
+
*/
|
|
2259
|
+
'featured'?: boolean;
|
|
2260
|
+
/**
|
|
2261
|
+
*
|
|
2262
|
+
* @type {number}
|
|
2263
|
+
* @memberof CalendarEvent
|
|
2264
|
+
*/
|
|
2265
|
+
'guestEarlyJoinMinutes'?: number;
|
|
2266
|
+
/**
|
|
2267
|
+
*
|
|
2268
|
+
* @type {number}
|
|
2269
|
+
* @memberof CalendarEvent
|
|
2270
|
+
*/
|
|
2271
|
+
'hostEarlyJoinMinutes'?: number;
|
|
2272
|
+
/**
|
|
2273
|
+
*
|
|
2274
|
+
* @type {string}
|
|
2275
|
+
* @memberof CalendarEvent
|
|
2276
|
+
*/
|
|
2277
|
+
'id': string;
|
|
2278
|
+
/**
|
|
2279
|
+
*
|
|
2280
|
+
* @type {string}
|
|
2281
|
+
* @memberof CalendarEvent
|
|
2282
|
+
*/
|
|
2283
|
+
'imageId'?: string;
|
|
2284
|
+
/**
|
|
2285
|
+
*
|
|
2286
|
+
* @type {string}
|
|
2287
|
+
* @memberof CalendarEvent
|
|
2288
|
+
*/
|
|
2289
|
+
'imageUrl'?: string | null;
|
|
2290
|
+
/**
|
|
2291
|
+
*
|
|
2292
|
+
* @type {number}
|
|
2293
|
+
* @memberof CalendarEvent
|
|
2294
|
+
*/
|
|
2295
|
+
'interestedUserCount'?: number;
|
|
2296
|
+
/**
|
|
2297
|
+
*
|
|
2298
|
+
* @type {boolean}
|
|
2299
|
+
* @memberof CalendarEvent
|
|
2300
|
+
*/
|
|
2301
|
+
'isDraft'?: boolean;
|
|
2302
|
+
/**
|
|
2303
|
+
*
|
|
2304
|
+
* @type {Array<string>}
|
|
2305
|
+
* @memberof CalendarEvent
|
|
2306
|
+
*/
|
|
2307
|
+
'languages'?: Array<string>;
|
|
2308
|
+
/**
|
|
2309
|
+
*
|
|
2310
|
+
* @type {string}
|
|
2311
|
+
* @memberof CalendarEvent
|
|
2312
|
+
*/
|
|
2313
|
+
'ownerId'?: string;
|
|
2314
|
+
/**
|
|
2315
|
+
*
|
|
2316
|
+
* @type {Array<string>}
|
|
2317
|
+
* @memberof CalendarEvent
|
|
2318
|
+
*/
|
|
2319
|
+
'platforms'?: Array<string>;
|
|
2320
|
+
/**
|
|
2321
|
+
*
|
|
2322
|
+
* @type {Array<string>}
|
|
2323
|
+
* @memberof CalendarEvent
|
|
2324
|
+
*/
|
|
2325
|
+
'roleIds'?: Array<string> | null;
|
|
2326
|
+
/**
|
|
2327
|
+
*
|
|
2328
|
+
* @type {string}
|
|
2329
|
+
* @memberof CalendarEvent
|
|
2330
|
+
*/
|
|
2331
|
+
'startsAt'?: string;
|
|
2332
|
+
/**
|
|
2333
|
+
*
|
|
2334
|
+
* @type {Array<string>}
|
|
2335
|
+
* @memberof CalendarEvent
|
|
2336
|
+
*/
|
|
2337
|
+
'tags'?: Array<string>;
|
|
2338
|
+
/**
|
|
2339
|
+
*
|
|
2340
|
+
* @type {string}
|
|
2341
|
+
* @memberof CalendarEvent
|
|
2342
|
+
*/
|
|
2343
|
+
'title': string;
|
|
2344
|
+
/**
|
|
2345
|
+
*
|
|
2346
|
+
* @type {string}
|
|
2347
|
+
* @memberof CalendarEvent
|
|
2348
|
+
*/
|
|
2349
|
+
'type'?: string;
|
|
2350
|
+
/**
|
|
2351
|
+
*
|
|
2352
|
+
* @type {string}
|
|
2353
|
+
* @memberof CalendarEvent
|
|
2354
|
+
*/
|
|
2355
|
+
'updatedAt'?: string;
|
|
2356
|
+
/**
|
|
2357
|
+
*
|
|
2358
|
+
* @type {boolean}
|
|
2359
|
+
* @memberof CalendarEvent
|
|
2360
|
+
*/
|
|
2361
|
+
'usesInstanceOverflow'?: boolean;
|
|
2362
|
+
/**
|
|
2363
|
+
*
|
|
2364
|
+
* @type {CalendarEventUserInterest}
|
|
2365
|
+
* @memberof CalendarEvent
|
|
2366
|
+
*/
|
|
2367
|
+
'userInterest'?: CalendarEventUserInterest;
|
|
2368
|
+
}
|
|
2369
|
+
/**
|
|
2370
|
+
*
|
|
2371
|
+
* @export
|
|
2372
|
+
* @interface CalendarEventUserInterest
|
|
2373
|
+
*/
|
|
2374
|
+
export interface CalendarEventUserInterest {
|
|
2375
|
+
/**
|
|
2376
|
+
*
|
|
2377
|
+
* @type {string}
|
|
2378
|
+
* @memberof CalendarEventUserInterest
|
|
2379
|
+
*/
|
|
2380
|
+
'createdAt'?: string;
|
|
2381
|
+
/**
|
|
2382
|
+
*
|
|
2383
|
+
* @type {boolean}
|
|
2384
|
+
* @memberof CalendarEventUserInterest
|
|
2385
|
+
*/
|
|
2386
|
+
'isFollowing'?: boolean;
|
|
2387
|
+
/**
|
|
2388
|
+
*
|
|
2389
|
+
* @type {string}
|
|
2390
|
+
* @memberof CalendarEventUserInterest
|
|
2391
|
+
*/
|
|
2392
|
+
'updatedAt'?: string;
|
|
2393
|
+
}
|
|
2065
2394
|
/**
|
|
2066
2395
|
*
|
|
2067
2396
|
* @export
|
|
@@ -2175,21 +2504,147 @@ export interface CreateAvatarRequest {
|
|
|
2175
2504
|
/**
|
|
2176
2505
|
*
|
|
2177
2506
|
* @export
|
|
2178
|
-
* @interface
|
|
2507
|
+
* @interface CreateCalendarEventRequest
|
|
2179
2508
|
*/
|
|
2180
|
-
export interface
|
|
2509
|
+
export interface CreateCalendarEventRequest {
|
|
2181
2510
|
/**
|
|
2182
|
-
*
|
|
2511
|
+
* Event title
|
|
2183
2512
|
* @type {string}
|
|
2184
|
-
* @memberof
|
|
2513
|
+
* @memberof CreateCalendarEventRequest
|
|
2185
2514
|
*/
|
|
2186
|
-
'
|
|
2515
|
+
'title': string;
|
|
2187
2516
|
/**
|
|
2188
|
-
*
|
|
2189
|
-
* @type {
|
|
2190
|
-
* @memberof
|
|
2517
|
+
* Time the event starts at
|
|
2518
|
+
* @type {string}
|
|
2519
|
+
* @memberof CreateCalendarEventRequest
|
|
2191
2520
|
*/
|
|
2192
|
-
'
|
|
2521
|
+
'startsAt': string;
|
|
2522
|
+
/**
|
|
2523
|
+
*
|
|
2524
|
+
* @type {string}
|
|
2525
|
+
* @memberof CreateCalendarEventRequest
|
|
2526
|
+
*/
|
|
2527
|
+
'description': string;
|
|
2528
|
+
/**
|
|
2529
|
+
* Time the event ends at
|
|
2530
|
+
* @type {string}
|
|
2531
|
+
* @memberof CreateCalendarEventRequest
|
|
2532
|
+
*/
|
|
2533
|
+
'endsAt': string;
|
|
2534
|
+
/**
|
|
2535
|
+
*
|
|
2536
|
+
* @type {string}
|
|
2537
|
+
* @memberof CreateCalendarEventRequest
|
|
2538
|
+
*/
|
|
2539
|
+
'category': string;
|
|
2540
|
+
/**
|
|
2541
|
+
*
|
|
2542
|
+
* @type {Array<string>}
|
|
2543
|
+
* @memberof CreateCalendarEventRequest
|
|
2544
|
+
*/
|
|
2545
|
+
'tags'?: Array<string>;
|
|
2546
|
+
/**
|
|
2547
|
+
*
|
|
2548
|
+
* @type {boolean}
|
|
2549
|
+
* @memberof CreateCalendarEventRequest
|
|
2550
|
+
*/
|
|
2551
|
+
'isDraft'?: boolean;
|
|
2552
|
+
/**
|
|
2553
|
+
*
|
|
2554
|
+
* @type {string}
|
|
2555
|
+
* @memberof CreateCalendarEventRequest
|
|
2556
|
+
*/
|
|
2557
|
+
'imageId'?: string;
|
|
2558
|
+
/**
|
|
2559
|
+
*
|
|
2560
|
+
* @type {Array<string>}
|
|
2561
|
+
* @memberof CreateCalendarEventRequest
|
|
2562
|
+
*/
|
|
2563
|
+
'roleIds'?: Array<string>;
|
|
2564
|
+
/**
|
|
2565
|
+
*
|
|
2566
|
+
* @type {string}
|
|
2567
|
+
* @memberof CreateCalendarEventRequest
|
|
2568
|
+
*/
|
|
2569
|
+
'parentId'?: string;
|
|
2570
|
+
/**
|
|
2571
|
+
*
|
|
2572
|
+
* @type {Array<string>}
|
|
2573
|
+
* @memberof CreateCalendarEventRequest
|
|
2574
|
+
*/
|
|
2575
|
+
'platforms'?: Array<string>;
|
|
2576
|
+
/**
|
|
2577
|
+
*
|
|
2578
|
+
* @type {Array<string>}
|
|
2579
|
+
* @memberof CreateCalendarEventRequest
|
|
2580
|
+
*/
|
|
2581
|
+
'languages'?: Array<string>;
|
|
2582
|
+
/**
|
|
2583
|
+
* Send notification to group members.
|
|
2584
|
+
* @type {boolean}
|
|
2585
|
+
* @memberof CreateCalendarEventRequest
|
|
2586
|
+
*/
|
|
2587
|
+
'sendCreationNotification': boolean;
|
|
2588
|
+
/**
|
|
2589
|
+
*
|
|
2590
|
+
* @type {boolean}
|
|
2591
|
+
* @memberof CreateCalendarEventRequest
|
|
2592
|
+
*/
|
|
2593
|
+
'featured'?: boolean;
|
|
2594
|
+
/**
|
|
2595
|
+
*
|
|
2596
|
+
* @type {number}
|
|
2597
|
+
* @memberof CreateCalendarEventRequest
|
|
2598
|
+
*/
|
|
2599
|
+
'hostEarlyJoinMinutes'?: number;
|
|
2600
|
+
/**
|
|
2601
|
+
*
|
|
2602
|
+
* @type {number}
|
|
2603
|
+
* @memberof CreateCalendarEventRequest
|
|
2604
|
+
*/
|
|
2605
|
+
'guestEarlyJoinMinutes'?: number;
|
|
2606
|
+
/**
|
|
2607
|
+
*
|
|
2608
|
+
* @type {number}
|
|
2609
|
+
* @memberof CreateCalendarEventRequest
|
|
2610
|
+
*/
|
|
2611
|
+
'closeInstanceAfterEndMinutes'?: number;
|
|
2612
|
+
/**
|
|
2613
|
+
*
|
|
2614
|
+
* @type {boolean}
|
|
2615
|
+
* @memberof CreateCalendarEventRequest
|
|
2616
|
+
*/
|
|
2617
|
+
'usesInstanceOverflow'?: boolean;
|
|
2618
|
+
/**
|
|
2619
|
+
*
|
|
2620
|
+
* @type {string}
|
|
2621
|
+
* @memberof CreateCalendarEventRequest
|
|
2622
|
+
*/
|
|
2623
|
+
'accessType': CreateCalendarEventRequestAccessTypeEnum;
|
|
2624
|
+
}
|
|
2625
|
+
export declare const CreateCalendarEventRequestAccessTypeEnum: {
|
|
2626
|
+
readonly Public: "public";
|
|
2627
|
+
readonly Group: "group";
|
|
2628
|
+
};
|
|
2629
|
+
export type CreateCalendarEventRequestAccessTypeEnum = typeof CreateCalendarEventRequestAccessTypeEnum[keyof typeof CreateCalendarEventRequestAccessTypeEnum];
|
|
2630
|
+
/**
|
|
2631
|
+
*
|
|
2632
|
+
* @export
|
|
2633
|
+
* @interface CreateFileRequest
|
|
2634
|
+
*/
|
|
2635
|
+
export interface CreateFileRequest {
|
|
2636
|
+
/**
|
|
2637
|
+
*
|
|
2638
|
+
* @type {string}
|
|
2639
|
+
* @memberof CreateFileRequest
|
|
2640
|
+
*/
|
|
2641
|
+
'name': string;
|
|
2642
|
+
/**
|
|
2643
|
+
*
|
|
2644
|
+
* @type {MIMEType}
|
|
2645
|
+
* @memberof CreateFileRequest
|
|
2646
|
+
*/
|
|
2647
|
+
'mimeType': MIMEType;
|
|
2193
2648
|
/**
|
|
2194
2649
|
*
|
|
2195
2650
|
* @type {string}
|
|
@@ -4254,6 +4709,19 @@ export interface FinishFileDataUploadRequest {
|
|
|
4254
4709
|
*/
|
|
4255
4710
|
'maxParts': string;
|
|
4256
4711
|
}
|
|
4712
|
+
/**
|
|
4713
|
+
*
|
|
4714
|
+
* @export
|
|
4715
|
+
* @interface FollowCalendarEventRequest
|
|
4716
|
+
*/
|
|
4717
|
+
export interface FollowCalendarEventRequest {
|
|
4718
|
+
/**
|
|
4719
|
+
*
|
|
4720
|
+
* @type {boolean}
|
|
4721
|
+
* @memberof FollowCalendarEventRequest
|
|
4722
|
+
*/
|
|
4723
|
+
'isFollowing': boolean;
|
|
4724
|
+
}
|
|
4257
4725
|
/**
|
|
4258
4726
|
*
|
|
4259
4727
|
* @export
|
|
@@ -5293,6 +5761,7 @@ export declare const GroupPermissions: {
|
|
|
5293
5761
|
readonly group_members_viewall: "group-members-viewall";
|
|
5294
5762
|
readonly group_roles_assign: "group-roles-assign";
|
|
5295
5763
|
readonly group_roles_manage: "group-roles-manage";
|
|
5764
|
+
readonly group_calendar_manage: "group-calendar-manage";
|
|
5296
5765
|
};
|
|
5297
5766
|
export type GroupPermissions = typeof GroupPermissions[keyof typeof GroupPermissions];
|
|
5298
5767
|
/**
|
|
@@ -6136,560 +6605,994 @@ export type InstanceType = typeof InstanceType[keyof typeof InstanceType];
|
|
|
6136
6605
|
/**
|
|
6137
6606
|
*
|
|
6138
6607
|
* @export
|
|
6139
|
-
* @interface
|
|
6608
|
+
* @interface Inventory
|
|
6140
6609
|
*/
|
|
6141
|
-
export interface
|
|
6142
|
-
/**
|
|
6143
|
-
*
|
|
6144
|
-
* @type {boolean}
|
|
6145
|
-
* @memberof InviteMessage
|
|
6146
|
-
*/
|
|
6147
|
-
'canBeUpdated': boolean;
|
|
6148
|
-
/**
|
|
6149
|
-
*
|
|
6150
|
-
* @type {string}
|
|
6151
|
-
* @memberof InviteMessage
|
|
6152
|
-
*/
|
|
6153
|
-
'id': string;
|
|
6154
|
-
/**
|
|
6155
|
-
*
|
|
6156
|
-
* @type {string}
|
|
6157
|
-
* @memberof InviteMessage
|
|
6158
|
-
*/
|
|
6159
|
-
'message': string;
|
|
6610
|
+
export interface Inventory {
|
|
6160
6611
|
/**
|
|
6161
6612
|
*
|
|
6162
|
-
* @type {
|
|
6163
|
-
* @memberof
|
|
6164
|
-
*/
|
|
6165
|
-
'messageType': InviteMessageType;
|
|
6166
|
-
/**
|
|
6167
|
-
* Changes to 60 when updated, although probably server-side configurable.
|
|
6168
|
-
* @type {number}
|
|
6169
|
-
* @memberof InviteMessage
|
|
6613
|
+
* @type {Array<InventoryItem>}
|
|
6614
|
+
* @memberof Inventory
|
|
6170
6615
|
*/
|
|
6171
|
-
'
|
|
6616
|
+
'data': Array<InventoryItem>;
|
|
6172
6617
|
/**
|
|
6173
6618
|
*
|
|
6174
6619
|
* @type {number}
|
|
6175
|
-
* @memberof
|
|
6176
|
-
*/
|
|
6177
|
-
'slot': number;
|
|
6178
|
-
/**
|
|
6179
|
-
*
|
|
6180
|
-
* @type {string}
|
|
6181
|
-
* @memberof InviteMessage
|
|
6620
|
+
* @memberof Inventory
|
|
6182
6621
|
*/
|
|
6183
|
-
'
|
|
6622
|
+
'totalCount': number;
|
|
6184
6623
|
}
|
|
6185
6624
|
/**
|
|
6186
6625
|
*
|
|
6187
6626
|
* @export
|
|
6188
|
-
* @
|
|
6189
|
-
*/
|
|
6190
|
-
export declare const InviteMessageType: {
|
|
6191
|
-
readonly Message: "message";
|
|
6192
|
-
readonly Response: "response";
|
|
6193
|
-
readonly Request: "request";
|
|
6194
|
-
readonly RequestResponse: "requestResponse";
|
|
6195
|
-
};
|
|
6196
|
-
export type InviteMessageType = typeof InviteMessageType[keyof typeof InviteMessageType];
|
|
6197
|
-
/**
|
|
6198
|
-
*
|
|
6199
|
-
* @export
|
|
6200
|
-
* @interface InviteRequest
|
|
6627
|
+
* @interface InventoryDrop
|
|
6201
6628
|
*/
|
|
6202
|
-
export interface
|
|
6629
|
+
export interface InventoryDrop {
|
|
6203
6630
|
/**
|
|
6204
|
-
*
|
|
6631
|
+
* 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.
|
|
6205
6632
|
* @type {string}
|
|
6206
|
-
* @memberof
|
|
6633
|
+
* @memberof InventoryDrop
|
|
6207
6634
|
*/
|
|
6208
|
-
'
|
|
6635
|
+
'authorId': string;
|
|
6209
6636
|
/**
|
|
6210
6637
|
*
|
|
6211
|
-
* @type {
|
|
6212
|
-
* @memberof
|
|
6638
|
+
* @type {string}
|
|
6639
|
+
* @memberof InventoryDrop
|
|
6213
6640
|
*/
|
|
6214
|
-
'
|
|
6215
|
-
}
|
|
6216
|
-
/**
|
|
6217
|
-
*
|
|
6218
|
-
* @export
|
|
6219
|
-
* @interface InviteResponse
|
|
6220
|
-
*/
|
|
6221
|
-
export interface InviteResponse {
|
|
6641
|
+
'created_at': string;
|
|
6222
6642
|
/**
|
|
6223
6643
|
*
|
|
6224
|
-
* @type {
|
|
6225
|
-
* @memberof
|
|
6644
|
+
* @type {string}
|
|
6645
|
+
* @memberof InventoryDrop
|
|
6226
6646
|
*/
|
|
6227
|
-
'
|
|
6228
|
-
}
|
|
6229
|
-
/**
|
|
6230
|
-
*
|
|
6231
|
-
* @export
|
|
6232
|
-
* @interface Jam
|
|
6233
|
-
*/
|
|
6234
|
-
export interface Jam {
|
|
6647
|
+
'dropExpiryDate': string | null;
|
|
6235
6648
|
/**
|
|
6236
6649
|
*
|
|
6237
6650
|
* @type {string}
|
|
6238
|
-
* @memberof
|
|
6651
|
+
* @memberof InventoryDrop
|
|
6239
6652
|
*/
|
|
6240
|
-
'
|
|
6653
|
+
'endDropDate': string;
|
|
6241
6654
|
/**
|
|
6242
6655
|
*
|
|
6243
6656
|
* @type {string}
|
|
6244
|
-
* @memberof
|
|
6657
|
+
* @memberof InventoryDrop
|
|
6245
6658
|
*/
|
|
6246
6659
|
'id': string;
|
|
6247
6660
|
/**
|
|
6248
6661
|
*
|
|
6249
|
-
* @type {
|
|
6250
|
-
* @memberof
|
|
6662
|
+
* @type {string}
|
|
6663
|
+
* @memberof InventoryDrop
|
|
6251
6664
|
*/
|
|
6252
|
-
'
|
|
6665
|
+
'name': string;
|
|
6253
6666
|
/**
|
|
6254
6667
|
*
|
|
6255
|
-
* @type {
|
|
6256
|
-
* @memberof
|
|
6668
|
+
* @type {InventoryNotificationDetails}
|
|
6669
|
+
* @memberof InventoryDrop
|
|
6257
6670
|
*/
|
|
6258
|
-
'
|
|
6671
|
+
'notificationDetails': InventoryNotificationDetails;
|
|
6259
6672
|
/**
|
|
6260
|
-
*
|
|
6673
|
+
*
|
|
6261
6674
|
* @type {string}
|
|
6262
|
-
* @memberof
|
|
6675
|
+
* @memberof InventoryDrop
|
|
6263
6676
|
*/
|
|
6264
|
-
'
|
|
6677
|
+
'startDropDate': string;
|
|
6265
6678
|
/**
|
|
6266
6679
|
*
|
|
6267
|
-
* @type {
|
|
6268
|
-
* @memberof
|
|
6680
|
+
* @type {string}
|
|
6681
|
+
* @memberof InventoryDrop
|
|
6269
6682
|
*/
|
|
6270
|
-
'
|
|
6683
|
+
'status': string;
|
|
6271
6684
|
/**
|
|
6272
6685
|
*
|
|
6273
|
-
* @type {string}
|
|
6274
|
-
* @memberof
|
|
6686
|
+
* @type {Array<string>}
|
|
6687
|
+
* @memberof InventoryDrop
|
|
6275
6688
|
*/
|
|
6276
|
-
'
|
|
6689
|
+
'tags': Array<string>;
|
|
6277
6690
|
/**
|
|
6278
6691
|
*
|
|
6279
|
-
* @type {
|
|
6280
|
-
* @memberof
|
|
6692
|
+
* @type {string}
|
|
6693
|
+
* @memberof InventoryDrop
|
|
6281
6694
|
*/
|
|
6282
|
-
'
|
|
6695
|
+
'targetGroup': string;
|
|
6283
6696
|
/**
|
|
6284
6697
|
*
|
|
6285
|
-
* @type {string}
|
|
6286
|
-
* @memberof
|
|
6698
|
+
* @type {Array<string>}
|
|
6699
|
+
* @memberof InventoryDrop
|
|
6287
6700
|
*/
|
|
6288
|
-
'
|
|
6701
|
+
'templateIds': Array<string>;
|
|
6289
6702
|
/**
|
|
6290
6703
|
*
|
|
6291
6704
|
* @type {string}
|
|
6292
|
-
* @memberof
|
|
6705
|
+
* @memberof InventoryDrop
|
|
6293
6706
|
*/
|
|
6294
6707
|
'updated_at': string;
|
|
6295
6708
|
}
|
|
6296
6709
|
/**
|
|
6297
6710
|
*
|
|
6298
6711
|
* @export
|
|
6299
|
-
* @interface
|
|
6712
|
+
* @interface InventoryItem
|
|
6300
6713
|
*/
|
|
6301
|
-
export interface
|
|
6714
|
+
export interface InventoryItem {
|
|
6302
6715
|
/**
|
|
6303
6716
|
*
|
|
6304
|
-
* @type {string}
|
|
6305
|
-
* @memberof
|
|
6717
|
+
* @type {Array<string>}
|
|
6718
|
+
* @memberof InventoryItem
|
|
6306
6719
|
*/
|
|
6307
|
-
'
|
|
6720
|
+
'collections': Array<string>;
|
|
6308
6721
|
/**
|
|
6309
6722
|
*
|
|
6310
6723
|
* @type {string}
|
|
6311
|
-
* @memberof
|
|
6724
|
+
* @memberof InventoryItem
|
|
6312
6725
|
*/
|
|
6313
|
-
'
|
|
6726
|
+
'created_at': string;
|
|
6314
6727
|
/**
|
|
6315
6728
|
*
|
|
6316
6729
|
* @type {string}
|
|
6317
|
-
* @memberof
|
|
6730
|
+
* @memberof InventoryItem
|
|
6318
6731
|
*/
|
|
6319
|
-
'
|
|
6732
|
+
'description': string;
|
|
6320
6733
|
/**
|
|
6321
6734
|
*
|
|
6322
6735
|
* @type {string}
|
|
6323
|
-
* @memberof
|
|
6736
|
+
* @memberof InventoryItem
|
|
6324
6737
|
*/
|
|
6325
|
-
'
|
|
6326
|
-
}
|
|
6327
|
-
/**
|
|
6328
|
-
*
|
|
6329
|
-
* @export
|
|
6330
|
-
* @interface License
|
|
6331
|
-
*/
|
|
6332
|
-
export interface License {
|
|
6738
|
+
'expiryDate': string | null;
|
|
6333
6739
|
/**
|
|
6334
|
-
*
|
|
6740
|
+
*
|
|
6741
|
+
* @type {Array<string>}
|
|
6742
|
+
* @memberof InventoryItem
|
|
6743
|
+
*/
|
|
6744
|
+
'flags': Array<string>;
|
|
6745
|
+
/**
|
|
6746
|
+
* 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.
|
|
6335
6747
|
* @type {string}
|
|
6336
|
-
* @memberof
|
|
6748
|
+
* @memberof InventoryItem
|
|
6337
6749
|
*/
|
|
6338
|
-
'
|
|
6750
|
+
'holderId': string;
|
|
6339
6751
|
/**
|
|
6340
6752
|
*
|
|
6341
|
-
* @type {
|
|
6342
|
-
* @memberof
|
|
6753
|
+
* @type {string}
|
|
6754
|
+
* @memberof InventoryItem
|
|
6343
6755
|
*/
|
|
6344
|
-
'
|
|
6756
|
+
'id': string;
|
|
6345
6757
|
/**
|
|
6346
6758
|
*
|
|
6347
6759
|
* @type {string}
|
|
6348
|
-
* @memberof
|
|
6760
|
+
* @memberof InventoryItem
|
|
6349
6761
|
*/
|
|
6350
|
-
'
|
|
6762
|
+
'imageUrl': string;
|
|
6351
6763
|
/**
|
|
6352
6764
|
*
|
|
6353
|
-
* @type {
|
|
6354
|
-
* @memberof
|
|
6765
|
+
* @type {boolean}
|
|
6766
|
+
* @memberof InventoryItem
|
|
6355
6767
|
*/
|
|
6356
|
-
'
|
|
6357
|
-
}
|
|
6358
|
-
/**
|
|
6359
|
-
*
|
|
6360
|
-
* @export
|
|
6361
|
-
* @enum {string}
|
|
6362
|
-
*/
|
|
6363
|
-
export declare const LicenseAction: {
|
|
6364
|
-
readonly Wear: "wear";
|
|
6365
|
-
readonly Have: "have";
|
|
6366
|
-
};
|
|
6367
|
-
export type LicenseAction = typeof LicenseAction[keyof typeof LicenseAction];
|
|
6368
|
-
/**
|
|
6369
|
-
*
|
|
6370
|
-
* @export
|
|
6371
|
-
* @interface LicenseGroup
|
|
6372
|
-
*/
|
|
6373
|
-
export interface LicenseGroup {
|
|
6768
|
+
'isArchived': boolean;
|
|
6374
6769
|
/**
|
|
6375
6770
|
*
|
|
6376
|
-
* @type {
|
|
6377
|
-
* @memberof
|
|
6771
|
+
* @type {boolean}
|
|
6772
|
+
* @memberof InventoryItem
|
|
6378
6773
|
*/
|
|
6379
|
-
'
|
|
6774
|
+
'isSeen': boolean;
|
|
6380
6775
|
/**
|
|
6381
6776
|
*
|
|
6382
|
-
* @type {
|
|
6383
|
-
* @memberof
|
|
6777
|
+
* @type {InventoryItemType}
|
|
6778
|
+
* @memberof InventoryItem
|
|
6384
6779
|
*/
|
|
6385
|
-
'
|
|
6780
|
+
'itemType': InventoryItemType;
|
|
6386
6781
|
/**
|
|
6387
6782
|
*
|
|
6388
6783
|
* @type {string}
|
|
6389
|
-
* @memberof
|
|
6784
|
+
* @memberof InventoryItem
|
|
6390
6785
|
*/
|
|
6391
|
-
'
|
|
6786
|
+
'itemTypeLabel': string;
|
|
6392
6787
|
/**
|
|
6393
6788
|
*
|
|
6394
|
-
* @type {
|
|
6395
|
-
* @memberof
|
|
6789
|
+
* @type {InventoryMetadata}
|
|
6790
|
+
* @memberof InventoryItem
|
|
6396
6791
|
*/
|
|
6397
|
-
'
|
|
6398
|
-
}
|
|
6399
|
-
/**
|
|
6400
|
-
*
|
|
6401
|
-
* @export
|
|
6402
|
-
* @enum {string}
|
|
6403
|
-
*/
|
|
6404
|
-
export declare const LicenseType: {
|
|
6405
|
-
readonly Avatar: "avatar";
|
|
6406
|
-
readonly LicenseGroup: "licenseGroup";
|
|
6407
|
-
readonly Permission: "permission";
|
|
6408
|
-
readonly Product: "product";
|
|
6409
|
-
};
|
|
6410
|
-
export type LicenseType = typeof LicenseType[keyof typeof LicenseType];
|
|
6411
|
-
/**
|
|
6412
|
-
*
|
|
6413
|
-
* @export
|
|
6414
|
-
* @interface LimitedGroup
|
|
6415
|
-
*/
|
|
6416
|
-
export interface LimitedGroup {
|
|
6792
|
+
'metadata': InventoryMetadata;
|
|
6417
6793
|
/**
|
|
6418
6794
|
*
|
|
6419
6795
|
* @type {string}
|
|
6420
|
-
* @memberof
|
|
6796
|
+
* @memberof InventoryItem
|
|
6421
6797
|
*/
|
|
6422
|
-
'
|
|
6798
|
+
'name': string;
|
|
6423
6799
|
/**
|
|
6424
6800
|
*
|
|
6425
|
-
* @type {string}
|
|
6426
|
-
* @memberof
|
|
6801
|
+
* @type {Array<string>}
|
|
6802
|
+
* @memberof InventoryItem
|
|
6427
6803
|
*/
|
|
6428
|
-
'
|
|
6804
|
+
'tags': Array<string>;
|
|
6429
6805
|
/**
|
|
6430
6806
|
*
|
|
6431
6807
|
* @type {string}
|
|
6432
|
-
* @memberof
|
|
6808
|
+
* @memberof InventoryItem
|
|
6433
6809
|
*/
|
|
6434
|
-
'
|
|
6810
|
+
'templateId': string;
|
|
6435
6811
|
/**
|
|
6436
6812
|
*
|
|
6437
6813
|
* @type {string}
|
|
6438
|
-
* @memberof
|
|
6814
|
+
* @memberof InventoryItem
|
|
6439
6815
|
*/
|
|
6440
|
-
'
|
|
6816
|
+
'template_created_at': string;
|
|
6441
6817
|
/**
|
|
6442
6818
|
*
|
|
6443
6819
|
* @type {string}
|
|
6444
|
-
* @memberof
|
|
6820
|
+
* @memberof InventoryItem
|
|
6445
6821
|
*/
|
|
6446
|
-
'
|
|
6822
|
+
'template_updated_at': string;
|
|
6447
6823
|
/**
|
|
6448
6824
|
*
|
|
6449
6825
|
* @type {string}
|
|
6450
|
-
* @memberof
|
|
6826
|
+
* @memberof InventoryItem
|
|
6451
6827
|
*/
|
|
6452
|
-
'
|
|
6828
|
+
'updated_at': string;
|
|
6829
|
+
}
|
|
6830
|
+
/**
|
|
6831
|
+
*
|
|
6832
|
+
* @export
|
|
6833
|
+
* @enum {string}
|
|
6834
|
+
*/
|
|
6835
|
+
export declare const InventoryItemType: {
|
|
6836
|
+
readonly Bundle: "bundle";
|
|
6837
|
+
readonly Prop: "prop";
|
|
6838
|
+
readonly Emoji: "emoji";
|
|
6839
|
+
readonly Sticker: "sticker";
|
|
6840
|
+
};
|
|
6841
|
+
export type InventoryItemType = typeof InventoryItemType[keyof typeof InventoryItemType];
|
|
6842
|
+
/**
|
|
6843
|
+
*
|
|
6844
|
+
* @export
|
|
6845
|
+
* @interface InventoryMetadata
|
|
6846
|
+
*/
|
|
6847
|
+
export interface InventoryMetadata {
|
|
6848
|
+
[key: string]: any;
|
|
6453
6849
|
/**
|
|
6454
|
-
*
|
|
6455
|
-
* @type {string}
|
|
6456
|
-
* @memberof
|
|
6850
|
+
* Only in bundles
|
|
6851
|
+
* @type {Array<string>}
|
|
6852
|
+
* @memberof InventoryMetadata
|
|
6457
6853
|
*/
|
|
6458
|
-
'
|
|
6854
|
+
'inventoryItemsToInstantiate'?: Array<string>;
|
|
6459
6855
|
/**
|
|
6460
|
-
*
|
|
6461
|
-
* @type {
|
|
6462
|
-
* @memberof
|
|
6856
|
+
*
|
|
6857
|
+
* @type {boolean}
|
|
6858
|
+
* @memberof InventoryMetadata
|
|
6463
6859
|
*/
|
|
6464
|
-
'
|
|
6860
|
+
'animated'?: boolean;
|
|
6465
6861
|
/**
|
|
6466
6862
|
*
|
|
6467
6863
|
* @type {string}
|
|
6468
|
-
* @memberof
|
|
6864
|
+
* @memberof InventoryMetadata
|
|
6469
6865
|
*/
|
|
6470
|
-
'
|
|
6866
|
+
'animationStyle'?: string;
|
|
6471
6867
|
/**
|
|
6472
6868
|
*
|
|
6473
6869
|
* @type {string}
|
|
6474
|
-
* @memberof
|
|
6870
|
+
* @memberof InventoryMetadata
|
|
6475
6871
|
*/
|
|
6476
|
-
'
|
|
6872
|
+
'assetBundleId'?: string;
|
|
6477
6873
|
/**
|
|
6478
6874
|
*
|
|
6479
6875
|
* @type {string}
|
|
6480
|
-
* @memberof
|
|
6876
|
+
* @memberof InventoryMetadata
|
|
6481
6877
|
*/
|
|
6482
|
-
'
|
|
6878
|
+
'fileId'?: string;
|
|
6483
6879
|
/**
|
|
6484
6880
|
*
|
|
6485
|
-
* @type {
|
|
6486
|
-
* @memberof
|
|
6881
|
+
* @type {string}
|
|
6882
|
+
* @memberof InventoryMetadata
|
|
6487
6883
|
*/
|
|
6488
|
-
'
|
|
6884
|
+
'imageUrl'?: string;
|
|
6489
6885
|
/**
|
|
6490
6886
|
*
|
|
6491
|
-
* @type {
|
|
6492
|
-
* @memberof
|
|
6887
|
+
* @type {string}
|
|
6888
|
+
* @memberof InventoryMetadata
|
|
6493
6889
|
*/
|
|
6494
|
-
'
|
|
6890
|
+
'maskTag'?: string;
|
|
6495
6891
|
/**
|
|
6496
6892
|
*
|
|
6497
6893
|
* @type {string}
|
|
6498
|
-
* @memberof
|
|
6894
|
+
* @memberof InventoryMetadata
|
|
6499
6895
|
*/
|
|
6500
|
-
'
|
|
6896
|
+
'propId'?: string;
|
|
6897
|
+
}
|
|
6898
|
+
/**
|
|
6899
|
+
*
|
|
6900
|
+
* @export
|
|
6901
|
+
* @interface InventoryNotificationDetails
|
|
6902
|
+
*/
|
|
6903
|
+
export interface InventoryNotificationDetails {
|
|
6501
6904
|
/**
|
|
6502
6905
|
*
|
|
6503
|
-
* @type {
|
|
6504
|
-
* @memberof
|
|
6906
|
+
* @type {string}
|
|
6907
|
+
* @memberof InventoryNotificationDetails
|
|
6505
6908
|
*/
|
|
6506
|
-
'
|
|
6909
|
+
'body': string;
|
|
6507
6910
|
/**
|
|
6508
6911
|
*
|
|
6509
|
-
* @type {
|
|
6510
|
-
* @memberof
|
|
6912
|
+
* @type {string}
|
|
6913
|
+
* @memberof InventoryNotificationDetails
|
|
6511
6914
|
*/
|
|
6512
|
-
'
|
|
6915
|
+
'imageUrl': string;
|
|
6513
6916
|
/**
|
|
6514
6917
|
*
|
|
6515
|
-
* @type {
|
|
6516
|
-
* @memberof
|
|
6918
|
+
* @type {string}
|
|
6919
|
+
* @memberof InventoryNotificationDetails
|
|
6517
6920
|
*/
|
|
6518
|
-
'
|
|
6921
|
+
'title': string;
|
|
6519
6922
|
}
|
|
6520
6923
|
/**
|
|
6521
6924
|
*
|
|
6522
6925
|
* @export
|
|
6523
|
-
* @interface
|
|
6926
|
+
* @interface InventorySpawn
|
|
6524
6927
|
*/
|
|
6525
|
-
export interface
|
|
6928
|
+
export interface InventorySpawn {
|
|
6526
6929
|
/**
|
|
6527
|
-
*
|
|
6930
|
+
*
|
|
6528
6931
|
* @type {string}
|
|
6529
|
-
* @memberof
|
|
6932
|
+
* @memberof InventorySpawn
|
|
6530
6933
|
*/
|
|
6531
|
-
'
|
|
6934
|
+
'token': string;
|
|
6532
6935
|
/**
|
|
6533
6936
|
*
|
|
6534
|
-
* @type {
|
|
6535
|
-
* @memberof
|
|
6937
|
+
* @type {number}
|
|
6938
|
+
* @memberof InventorySpawn
|
|
6536
6939
|
*/
|
|
6537
|
-
'
|
|
6940
|
+
'version': number;
|
|
6538
6941
|
}
|
|
6539
6942
|
/**
|
|
6540
|
-
*
|
|
6943
|
+
*
|
|
6541
6944
|
* @export
|
|
6542
|
-
* @interface
|
|
6945
|
+
* @interface InventoryTemplate
|
|
6543
6946
|
*/
|
|
6544
|
-
export interface
|
|
6947
|
+
export interface InventoryTemplate {
|
|
6545
6948
|
/**
|
|
6546
|
-
*
|
|
6949
|
+
* 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.
|
|
6547
6950
|
* @type {string}
|
|
6548
|
-
* @memberof
|
|
6951
|
+
* @memberof InventoryTemplate
|
|
6549
6952
|
*/
|
|
6550
|
-
'
|
|
6953
|
+
'authorId': string;
|
|
6551
6954
|
/**
|
|
6552
6955
|
*
|
|
6553
6956
|
* @type {Array<string>}
|
|
6554
|
-
* @memberof
|
|
6957
|
+
* @memberof InventoryTemplate
|
|
6555
6958
|
*/
|
|
6556
|
-
'
|
|
6959
|
+
'collections': Array<string>;
|
|
6557
6960
|
/**
|
|
6558
|
-
*
|
|
6961
|
+
*
|
|
6559
6962
|
* @type {string}
|
|
6560
|
-
* @memberof
|
|
6963
|
+
* @memberof InventoryTemplate
|
|
6561
6964
|
*/
|
|
6562
|
-
'
|
|
6965
|
+
'created_at': string;
|
|
6563
6966
|
/**
|
|
6564
|
-
*
|
|
6967
|
+
*
|
|
6565
6968
|
* @type {string}
|
|
6566
|
-
* @memberof
|
|
6969
|
+
* @memberof InventoryTemplate
|
|
6567
6970
|
*/
|
|
6568
|
-
'
|
|
6971
|
+
'description': string;
|
|
6569
6972
|
/**
|
|
6570
6973
|
*
|
|
6571
6974
|
* @type {Array<string>}
|
|
6572
|
-
* @memberof
|
|
6975
|
+
* @memberof InventoryTemplate
|
|
6573
6976
|
*/
|
|
6574
|
-
'
|
|
6977
|
+
'flags': Array<string>;
|
|
6575
6978
|
/**
|
|
6576
6979
|
*
|
|
6577
|
-
* @type {
|
|
6578
|
-
* @memberof
|
|
6980
|
+
* @type {string}
|
|
6981
|
+
* @memberof InventoryTemplate
|
|
6579
6982
|
*/
|
|
6580
|
-
'
|
|
6983
|
+
'id': string;
|
|
6581
6984
|
/**
|
|
6582
6985
|
*
|
|
6583
6986
|
* @type {string}
|
|
6584
|
-
* @memberof
|
|
6987
|
+
* @memberof InventoryTemplate
|
|
6585
6988
|
*/
|
|
6586
|
-
'
|
|
6989
|
+
'imageUrl': string;
|
|
6587
6990
|
/**
|
|
6588
6991
|
*
|
|
6589
|
-
* @type {
|
|
6590
|
-
* @memberof
|
|
6992
|
+
* @type {InventoryItemType}
|
|
6993
|
+
* @memberof InventoryTemplate
|
|
6591
6994
|
*/
|
|
6592
|
-
'
|
|
6995
|
+
'itemType': InventoryItemType;
|
|
6593
6996
|
/**
|
|
6594
|
-
*
|
|
6997
|
+
*
|
|
6595
6998
|
* @type {string}
|
|
6596
|
-
* @memberof
|
|
6999
|
+
* @memberof InventoryTemplate
|
|
6597
7000
|
*/
|
|
6598
|
-
'
|
|
7001
|
+
'itemTypeLabel': string;
|
|
6599
7002
|
/**
|
|
6600
7003
|
*
|
|
6601
|
-
* @type {
|
|
6602
|
-
* @memberof
|
|
7004
|
+
* @type {InventoryMetadata}
|
|
7005
|
+
* @memberof InventoryTemplate
|
|
6603
7006
|
*/
|
|
6604
|
-
'
|
|
7007
|
+
'metadata'?: InventoryMetadata;
|
|
6605
7008
|
/**
|
|
6606
7009
|
*
|
|
6607
7010
|
* @type {string}
|
|
6608
|
-
* @memberof
|
|
6609
|
-
*/
|
|
6610
|
-
'imageUrl': string;
|
|
6611
|
-
/**
|
|
6612
|
-
* This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`.
|
|
6613
|
-
* @type {string}
|
|
6614
|
-
* @memberof LimitedUserFriend
|
|
7011
|
+
* @memberof InventoryTemplate
|
|
6615
7012
|
*/
|
|
6616
|
-
'
|
|
7013
|
+
'name': string;
|
|
6617
7014
|
/**
|
|
6618
7015
|
*
|
|
6619
|
-
* @type {
|
|
6620
|
-
* @memberof
|
|
7016
|
+
* @type {InventoryNotificationDetails}
|
|
7017
|
+
* @memberof InventoryTemplate
|
|
6621
7018
|
*/
|
|
6622
|
-
'
|
|
7019
|
+
'notificationDetails'?: InventoryNotificationDetails;
|
|
6623
7020
|
/**
|
|
6624
7021
|
*
|
|
6625
7022
|
* @type {string}
|
|
6626
|
-
* @memberof
|
|
7023
|
+
* @memberof InventoryTemplate
|
|
6627
7024
|
*/
|
|
6628
|
-
'
|
|
7025
|
+
'status': string;
|
|
6629
7026
|
/**
|
|
6630
7027
|
*
|
|
6631
|
-
* @type {string}
|
|
6632
|
-
* @memberof
|
|
7028
|
+
* @type {Array<string>}
|
|
7029
|
+
* @memberof InventoryTemplate
|
|
6633
7030
|
*/
|
|
6634
|
-
'
|
|
7031
|
+
'tags': Array<string>;
|
|
6635
7032
|
/**
|
|
6636
7033
|
*
|
|
6637
7034
|
* @type {string}
|
|
6638
|
-
* @memberof
|
|
7035
|
+
* @memberof InventoryTemplate
|
|
6639
7036
|
*/
|
|
6640
|
-
'
|
|
7037
|
+
'updated_at': string;
|
|
7038
|
+
}
|
|
7039
|
+
/**
|
|
7040
|
+
*
|
|
7041
|
+
* @export
|
|
7042
|
+
* @interface InviteMessage
|
|
7043
|
+
*/
|
|
7044
|
+
export interface InviteMessage {
|
|
6641
7045
|
/**
|
|
6642
7046
|
*
|
|
6643
|
-
* @type {
|
|
6644
|
-
* @memberof
|
|
7047
|
+
* @type {boolean}
|
|
7048
|
+
* @memberof InviteMessage
|
|
6645
7049
|
*/
|
|
6646
|
-
'
|
|
7050
|
+
'canBeUpdated': boolean;
|
|
6647
7051
|
/**
|
|
6648
7052
|
*
|
|
6649
7053
|
* @type {string}
|
|
6650
|
-
* @memberof
|
|
7054
|
+
* @memberof InviteMessage
|
|
6651
7055
|
*/
|
|
6652
|
-
'
|
|
7056
|
+
'id': string;
|
|
6653
7057
|
/**
|
|
6654
7058
|
*
|
|
6655
7059
|
* @type {string}
|
|
6656
|
-
* @memberof
|
|
7060
|
+
* @memberof InviteMessage
|
|
6657
7061
|
*/
|
|
6658
|
-
'
|
|
7062
|
+
'message': string;
|
|
6659
7063
|
/**
|
|
6660
7064
|
*
|
|
6661
|
-
* @type {
|
|
6662
|
-
* @memberof
|
|
7065
|
+
* @type {InviteMessageType}
|
|
7066
|
+
* @memberof InviteMessage
|
|
6663
7067
|
*/
|
|
6664
|
-
'
|
|
7068
|
+
'messageType': InviteMessageType;
|
|
6665
7069
|
/**
|
|
6666
|
-
*
|
|
6667
|
-
* @type {
|
|
6668
|
-
* @memberof
|
|
7070
|
+
* Changes to 60 when updated, although probably server-side configurable.
|
|
7071
|
+
* @type {number}
|
|
7072
|
+
* @memberof InviteMessage
|
|
6669
7073
|
*/
|
|
6670
|
-
'
|
|
7074
|
+
'remainingCooldownMinutes': number;
|
|
6671
7075
|
/**
|
|
6672
|
-
*
|
|
6673
|
-
* @type {
|
|
6674
|
-
* @memberof
|
|
7076
|
+
*
|
|
7077
|
+
* @type {number}
|
|
7078
|
+
* @memberof InviteMessage
|
|
6675
7079
|
*/
|
|
6676
|
-
'
|
|
7080
|
+
'slot': number;
|
|
6677
7081
|
/**
|
|
6678
7082
|
*
|
|
6679
7083
|
* @type {string}
|
|
6680
|
-
* @memberof
|
|
7084
|
+
* @memberof InviteMessage
|
|
6681
7085
|
*/
|
|
6682
|
-
'
|
|
7086
|
+
'updatedAt': string;
|
|
6683
7087
|
}
|
|
6684
7088
|
/**
|
|
6685
7089
|
*
|
|
6686
7090
|
* @export
|
|
6687
|
-
* @
|
|
7091
|
+
* @enum {string}
|
|
6688
7092
|
*/
|
|
6689
|
-
export
|
|
6690
|
-
|
|
6691
|
-
|
|
6692
|
-
|
|
7093
|
+
export declare const InviteMessageType: {
|
|
7094
|
+
readonly Message: "message";
|
|
7095
|
+
readonly Response: "response";
|
|
7096
|
+
readonly Request: "request";
|
|
7097
|
+
readonly RequestResponse: "requestResponse";
|
|
7098
|
+
};
|
|
7099
|
+
export type InviteMessageType = typeof InviteMessageType[keyof typeof InviteMessageType];
|
|
7100
|
+
/**
|
|
7101
|
+
*
|
|
7102
|
+
* @export
|
|
7103
|
+
* @interface InviteRequest
|
|
7104
|
+
*/
|
|
7105
|
+
export interface InviteRequest {
|
|
7106
|
+
/**
|
|
7107
|
+
* InstanceID can be \"offline\" on User profiles if you are not friends with that user and \"private\" if you are friends and user is in private instance.
|
|
7108
|
+
* @type {string}
|
|
7109
|
+
* @memberof InviteRequest
|
|
7110
|
+
*/
|
|
7111
|
+
'instanceId': string;
|
|
7112
|
+
/**
|
|
7113
|
+
*
|
|
7114
|
+
* @type {number}
|
|
7115
|
+
* @memberof InviteRequest
|
|
7116
|
+
*/
|
|
7117
|
+
'messageSlot'?: number;
|
|
7118
|
+
}
|
|
7119
|
+
/**
|
|
7120
|
+
*
|
|
7121
|
+
* @export
|
|
7122
|
+
* @interface InviteResponse
|
|
7123
|
+
*/
|
|
7124
|
+
export interface InviteResponse {
|
|
7125
|
+
/**
|
|
7126
|
+
*
|
|
7127
|
+
* @type {number}
|
|
7128
|
+
* @memberof InviteResponse
|
|
7129
|
+
*/
|
|
7130
|
+
'responseSlot': number;
|
|
7131
|
+
}
|
|
7132
|
+
/**
|
|
7133
|
+
*
|
|
7134
|
+
* @export
|
|
7135
|
+
* @interface Jam
|
|
7136
|
+
*/
|
|
7137
|
+
export interface Jam {
|
|
7138
|
+
/**
|
|
7139
|
+
*
|
|
7140
|
+
* @type {string}
|
|
7141
|
+
* @memberof Jam
|
|
7142
|
+
*/
|
|
7143
|
+
'description': string;
|
|
7144
|
+
/**
|
|
7145
|
+
*
|
|
7146
|
+
* @type {string}
|
|
7147
|
+
* @memberof Jam
|
|
7148
|
+
*/
|
|
7149
|
+
'id': string;
|
|
7150
|
+
/**
|
|
7151
|
+
*
|
|
7152
|
+
* @type {boolean}
|
|
7153
|
+
* @memberof Jam
|
|
7154
|
+
*/
|
|
7155
|
+
'isVisible': boolean;
|
|
7156
|
+
/**
|
|
7157
|
+
*
|
|
7158
|
+
* @type {string}
|
|
7159
|
+
* @memberof Jam
|
|
7160
|
+
*/
|
|
7161
|
+
'moreInfo': string;
|
|
7162
|
+
/**
|
|
7163
|
+
* One of: - submissions_open - closed
|
|
7164
|
+
* @type {string}
|
|
7165
|
+
* @memberof Jam
|
|
7166
|
+
*/
|
|
7167
|
+
'state': string;
|
|
7168
|
+
/**
|
|
7169
|
+
*
|
|
7170
|
+
* @type {JamStateChangeDates}
|
|
7171
|
+
* @memberof Jam
|
|
7172
|
+
*/
|
|
7173
|
+
'stateChangeDates': JamStateChangeDates;
|
|
7174
|
+
/**
|
|
7175
|
+
*
|
|
7176
|
+
* @type {string}
|
|
7177
|
+
* @memberof Jam
|
|
7178
|
+
*/
|
|
7179
|
+
'submissionContentGateDate': string | null;
|
|
7180
|
+
/**
|
|
7181
|
+
*
|
|
7182
|
+
* @type {boolean}
|
|
7183
|
+
* @memberof Jam
|
|
7184
|
+
*/
|
|
7185
|
+
'submissionContentGated': boolean;
|
|
7186
|
+
/**
|
|
7187
|
+
*
|
|
7188
|
+
* @type {string}
|
|
7189
|
+
* @memberof Jam
|
|
7190
|
+
*/
|
|
7191
|
+
'title': string;
|
|
7192
|
+
/**
|
|
7193
|
+
*
|
|
7194
|
+
* @type {string}
|
|
7195
|
+
* @memberof Jam
|
|
7196
|
+
*/
|
|
7197
|
+
'updated_at': string;
|
|
7198
|
+
}
|
|
7199
|
+
/**
|
|
7200
|
+
*
|
|
7201
|
+
* @export
|
|
7202
|
+
* @interface JamStateChangeDates
|
|
7203
|
+
*/
|
|
7204
|
+
export interface JamStateChangeDates {
|
|
7205
|
+
/**
|
|
7206
|
+
*
|
|
7207
|
+
* @type {string}
|
|
7208
|
+
* @memberof JamStateChangeDates
|
|
7209
|
+
*/
|
|
7210
|
+
'closed'?: string | null;
|
|
7211
|
+
/**
|
|
7212
|
+
*
|
|
7213
|
+
* @type {string}
|
|
7214
|
+
* @memberof JamStateChangeDates
|
|
7215
|
+
*/
|
|
7216
|
+
'submissionsClosed'?: string | null;
|
|
7217
|
+
/**
|
|
7218
|
+
*
|
|
7219
|
+
* @type {string}
|
|
7220
|
+
* @memberof JamStateChangeDates
|
|
7221
|
+
*/
|
|
7222
|
+
'submissionsOpened'?: string | null;
|
|
7223
|
+
/**
|
|
7224
|
+
*
|
|
7225
|
+
* @type {string}
|
|
7226
|
+
* @memberof JamStateChangeDates
|
|
7227
|
+
*/
|
|
7228
|
+
'winnersSelected'?: string | null;
|
|
7229
|
+
}
|
|
7230
|
+
/**
|
|
7231
|
+
*
|
|
7232
|
+
* @export
|
|
7233
|
+
* @interface License
|
|
7234
|
+
*/
|
|
7235
|
+
export interface License {
|
|
7236
|
+
/**
|
|
7237
|
+
* Either a AvatarID, LicenseGroupID, PermissionID or ProductID. This depends on the `forType` field.
|
|
7238
|
+
* @type {string}
|
|
7239
|
+
* @memberof License
|
|
7240
|
+
*/
|
|
7241
|
+
'forId': string;
|
|
7242
|
+
/**
|
|
7243
|
+
*
|
|
7244
|
+
* @type {LicenseType}
|
|
7245
|
+
* @memberof License
|
|
7246
|
+
*/
|
|
7247
|
+
'forType': LicenseType;
|
|
7248
|
+
/**
|
|
7249
|
+
*
|
|
7250
|
+
* @type {string}
|
|
7251
|
+
* @memberof License
|
|
7252
|
+
*/
|
|
7253
|
+
'forName': string;
|
|
7254
|
+
/**
|
|
7255
|
+
*
|
|
7256
|
+
* @type {LicenseAction}
|
|
7257
|
+
* @memberof License
|
|
7258
|
+
*/
|
|
7259
|
+
'forAction': LicenseAction;
|
|
7260
|
+
}
|
|
7261
|
+
/**
|
|
7262
|
+
*
|
|
7263
|
+
* @export
|
|
7264
|
+
* @enum {string}
|
|
7265
|
+
*/
|
|
7266
|
+
export declare const LicenseAction: {
|
|
7267
|
+
readonly Wear: "wear";
|
|
7268
|
+
readonly Have: "have";
|
|
7269
|
+
};
|
|
7270
|
+
export type LicenseAction = typeof LicenseAction[keyof typeof LicenseAction];
|
|
7271
|
+
/**
|
|
7272
|
+
*
|
|
7273
|
+
* @export
|
|
7274
|
+
* @interface LicenseGroup
|
|
7275
|
+
*/
|
|
7276
|
+
export interface LicenseGroup {
|
|
7277
|
+
/**
|
|
7278
|
+
*
|
|
7279
|
+
* @type {string}
|
|
7280
|
+
* @memberof LicenseGroup
|
|
7281
|
+
*/
|
|
7282
|
+
'id': string;
|
|
7283
|
+
/**
|
|
7284
|
+
*
|
|
7285
|
+
* @type {string}
|
|
7286
|
+
* @memberof LicenseGroup
|
|
7287
|
+
*/
|
|
7288
|
+
'name': string;
|
|
7289
|
+
/**
|
|
7290
|
+
*
|
|
7291
|
+
* @type {string}
|
|
7292
|
+
* @memberof LicenseGroup
|
|
7293
|
+
*/
|
|
7294
|
+
'description': string;
|
|
7295
|
+
/**
|
|
7296
|
+
*
|
|
7297
|
+
* @type {Array<License>}
|
|
7298
|
+
* @memberof LicenseGroup
|
|
7299
|
+
*/
|
|
7300
|
+
'licenses': Array<License>;
|
|
7301
|
+
}
|
|
7302
|
+
/**
|
|
7303
|
+
*
|
|
7304
|
+
* @export
|
|
7305
|
+
* @enum {string}
|
|
7306
|
+
*/
|
|
7307
|
+
export declare const LicenseType: {
|
|
7308
|
+
readonly Avatar: "avatar";
|
|
7309
|
+
readonly LicenseGroup: "licenseGroup";
|
|
7310
|
+
readonly Permission: "permission";
|
|
7311
|
+
readonly Product: "product";
|
|
7312
|
+
};
|
|
7313
|
+
export type LicenseType = typeof LicenseType[keyof typeof LicenseType];
|
|
7314
|
+
/**
|
|
7315
|
+
*
|
|
7316
|
+
* @export
|
|
7317
|
+
* @interface LimitedGroup
|
|
7318
|
+
*/
|
|
7319
|
+
export interface LimitedGroup {
|
|
7320
|
+
/**
|
|
7321
|
+
*
|
|
7322
|
+
* @type {string}
|
|
7323
|
+
* @memberof LimitedGroup
|
|
7324
|
+
*/
|
|
7325
|
+
'id'?: string;
|
|
7326
|
+
/**
|
|
7327
|
+
*
|
|
7328
|
+
* @type {string}
|
|
7329
|
+
* @memberof LimitedGroup
|
|
7330
|
+
*/
|
|
7331
|
+
'name'?: string;
|
|
7332
|
+
/**
|
|
7333
|
+
*
|
|
7334
|
+
* @type {string}
|
|
7335
|
+
* @memberof LimitedGroup
|
|
7336
|
+
*/
|
|
7337
|
+
'shortCode'?: string;
|
|
7338
|
+
/**
|
|
7339
|
+
*
|
|
7340
|
+
* @type {string}
|
|
7341
|
+
* @memberof LimitedGroup
|
|
7342
|
+
*/
|
|
7343
|
+
'discriminator'?: string;
|
|
7344
|
+
/**
|
|
7345
|
+
*
|
|
7346
|
+
* @type {string}
|
|
7347
|
+
* @memberof LimitedGroup
|
|
7348
|
+
*/
|
|
7349
|
+
'description'?: string;
|
|
7350
|
+
/**
|
|
7351
|
+
*
|
|
7352
|
+
* @type {string}
|
|
7353
|
+
* @memberof LimitedGroup
|
|
7354
|
+
*/
|
|
7355
|
+
'iconUrl'?: string | null;
|
|
7356
|
+
/**
|
|
7357
|
+
*
|
|
7358
|
+
* @type {string}
|
|
7359
|
+
* @memberof LimitedGroup
|
|
7360
|
+
*/
|
|
7361
|
+
'bannerUrl'?: string | null;
|
|
7362
|
+
/**
|
|
7363
|
+
* 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.
|
|
7364
|
+
* @type {string}
|
|
7365
|
+
* @memberof LimitedGroup
|
|
7366
|
+
*/
|
|
7367
|
+
'ownerId'?: string;
|
|
7368
|
+
/**
|
|
7369
|
+
*
|
|
7370
|
+
* @type {string}
|
|
7371
|
+
* @memberof LimitedGroup
|
|
7372
|
+
*/
|
|
7373
|
+
'rules'?: string | null;
|
|
7374
|
+
/**
|
|
7375
|
+
*
|
|
7376
|
+
* @type {string}
|
|
7377
|
+
* @memberof LimitedGroup
|
|
7378
|
+
*/
|
|
7379
|
+
'iconId'?: string | null;
|
|
7380
|
+
/**
|
|
7381
|
+
*
|
|
7382
|
+
* @type {string}
|
|
7383
|
+
* @memberof LimitedGroup
|
|
7384
|
+
*/
|
|
7385
|
+
'bannerId'?: string | null;
|
|
7386
|
+
/**
|
|
7387
|
+
*
|
|
7388
|
+
* @type {number}
|
|
7389
|
+
* @memberof LimitedGroup
|
|
7390
|
+
*/
|
|
7391
|
+
'memberCount'?: number;
|
|
7392
|
+
/**
|
|
7393
|
+
*
|
|
7394
|
+
* @type {Array<string>}
|
|
7395
|
+
* @memberof LimitedGroup
|
|
7396
|
+
*/
|
|
7397
|
+
'tags'?: Array<string>;
|
|
7398
|
+
/**
|
|
7399
|
+
*
|
|
7400
|
+
* @type {string}
|
|
7401
|
+
* @memberof LimitedGroup
|
|
7402
|
+
*/
|
|
7403
|
+
'createdAt'?: string;
|
|
7404
|
+
/**
|
|
7405
|
+
*
|
|
7406
|
+
* @type {GroupMemberStatus}
|
|
7407
|
+
* @memberof LimitedGroup
|
|
7408
|
+
*/
|
|
7409
|
+
'membershipStatus'?: GroupMemberStatus;
|
|
7410
|
+
/**
|
|
7411
|
+
*
|
|
7412
|
+
* @type {boolean}
|
|
7413
|
+
* @memberof LimitedGroup
|
|
7414
|
+
*/
|
|
7415
|
+
'isSearchable'?: boolean;
|
|
7416
|
+
/**
|
|
7417
|
+
*
|
|
7418
|
+
* @type {Array<GroupGallery>}
|
|
7419
|
+
* @memberof LimitedGroup
|
|
7420
|
+
*/
|
|
7421
|
+
'galleries'?: Array<GroupGallery>;
|
|
7422
|
+
}
|
|
7423
|
+
/**
|
|
7424
|
+
*
|
|
7425
|
+
* @export
|
|
7426
|
+
* @interface LimitedUnityPackage
|
|
7427
|
+
*/
|
|
7428
|
+
export interface LimitedUnityPackage {
|
|
7429
|
+
/**
|
|
7430
|
+
* This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`.
|
|
7431
|
+
* @type {string}
|
|
7432
|
+
* @memberof LimitedUnityPackage
|
|
7433
|
+
*/
|
|
7434
|
+
'platform': string;
|
|
7435
|
+
/**
|
|
7436
|
+
*
|
|
7437
|
+
* @type {string}
|
|
7438
|
+
* @memberof LimitedUnityPackage
|
|
7439
|
+
*/
|
|
7440
|
+
'unityVersion': string;
|
|
7441
|
+
}
|
|
7442
|
+
/**
|
|
7443
|
+
* User object received when querying your friends list
|
|
7444
|
+
* @export
|
|
7445
|
+
* @interface LimitedUserFriend
|
|
7446
|
+
*/
|
|
7447
|
+
export interface LimitedUserFriend {
|
|
7448
|
+
/**
|
|
7449
|
+
*
|
|
7450
|
+
* @type {string}
|
|
7451
|
+
* @memberof LimitedUserFriend
|
|
7452
|
+
*/
|
|
7453
|
+
'bio'?: string;
|
|
7454
|
+
/**
|
|
7455
|
+
*
|
|
7456
|
+
* @type {Array<string>}
|
|
7457
|
+
* @memberof LimitedUserFriend
|
|
7458
|
+
*/
|
|
7459
|
+
'bioLinks'?: Array<string>;
|
|
7460
|
+
/**
|
|
7461
|
+
* When profilePicOverride is not empty, use it instead.
|
|
7462
|
+
* @type {string}
|
|
7463
|
+
* @memberof LimitedUserFriend
|
|
7464
|
+
*/
|
|
7465
|
+
'currentAvatarImageUrl': string;
|
|
7466
|
+
/**
|
|
7467
|
+
* When profilePicOverride is not empty, use it instead.
|
|
7468
|
+
* @type {string}
|
|
7469
|
+
* @memberof LimitedUserFriend
|
|
7470
|
+
*/
|
|
7471
|
+
'currentAvatarThumbnailImageUrl'?: string;
|
|
7472
|
+
/**
|
|
7473
|
+
*
|
|
7474
|
+
* @type {Array<string>}
|
|
7475
|
+
* @memberof LimitedUserFriend
|
|
7476
|
+
*/
|
|
7477
|
+
'currentAvatarTags'?: Array<string>;
|
|
7478
|
+
/**
|
|
7479
|
+
*
|
|
7480
|
+
* @type {DeveloperType}
|
|
7481
|
+
* @memberof LimitedUserFriend
|
|
7482
|
+
*/
|
|
7483
|
+
'developerType': DeveloperType;
|
|
7484
|
+
/**
|
|
7485
|
+
*
|
|
7486
|
+
* @type {string}
|
|
7487
|
+
* @memberof LimitedUserFriend
|
|
7488
|
+
*/
|
|
7489
|
+
'displayName': string;
|
|
7490
|
+
/**
|
|
7491
|
+
*
|
|
7492
|
+
* @type {string}
|
|
7493
|
+
* @memberof LimitedUserFriend
|
|
7494
|
+
*/
|
|
7495
|
+
'friendKey': string;
|
|
7496
|
+
/**
|
|
7497
|
+
* 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.
|
|
7498
|
+
* @type {string}
|
|
7499
|
+
* @memberof LimitedUserFriend
|
|
7500
|
+
*/
|
|
7501
|
+
'id': string;
|
|
7502
|
+
/**
|
|
7503
|
+
*
|
|
7504
|
+
* @type {boolean}
|
|
7505
|
+
* @memberof LimitedUserFriend
|
|
7506
|
+
*/
|
|
7507
|
+
'isFriend': boolean;
|
|
7508
|
+
/**
|
|
7509
|
+
*
|
|
7510
|
+
* @type {string}
|
|
7511
|
+
* @memberof LimitedUserFriend
|
|
7512
|
+
*/
|
|
7513
|
+
'imageUrl': string;
|
|
7514
|
+
/**
|
|
7515
|
+
* This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`.
|
|
7516
|
+
* @type {string}
|
|
7517
|
+
* @memberof LimitedUserFriend
|
|
7518
|
+
*/
|
|
7519
|
+
'last_platform': string;
|
|
7520
|
+
/**
|
|
7521
|
+
*
|
|
7522
|
+
* @type {string}
|
|
7523
|
+
* @memberof LimitedUserFriend
|
|
7524
|
+
*/
|
|
7525
|
+
'location': string;
|
|
7526
|
+
/**
|
|
7527
|
+
*
|
|
7528
|
+
* @type {string}
|
|
7529
|
+
* @memberof LimitedUserFriend
|
|
7530
|
+
*/
|
|
7531
|
+
'last_login': string | null;
|
|
7532
|
+
/**
|
|
7533
|
+
*
|
|
7534
|
+
* @type {string}
|
|
7535
|
+
* @memberof LimitedUserFriend
|
|
7536
|
+
*/
|
|
7537
|
+
'last_activity': string | null;
|
|
7538
|
+
/**
|
|
7539
|
+
*
|
|
7540
|
+
* @type {string}
|
|
7541
|
+
* @memberof LimitedUserFriend
|
|
7542
|
+
*/
|
|
7543
|
+
'last_mobile': string | null;
|
|
7544
|
+
/**
|
|
7545
|
+
*
|
|
7546
|
+
* @type {string}
|
|
7547
|
+
* @memberof LimitedUserFriend
|
|
7548
|
+
*/
|
|
7549
|
+
'platform': string;
|
|
7550
|
+
/**
|
|
7551
|
+
*
|
|
7552
|
+
* @type {string}
|
|
7553
|
+
* @memberof LimitedUserFriend
|
|
7554
|
+
*/
|
|
7555
|
+
'profilePicOverride': string;
|
|
7556
|
+
/**
|
|
7557
|
+
*
|
|
7558
|
+
* @type {string}
|
|
7559
|
+
* @memberof LimitedUserFriend
|
|
7560
|
+
*/
|
|
7561
|
+
'profilePicOverrideThumbnail': string;
|
|
7562
|
+
/**
|
|
7563
|
+
*
|
|
7564
|
+
* @type {UserStatus}
|
|
7565
|
+
* @memberof LimitedUserFriend
|
|
7566
|
+
*/
|
|
7567
|
+
'status': UserStatus;
|
|
7568
|
+
/**
|
|
7569
|
+
*
|
|
7570
|
+
* @type {string}
|
|
7571
|
+
* @memberof LimitedUserFriend
|
|
7572
|
+
*/
|
|
7573
|
+
'statusDescription': string;
|
|
7574
|
+
/**
|
|
7575
|
+
* <- Always empty.
|
|
7576
|
+
* @type {Array<string>}
|
|
7577
|
+
* @memberof LimitedUserFriend
|
|
7578
|
+
*/
|
|
7579
|
+
'tags': Array<string>;
|
|
7580
|
+
/**
|
|
7581
|
+
*
|
|
7582
|
+
* @type {string}
|
|
7583
|
+
* @memberof LimitedUserFriend
|
|
7584
|
+
*/
|
|
7585
|
+
'userIcon': string;
|
|
7586
|
+
}
|
|
7587
|
+
/**
|
|
7588
|
+
*
|
|
7589
|
+
* @export
|
|
7590
|
+
* @interface LimitedUserGroups
|
|
7591
|
+
*/
|
|
7592
|
+
export interface LimitedUserGroups {
|
|
7593
|
+
/**
|
|
7594
|
+
*
|
|
7595
|
+
* @type {string}
|
|
6693
7596
|
* @memberof LimitedUserGroups
|
|
6694
7597
|
*/
|
|
6695
7598
|
'id'?: string;
|
|
@@ -7528,6 +8431,31 @@ export declare const OrderOption: {
|
|
|
7528
8431
|
readonly Descending: "descending";
|
|
7529
8432
|
};
|
|
7530
8433
|
export type OrderOption = typeof OrderOption[keyof typeof OrderOption];
|
|
8434
|
+
/**
|
|
8435
|
+
*
|
|
8436
|
+
* @export
|
|
8437
|
+
* @interface PaginatedCalendarEventList
|
|
8438
|
+
*/
|
|
8439
|
+
export interface PaginatedCalendarEventList {
|
|
8440
|
+
/**
|
|
8441
|
+
*
|
|
8442
|
+
* @type {Array<CalendarEvent>}
|
|
8443
|
+
* @memberof PaginatedCalendarEventList
|
|
8444
|
+
*/
|
|
8445
|
+
'results'?: Array<CalendarEvent>;
|
|
8446
|
+
/**
|
|
8447
|
+
* The total number of results that the query would return if there were no pagination.
|
|
8448
|
+
* @type {number}
|
|
8449
|
+
* @memberof PaginatedCalendarEventList
|
|
8450
|
+
*/
|
|
8451
|
+
'totalCount'?: number;
|
|
8452
|
+
/**
|
|
8453
|
+
* Whether there are more results after this page.
|
|
8454
|
+
* @type {boolean}
|
|
8455
|
+
* @memberof PaginatedCalendarEventList
|
|
8456
|
+
*/
|
|
8457
|
+
'hasNext'?: boolean;
|
|
8458
|
+
}
|
|
7531
8459
|
/**
|
|
7532
8460
|
*
|
|
7533
8461
|
* @export
|
|
@@ -8172,40 +9100,186 @@ export interface ProductListingVariant {
|
|
|
8172
9100
|
'listingVariantId': string;
|
|
8173
9101
|
/**
|
|
8174
9102
|
*
|
|
8175
|
-
* @type {boolean}
|
|
8176
|
-
* @memberof ProductListingVariant
|
|
9103
|
+
* @type {boolean}
|
|
9104
|
+
* @memberof ProductListingVariant
|
|
9105
|
+
*/
|
|
9106
|
+
'nonRefundable': boolean;
|
|
9107
|
+
/**
|
|
9108
|
+
*
|
|
9109
|
+
* @type {number}
|
|
9110
|
+
* @memberof ProductListingVariant
|
|
9111
|
+
*/
|
|
9112
|
+
'quantity': number;
|
|
9113
|
+
/**
|
|
9114
|
+
*
|
|
9115
|
+
* @type {boolean}
|
|
9116
|
+
* @memberof ProductListingVariant
|
|
9117
|
+
*/
|
|
9118
|
+
'sellerVariant': boolean;
|
|
9119
|
+
/**
|
|
9120
|
+
*
|
|
9121
|
+
* @type {number}
|
|
9122
|
+
* @memberof ProductListingVariant
|
|
9123
|
+
*/
|
|
9124
|
+
'unitPriceTokens': number;
|
|
9125
|
+
}
|
|
9126
|
+
/**
|
|
9127
|
+
*
|
|
9128
|
+
* @export
|
|
9129
|
+
* @enum {string}
|
|
9130
|
+
*/
|
|
9131
|
+
export declare const ProductType: {
|
|
9132
|
+
readonly Listing: "listing";
|
|
9133
|
+
readonly Role: "role";
|
|
9134
|
+
readonly Udon: "udon";
|
|
9135
|
+
};
|
|
9136
|
+
export type ProductType = typeof ProductType[keyof typeof ProductType];
|
|
9137
|
+
/**
|
|
9138
|
+
*
|
|
9139
|
+
* @export
|
|
9140
|
+
* @interface Prop
|
|
9141
|
+
*/
|
|
9142
|
+
export interface Prop {
|
|
9143
|
+
/**
|
|
9144
|
+
*
|
|
9145
|
+
* @type {string}
|
|
9146
|
+
* @memberof Prop
|
|
9147
|
+
*/
|
|
9148
|
+
'_created_at': string;
|
|
9149
|
+
/**
|
|
9150
|
+
*
|
|
9151
|
+
* @type {string}
|
|
9152
|
+
* @memberof Prop
|
|
9153
|
+
*/
|
|
9154
|
+
'_updated_at': string;
|
|
9155
|
+
/**
|
|
9156
|
+
* 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.
|
|
9157
|
+
* @type {string}
|
|
9158
|
+
* @memberof Prop
|
|
9159
|
+
*/
|
|
9160
|
+
'authorId': string;
|
|
9161
|
+
/**
|
|
9162
|
+
*
|
|
9163
|
+
* @type {string}
|
|
9164
|
+
* @memberof Prop
|
|
9165
|
+
*/
|
|
9166
|
+
'authorName': string;
|
|
9167
|
+
/**
|
|
9168
|
+
*
|
|
9169
|
+
* @type {string}
|
|
9170
|
+
* @memberof Prop
|
|
9171
|
+
*/
|
|
9172
|
+
'description': string;
|
|
9173
|
+
/**
|
|
9174
|
+
*
|
|
9175
|
+
* @type {string}
|
|
9176
|
+
* @memberof Prop
|
|
9177
|
+
*/
|
|
9178
|
+
'id': string;
|
|
9179
|
+
/**
|
|
9180
|
+
*
|
|
9181
|
+
* @type {string}
|
|
9182
|
+
* @memberof Prop
|
|
9183
|
+
*/
|
|
9184
|
+
'imageUrl': string;
|
|
9185
|
+
/**
|
|
9186
|
+
*
|
|
9187
|
+
* @type {number}
|
|
9188
|
+
* @memberof Prop
|
|
9189
|
+
*/
|
|
9190
|
+
'maxCountPerUser': number;
|
|
9191
|
+
/**
|
|
9192
|
+
*
|
|
9193
|
+
* @type {string}
|
|
9194
|
+
* @memberof Prop
|
|
9195
|
+
*/
|
|
9196
|
+
'name': string;
|
|
9197
|
+
/**
|
|
9198
|
+
*
|
|
9199
|
+
* @type {ReleaseStatus}
|
|
9200
|
+
* @memberof Prop
|
|
9201
|
+
*/
|
|
9202
|
+
'releaseStatus': ReleaseStatus;
|
|
9203
|
+
/**
|
|
9204
|
+
*
|
|
9205
|
+
* @type {number}
|
|
9206
|
+
* @memberof Prop
|
|
9207
|
+
*/
|
|
9208
|
+
'spawnType': number;
|
|
9209
|
+
/**
|
|
9210
|
+
*
|
|
9211
|
+
* @type {Array<string>}
|
|
9212
|
+
* @memberof Prop
|
|
9213
|
+
*/
|
|
9214
|
+
'tags': Array<string>;
|
|
9215
|
+
/**
|
|
9216
|
+
*
|
|
9217
|
+
* @type {string}
|
|
9218
|
+
* @memberof Prop
|
|
9219
|
+
*/
|
|
9220
|
+
'thumbnailImageUrl': string;
|
|
9221
|
+
/**
|
|
9222
|
+
*
|
|
9223
|
+
* @type {string}
|
|
9224
|
+
* @memberof Prop
|
|
9225
|
+
*/
|
|
9226
|
+
'unityPackageUrl': string | null;
|
|
9227
|
+
/**
|
|
9228
|
+
*
|
|
9229
|
+
* @type {Set<PropUnityPackage>}
|
|
9230
|
+
* @memberof Prop
|
|
9231
|
+
*/
|
|
9232
|
+
'unityPackages': Set<PropUnityPackage>;
|
|
9233
|
+
/**
|
|
9234
|
+
*
|
|
9235
|
+
* @type {number}
|
|
9236
|
+
* @memberof Prop
|
|
9237
|
+
*/
|
|
9238
|
+
'worldPlacementMask': number;
|
|
9239
|
+
}
|
|
9240
|
+
/**
|
|
9241
|
+
*
|
|
9242
|
+
* @export
|
|
9243
|
+
* @interface PropUnityPackage
|
|
9244
|
+
*/
|
|
9245
|
+
export interface PropUnityPackage {
|
|
9246
|
+
/**
|
|
9247
|
+
*
|
|
9248
|
+
* @type {string}
|
|
9249
|
+
* @memberof PropUnityPackage
|
|
9250
|
+
*/
|
|
9251
|
+
'assetUrl': string;
|
|
9252
|
+
/**
|
|
9253
|
+
*
|
|
9254
|
+
* @type {number}
|
|
9255
|
+
* @memberof PropUnityPackage
|
|
9256
|
+
*/
|
|
9257
|
+
'assetVersion': number;
|
|
9258
|
+
/**
|
|
9259
|
+
*
|
|
9260
|
+
* @type {string}
|
|
9261
|
+
* @memberof PropUnityPackage
|
|
8177
9262
|
*/
|
|
8178
|
-
'
|
|
9263
|
+
'propSignature': string;
|
|
8179
9264
|
/**
|
|
8180
|
-
*
|
|
8181
|
-
* @type {
|
|
8182
|
-
* @memberof
|
|
9265
|
+
* This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`.
|
|
9266
|
+
* @type {string}
|
|
9267
|
+
* @memberof PropUnityPackage
|
|
8183
9268
|
*/
|
|
8184
|
-
'
|
|
9269
|
+
'platform': string;
|
|
8185
9270
|
/**
|
|
8186
9271
|
*
|
|
8187
|
-
* @type {
|
|
8188
|
-
* @memberof
|
|
9272
|
+
* @type {string}
|
|
9273
|
+
* @memberof PropUnityPackage
|
|
8189
9274
|
*/
|
|
8190
|
-
'
|
|
9275
|
+
'unityVersion': string;
|
|
8191
9276
|
/**
|
|
8192
9277
|
*
|
|
8193
|
-
* @type {
|
|
8194
|
-
* @memberof
|
|
9278
|
+
* @type {string}
|
|
9279
|
+
* @memberof PropUnityPackage
|
|
8195
9280
|
*/
|
|
8196
|
-
'
|
|
9281
|
+
'variant': string;
|
|
8197
9282
|
}
|
|
8198
|
-
/**
|
|
8199
|
-
*
|
|
8200
|
-
* @export
|
|
8201
|
-
* @enum {string}
|
|
8202
|
-
*/
|
|
8203
|
-
export declare const ProductType: {
|
|
8204
|
-
readonly Listing: "listing";
|
|
8205
|
-
readonly Role: "role";
|
|
8206
|
-
readonly Udon: "udon";
|
|
8207
|
-
};
|
|
8208
|
-
export type ProductType = typeof ProductType[keyof typeof ProductType];
|
|
8209
9283
|
/**
|
|
8210
9284
|
* API/Photon region.
|
|
8211
9285
|
* @export
|
|
@@ -8446,7 +9520,7 @@ export interface RequestInviteRequest {
|
|
|
8446
9520
|
* @type {number}
|
|
8447
9521
|
* @memberof RequestInviteRequest
|
|
8448
9522
|
*/
|
|
8449
|
-
'
|
|
9523
|
+
'requestSlot'?: number;
|
|
8450
9524
|
}
|
|
8451
9525
|
/**
|
|
8452
9526
|
*
|
|
@@ -9403,6 +10477,121 @@ export interface UpdateAvatarRequest {
|
|
|
9403
10477
|
*/
|
|
9404
10478
|
'unityVersion'?: string;
|
|
9405
10479
|
}
|
|
10480
|
+
/**
|
|
10481
|
+
*
|
|
10482
|
+
* @export
|
|
10483
|
+
* @interface UpdateCalendarEventRequest
|
|
10484
|
+
*/
|
|
10485
|
+
export interface UpdateCalendarEventRequest {
|
|
10486
|
+
/**
|
|
10487
|
+
* Event title
|
|
10488
|
+
* @type {string}
|
|
10489
|
+
* @memberof UpdateCalendarEventRequest
|
|
10490
|
+
*/
|
|
10491
|
+
'title'?: string;
|
|
10492
|
+
/**
|
|
10493
|
+
* Time the vent starts at
|
|
10494
|
+
* @type {string}
|
|
10495
|
+
* @memberof UpdateCalendarEventRequest
|
|
10496
|
+
*/
|
|
10497
|
+
'startsAt'?: string;
|
|
10498
|
+
/**
|
|
10499
|
+
*
|
|
10500
|
+
* @type {string}
|
|
10501
|
+
* @memberof UpdateCalendarEventRequest
|
|
10502
|
+
*/
|
|
10503
|
+
'description'?: string;
|
|
10504
|
+
/**
|
|
10505
|
+
* Time the vent starts at
|
|
10506
|
+
* @type {string}
|
|
10507
|
+
* @memberof UpdateCalendarEventRequest
|
|
10508
|
+
*/
|
|
10509
|
+
'endsAt'?: string;
|
|
10510
|
+
/**
|
|
10511
|
+
*
|
|
10512
|
+
* @type {string}
|
|
10513
|
+
* @memberof UpdateCalendarEventRequest
|
|
10514
|
+
*/
|
|
10515
|
+
'category'?: string;
|
|
10516
|
+
/**
|
|
10517
|
+
*
|
|
10518
|
+
* @type {Array<string>}
|
|
10519
|
+
* @memberof UpdateCalendarEventRequest
|
|
10520
|
+
*/
|
|
10521
|
+
'tags'?: Array<string>;
|
|
10522
|
+
/**
|
|
10523
|
+
*
|
|
10524
|
+
* @type {boolean}
|
|
10525
|
+
* @memberof UpdateCalendarEventRequest
|
|
10526
|
+
*/
|
|
10527
|
+
'isDraft'?: boolean;
|
|
10528
|
+
/**
|
|
10529
|
+
*
|
|
10530
|
+
* @type {string}
|
|
10531
|
+
* @memberof UpdateCalendarEventRequest
|
|
10532
|
+
*/
|
|
10533
|
+
'imageId'?: string;
|
|
10534
|
+
/**
|
|
10535
|
+
*
|
|
10536
|
+
* @type {Array<string>}
|
|
10537
|
+
* @memberof UpdateCalendarEventRequest
|
|
10538
|
+
*/
|
|
10539
|
+
'roleIds'?: Array<string>;
|
|
10540
|
+
/**
|
|
10541
|
+
*
|
|
10542
|
+
* @type {string}
|
|
10543
|
+
* @memberof UpdateCalendarEventRequest
|
|
10544
|
+
*/
|
|
10545
|
+
'parentId'?: string;
|
|
10546
|
+
/**
|
|
10547
|
+
*
|
|
10548
|
+
* @type {Array<string>}
|
|
10549
|
+
* @memberof UpdateCalendarEventRequest
|
|
10550
|
+
*/
|
|
10551
|
+
'platforms'?: Array<string>;
|
|
10552
|
+
/**
|
|
10553
|
+
*
|
|
10554
|
+
* @type {Array<string>}
|
|
10555
|
+
* @memberof UpdateCalendarEventRequest
|
|
10556
|
+
*/
|
|
10557
|
+
'languages'?: Array<string>;
|
|
10558
|
+
/**
|
|
10559
|
+
* Send notification to group members.
|
|
10560
|
+
* @type {boolean}
|
|
10561
|
+
* @memberof UpdateCalendarEventRequest
|
|
10562
|
+
*/
|
|
10563
|
+
'sendCreationNotification'?: boolean;
|
|
10564
|
+
/**
|
|
10565
|
+
*
|
|
10566
|
+
* @type {boolean}
|
|
10567
|
+
* @memberof UpdateCalendarEventRequest
|
|
10568
|
+
*/
|
|
10569
|
+
'featured'?: boolean;
|
|
10570
|
+
/**
|
|
10571
|
+
*
|
|
10572
|
+
* @type {number}
|
|
10573
|
+
* @memberof UpdateCalendarEventRequest
|
|
10574
|
+
*/
|
|
10575
|
+
'hostEarlyJoinMinutes'?: number;
|
|
10576
|
+
/**
|
|
10577
|
+
*
|
|
10578
|
+
* @type {number}
|
|
10579
|
+
* @memberof UpdateCalendarEventRequest
|
|
10580
|
+
*/
|
|
10581
|
+
'guestEarlyJoinMinutes'?: number;
|
|
10582
|
+
/**
|
|
10583
|
+
*
|
|
10584
|
+
* @type {number}
|
|
10585
|
+
* @memberof UpdateCalendarEventRequest
|
|
10586
|
+
*/
|
|
10587
|
+
'closeInstanceAfterEndMinutes'?: number;
|
|
10588
|
+
/**
|
|
10589
|
+
*
|
|
10590
|
+
* @type {boolean}
|
|
10591
|
+
* @memberof UpdateCalendarEventRequest
|
|
10592
|
+
*/
|
|
10593
|
+
'usesInstanceOverflow'?: boolean;
|
|
10594
|
+
}
|
|
9406
10595
|
/**
|
|
9407
10596
|
*
|
|
9408
10597
|
* @export
|
|
@@ -10599,39 +11788,179 @@ export interface WorldMetadata {
|
|
|
10599
11788
|
* @type {string}
|
|
10600
11789
|
* @memberof WorldMetadata
|
|
10601
11790
|
*/
|
|
10602
|
-
'id': string;
|
|
11791
|
+
'id': string;
|
|
11792
|
+
/**
|
|
11793
|
+
*
|
|
11794
|
+
* @type {object}
|
|
11795
|
+
* @memberof WorldMetadata
|
|
11796
|
+
*/
|
|
11797
|
+
'metadata': object;
|
|
11798
|
+
}
|
|
11799
|
+
/**
|
|
11800
|
+
*
|
|
11801
|
+
* @export
|
|
11802
|
+
* @interface WorldPublishStatus
|
|
11803
|
+
*/
|
|
11804
|
+
export interface WorldPublishStatus {
|
|
11805
|
+
/**
|
|
11806
|
+
*
|
|
11807
|
+
* @type {boolean}
|
|
11808
|
+
* @memberof WorldPublishStatus
|
|
11809
|
+
*/
|
|
11810
|
+
'canPublish': boolean;
|
|
11811
|
+
}
|
|
11812
|
+
/**
|
|
11813
|
+
* AuthenticationApi - axios parameter creator
|
|
11814
|
+
* @export
|
|
11815
|
+
*/
|
|
11816
|
+
export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11817
|
+
/**
|
|
11818
|
+
* Cancels the sequence for enabling time-based 2FA.
|
|
11819
|
+
* @summary Cancel pending enabling of time-based 2FA codes
|
|
11820
|
+
* @param {*} [options] Override http request option.
|
|
11821
|
+
* @throws {RequiredError}
|
|
11822
|
+
*/
|
|
11823
|
+
cancelPending2FA: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11824
|
+
/**
|
|
11825
|
+
* Checks if a user by a given `username`, `displayName` or `email` exist. This is used during registration to check if a username has already been taken, during change of displayName to check if a displayName is available, and during change of email to check if the email is already used. In the later two cases the `excludeUserId` is used to exclude oneself, otherwise the result would always be true. It is **REQUIRED** to include **AT LEAST** `username`, `displayName` **or** `email` query parameter. Although they can be combined - in addition with `excludeUserId` (generally to exclude yourself) - to further fine-tune the search.
|
|
11826
|
+
* @summary Check User Exists
|
|
11827
|
+
* @param {string} [email] Filter by email.
|
|
11828
|
+
* @param {string} [displayName] Filter by displayName.
|
|
11829
|
+
* @param {string} [username] Filter by Username.
|
|
11830
|
+
* @param {string} [excludeUserId] Exclude by UserID.
|
|
11831
|
+
* @param {*} [options] Override http request option.
|
|
11832
|
+
* @throws {RequiredError}
|
|
11833
|
+
*/
|
|
11834
|
+
checkUserExists: (email?: string, displayName?: string, username?: string, excludeUserId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11835
|
+
/**
|
|
11836
|
+
* Confirms the email address for a user
|
|
11837
|
+
* @summary Confirm Email
|
|
11838
|
+
* @param {string} id Target user for which to verify email.
|
|
11839
|
+
* @param {string} verifyEmail Token to verify email.
|
|
11840
|
+
* @param {*} [options] Override http request option.
|
|
11841
|
+
* @throws {RequiredError}
|
|
11842
|
+
*/
|
|
11843
|
+
confirmEmail: (id: string, verifyEmail: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11844
|
+
/**
|
|
11845
|
+
* Deletes the account with given ID. Normal users only have permission to delete their own account. Account deletion is 14 days from this request, and will be cancelled if you do an authenticated request with the account afterwards. **VRC+ NOTE:** Despite the 14-days cooldown, any VRC+ subscription will be cancelled **immediately**. **METHOD NOTE:** Despite this being a Delete action, the method type required is PUT.
|
|
11846
|
+
* @summary Delete User
|
|
11847
|
+
* @param {string} userId Must be a valid user ID.
|
|
11848
|
+
* @param {*} [options] Override http request option.
|
|
11849
|
+
* @throws {RequiredError}
|
|
11850
|
+
*/
|
|
11851
|
+
deleteUser: (userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11852
|
+
/**
|
|
11853
|
+
* Disables 2FA for the currently logged in account
|
|
11854
|
+
* @summary Disable 2FA
|
|
11855
|
+
* @param {*} [options] Override http request option.
|
|
11856
|
+
* @throws {RequiredError}
|
|
11857
|
+
*/
|
|
11858
|
+
disable2FA: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11859
|
+
/**
|
|
11860
|
+
* Begins the sequence for enabling time-based 2FA.
|
|
11861
|
+
* @summary Enable time-based 2FA codes
|
|
11862
|
+
* @param {*} [options] Override http request option.
|
|
11863
|
+
* @throws {RequiredError}
|
|
11864
|
+
*/
|
|
11865
|
+
enable2FA: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11866
|
+
/**
|
|
11867
|
+
* This endpoint does the following two operations: 1) Checks if you are already logged in by looking for a valid `auth` cookie. If you are have a valid auth cookie then no additional auth-related actions are taken. If you are **not** logged in then it will log you in with the `Authorization` header and set the `auth` cookie. The `auth` cookie will only be sent once. 2) If logged in, this function will also return the CurrentUser object containing detailed information about the currently logged in user. The auth string after `Authorization: Basic {string}` is a base64-encoded string of the username and password, both individually url-encoded, and then joined with a colon. > base64(urlencode(username):urlencode(password)) **WARNING: Session Limit:** Each authentication with login credentials counts as a separate session, out of which you have a limited amount. Make sure to save and reuse the `auth` cookie if you are often restarting the program. The provided API libraries automatically save cookies during runtime, but does not persist during restart. While it can be fine to use username/password during development, expect in production to very fast run into the rate-limit and be temporarily blocked from making new sessions until older ones expire. The exact number of simultaneous sessions is unknown/undisclosed.
|
|
11868
|
+
* @summary Login and/or Get Current User Info
|
|
11869
|
+
* @param {*} [options] Override http request option.
|
|
11870
|
+
* @throws {RequiredError}
|
|
11871
|
+
*/
|
|
11872
|
+
getCurrentUser: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11873
|
+
/**
|
|
11874
|
+
* Gets the OTP (One Time Password) recovery codes for accounts with 2FA-protection enabled.
|
|
11875
|
+
* @summary Get 2FA Recovery codes
|
|
11876
|
+
* @param {*} [options] Override http request option.
|
|
11877
|
+
* @throws {RequiredError}
|
|
11878
|
+
*/
|
|
11879
|
+
getRecoveryCodes: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11880
|
+
/**
|
|
11881
|
+
* Invalidates the login session.
|
|
11882
|
+
* @summary Logout
|
|
11883
|
+
* @param {*} [options] Override http request option.
|
|
11884
|
+
* @throws {RequiredError}
|
|
11885
|
+
*/
|
|
11886
|
+
logout: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11887
|
+
/**
|
|
11888
|
+
* ~~Register a new user account.~~ **DEPRECATED:** Automated creation of accounts has no legitimate public third-party use case, and would be in violation of ToS §13.2: *By using the Platform, you agree not to: i. [...] use the Platform in a manner inconsistent with individual human usage* This endpoint is documented in the interest of completeness
|
|
11889
|
+
* @summary Register User Account
|
|
11890
|
+
* @param {RegisterUserAccountRequest} registerUserAccountRequest
|
|
11891
|
+
* @param {*} [options] Override http request option.
|
|
11892
|
+
* @deprecated
|
|
11893
|
+
* @throws {RequiredError}
|
|
11894
|
+
*/
|
|
11895
|
+
registerUserAccount: (registerUserAccountRequest: RegisterUserAccountRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11896
|
+
/**
|
|
11897
|
+
* Requests a resend of pending email address confirmation email
|
|
11898
|
+
* @summary Resend Email Confirmation
|
|
11899
|
+
* @param {*} [options] Override http request option.
|
|
11900
|
+
* @throws {RequiredError}
|
|
11901
|
+
*/
|
|
11902
|
+
resendEmailConfirmation: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11903
|
+
/**
|
|
11904
|
+
* Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
|
|
11905
|
+
* @summary Verify 2FA code
|
|
11906
|
+
* @param {TwoFactorAuthCode} twoFactorAuthCode
|
|
11907
|
+
* @param {*} [options] Override http request option.
|
|
11908
|
+
* @throws {RequiredError}
|
|
11909
|
+
*/
|
|
11910
|
+
verify2FA: (twoFactorAuthCode: TwoFactorAuthCode, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11911
|
+
/**
|
|
11912
|
+
* Finishes the login sequence with an 2FA email code.
|
|
11913
|
+
* @summary Verify 2FA email code
|
|
11914
|
+
* @param {TwoFactorEmailCode} twoFactorEmailCode
|
|
11915
|
+
* @param {*} [options] Override http request option.
|
|
11916
|
+
* @throws {RequiredError}
|
|
11917
|
+
*/
|
|
11918
|
+
verify2FAEmailCode: (twoFactorEmailCode: TwoFactorEmailCode, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11919
|
+
/**
|
|
11920
|
+
* Verify whether the currently provided Auth Token is valid.
|
|
11921
|
+
* @summary Verify Auth Token
|
|
11922
|
+
* @param {*} [options] Override http request option.
|
|
11923
|
+
* @throws {RequiredError}
|
|
11924
|
+
*/
|
|
11925
|
+
verifyAuthToken: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11926
|
+
/**
|
|
11927
|
+
* Verifies a login attempt for a user
|
|
11928
|
+
* @summary Verify Login Place
|
|
11929
|
+
* @param {string} token Token to verify login attempt.
|
|
11930
|
+
* @param {string} [userId] Filter by UserID.
|
|
11931
|
+
* @param {*} [options] Override http request option.
|
|
11932
|
+
* @throws {RequiredError}
|
|
11933
|
+
*/
|
|
11934
|
+
verifyLoginPlace: (token: string, userId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10603
11935
|
/**
|
|
10604
|
-
*
|
|
10605
|
-
* @
|
|
10606
|
-
* @
|
|
11936
|
+
* Finishes sequence for enabling time-based 2FA.
|
|
11937
|
+
* @summary Verify Pending 2FA code
|
|
11938
|
+
* @param {TwoFactorAuthCode} twoFactorAuthCode
|
|
11939
|
+
* @param {*} [options] Override http request option.
|
|
11940
|
+
* @throws {RequiredError}
|
|
10607
11941
|
*/
|
|
10608
|
-
|
|
10609
|
-
}
|
|
10610
|
-
/**
|
|
10611
|
-
*
|
|
10612
|
-
* @export
|
|
10613
|
-
* @interface WorldPublishStatus
|
|
10614
|
-
*/
|
|
10615
|
-
export interface WorldPublishStatus {
|
|
11942
|
+
verifyPending2FA: (twoFactorAuthCode: TwoFactorAuthCode, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10616
11943
|
/**
|
|
10617
|
-
*
|
|
10618
|
-
* @
|
|
10619
|
-
* @
|
|
11944
|
+
* Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
|
|
11945
|
+
* @summary Verify 2FA code with Recovery code
|
|
11946
|
+
* @param {TwoFactorAuthCode} twoFactorAuthCode
|
|
11947
|
+
* @param {*} [options] Override http request option.
|
|
11948
|
+
* @throws {RequiredError}
|
|
10620
11949
|
*/
|
|
10621
|
-
|
|
10622
|
-
}
|
|
11950
|
+
verifyRecoveryCode: (twoFactorAuthCode: TwoFactorAuthCode, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11951
|
+
};
|
|
10623
11952
|
/**
|
|
10624
|
-
* AuthenticationApi -
|
|
11953
|
+
* AuthenticationApi - functional programming interface
|
|
10625
11954
|
* @export
|
|
10626
11955
|
*/
|
|
10627
|
-
export declare const
|
|
11956
|
+
export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
10628
11957
|
/**
|
|
10629
11958
|
* Cancels the sequence for enabling time-based 2FA.
|
|
10630
11959
|
* @summary Cancel pending enabling of time-based 2FA codes
|
|
10631
11960
|
* @param {*} [options] Override http request option.
|
|
10632
11961
|
* @throws {RequiredError}
|
|
10633
11962
|
*/
|
|
10634
|
-
cancelPending2FA
|
|
11963
|
+
cancelPending2FA(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Disable2FAResult>>;
|
|
10635
11964
|
/**
|
|
10636
11965
|
* Checks if a user by a given `username`, `displayName` or `email` exist. This is used during registration to check if a username has already been taken, during change of displayName to check if a displayName is available, and during change of email to check if the email is already used. In the later two cases the `excludeUserId` is used to exclude oneself, otherwise the result would always be true. It is **REQUIRED** to include **AT LEAST** `username`, `displayName` **or** `email` query parameter. Although they can be combined - in addition with `excludeUserId` (generally to exclude yourself) - to further fine-tune the search.
|
|
10637
11966
|
* @summary Check User Exists
|
|
@@ -10642,7 +11971,7 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
10642
11971
|
* @param {*} [options] Override http request option.
|
|
10643
11972
|
* @throws {RequiredError}
|
|
10644
11973
|
*/
|
|
10645
|
-
checkUserExists
|
|
11974
|
+
checkUserExists(email?: string, displayName?: string, username?: string, excludeUserId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserExists>>;
|
|
10646
11975
|
/**
|
|
10647
11976
|
* Confirms the email address for a user
|
|
10648
11977
|
* @summary Confirm Email
|
|
@@ -10651,7 +11980,7 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
10651
11980
|
* @param {*} [options] Override http request option.
|
|
10652
11981
|
* @throws {RequiredError}
|
|
10653
11982
|
*/
|
|
10654
|
-
confirmEmail
|
|
11983
|
+
confirmEmail(id: string, verifyEmail: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
10655
11984
|
/**
|
|
10656
11985
|
* Deletes the account with given ID. Normal users only have permission to delete their own account. Account deletion is 14 days from this request, and will be cancelled if you do an authenticated request with the account afterwards. **VRC+ NOTE:** Despite the 14-days cooldown, any VRC+ subscription will be cancelled **immediately**. **METHOD NOTE:** Despite this being a Delete action, the method type required is PUT.
|
|
10657
11986
|
* @summary Delete User
|
|
@@ -10659,42 +11988,42 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
10659
11988
|
* @param {*} [options] Override http request option.
|
|
10660
11989
|
* @throws {RequiredError}
|
|
10661
11990
|
*/
|
|
10662
|
-
deleteUser
|
|
11991
|
+
deleteUser(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>>;
|
|
10663
11992
|
/**
|
|
10664
11993
|
* Disables 2FA for the currently logged in account
|
|
10665
11994
|
* @summary Disable 2FA
|
|
10666
11995
|
* @param {*} [options] Override http request option.
|
|
10667
11996
|
* @throws {RequiredError}
|
|
10668
11997
|
*/
|
|
10669
|
-
disable2FA
|
|
11998
|
+
disable2FA(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Disable2FAResult>>;
|
|
10670
11999
|
/**
|
|
10671
12000
|
* Begins the sequence for enabling time-based 2FA.
|
|
10672
12001
|
* @summary Enable time-based 2FA codes
|
|
10673
12002
|
* @param {*} [options] Override http request option.
|
|
10674
12003
|
* @throws {RequiredError}
|
|
10675
12004
|
*/
|
|
10676
|
-
enable2FA
|
|
12005
|
+
enable2FA(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pending2FAResult>>;
|
|
10677
12006
|
/**
|
|
10678
12007
|
* This endpoint does the following two operations: 1) Checks if you are already logged in by looking for a valid `auth` cookie. If you are have a valid auth cookie then no additional auth-related actions are taken. If you are **not** logged in then it will log you in with the `Authorization` header and set the `auth` cookie. The `auth` cookie will only be sent once. 2) If logged in, this function will also return the CurrentUser object containing detailed information about the currently logged in user. The auth string after `Authorization: Basic {string}` is a base64-encoded string of the username and password, both individually url-encoded, and then joined with a colon. > base64(urlencode(username):urlencode(password)) **WARNING: Session Limit:** Each authentication with login credentials counts as a separate session, out of which you have a limited amount. Make sure to save and reuse the `auth` cookie if you are often restarting the program. The provided API libraries automatically save cookies during runtime, but does not persist during restart. While it can be fine to use username/password during development, expect in production to very fast run into the rate-limit and be temporarily blocked from making new sessions until older ones expire. The exact number of simultaneous sessions is unknown/undisclosed.
|
|
10679
12008
|
* @summary Login and/or Get Current User Info
|
|
10680
12009
|
* @param {*} [options] Override http request option.
|
|
10681
12010
|
* @throws {RequiredError}
|
|
10682
12011
|
*/
|
|
10683
|
-
getCurrentUser
|
|
12012
|
+
getCurrentUser(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>>;
|
|
10684
12013
|
/**
|
|
10685
12014
|
* Gets the OTP (One Time Password) recovery codes for accounts with 2FA-protection enabled.
|
|
10686
12015
|
* @summary Get 2FA Recovery codes
|
|
10687
12016
|
* @param {*} [options] Override http request option.
|
|
10688
12017
|
* @throws {RequiredError}
|
|
10689
12018
|
*/
|
|
10690
|
-
getRecoveryCodes
|
|
12019
|
+
getRecoveryCodes(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TwoFactorRecoveryCodes>>;
|
|
10691
12020
|
/**
|
|
10692
12021
|
* Invalidates the login session.
|
|
10693
12022
|
* @summary Logout
|
|
10694
12023
|
* @param {*} [options] Override http request option.
|
|
10695
12024
|
* @throws {RequiredError}
|
|
10696
12025
|
*/
|
|
10697
|
-
logout
|
|
12026
|
+
logout(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>>;
|
|
10698
12027
|
/**
|
|
10699
12028
|
* ~~Register a new user account.~~ **DEPRECATED:** Automated creation of accounts has no legitimate public third-party use case, and would be in violation of ToS §13.2: *By using the Platform, you agree not to: i. [...] use the Platform in a manner inconsistent with individual human usage* This endpoint is documented in the interest of completeness
|
|
10700
12029
|
* @summary Register User Account
|
|
@@ -10703,14 +12032,14 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
10703
12032
|
* @deprecated
|
|
10704
12033
|
* @throws {RequiredError}
|
|
10705
12034
|
*/
|
|
10706
|
-
registerUserAccount
|
|
12035
|
+
registerUserAccount(registerUserAccountRequest: RegisterUserAccountRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>>;
|
|
10707
12036
|
/**
|
|
10708
12037
|
* Requests a resend of pending email address confirmation email
|
|
10709
12038
|
* @summary Resend Email Confirmation
|
|
10710
12039
|
* @param {*} [options] Override http request option.
|
|
10711
12040
|
* @throws {RequiredError}
|
|
10712
12041
|
*/
|
|
10713
|
-
resendEmailConfirmation
|
|
12042
|
+
resendEmailConfirmation(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>>;
|
|
10714
12043
|
/**
|
|
10715
12044
|
* Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
|
|
10716
12045
|
* @summary Verify 2FA code
|
|
@@ -10718,7 +12047,7 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
10718
12047
|
* @param {*} [options] Override http request option.
|
|
10719
12048
|
* @throws {RequiredError}
|
|
10720
12049
|
*/
|
|
10721
|
-
verify2FA
|
|
12050
|
+
verify2FA(twoFactorAuthCode: TwoFactorAuthCode, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Verify2FAResult>>;
|
|
10722
12051
|
/**
|
|
10723
12052
|
* Finishes the login sequence with an 2FA email code.
|
|
10724
12053
|
* @summary Verify 2FA email code
|
|
@@ -10726,14 +12055,14 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
10726
12055
|
* @param {*} [options] Override http request option.
|
|
10727
12056
|
* @throws {RequiredError}
|
|
10728
12057
|
*/
|
|
10729
|
-
verify2FAEmailCode
|
|
12058
|
+
verify2FAEmailCode(twoFactorEmailCode: TwoFactorEmailCode, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Verify2FAEmailCodeResult>>;
|
|
10730
12059
|
/**
|
|
10731
12060
|
* Verify whether the currently provided Auth Token is valid.
|
|
10732
12061
|
* @summary Verify Auth Token
|
|
10733
12062
|
* @param {*} [options] Override http request option.
|
|
10734
12063
|
* @throws {RequiredError}
|
|
10735
12064
|
*/
|
|
10736
|
-
verifyAuthToken
|
|
12065
|
+
verifyAuthToken(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VerifyAuthTokenResult>>;
|
|
10737
12066
|
/**
|
|
10738
12067
|
* Verifies a login attempt for a user
|
|
10739
12068
|
* @summary Verify Login Place
|
|
@@ -10742,7 +12071,7 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
10742
12071
|
* @param {*} [options] Override http request option.
|
|
10743
12072
|
* @throws {RequiredError}
|
|
10744
12073
|
*/
|
|
10745
|
-
verifyLoginPlace
|
|
12074
|
+
verifyLoginPlace(token: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
10746
12075
|
/**
|
|
10747
12076
|
* Finishes sequence for enabling time-based 2FA.
|
|
10748
12077
|
* @summary Verify Pending 2FA code
|
|
@@ -10750,7 +12079,7 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
10750
12079
|
* @param {*} [options] Override http request option.
|
|
10751
12080
|
* @throws {RequiredError}
|
|
10752
12081
|
*/
|
|
10753
|
-
verifyPending2FA
|
|
12082
|
+
verifyPending2FA(twoFactorAuthCode: TwoFactorAuthCode, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Verify2FAResult>>;
|
|
10754
12083
|
/**
|
|
10755
12084
|
* Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
|
|
10756
12085
|
* @summary Verify 2FA code with Recovery code
|
|
@@ -10758,20 +12087,20 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
10758
12087
|
* @param {*} [options] Override http request option.
|
|
10759
12088
|
* @throws {RequiredError}
|
|
10760
12089
|
*/
|
|
10761
|
-
verifyRecoveryCode
|
|
12090
|
+
verifyRecoveryCode(twoFactorAuthCode: TwoFactorAuthCode, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Verify2FAResult>>;
|
|
10762
12091
|
};
|
|
10763
12092
|
/**
|
|
10764
|
-
* AuthenticationApi -
|
|
12093
|
+
* AuthenticationApi - factory interface
|
|
10765
12094
|
* @export
|
|
10766
12095
|
*/
|
|
10767
|
-
export declare const
|
|
12096
|
+
export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
10768
12097
|
/**
|
|
10769
12098
|
* Cancels the sequence for enabling time-based 2FA.
|
|
10770
12099
|
* @summary Cancel pending enabling of time-based 2FA codes
|
|
10771
12100
|
* @param {*} [options] Override http request option.
|
|
10772
12101
|
* @throws {RequiredError}
|
|
10773
12102
|
*/
|
|
10774
|
-
cancelPending2FA(options?:
|
|
12103
|
+
cancelPending2FA(options?: any): AxiosPromise<Disable2FAResult>;
|
|
10775
12104
|
/**
|
|
10776
12105
|
* Checks if a user by a given `username`, `displayName` or `email` exist. This is used during registration to check if a username has already been taken, during change of displayName to check if a displayName is available, and during change of email to check if the email is already used. In the later two cases the `excludeUserId` is used to exclude oneself, otherwise the result would always be true. It is **REQUIRED** to include **AT LEAST** `username`, `displayName` **or** `email` query parameter. Although they can be combined - in addition with `excludeUserId` (generally to exclude yourself) - to further fine-tune the search.
|
|
10777
12106
|
* @summary Check User Exists
|
|
@@ -10782,7 +12111,7 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
10782
12111
|
* @param {*} [options] Override http request option.
|
|
10783
12112
|
* @throws {RequiredError}
|
|
10784
12113
|
*/
|
|
10785
|
-
checkUserExists(email?: string, displayName?: string, username?: string, excludeUserId?: string, options?:
|
|
12114
|
+
checkUserExists(email?: string, displayName?: string, username?: string, excludeUserId?: string, options?: any): AxiosPromise<UserExists>;
|
|
10786
12115
|
/**
|
|
10787
12116
|
* Confirms the email address for a user
|
|
10788
12117
|
* @summary Confirm Email
|
|
@@ -10791,7 +12120,7 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
10791
12120
|
* @param {*} [options] Override http request option.
|
|
10792
12121
|
* @throws {RequiredError}
|
|
10793
12122
|
*/
|
|
10794
|
-
confirmEmail(id: string, verifyEmail: string, options?:
|
|
12123
|
+
confirmEmail(id: string, verifyEmail: string, options?: any): AxiosPromise<void>;
|
|
10795
12124
|
/**
|
|
10796
12125
|
* Deletes the account with given ID. Normal users only have permission to delete their own account. Account deletion is 14 days from this request, and will be cancelled if you do an authenticated request with the account afterwards. **VRC+ NOTE:** Despite the 14-days cooldown, any VRC+ subscription will be cancelled **immediately**. **METHOD NOTE:** Despite this being a Delete action, the method type required is PUT.
|
|
10797
12126
|
* @summary Delete User
|
|
@@ -10799,42 +12128,42 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
10799
12128
|
* @param {*} [options] Override http request option.
|
|
10800
12129
|
* @throws {RequiredError}
|
|
10801
12130
|
*/
|
|
10802
|
-
deleteUser(userId: string, options?:
|
|
12131
|
+
deleteUser(userId: string, options?: any): AxiosPromise<CurrentUser>;
|
|
10803
12132
|
/**
|
|
10804
12133
|
* Disables 2FA for the currently logged in account
|
|
10805
12134
|
* @summary Disable 2FA
|
|
10806
12135
|
* @param {*} [options] Override http request option.
|
|
10807
12136
|
* @throws {RequiredError}
|
|
10808
12137
|
*/
|
|
10809
|
-
disable2FA(options?:
|
|
12138
|
+
disable2FA(options?: any): AxiosPromise<Disable2FAResult>;
|
|
10810
12139
|
/**
|
|
10811
12140
|
* Begins the sequence for enabling time-based 2FA.
|
|
10812
12141
|
* @summary Enable time-based 2FA codes
|
|
10813
12142
|
* @param {*} [options] Override http request option.
|
|
10814
12143
|
* @throws {RequiredError}
|
|
10815
12144
|
*/
|
|
10816
|
-
enable2FA(options?:
|
|
12145
|
+
enable2FA(options?: any): AxiosPromise<Pending2FAResult>;
|
|
10817
12146
|
/**
|
|
10818
12147
|
* This endpoint does the following two operations: 1) Checks if you are already logged in by looking for a valid `auth` cookie. If you are have a valid auth cookie then no additional auth-related actions are taken. If you are **not** logged in then it will log you in with the `Authorization` header and set the `auth` cookie. The `auth` cookie will only be sent once. 2) If logged in, this function will also return the CurrentUser object containing detailed information about the currently logged in user. The auth string after `Authorization: Basic {string}` is a base64-encoded string of the username and password, both individually url-encoded, and then joined with a colon. > base64(urlencode(username):urlencode(password)) **WARNING: Session Limit:** Each authentication with login credentials counts as a separate session, out of which you have a limited amount. Make sure to save and reuse the `auth` cookie if you are often restarting the program. The provided API libraries automatically save cookies during runtime, but does not persist during restart. While it can be fine to use username/password during development, expect in production to very fast run into the rate-limit and be temporarily blocked from making new sessions until older ones expire. The exact number of simultaneous sessions is unknown/undisclosed.
|
|
10819
12148
|
* @summary Login and/or Get Current User Info
|
|
10820
12149
|
* @param {*} [options] Override http request option.
|
|
10821
12150
|
* @throws {RequiredError}
|
|
10822
12151
|
*/
|
|
10823
|
-
getCurrentUser(options?:
|
|
12152
|
+
getCurrentUser(options?: any): AxiosPromise<CurrentUser>;
|
|
10824
12153
|
/**
|
|
10825
12154
|
* Gets the OTP (One Time Password) recovery codes for accounts with 2FA-protection enabled.
|
|
10826
12155
|
* @summary Get 2FA Recovery codes
|
|
10827
12156
|
* @param {*} [options] Override http request option.
|
|
10828
12157
|
* @throws {RequiredError}
|
|
10829
12158
|
*/
|
|
10830
|
-
getRecoveryCodes(options?:
|
|
12159
|
+
getRecoveryCodes(options?: any): AxiosPromise<TwoFactorRecoveryCodes>;
|
|
10831
12160
|
/**
|
|
10832
12161
|
* Invalidates the login session.
|
|
10833
12162
|
* @summary Logout
|
|
10834
12163
|
* @param {*} [options] Override http request option.
|
|
10835
12164
|
* @throws {RequiredError}
|
|
10836
12165
|
*/
|
|
10837
|
-
logout(options?:
|
|
12166
|
+
logout(options?: any): AxiosPromise<Success>;
|
|
10838
12167
|
/**
|
|
10839
12168
|
* ~~Register a new user account.~~ **DEPRECATED:** Automated creation of accounts has no legitimate public third-party use case, and would be in violation of ToS §13.2: *By using the Platform, you agree not to: i. [...] use the Platform in a manner inconsistent with individual human usage* This endpoint is documented in the interest of completeness
|
|
10840
12169
|
* @summary Register User Account
|
|
@@ -10843,14 +12172,14 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
10843
12172
|
* @deprecated
|
|
10844
12173
|
* @throws {RequiredError}
|
|
10845
12174
|
*/
|
|
10846
|
-
registerUserAccount(registerUserAccountRequest: RegisterUserAccountRequest, options?:
|
|
12175
|
+
registerUserAccount(registerUserAccountRequest: RegisterUserAccountRequest, options?: any): AxiosPromise<CurrentUser>;
|
|
10847
12176
|
/**
|
|
10848
12177
|
* Requests a resend of pending email address confirmation email
|
|
10849
12178
|
* @summary Resend Email Confirmation
|
|
10850
12179
|
* @param {*} [options] Override http request option.
|
|
10851
12180
|
* @throws {RequiredError}
|
|
10852
12181
|
*/
|
|
10853
|
-
resendEmailConfirmation(options?:
|
|
12182
|
+
resendEmailConfirmation(options?: any): AxiosPromise<Success>;
|
|
10854
12183
|
/**
|
|
10855
12184
|
* Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
|
|
10856
12185
|
* @summary Verify 2FA code
|
|
@@ -10858,7 +12187,7 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
10858
12187
|
* @param {*} [options] Override http request option.
|
|
10859
12188
|
* @throws {RequiredError}
|
|
10860
12189
|
*/
|
|
10861
|
-
verify2FA(twoFactorAuthCode: TwoFactorAuthCode, options?:
|
|
12190
|
+
verify2FA(twoFactorAuthCode: TwoFactorAuthCode, options?: any): AxiosPromise<Verify2FAResult>;
|
|
10862
12191
|
/**
|
|
10863
12192
|
* Finishes the login sequence with an 2FA email code.
|
|
10864
12193
|
* @summary Verify 2FA email code
|
|
@@ -10866,14 +12195,14 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
10866
12195
|
* @param {*} [options] Override http request option.
|
|
10867
12196
|
* @throws {RequiredError}
|
|
10868
12197
|
*/
|
|
10869
|
-
verify2FAEmailCode(twoFactorEmailCode: TwoFactorEmailCode, options?:
|
|
12198
|
+
verify2FAEmailCode(twoFactorEmailCode: TwoFactorEmailCode, options?: any): AxiosPromise<Verify2FAEmailCodeResult>;
|
|
10870
12199
|
/**
|
|
10871
12200
|
* Verify whether the currently provided Auth Token is valid.
|
|
10872
12201
|
* @summary Verify Auth Token
|
|
10873
12202
|
* @param {*} [options] Override http request option.
|
|
10874
12203
|
* @throws {RequiredError}
|
|
10875
12204
|
*/
|
|
10876
|
-
verifyAuthToken(options?:
|
|
12205
|
+
verifyAuthToken(options?: any): AxiosPromise<VerifyAuthTokenResult>;
|
|
10877
12206
|
/**
|
|
10878
12207
|
* Verifies a login attempt for a user
|
|
10879
12208
|
* @summary Verify Login Place
|
|
@@ -10882,7 +12211,7 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
10882
12211
|
* @param {*} [options] Override http request option.
|
|
10883
12212
|
* @throws {RequiredError}
|
|
10884
12213
|
*/
|
|
10885
|
-
verifyLoginPlace(token: string, userId?: string, options?:
|
|
12214
|
+
verifyLoginPlace(token: string, userId?: string, options?: any): AxiosPromise<void>;
|
|
10886
12215
|
/**
|
|
10887
12216
|
* Finishes sequence for enabling time-based 2FA.
|
|
10888
12217
|
* @summary Verify Pending 2FA code
|
|
@@ -10890,7 +12219,7 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
10890
12219
|
* @param {*} [options] Override http request option.
|
|
10891
12220
|
* @throws {RequiredError}
|
|
10892
12221
|
*/
|
|
10893
|
-
verifyPending2FA(twoFactorAuthCode: TwoFactorAuthCode, options?:
|
|
12222
|
+
verifyPending2FA(twoFactorAuthCode: TwoFactorAuthCode, options?: any): AxiosPromise<Verify2FAResult>;
|
|
10894
12223
|
/**
|
|
10895
12224
|
* Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
|
|
10896
12225
|
* @summary Verify 2FA code with Recovery code
|
|
@@ -10898,20 +12227,23 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
10898
12227
|
* @param {*} [options] Override http request option.
|
|
10899
12228
|
* @throws {RequiredError}
|
|
10900
12229
|
*/
|
|
10901
|
-
verifyRecoveryCode(twoFactorAuthCode: TwoFactorAuthCode, options?:
|
|
12230
|
+
verifyRecoveryCode(twoFactorAuthCode: TwoFactorAuthCode, options?: any): AxiosPromise<Verify2FAResult>;
|
|
10902
12231
|
};
|
|
10903
12232
|
/**
|
|
10904
|
-
* AuthenticationApi -
|
|
12233
|
+
* AuthenticationApi - object-oriented interface
|
|
10905
12234
|
* @export
|
|
12235
|
+
* @class AuthenticationApi
|
|
12236
|
+
* @extends {BaseAPI}
|
|
10906
12237
|
*/
|
|
10907
|
-
export declare
|
|
12238
|
+
export declare class AuthenticationApi extends BaseAPI {
|
|
10908
12239
|
/**
|
|
10909
12240
|
* Cancels the sequence for enabling time-based 2FA.
|
|
10910
12241
|
* @summary Cancel pending enabling of time-based 2FA codes
|
|
10911
12242
|
* @param {*} [options] Override http request option.
|
|
10912
12243
|
* @throws {RequiredError}
|
|
12244
|
+
* @memberof AuthenticationApi
|
|
10913
12245
|
*/
|
|
10914
|
-
cancelPending2FA(options?:
|
|
12246
|
+
cancelPending2FA(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Disable2FAResult, any>>;
|
|
10915
12247
|
/**
|
|
10916
12248
|
* Checks if a user by a given `username`, `displayName` or `email` exist. This is used during registration to check if a username has already been taken, during change of displayName to check if a displayName is available, and during change of email to check if the email is already used. In the later two cases the `excludeUserId` is used to exclude oneself, otherwise the result would always be true. It is **REQUIRED** to include **AT LEAST** `username`, `displayName` **or** `email` query parameter. Although they can be combined - in addition with `excludeUserId` (generally to exclude yourself) - to further fine-tune the search.
|
|
10917
12249
|
* @summary Check User Exists
|
|
@@ -10921,8 +12253,9 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
10921
12253
|
* @param {string} [excludeUserId] Exclude by UserID.
|
|
10922
12254
|
* @param {*} [options] Override http request option.
|
|
10923
12255
|
* @throws {RequiredError}
|
|
12256
|
+
* @memberof AuthenticationApi
|
|
10924
12257
|
*/
|
|
10925
|
-
checkUserExists(email?: string, displayName?: string, username?: string, excludeUserId?: string, options?:
|
|
12258
|
+
checkUserExists(email?: string, displayName?: string, username?: string, excludeUserId?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserExists, any>>;
|
|
10926
12259
|
/**
|
|
10927
12260
|
* Confirms the email address for a user
|
|
10928
12261
|
* @summary Confirm Email
|
|
@@ -10930,51 +12263,58 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
10930
12263
|
* @param {string} verifyEmail Token to verify email.
|
|
10931
12264
|
* @param {*} [options] Override http request option.
|
|
10932
12265
|
* @throws {RequiredError}
|
|
12266
|
+
* @memberof AuthenticationApi
|
|
10933
12267
|
*/
|
|
10934
|
-
confirmEmail(id: string, verifyEmail: string, options?:
|
|
12268
|
+
confirmEmail(id: string, verifyEmail: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
10935
12269
|
/**
|
|
10936
12270
|
* Deletes the account with given ID. Normal users only have permission to delete their own account. Account deletion is 14 days from this request, and will be cancelled if you do an authenticated request with the account afterwards. **VRC+ NOTE:** Despite the 14-days cooldown, any VRC+ subscription will be cancelled **immediately**. **METHOD NOTE:** Despite this being a Delete action, the method type required is PUT.
|
|
10937
12271
|
* @summary Delete User
|
|
10938
12272
|
* @param {string} userId Must be a valid user ID.
|
|
10939
12273
|
* @param {*} [options] Override http request option.
|
|
10940
12274
|
* @throws {RequiredError}
|
|
12275
|
+
* @memberof AuthenticationApi
|
|
10941
12276
|
*/
|
|
10942
|
-
deleteUser(userId: string, options?:
|
|
12277
|
+
deleteUser(userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CurrentUser, any>>;
|
|
10943
12278
|
/**
|
|
10944
12279
|
* Disables 2FA for the currently logged in account
|
|
10945
12280
|
* @summary Disable 2FA
|
|
10946
12281
|
* @param {*} [options] Override http request option.
|
|
10947
12282
|
* @throws {RequiredError}
|
|
12283
|
+
* @memberof AuthenticationApi
|
|
10948
12284
|
*/
|
|
10949
|
-
disable2FA(options?:
|
|
12285
|
+
disable2FA(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Disable2FAResult, any>>;
|
|
10950
12286
|
/**
|
|
10951
12287
|
* Begins the sequence for enabling time-based 2FA.
|
|
10952
12288
|
* @summary Enable time-based 2FA codes
|
|
10953
12289
|
* @param {*} [options] Override http request option.
|
|
10954
12290
|
* @throws {RequiredError}
|
|
12291
|
+
* @memberof AuthenticationApi
|
|
10955
12292
|
*/
|
|
10956
|
-
enable2FA(options?:
|
|
12293
|
+
enable2FA(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Pending2FAResult, any>>;
|
|
10957
12294
|
/**
|
|
10958
12295
|
* This endpoint does the following two operations: 1) Checks if you are already logged in by looking for a valid `auth` cookie. If you are have a valid auth cookie then no additional auth-related actions are taken. If you are **not** logged in then it will log you in with the `Authorization` header and set the `auth` cookie. The `auth` cookie will only be sent once. 2) If logged in, this function will also return the CurrentUser object containing detailed information about the currently logged in user. The auth string after `Authorization: Basic {string}` is a base64-encoded string of the username and password, both individually url-encoded, and then joined with a colon. > base64(urlencode(username):urlencode(password)) **WARNING: Session Limit:** Each authentication with login credentials counts as a separate session, out of which you have a limited amount. Make sure to save and reuse the `auth` cookie if you are often restarting the program. The provided API libraries automatically save cookies during runtime, but does not persist during restart. While it can be fine to use username/password during development, expect in production to very fast run into the rate-limit and be temporarily blocked from making new sessions until older ones expire. The exact number of simultaneous sessions is unknown/undisclosed.
|
|
10959
12296
|
* @summary Login and/or Get Current User Info
|
|
10960
12297
|
* @param {*} [options] Override http request option.
|
|
10961
12298
|
* @throws {RequiredError}
|
|
12299
|
+
* @memberof AuthenticationApi
|
|
10962
12300
|
*/
|
|
10963
|
-
getCurrentUser(options?:
|
|
12301
|
+
getCurrentUser(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CurrentUser, any>>;
|
|
10964
12302
|
/**
|
|
10965
12303
|
* Gets the OTP (One Time Password) recovery codes for accounts with 2FA-protection enabled.
|
|
10966
12304
|
* @summary Get 2FA Recovery codes
|
|
10967
12305
|
* @param {*} [options] Override http request option.
|
|
10968
12306
|
* @throws {RequiredError}
|
|
12307
|
+
* @memberof AuthenticationApi
|
|
10969
12308
|
*/
|
|
10970
|
-
getRecoveryCodes(options?:
|
|
12309
|
+
getRecoveryCodes(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TwoFactorRecoveryCodes, any>>;
|
|
10971
12310
|
/**
|
|
10972
12311
|
* Invalidates the login session.
|
|
10973
12312
|
* @summary Logout
|
|
10974
12313
|
* @param {*} [options] Override http request option.
|
|
10975
12314
|
* @throws {RequiredError}
|
|
12315
|
+
* @memberof AuthenticationApi
|
|
10976
12316
|
*/
|
|
10977
|
-
logout(options?:
|
|
12317
|
+
logout(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
10978
12318
|
/**
|
|
10979
12319
|
* ~~Register a new user account.~~ **DEPRECATED:** Automated creation of accounts has no legitimate public third-party use case, and would be in violation of ToS §13.2: *By using the Platform, you agree not to: i. [...] use the Platform in a manner inconsistent with individual human usage* This endpoint is documented in the interest of completeness
|
|
10980
12320
|
* @summary Register User Account
|
|
@@ -10982,228 +12322,363 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
10982
12322
|
* @param {*} [options] Override http request option.
|
|
10983
12323
|
* @deprecated
|
|
10984
12324
|
* @throws {RequiredError}
|
|
12325
|
+
* @memberof AuthenticationApi
|
|
10985
12326
|
*/
|
|
10986
|
-
registerUserAccount(registerUserAccountRequest: RegisterUserAccountRequest, options?:
|
|
12327
|
+
registerUserAccount(registerUserAccountRequest: RegisterUserAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CurrentUser, any>>;
|
|
10987
12328
|
/**
|
|
10988
12329
|
* Requests a resend of pending email address confirmation email
|
|
10989
12330
|
* @summary Resend Email Confirmation
|
|
10990
12331
|
* @param {*} [options] Override http request option.
|
|
10991
12332
|
* @throws {RequiredError}
|
|
12333
|
+
* @memberof AuthenticationApi
|
|
10992
12334
|
*/
|
|
10993
|
-
resendEmailConfirmation(options?:
|
|
12335
|
+
resendEmailConfirmation(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
10994
12336
|
/**
|
|
10995
12337
|
* Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
|
|
10996
12338
|
* @summary Verify 2FA code
|
|
10997
12339
|
* @param {TwoFactorAuthCode} twoFactorAuthCode
|
|
10998
12340
|
* @param {*} [options] Override http request option.
|
|
10999
12341
|
* @throws {RequiredError}
|
|
12342
|
+
* @memberof AuthenticationApi
|
|
11000
12343
|
*/
|
|
11001
|
-
verify2FA(twoFactorAuthCode: TwoFactorAuthCode, options?:
|
|
12344
|
+
verify2FA(twoFactorAuthCode: TwoFactorAuthCode, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Verify2FAResult, any>>;
|
|
11002
12345
|
/**
|
|
11003
12346
|
* Finishes the login sequence with an 2FA email code.
|
|
11004
12347
|
* @summary Verify 2FA email code
|
|
11005
12348
|
* @param {TwoFactorEmailCode} twoFactorEmailCode
|
|
11006
12349
|
* @param {*} [options] Override http request option.
|
|
11007
12350
|
* @throws {RequiredError}
|
|
12351
|
+
* @memberof AuthenticationApi
|
|
12352
|
+
*/
|
|
12353
|
+
verify2FAEmailCode(twoFactorEmailCode: TwoFactorEmailCode, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Verify2FAEmailCodeResult, any>>;
|
|
12354
|
+
/**
|
|
12355
|
+
* Verify whether the currently provided Auth Token is valid.
|
|
12356
|
+
* @summary Verify Auth Token
|
|
12357
|
+
* @param {*} [options] Override http request option.
|
|
12358
|
+
* @throws {RequiredError}
|
|
12359
|
+
* @memberof AuthenticationApi
|
|
12360
|
+
*/
|
|
12361
|
+
verifyAuthToken(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VerifyAuthTokenResult, any>>;
|
|
12362
|
+
/**
|
|
12363
|
+
* Verifies a login attempt for a user
|
|
12364
|
+
* @summary Verify Login Place
|
|
12365
|
+
* @param {string} token Token to verify login attempt.
|
|
12366
|
+
* @param {string} [userId] Filter by UserID.
|
|
12367
|
+
* @param {*} [options] Override http request option.
|
|
12368
|
+
* @throws {RequiredError}
|
|
12369
|
+
* @memberof AuthenticationApi
|
|
12370
|
+
*/
|
|
12371
|
+
verifyLoginPlace(token: string, userId?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
12372
|
+
/**
|
|
12373
|
+
* Finishes sequence for enabling time-based 2FA.
|
|
12374
|
+
* @summary Verify Pending 2FA code
|
|
12375
|
+
* @param {TwoFactorAuthCode} twoFactorAuthCode
|
|
12376
|
+
* @param {*} [options] Override http request option.
|
|
12377
|
+
* @throws {RequiredError}
|
|
12378
|
+
* @memberof AuthenticationApi
|
|
12379
|
+
*/
|
|
12380
|
+
verifyPending2FA(twoFactorAuthCode: TwoFactorAuthCode, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Verify2FAResult, any>>;
|
|
12381
|
+
/**
|
|
12382
|
+
* Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
|
|
12383
|
+
* @summary Verify 2FA code with Recovery code
|
|
12384
|
+
* @param {TwoFactorAuthCode} twoFactorAuthCode
|
|
12385
|
+
* @param {*} [options] Override http request option.
|
|
12386
|
+
* @throws {RequiredError}
|
|
12387
|
+
* @memberof AuthenticationApi
|
|
12388
|
+
*/
|
|
12389
|
+
verifyRecoveryCode(twoFactorAuthCode: TwoFactorAuthCode, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Verify2FAResult, any>>;
|
|
12390
|
+
}
|
|
12391
|
+
/**
|
|
12392
|
+
* AvatarsApi - axios parameter creator
|
|
12393
|
+
* @export
|
|
12394
|
+
*/
|
|
12395
|
+
export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
12396
|
+
/**
|
|
12397
|
+
* 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.
|
|
12398
|
+
* @summary Create Avatar
|
|
12399
|
+
* @param {CreateAvatarRequest} [createAvatarRequest]
|
|
12400
|
+
* @param {*} [options] Override http request option.
|
|
12401
|
+
* @throws {RequiredError}
|
|
12402
|
+
*/
|
|
12403
|
+
createAvatar: (createAvatarRequest?: CreateAvatarRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
12404
|
+
/**
|
|
12405
|
+
* 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.
|
|
12406
|
+
* @summary Delete Avatar
|
|
12407
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
12408
|
+
* @param {*} [options] Override http request option.
|
|
12409
|
+
* @throws {RequiredError}
|
|
12410
|
+
*/
|
|
12411
|
+
deleteAvatar: (avatarId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
12412
|
+
/**
|
|
12413
|
+
* Delete generated Impostor for that avatar.
|
|
12414
|
+
* @summary Delete generated Impostor
|
|
12415
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
12416
|
+
* @param {*} [options] Override http request option.
|
|
12417
|
+
* @throws {RequiredError}
|
|
12418
|
+
*/
|
|
12419
|
+
deleteImpostor: (avatarId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
12420
|
+
/**
|
|
12421
|
+
* Enqueue Impostor generation for that avatar.
|
|
12422
|
+
* @summary Enqueue Impostor generation
|
|
12423
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
12424
|
+
* @param {*} [options] Override http request option.
|
|
12425
|
+
* @throws {RequiredError}
|
|
12426
|
+
*/
|
|
12427
|
+
enqueueImpostor: (avatarId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
12428
|
+
/**
|
|
12429
|
+
* Get information about a specific Avatar.
|
|
12430
|
+
* @summary Get Avatar
|
|
12431
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
12432
|
+
* @param {*} [options] Override http request option.
|
|
12433
|
+
* @throws {RequiredError}
|
|
12434
|
+
*/
|
|
12435
|
+
getAvatar: (avatarId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
12436
|
+
/**
|
|
12437
|
+
* List avatar styles.
|
|
12438
|
+
* @summary Get Avatar Styles
|
|
12439
|
+
* @param {*} [options] Override http request option.
|
|
12440
|
+
* @throws {RequiredError}
|
|
12441
|
+
*/
|
|
12442
|
+
getAvatarStyles: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
12443
|
+
/**
|
|
12444
|
+
* Search and list favorited avatars by query filters.
|
|
12445
|
+
* @summary List Favorited Avatars
|
|
12446
|
+
* @param {boolean} [featured] Filters on featured results.
|
|
12447
|
+
* @param {SortOption} [sort] The sort order of the results.
|
|
12448
|
+
* @param {number} [n] The number of objects to return.
|
|
12449
|
+
* @param {OrderOption} [order] Result ordering
|
|
12450
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
12451
|
+
* @param {string} [search] Filters by world name.
|
|
12452
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
12453
|
+
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
12454
|
+
* @param {ReleaseStatus} [releaseStatus] Filter by ReleaseStatus.
|
|
12455
|
+
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
12456
|
+
* @param {string} [minUnityVersion] The minimum Unity version supported by the asset.
|
|
12457
|
+
* @param {string} [platform] The platform the asset supports.
|
|
12458
|
+
* @param {string} [userId] Target user to see information on, admin-only.
|
|
12459
|
+
* @param {*} [options] Override http request option.
|
|
12460
|
+
* @throws {RequiredError}
|
|
11008
12461
|
*/
|
|
11009
|
-
|
|
12462
|
+
getFavoritedAvatars: (featured?: boolean, sort?: SortOption, n?: number, order?: OrderOption, offset?: number, search?: string, tag?: string, notag?: string, releaseStatus?: ReleaseStatus, maxUnityVersion?: string, minUnityVersion?: string, platform?: string, userId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11010
12463
|
/**
|
|
11011
|
-
*
|
|
11012
|
-
* @summary
|
|
12464
|
+
* Gets service stats for queued impostor.
|
|
12465
|
+
* @summary Get Impostor Queue Stats
|
|
11013
12466
|
* @param {*} [options] Override http request option.
|
|
11014
12467
|
* @throws {RequiredError}
|
|
11015
12468
|
*/
|
|
11016
|
-
|
|
12469
|
+
getImpostorQueueStats: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11017
12470
|
/**
|
|
11018
|
-
*
|
|
11019
|
-
* @summary
|
|
11020
|
-
* @param {
|
|
11021
|
-
* @param {
|
|
12471
|
+
* List licensed avatars.
|
|
12472
|
+
* @summary List Licensed Avatars
|
|
12473
|
+
* @param {number} [n] The number of objects to return.
|
|
12474
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11022
12475
|
* @param {*} [options] Override http request option.
|
|
11023
12476
|
* @throws {RequiredError}
|
|
11024
12477
|
*/
|
|
11025
|
-
|
|
12478
|
+
getLicensedAvatars: (n?: number, offset?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11026
12479
|
/**
|
|
11027
|
-
*
|
|
11028
|
-
* @summary
|
|
11029
|
-
* @param {
|
|
12480
|
+
* Get the current avatar for the user. This will return an error for any other user than the one logged in.
|
|
12481
|
+
* @summary Get Own Avatar
|
|
12482
|
+
* @param {string} userId Must be a valid user ID.
|
|
11030
12483
|
* @param {*} [options] Override http request option.
|
|
11031
12484
|
* @throws {RequiredError}
|
|
11032
12485
|
*/
|
|
11033
|
-
|
|
12486
|
+
getOwnAvatar: (userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11034
12487
|
/**
|
|
11035
|
-
*
|
|
11036
|
-
* @summary
|
|
11037
|
-
* @param {
|
|
12488
|
+
* 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.
|
|
12489
|
+
* @summary Search Avatars
|
|
12490
|
+
* @param {boolean} [featured] Filters on featured results.
|
|
12491
|
+
* @param {SortOption} [sort] The sort order of the results.
|
|
12492
|
+
* @param {'me'} [user] Set to `me` for searching own avatars.
|
|
12493
|
+
* @param {string} [userId] Filter by UserID.
|
|
12494
|
+
* @param {number} [n] The number of objects to return.
|
|
12495
|
+
* @param {OrderOption} [order] Result ordering
|
|
12496
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
12497
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
12498
|
+
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
12499
|
+
* @param {ReleaseStatus} [releaseStatus] Filter by ReleaseStatus.
|
|
12500
|
+
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
12501
|
+
* @param {string} [minUnityVersion] The minimum Unity version supported by the asset.
|
|
12502
|
+
* @param {string} [platform] The platform the asset supports.
|
|
11038
12503
|
* @param {*} [options] Override http request option.
|
|
11039
12504
|
* @throws {RequiredError}
|
|
11040
12505
|
*/
|
|
11041
|
-
|
|
11042
|
-
};
|
|
11043
|
-
/**
|
|
11044
|
-
* AuthenticationApi - object-oriented interface
|
|
11045
|
-
* @export
|
|
11046
|
-
* @class AuthenticationApi
|
|
11047
|
-
* @extends {BaseAPI}
|
|
11048
|
-
*/
|
|
11049
|
-
export declare class AuthenticationApi extends BaseAPI {
|
|
12506
|
+
searchAvatars: (featured?: boolean, sort?: SortOption, user?: 'me', userId?: string, n?: number, order?: OrderOption, offset?: number, tag?: string, notag?: string, releaseStatus?: ReleaseStatus, maxUnityVersion?: string, minUnityVersion?: string, platform?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11050
12507
|
/**
|
|
11051
|
-
*
|
|
11052
|
-
* @summary
|
|
12508
|
+
* Switches into that avatar.
|
|
12509
|
+
* @summary Select Avatar
|
|
12510
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11053
12511
|
* @param {*} [options] Override http request option.
|
|
11054
12512
|
* @throws {RequiredError}
|
|
11055
|
-
* @memberof AuthenticationApi
|
|
11056
12513
|
*/
|
|
11057
|
-
|
|
12514
|
+
selectAvatar: (avatarId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11058
12515
|
/**
|
|
11059
|
-
*
|
|
11060
|
-
* @summary
|
|
11061
|
-
* @param {string}
|
|
11062
|
-
* @param {string} [displayName] Filter by displayName.
|
|
11063
|
-
* @param {string} [username] Filter by Username.
|
|
11064
|
-
* @param {string} [excludeUserId] Exclude by UserID.
|
|
12516
|
+
* Switches into that avatar as your fallback avatar.
|
|
12517
|
+
* @summary Select Fallback Avatar
|
|
12518
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11065
12519
|
* @param {*} [options] Override http request option.
|
|
12520
|
+
* @deprecated
|
|
11066
12521
|
* @throws {RequiredError}
|
|
11067
|
-
* @memberof AuthenticationApi
|
|
11068
12522
|
*/
|
|
11069
|
-
|
|
12523
|
+
selectFallbackAvatar: (avatarId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11070
12524
|
/**
|
|
11071
|
-
*
|
|
11072
|
-
* @summary
|
|
11073
|
-
* @param {string}
|
|
11074
|
-
* @param {
|
|
12525
|
+
* Update information about a specific avatar.
|
|
12526
|
+
* @summary Update Avatar
|
|
12527
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
12528
|
+
* @param {UpdateAvatarRequest} [updateAvatarRequest]
|
|
11075
12529
|
* @param {*} [options] Override http request option.
|
|
11076
12530
|
* @throws {RequiredError}
|
|
11077
|
-
* @memberof AuthenticationApi
|
|
11078
12531
|
*/
|
|
11079
|
-
|
|
12532
|
+
updateAvatar: (avatarId: string, updateAvatarRequest?: UpdateAvatarRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
12533
|
+
};
|
|
12534
|
+
/**
|
|
12535
|
+
* AvatarsApi - functional programming interface
|
|
12536
|
+
* @export
|
|
12537
|
+
*/
|
|
12538
|
+
export declare const AvatarsApiFp: (configuration?: Configuration) => {
|
|
11080
12539
|
/**
|
|
11081
|
-
*
|
|
11082
|
-
* @summary
|
|
11083
|
-
* @param {
|
|
12540
|
+
* 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.
|
|
12541
|
+
* @summary Create Avatar
|
|
12542
|
+
* @param {CreateAvatarRequest} [createAvatarRequest]
|
|
11084
12543
|
* @param {*} [options] Override http request option.
|
|
11085
12544
|
* @throws {RequiredError}
|
|
11086
|
-
* @memberof AuthenticationApi
|
|
11087
12545
|
*/
|
|
11088
|
-
|
|
12546
|
+
createAvatar(createAvatarRequest?: CreateAvatarRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Avatar>>;
|
|
11089
12547
|
/**
|
|
11090
|
-
*
|
|
11091
|
-
* @summary
|
|
12548
|
+
* 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.
|
|
12549
|
+
* @summary Delete Avatar
|
|
12550
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11092
12551
|
* @param {*} [options] Override http request option.
|
|
11093
12552
|
* @throws {RequiredError}
|
|
11094
|
-
* @memberof AuthenticationApi
|
|
11095
12553
|
*/
|
|
11096
|
-
|
|
12554
|
+
deleteAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Avatar>>;
|
|
11097
12555
|
/**
|
|
11098
|
-
*
|
|
11099
|
-
* @summary
|
|
12556
|
+
* Delete generated Impostor for that avatar.
|
|
12557
|
+
* @summary Delete generated Impostor
|
|
12558
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11100
12559
|
* @param {*} [options] Override http request option.
|
|
11101
12560
|
* @throws {RequiredError}
|
|
11102
|
-
* @memberof AuthenticationApi
|
|
11103
12561
|
*/
|
|
11104
|
-
|
|
12562
|
+
deleteImpostor(avatarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
11105
12563
|
/**
|
|
11106
|
-
*
|
|
11107
|
-
* @summary
|
|
12564
|
+
* Enqueue Impostor generation for that avatar.
|
|
12565
|
+
* @summary Enqueue Impostor generation
|
|
12566
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11108
12567
|
* @param {*} [options] Override http request option.
|
|
11109
12568
|
* @throws {RequiredError}
|
|
11110
|
-
* @memberof AuthenticationApi
|
|
11111
12569
|
*/
|
|
11112
|
-
|
|
12570
|
+
enqueueImpostor(avatarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceStatus>>;
|
|
11113
12571
|
/**
|
|
11114
|
-
*
|
|
11115
|
-
* @summary Get
|
|
12572
|
+
* Get information about a specific Avatar.
|
|
12573
|
+
* @summary Get Avatar
|
|
12574
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11116
12575
|
* @param {*} [options] Override http request option.
|
|
11117
12576
|
* @throws {RequiredError}
|
|
11118
|
-
* @memberof AuthenticationApi
|
|
11119
12577
|
*/
|
|
11120
|
-
|
|
12578
|
+
getAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Avatar>>;
|
|
11121
12579
|
/**
|
|
11122
|
-
*
|
|
11123
|
-
* @summary
|
|
12580
|
+
* List avatar styles.
|
|
12581
|
+
* @summary Get Avatar Styles
|
|
11124
12582
|
* @param {*} [options] Override http request option.
|
|
11125
12583
|
* @throws {RequiredError}
|
|
11126
|
-
* @memberof AuthenticationApi
|
|
11127
12584
|
*/
|
|
11128
|
-
|
|
12585
|
+
getAvatarStyles(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AvatarStyle>>>;
|
|
11129
12586
|
/**
|
|
11130
|
-
*
|
|
11131
|
-
* @summary
|
|
11132
|
-
* @param {
|
|
12587
|
+
* Search and list favorited avatars by query filters.
|
|
12588
|
+
* @summary List Favorited Avatars
|
|
12589
|
+
* @param {boolean} [featured] Filters on featured results.
|
|
12590
|
+
* @param {SortOption} [sort] The sort order of the results.
|
|
12591
|
+
* @param {number} [n] The number of objects to return.
|
|
12592
|
+
* @param {OrderOption} [order] Result ordering
|
|
12593
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
12594
|
+
* @param {string} [search] Filters by world name.
|
|
12595
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
12596
|
+
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
12597
|
+
* @param {ReleaseStatus} [releaseStatus] Filter by ReleaseStatus.
|
|
12598
|
+
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
12599
|
+
* @param {string} [minUnityVersion] The minimum Unity version supported by the asset.
|
|
12600
|
+
* @param {string} [platform] The platform the asset supports.
|
|
12601
|
+
* @param {string} [userId] Target user to see information on, admin-only.
|
|
11133
12602
|
* @param {*} [options] Override http request option.
|
|
11134
|
-
* @deprecated
|
|
11135
12603
|
* @throws {RequiredError}
|
|
11136
|
-
* @memberof AuthenticationApi
|
|
11137
12604
|
*/
|
|
11138
|
-
|
|
12605
|
+
getFavoritedAvatars(featured?: boolean, sort?: SortOption, n?: number, order?: OrderOption, offset?: number, search?: string, tag?: string, notag?: string, releaseStatus?: ReleaseStatus, maxUnityVersion?: string, minUnityVersion?: string, platform?: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Avatar>>>;
|
|
11139
12606
|
/**
|
|
11140
|
-
*
|
|
11141
|
-
* @summary
|
|
12607
|
+
* Gets service stats for queued impostor.
|
|
12608
|
+
* @summary Get Impostor Queue Stats
|
|
11142
12609
|
* @param {*} [options] Override http request option.
|
|
11143
12610
|
* @throws {RequiredError}
|
|
11144
|
-
* @memberof AuthenticationApi
|
|
11145
12611
|
*/
|
|
11146
|
-
|
|
12612
|
+
getImpostorQueueStats(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceQueueStats>>;
|
|
11147
12613
|
/**
|
|
11148
|
-
*
|
|
11149
|
-
* @summary
|
|
11150
|
-
* @param {
|
|
12614
|
+
* List licensed avatars.
|
|
12615
|
+
* @summary List Licensed Avatars
|
|
12616
|
+
* @param {number} [n] The number of objects to return.
|
|
12617
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11151
12618
|
* @param {*} [options] Override http request option.
|
|
11152
12619
|
* @throws {RequiredError}
|
|
11153
|
-
* @memberof AuthenticationApi
|
|
11154
12620
|
*/
|
|
11155
|
-
|
|
12621
|
+
getLicensedAvatars(n?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Avatar>>>;
|
|
11156
12622
|
/**
|
|
11157
|
-
*
|
|
11158
|
-
* @summary
|
|
11159
|
-
* @param {
|
|
12623
|
+
* Get the current avatar for the user. This will return an error for any other user than the one logged in.
|
|
12624
|
+
* @summary Get Own Avatar
|
|
12625
|
+
* @param {string} userId Must be a valid user ID.
|
|
11160
12626
|
* @param {*} [options] Override http request option.
|
|
11161
12627
|
* @throws {RequiredError}
|
|
11162
|
-
* @memberof AuthenticationApi
|
|
11163
12628
|
*/
|
|
11164
|
-
|
|
12629
|
+
getOwnAvatar(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Avatar>>;
|
|
11165
12630
|
/**
|
|
11166
|
-
*
|
|
11167
|
-
* @summary
|
|
12631
|
+
* 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.
|
|
12632
|
+
* @summary Search Avatars
|
|
12633
|
+
* @param {boolean} [featured] Filters on featured results.
|
|
12634
|
+
* @param {SortOption} [sort] The sort order of the results.
|
|
12635
|
+
* @param {'me'} [user] Set to `me` for searching own avatars.
|
|
12636
|
+
* @param {string} [userId] Filter by UserID.
|
|
12637
|
+
* @param {number} [n] The number of objects to return.
|
|
12638
|
+
* @param {OrderOption} [order] Result ordering
|
|
12639
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
12640
|
+
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
12641
|
+
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
12642
|
+
* @param {ReleaseStatus} [releaseStatus] Filter by ReleaseStatus.
|
|
12643
|
+
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
12644
|
+
* @param {string} [minUnityVersion] The minimum Unity version supported by the asset.
|
|
12645
|
+
* @param {string} [platform] The platform the asset supports.
|
|
11168
12646
|
* @param {*} [options] Override http request option.
|
|
11169
12647
|
* @throws {RequiredError}
|
|
11170
|
-
* @memberof AuthenticationApi
|
|
11171
12648
|
*/
|
|
11172
|
-
|
|
12649
|
+
searchAvatars(featured?: boolean, sort?: SortOption, user?: 'me', userId?: string, n?: number, order?: OrderOption, offset?: number, tag?: string, notag?: string, releaseStatus?: ReleaseStatus, maxUnityVersion?: string, minUnityVersion?: string, platform?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Avatar>>>;
|
|
11173
12650
|
/**
|
|
11174
|
-
*
|
|
11175
|
-
* @summary
|
|
11176
|
-
* @param {string}
|
|
11177
|
-
* @param {string} [userId] Filter by UserID.
|
|
12651
|
+
* Switches into that avatar.
|
|
12652
|
+
* @summary Select Avatar
|
|
12653
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11178
12654
|
* @param {*} [options] Override http request option.
|
|
11179
12655
|
* @throws {RequiredError}
|
|
11180
|
-
* @memberof AuthenticationApi
|
|
11181
12656
|
*/
|
|
11182
|
-
|
|
12657
|
+
selectAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>>;
|
|
11183
12658
|
/**
|
|
11184
|
-
*
|
|
11185
|
-
* @summary
|
|
11186
|
-
* @param {
|
|
12659
|
+
* Switches into that avatar as your fallback avatar.
|
|
12660
|
+
* @summary Select Fallback Avatar
|
|
12661
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
11187
12662
|
* @param {*} [options] Override http request option.
|
|
12663
|
+
* @deprecated
|
|
11188
12664
|
* @throws {RequiredError}
|
|
11189
|
-
* @memberof AuthenticationApi
|
|
11190
12665
|
*/
|
|
11191
|
-
|
|
12666
|
+
selectFallbackAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>>;
|
|
11192
12667
|
/**
|
|
11193
|
-
*
|
|
11194
|
-
* @summary
|
|
11195
|
-
* @param {
|
|
12668
|
+
* Update information about a specific avatar.
|
|
12669
|
+
* @summary Update Avatar
|
|
12670
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
12671
|
+
* @param {UpdateAvatarRequest} [updateAvatarRequest]
|
|
11196
12672
|
* @param {*} [options] Override http request option.
|
|
11197
12673
|
* @throws {RequiredError}
|
|
11198
|
-
* @memberof AuthenticationApi
|
|
11199
12674
|
*/
|
|
11200
|
-
|
|
11201
|
-
}
|
|
12675
|
+
updateAvatar(avatarId: string, updateAvatarRequest?: UpdateAvatarRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Avatar>>;
|
|
12676
|
+
};
|
|
11202
12677
|
/**
|
|
11203
|
-
* AvatarsApi -
|
|
12678
|
+
* AvatarsApi - factory interface
|
|
11204
12679
|
* @export
|
|
11205
12680
|
*/
|
|
11206
|
-
export declare const
|
|
12681
|
+
export declare const AvatarsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11207
12682
|
/**
|
|
11208
12683
|
* 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.
|
|
11209
12684
|
* @summary Create Avatar
|
|
@@ -11211,7 +12686,7 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
11211
12686
|
* @param {*} [options] Override http request option.
|
|
11212
12687
|
* @throws {RequiredError}
|
|
11213
12688
|
*/
|
|
11214
|
-
createAvatar
|
|
12689
|
+
createAvatar(createAvatarRequest?: CreateAvatarRequest, options?: any): AxiosPromise<Avatar>;
|
|
11215
12690
|
/**
|
|
11216
12691
|
* 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.
|
|
11217
12692
|
* @summary Delete Avatar
|
|
@@ -11219,7 +12694,7 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
11219
12694
|
* @param {*} [options] Override http request option.
|
|
11220
12695
|
* @throws {RequiredError}
|
|
11221
12696
|
*/
|
|
11222
|
-
deleteAvatar
|
|
12697
|
+
deleteAvatar(avatarId: string, options?: any): AxiosPromise<Avatar>;
|
|
11223
12698
|
/**
|
|
11224
12699
|
* Delete generated Impostor for that avatar.
|
|
11225
12700
|
* @summary Delete generated Impostor
|
|
@@ -11227,7 +12702,7 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
11227
12702
|
* @param {*} [options] Override http request option.
|
|
11228
12703
|
* @throws {RequiredError}
|
|
11229
12704
|
*/
|
|
11230
|
-
deleteImpostor
|
|
12705
|
+
deleteImpostor(avatarId: string, options?: any): AxiosPromise<void>;
|
|
11231
12706
|
/**
|
|
11232
12707
|
* Enqueue Impostor generation for that avatar.
|
|
11233
12708
|
* @summary Enqueue Impostor generation
|
|
@@ -11235,15 +12710,22 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
11235
12710
|
* @param {*} [options] Override http request option.
|
|
11236
12711
|
* @throws {RequiredError}
|
|
11237
12712
|
*/
|
|
11238
|
-
enqueueImpostor
|
|
12713
|
+
enqueueImpostor(avatarId: string, options?: any): AxiosPromise<ServiceStatus>;
|
|
12714
|
+
/**
|
|
12715
|
+
* Get information about a specific Avatar.
|
|
12716
|
+
* @summary Get Avatar
|
|
12717
|
+
* @param {string} avatarId Must be a valid avatar ID.
|
|
12718
|
+
* @param {*} [options] Override http request option.
|
|
12719
|
+
* @throws {RequiredError}
|
|
12720
|
+
*/
|
|
12721
|
+
getAvatar(avatarId: string, options?: any): AxiosPromise<Avatar>;
|
|
11239
12722
|
/**
|
|
11240
|
-
*
|
|
11241
|
-
* @summary Get Avatar
|
|
11242
|
-
* @param {string} avatarId Must be a valid avatar ID.
|
|
12723
|
+
* List avatar styles.
|
|
12724
|
+
* @summary Get Avatar Styles
|
|
11243
12725
|
* @param {*} [options] Override http request option.
|
|
11244
12726
|
* @throws {RequiredError}
|
|
11245
12727
|
*/
|
|
11246
|
-
|
|
12728
|
+
getAvatarStyles(options?: any): AxiosPromise<Array<AvatarStyle>>;
|
|
11247
12729
|
/**
|
|
11248
12730
|
* Search and list favorited avatars by query filters.
|
|
11249
12731
|
* @summary List Favorited Avatars
|
|
@@ -11263,14 +12745,14 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
11263
12745
|
* @param {*} [options] Override http request option.
|
|
11264
12746
|
* @throws {RequiredError}
|
|
11265
12747
|
*/
|
|
11266
|
-
getFavoritedAvatars
|
|
12748
|
+
getFavoritedAvatars(featured?: boolean, sort?: SortOption, n?: number, order?: OrderOption, offset?: number, search?: string, tag?: string, notag?: string, releaseStatus?: ReleaseStatus, maxUnityVersion?: string, minUnityVersion?: string, platform?: string, userId?: string, options?: any): AxiosPromise<Array<Avatar>>;
|
|
11267
12749
|
/**
|
|
11268
12750
|
* Gets service stats for queued impostor.
|
|
11269
12751
|
* @summary Get Impostor Queue Stats
|
|
11270
12752
|
* @param {*} [options] Override http request option.
|
|
11271
12753
|
* @throws {RequiredError}
|
|
11272
12754
|
*/
|
|
11273
|
-
getImpostorQueueStats
|
|
12755
|
+
getImpostorQueueStats(options?: any): AxiosPromise<ServiceQueueStats>;
|
|
11274
12756
|
/**
|
|
11275
12757
|
* List licensed avatars.
|
|
11276
12758
|
* @summary List Licensed Avatars
|
|
@@ -11279,7 +12761,7 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
11279
12761
|
* @param {*} [options] Override http request option.
|
|
11280
12762
|
* @throws {RequiredError}
|
|
11281
12763
|
*/
|
|
11282
|
-
getLicensedAvatars
|
|
12764
|
+
getLicensedAvatars(n?: number, offset?: number, options?: any): AxiosPromise<Array<Avatar>>;
|
|
11283
12765
|
/**
|
|
11284
12766
|
* Get the current avatar for the user. This will return an error for any other user than the one logged in.
|
|
11285
12767
|
* @summary Get Own Avatar
|
|
@@ -11287,7 +12769,7 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
11287
12769
|
* @param {*} [options] Override http request option.
|
|
11288
12770
|
* @throws {RequiredError}
|
|
11289
12771
|
*/
|
|
11290
|
-
getOwnAvatar
|
|
12772
|
+
getOwnAvatar(userId: string, options?: any): AxiosPromise<Avatar>;
|
|
11291
12773
|
/**
|
|
11292
12774
|
* 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.
|
|
11293
12775
|
* @summary Search Avatars
|
|
@@ -11307,7 +12789,7 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
11307
12789
|
* @param {*} [options] Override http request option.
|
|
11308
12790
|
* @throws {RequiredError}
|
|
11309
12791
|
*/
|
|
11310
|
-
searchAvatars
|
|
12792
|
+
searchAvatars(featured?: boolean, sort?: SortOption, user?: 'me', userId?: string, n?: number, order?: OrderOption, offset?: number, tag?: string, notag?: string, releaseStatus?: ReleaseStatus, maxUnityVersion?: string, minUnityVersion?: string, platform?: string, options?: any): AxiosPromise<Array<Avatar>>;
|
|
11311
12793
|
/**
|
|
11312
12794
|
* Switches into that avatar.
|
|
11313
12795
|
* @summary Select Avatar
|
|
@@ -11315,7 +12797,7 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
11315
12797
|
* @param {*} [options] Override http request option.
|
|
11316
12798
|
* @throws {RequiredError}
|
|
11317
12799
|
*/
|
|
11318
|
-
selectAvatar
|
|
12800
|
+
selectAvatar(avatarId: string, options?: any): AxiosPromise<CurrentUser>;
|
|
11319
12801
|
/**
|
|
11320
12802
|
* Switches into that avatar as your fallback avatar.
|
|
11321
12803
|
* @summary Select Fallback Avatar
|
|
@@ -11324,7 +12806,7 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
11324
12806
|
* @deprecated
|
|
11325
12807
|
* @throws {RequiredError}
|
|
11326
12808
|
*/
|
|
11327
|
-
selectFallbackAvatar
|
|
12809
|
+
selectFallbackAvatar(avatarId: string, options?: any): AxiosPromise<CurrentUser>;
|
|
11328
12810
|
/**
|
|
11329
12811
|
* Update information about a specific avatar.
|
|
11330
12812
|
* @summary Update Avatar
|
|
@@ -11333,53 +12815,68 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
11333
12815
|
* @param {*} [options] Override http request option.
|
|
11334
12816
|
* @throws {RequiredError}
|
|
11335
12817
|
*/
|
|
11336
|
-
updateAvatar
|
|
12818
|
+
updateAvatar(avatarId: string, updateAvatarRequest?: UpdateAvatarRequest, options?: any): AxiosPromise<Avatar>;
|
|
11337
12819
|
};
|
|
11338
12820
|
/**
|
|
11339
|
-
* AvatarsApi -
|
|
12821
|
+
* AvatarsApi - object-oriented interface
|
|
11340
12822
|
* @export
|
|
12823
|
+
* @class AvatarsApi
|
|
12824
|
+
* @extends {BaseAPI}
|
|
11341
12825
|
*/
|
|
11342
|
-
export declare
|
|
12826
|
+
export declare class AvatarsApi extends BaseAPI {
|
|
11343
12827
|
/**
|
|
11344
12828
|
* 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.
|
|
11345
12829
|
* @summary Create Avatar
|
|
11346
12830
|
* @param {CreateAvatarRequest} [createAvatarRequest]
|
|
11347
12831
|
* @param {*} [options] Override http request option.
|
|
11348
12832
|
* @throws {RequiredError}
|
|
12833
|
+
* @memberof AvatarsApi
|
|
11349
12834
|
*/
|
|
11350
|
-
createAvatar(createAvatarRequest?: CreateAvatarRequest, options?: AxiosRequestConfig): Promise<(axios
|
|
12835
|
+
createAvatar(createAvatarRequest?: CreateAvatarRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Avatar, any>>;
|
|
11351
12836
|
/**
|
|
11352
12837
|
* 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.
|
|
11353
12838
|
* @summary Delete Avatar
|
|
11354
12839
|
* @param {string} avatarId Must be a valid avatar ID.
|
|
11355
12840
|
* @param {*} [options] Override http request option.
|
|
11356
12841
|
* @throws {RequiredError}
|
|
12842
|
+
* @memberof AvatarsApi
|
|
11357
12843
|
*/
|
|
11358
|
-
deleteAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<(axios
|
|
12844
|
+
deleteAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Avatar, any>>;
|
|
11359
12845
|
/**
|
|
11360
12846
|
* Delete generated Impostor for that avatar.
|
|
11361
12847
|
* @summary Delete generated Impostor
|
|
11362
12848
|
* @param {string} avatarId Must be a valid avatar ID.
|
|
11363
12849
|
* @param {*} [options] Override http request option.
|
|
11364
12850
|
* @throws {RequiredError}
|
|
12851
|
+
* @memberof AvatarsApi
|
|
11365
12852
|
*/
|
|
11366
|
-
deleteImpostor(avatarId: string, options?: AxiosRequestConfig): Promise<(axios
|
|
12853
|
+
deleteImpostor(avatarId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
11367
12854
|
/**
|
|
11368
12855
|
* Enqueue Impostor generation for that avatar.
|
|
11369
12856
|
* @summary Enqueue Impostor generation
|
|
11370
12857
|
* @param {string} avatarId Must be a valid avatar ID.
|
|
11371
12858
|
* @param {*} [options] Override http request option.
|
|
11372
12859
|
* @throws {RequiredError}
|
|
12860
|
+
* @memberof AvatarsApi
|
|
11373
12861
|
*/
|
|
11374
|
-
enqueueImpostor(avatarId: string, options?: AxiosRequestConfig): Promise<(axios
|
|
12862
|
+
enqueueImpostor(avatarId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceStatus, any>>;
|
|
11375
12863
|
/**
|
|
11376
12864
|
* Get information about a specific Avatar.
|
|
11377
12865
|
* @summary Get Avatar
|
|
11378
12866
|
* @param {string} avatarId Must be a valid avatar ID.
|
|
11379
12867
|
* @param {*} [options] Override http request option.
|
|
11380
12868
|
* @throws {RequiredError}
|
|
12869
|
+
* @memberof AvatarsApi
|
|
12870
|
+
*/
|
|
12871
|
+
getAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Avatar, any>>;
|
|
12872
|
+
/**
|
|
12873
|
+
* List avatar styles.
|
|
12874
|
+
* @summary Get Avatar Styles
|
|
12875
|
+
* @param {*} [options] Override http request option.
|
|
12876
|
+
* @throws {RequiredError}
|
|
12877
|
+
* @memberof AvatarsApi
|
|
11381
12878
|
*/
|
|
11382
|
-
|
|
12879
|
+
getAvatarStyles(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AvatarStyle[], any>>;
|
|
11383
12880
|
/**
|
|
11384
12881
|
* Search and list favorited avatars by query filters.
|
|
11385
12882
|
* @summary List Favorited Avatars
|
|
@@ -11398,15 +12895,17 @@ export declare const AvatarsApiFp: (configuration?: Configuration) => {
|
|
|
11398
12895
|
* @param {string} [userId] Target user to see information on, admin-only.
|
|
11399
12896
|
* @param {*} [options] Override http request option.
|
|
11400
12897
|
* @throws {RequiredError}
|
|
12898
|
+
* @memberof AvatarsApi
|
|
11401
12899
|
*/
|
|
11402
|
-
getFavoritedAvatars(featured?: boolean, sort?: SortOption, n?: number, order?: OrderOption, offset?: number, search?: string, tag?: string, notag?: string, releaseStatus?: ReleaseStatus, maxUnityVersion?: string, minUnityVersion?: string, platform?: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios
|
|
12900
|
+
getFavoritedAvatars(featured?: boolean, sort?: SortOption, n?: number, order?: OrderOption, offset?: number, search?: string, tag?: string, notag?: string, releaseStatus?: ReleaseStatus, maxUnityVersion?: string, minUnityVersion?: string, platform?: string, userId?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Avatar[], any>>;
|
|
11403
12901
|
/**
|
|
11404
12902
|
* Gets service stats for queued impostor.
|
|
11405
12903
|
* @summary Get Impostor Queue Stats
|
|
11406
12904
|
* @param {*} [options] Override http request option.
|
|
11407
12905
|
* @throws {RequiredError}
|
|
12906
|
+
* @memberof AvatarsApi
|
|
11408
12907
|
*/
|
|
11409
|
-
getImpostorQueueStats(options?: AxiosRequestConfig): Promise<(axios
|
|
12908
|
+
getImpostorQueueStats(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceQueueStats, any>>;
|
|
11410
12909
|
/**
|
|
11411
12910
|
* List licensed avatars.
|
|
11412
12911
|
* @summary List Licensed Avatars
|
|
@@ -11414,16 +12913,18 @@ export declare const AvatarsApiFp: (configuration?: Configuration) => {
|
|
|
11414
12913
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11415
12914
|
* @param {*} [options] Override http request option.
|
|
11416
12915
|
* @throws {RequiredError}
|
|
12916
|
+
* @memberof AvatarsApi
|
|
11417
12917
|
*/
|
|
11418
|
-
getLicensedAvatars(n?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios
|
|
12918
|
+
getLicensedAvatars(n?: number, offset?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Avatar[], any>>;
|
|
11419
12919
|
/**
|
|
11420
12920
|
* Get the current avatar for the user. This will return an error for any other user than the one logged in.
|
|
11421
12921
|
* @summary Get Own Avatar
|
|
11422
12922
|
* @param {string} userId Must be a valid user ID.
|
|
11423
12923
|
* @param {*} [options] Override http request option.
|
|
11424
12924
|
* @throws {RequiredError}
|
|
12925
|
+
* @memberof AvatarsApi
|
|
11425
12926
|
*/
|
|
11426
|
-
getOwnAvatar(userId: string, options?: AxiosRequestConfig): Promise<(axios
|
|
12927
|
+
getOwnAvatar(userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Avatar, any>>;
|
|
11427
12928
|
/**
|
|
11428
12929
|
* 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.
|
|
11429
12930
|
* @summary Search Avatars
|
|
@@ -11442,16 +12943,18 @@ export declare const AvatarsApiFp: (configuration?: Configuration) => {
|
|
|
11442
12943
|
* @param {string} [platform] The platform the asset supports.
|
|
11443
12944
|
* @param {*} [options] Override http request option.
|
|
11444
12945
|
* @throws {RequiredError}
|
|
12946
|
+
* @memberof AvatarsApi
|
|
11445
12947
|
*/
|
|
11446
|
-
searchAvatars(featured?: boolean, sort?: SortOption, user?: 'me', userId?: string, n?: number, order?: OrderOption, offset?: number, tag?: string, notag?: string, releaseStatus?: ReleaseStatus, maxUnityVersion?: string, minUnityVersion?: string, platform?: string, options?: AxiosRequestConfig): Promise<(axios
|
|
12948
|
+
searchAvatars(featured?: boolean, sort?: SortOption, user?: 'me', userId?: string, n?: number, order?: OrderOption, offset?: number, tag?: string, notag?: string, releaseStatus?: ReleaseStatus, maxUnityVersion?: string, minUnityVersion?: string, platform?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Avatar[], any>>;
|
|
11447
12949
|
/**
|
|
11448
12950
|
* Switches into that avatar.
|
|
11449
12951
|
* @summary Select Avatar
|
|
11450
12952
|
* @param {string} avatarId Must be a valid avatar ID.
|
|
11451
12953
|
* @param {*} [options] Override http request option.
|
|
11452
12954
|
* @throws {RequiredError}
|
|
12955
|
+
* @memberof AvatarsApi
|
|
11453
12956
|
*/
|
|
11454
|
-
selectAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<(axios
|
|
12957
|
+
selectAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CurrentUser, any>>;
|
|
11455
12958
|
/**
|
|
11456
12959
|
* Switches into that avatar as your fallback avatar.
|
|
11457
12960
|
* @summary Select Fallback Avatar
|
|
@@ -11459,8 +12962,9 @@ export declare const AvatarsApiFp: (configuration?: Configuration) => {
|
|
|
11459
12962
|
* @param {*} [options] Override http request option.
|
|
11460
12963
|
* @deprecated
|
|
11461
12964
|
* @throws {RequiredError}
|
|
12965
|
+
* @memberof AvatarsApi
|
|
11462
12966
|
*/
|
|
11463
|
-
selectFallbackAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<(axios
|
|
12967
|
+
selectFallbackAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CurrentUser, any>>;
|
|
11464
12968
|
/**
|
|
11465
12969
|
* Update information about a specific avatar.
|
|
11466
12970
|
* @summary Update Avatar
|
|
@@ -11468,295 +12972,433 @@ export declare const AvatarsApiFp: (configuration?: Configuration) => {
|
|
|
11468
12972
|
* @param {UpdateAvatarRequest} [updateAvatarRequest]
|
|
11469
12973
|
* @param {*} [options] Override http request option.
|
|
11470
12974
|
* @throws {RequiredError}
|
|
12975
|
+
* @memberof AvatarsApi
|
|
11471
12976
|
*/
|
|
11472
|
-
updateAvatar(avatarId: string, updateAvatarRequest?: UpdateAvatarRequest, options?: AxiosRequestConfig): Promise<(axios
|
|
11473
|
-
}
|
|
12977
|
+
updateAvatar(avatarId: string, updateAvatarRequest?: UpdateAvatarRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Avatar, any>>;
|
|
12978
|
+
}
|
|
11474
12979
|
/**
|
|
11475
|
-
*
|
|
12980
|
+
* CalendarApi - axios parameter creator
|
|
11476
12981
|
* @export
|
|
11477
12982
|
*/
|
|
11478
|
-
export declare const
|
|
12983
|
+
export declare const CalendarApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11479
12984
|
/**
|
|
11480
|
-
*
|
|
11481
|
-
* @summary Create
|
|
11482
|
-
* @param {
|
|
12985
|
+
* Creates an event for a group on the calendar
|
|
12986
|
+
* @summary Create a calendar event
|
|
12987
|
+
* @param {string} groupId Must be a valid group ID.
|
|
12988
|
+
* @param {CreateCalendarEventRequest} createCalendarEventRequest
|
|
11483
12989
|
* @param {*} [options] Override http request option.
|
|
11484
12990
|
* @throws {RequiredError}
|
|
11485
12991
|
*/
|
|
11486
|
-
|
|
12992
|
+
createGroupCalendarEvent: (groupId: string, createCalendarEventRequest: CreateCalendarEventRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11487
12993
|
/**
|
|
11488
|
-
* Delete
|
|
11489
|
-
* @summary Delete
|
|
11490
|
-
* @param {string}
|
|
12994
|
+
* Delete a group calendar event
|
|
12995
|
+
* @summary Delete a calendar event
|
|
12996
|
+
* @param {string} groupId Must be a valid group ID.
|
|
12997
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
11491
12998
|
* @param {*} [options] Override http request option.
|
|
11492
12999
|
* @throws {RequiredError}
|
|
11493
13000
|
*/
|
|
11494
|
-
|
|
13001
|
+
deleteGroupCalendarEvent: (groupId: string, calendarId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11495
13002
|
/**
|
|
11496
|
-
*
|
|
11497
|
-
* @summary
|
|
11498
|
-
* @param {string}
|
|
13003
|
+
* Follow or unfollow an event on a group\'s calendar
|
|
13004
|
+
* @summary Follow a calendar event
|
|
13005
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13006
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
13007
|
+
* @param {FollowCalendarEventRequest} followCalendarEventRequest
|
|
11499
13008
|
* @param {*} [options] Override http request option.
|
|
11500
13009
|
* @throws {RequiredError}
|
|
11501
13010
|
*/
|
|
11502
|
-
|
|
13011
|
+
followGroupCalendarEvent: (groupId: string, calendarId: string, followCalendarEventRequest: FollowCalendarEventRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11503
13012
|
/**
|
|
11504
|
-
*
|
|
11505
|
-
* @summary
|
|
11506
|
-
* @param {string}
|
|
13013
|
+
* Get a list of a user\'s calendar events for the month in ?date
|
|
13014
|
+
* @summary List calendar events
|
|
13015
|
+
* @param {string} [date] The month to search in.
|
|
13016
|
+
* @param {number} [n] The number of objects to return.
|
|
13017
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11507
13018
|
* @param {*} [options] Override http request option.
|
|
11508
13019
|
* @throws {RequiredError}
|
|
11509
13020
|
*/
|
|
11510
|
-
|
|
13021
|
+
getCalendarEvents: (date?: string, n?: number, offset?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11511
13022
|
/**
|
|
11512
|
-
* Get
|
|
11513
|
-
* @summary
|
|
11514
|
-
* @param {string}
|
|
13023
|
+
* Get a list of a featured calendar events for the month in ?date
|
|
13024
|
+
* @summary List featured calendar events
|
|
13025
|
+
* @param {string} [date] The month to search in.
|
|
13026
|
+
* @param {number} [n] The number of objects to return.
|
|
13027
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11515
13028
|
* @param {*} [options] Override http request option.
|
|
11516
13029
|
* @throws {RequiredError}
|
|
11517
13030
|
*/
|
|
11518
|
-
|
|
13031
|
+
getFeaturedCalendarEvents: (date?: string, n?: number, offset?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11519
13032
|
/**
|
|
11520
|
-
*
|
|
11521
|
-
* @summary List
|
|
11522
|
-
* @param {
|
|
11523
|
-
* @param {SortOption} [sort] The sort order of the results.
|
|
13033
|
+
* Get a list of a followed calendar events for the month in ?date
|
|
13034
|
+
* @summary List followed calendar events
|
|
13035
|
+
* @param {string} [date] The month to search in.
|
|
11524
13036
|
* @param {number} [n] The number of objects to return.
|
|
11525
|
-
* @param {OrderOption} [order] Result ordering
|
|
11526
13037
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11527
|
-
* @param {string} [search] Filters by world name.
|
|
11528
|
-
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
11529
|
-
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
11530
|
-
* @param {ReleaseStatus} [releaseStatus] Filter by ReleaseStatus.
|
|
11531
|
-
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
11532
|
-
* @param {string} [minUnityVersion] The minimum Unity version supported by the asset.
|
|
11533
|
-
* @param {string} [platform] The platform the asset supports.
|
|
11534
|
-
* @param {string} [userId] Target user to see information on, admin-only.
|
|
11535
13038
|
* @param {*} [options] Override http request option.
|
|
11536
13039
|
* @throws {RequiredError}
|
|
11537
13040
|
*/
|
|
11538
|
-
|
|
13041
|
+
getFollowedCalendarEvents: (date?: string, n?: number, offset?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11539
13042
|
/**
|
|
11540
|
-
*
|
|
11541
|
-
* @summary Get
|
|
13043
|
+
* Get a group calendar event
|
|
13044
|
+
* @summary Get a calendar event
|
|
13045
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13046
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
11542
13047
|
* @param {*} [options] Override http request option.
|
|
11543
13048
|
* @throws {RequiredError}
|
|
11544
13049
|
*/
|
|
11545
|
-
|
|
13050
|
+
getGroupCalendarEvent: (groupId: string, calendarId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11546
13051
|
/**
|
|
11547
|
-
*
|
|
11548
|
-
* @summary
|
|
13052
|
+
* Returns the specified calendar in iCalendar (ICS) format.
|
|
13053
|
+
* @summary Download calendar event as ICS
|
|
13054
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13055
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
13056
|
+
* @param {*} [options] Override http request option.
|
|
13057
|
+
* @throws {RequiredError}
|
|
13058
|
+
*/
|
|
13059
|
+
getGroupCalendarEventICS: (groupId: string, calendarId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13060
|
+
/**
|
|
13061
|
+
* Get a list of a group\'s calendar events
|
|
13062
|
+
* @summary List a group\'s calendar events
|
|
13063
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13064
|
+
* @param {string} [date] The month to search in.
|
|
11549
13065
|
* @param {number} [n] The number of objects to return.
|
|
11550
13066
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11551
13067
|
* @param {*} [options] Override http request option.
|
|
11552
13068
|
* @throws {RequiredError}
|
|
11553
13069
|
*/
|
|
11554
|
-
|
|
13070
|
+
getGroupCalendarEvents: (groupId: string, date?: string, n?: number, offset?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
11555
13071
|
/**
|
|
11556
|
-
*
|
|
11557
|
-
* @summary
|
|
11558
|
-
* @param {string}
|
|
13072
|
+
* Updates an event for a group on the calendar
|
|
13073
|
+
* @summary Update a calendar event
|
|
13074
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13075
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
13076
|
+
* @param {UpdateCalendarEventRequest} updateCalendarEventRequest
|
|
11559
13077
|
* @param {*} [options] Override http request option.
|
|
11560
13078
|
* @throws {RequiredError}
|
|
11561
13079
|
*/
|
|
11562
|
-
|
|
13080
|
+
updateGroupCalendarEvent: (groupId: string, calendarId: string, updateCalendarEventRequest: UpdateCalendarEventRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13081
|
+
};
|
|
13082
|
+
/**
|
|
13083
|
+
* CalendarApi - functional programming interface
|
|
13084
|
+
* @export
|
|
13085
|
+
*/
|
|
13086
|
+
export declare const CalendarApiFp: (configuration?: Configuration) => {
|
|
11563
13087
|
/**
|
|
11564
|
-
*
|
|
11565
|
-
* @summary
|
|
11566
|
-
* @param {
|
|
11567
|
-
* @param {
|
|
11568
|
-
* @param {
|
|
11569
|
-
* @
|
|
13088
|
+
* Creates an event for a group on the calendar
|
|
13089
|
+
* @summary Create a calendar event
|
|
13090
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13091
|
+
* @param {CreateCalendarEventRequest} createCalendarEventRequest
|
|
13092
|
+
* @param {*} [options] Override http request option.
|
|
13093
|
+
* @throws {RequiredError}
|
|
13094
|
+
*/
|
|
13095
|
+
createGroupCalendarEvent(groupId: string, createCalendarEventRequest: CreateCalendarEventRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CalendarEvent>>;
|
|
13096
|
+
/**
|
|
13097
|
+
* Delete a group calendar event
|
|
13098
|
+
* @summary Delete a calendar event
|
|
13099
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13100
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
13101
|
+
* @param {*} [options] Override http request option.
|
|
13102
|
+
* @throws {RequiredError}
|
|
13103
|
+
*/
|
|
13104
|
+
deleteGroupCalendarEvent(groupId: string, calendarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>>;
|
|
13105
|
+
/**
|
|
13106
|
+
* Follow or unfollow an event on a group\'s calendar
|
|
13107
|
+
* @summary Follow a calendar event
|
|
13108
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13109
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
13110
|
+
* @param {FollowCalendarEventRequest} followCalendarEventRequest
|
|
13111
|
+
* @param {*} [options] Override http request option.
|
|
13112
|
+
* @throws {RequiredError}
|
|
13113
|
+
*/
|
|
13114
|
+
followGroupCalendarEvent(groupId: string, calendarId: string, followCalendarEventRequest: FollowCalendarEventRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CalendarEvent>>;
|
|
13115
|
+
/**
|
|
13116
|
+
* Get a list of a user\'s calendar events for the month in ?date
|
|
13117
|
+
* @summary List calendar events
|
|
13118
|
+
* @param {string} [date] The month to search in.
|
|
11570
13119
|
* @param {number} [n] The number of objects to return.
|
|
11571
|
-
* @param {OrderOption} [order] Result ordering
|
|
11572
13120
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11573
|
-
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
11574
|
-
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
11575
|
-
* @param {ReleaseStatus} [releaseStatus] Filter by ReleaseStatus.
|
|
11576
|
-
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
11577
|
-
* @param {string} [minUnityVersion] The minimum Unity version supported by the asset.
|
|
11578
|
-
* @param {string} [platform] The platform the asset supports.
|
|
11579
13121
|
* @param {*} [options] Override http request option.
|
|
11580
13122
|
* @throws {RequiredError}
|
|
11581
13123
|
*/
|
|
11582
|
-
|
|
13124
|
+
getCalendarEvents(date?: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedCalendarEventList>>;
|
|
11583
13125
|
/**
|
|
11584
|
-
*
|
|
11585
|
-
* @summary
|
|
11586
|
-
* @param {string}
|
|
13126
|
+
* Get a list of a featured calendar events for the month in ?date
|
|
13127
|
+
* @summary List featured calendar events
|
|
13128
|
+
* @param {string} [date] The month to search in.
|
|
13129
|
+
* @param {number} [n] The number of objects to return.
|
|
13130
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11587
13131
|
* @param {*} [options] Override http request option.
|
|
11588
13132
|
* @throws {RequiredError}
|
|
11589
13133
|
*/
|
|
11590
|
-
|
|
13134
|
+
getFeaturedCalendarEvents(date?: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedCalendarEventList>>;
|
|
11591
13135
|
/**
|
|
11592
|
-
*
|
|
11593
|
-
* @summary
|
|
11594
|
-
* @param {string}
|
|
13136
|
+
* Get a list of a followed calendar events for the month in ?date
|
|
13137
|
+
* @summary List followed calendar events
|
|
13138
|
+
* @param {string} [date] The month to search in.
|
|
13139
|
+
* @param {number} [n] The number of objects to return.
|
|
13140
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11595
13141
|
* @param {*} [options] Override http request option.
|
|
11596
|
-
* @deprecated
|
|
11597
13142
|
* @throws {RequiredError}
|
|
11598
13143
|
*/
|
|
11599
|
-
|
|
13144
|
+
getFollowedCalendarEvents(date?: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedCalendarEventList>>;
|
|
11600
13145
|
/**
|
|
11601
|
-
*
|
|
11602
|
-
* @summary
|
|
11603
|
-
* @param {string}
|
|
11604
|
-
* @param {
|
|
13146
|
+
* Get a group calendar event
|
|
13147
|
+
* @summary Get a calendar event
|
|
13148
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13149
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
11605
13150
|
* @param {*} [options] Override http request option.
|
|
11606
13151
|
* @throws {RequiredError}
|
|
11607
13152
|
*/
|
|
11608
|
-
|
|
13153
|
+
getGroupCalendarEvent(groupId: string, calendarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CalendarEvent>>;
|
|
13154
|
+
/**
|
|
13155
|
+
* Returns the specified calendar in iCalendar (ICS) format.
|
|
13156
|
+
* @summary Download calendar event as ICS
|
|
13157
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13158
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
13159
|
+
* @param {*} [options] Override http request option.
|
|
13160
|
+
* @throws {RequiredError}
|
|
13161
|
+
*/
|
|
13162
|
+
getGroupCalendarEventICS(groupId: string, calendarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
13163
|
+
/**
|
|
13164
|
+
* Get a list of a group\'s calendar events
|
|
13165
|
+
* @summary List a group\'s calendar events
|
|
13166
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13167
|
+
* @param {string} [date] The month to search in.
|
|
13168
|
+
* @param {number} [n] The number of objects to return.
|
|
13169
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
13170
|
+
* @param {*} [options] Override http request option.
|
|
13171
|
+
* @throws {RequiredError}
|
|
13172
|
+
*/
|
|
13173
|
+
getGroupCalendarEvents(groupId: string, date?: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedCalendarEventList>>;
|
|
13174
|
+
/**
|
|
13175
|
+
* Updates an event for a group on the calendar
|
|
13176
|
+
* @summary Update a calendar event
|
|
13177
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13178
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
13179
|
+
* @param {UpdateCalendarEventRequest} updateCalendarEventRequest
|
|
13180
|
+
* @param {*} [options] Override http request option.
|
|
13181
|
+
* @throws {RequiredError}
|
|
13182
|
+
*/
|
|
13183
|
+
updateGroupCalendarEvent(groupId: string, calendarId: string, updateCalendarEventRequest: UpdateCalendarEventRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CalendarEvent>>;
|
|
11609
13184
|
};
|
|
11610
13185
|
/**
|
|
11611
|
-
*
|
|
13186
|
+
* CalendarApi - factory interface
|
|
11612
13187
|
* @export
|
|
11613
|
-
* @class AvatarsApi
|
|
11614
|
-
* @extends {BaseAPI}
|
|
11615
13188
|
*/
|
|
11616
|
-
export declare
|
|
13189
|
+
export declare const CalendarApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11617
13190
|
/**
|
|
11618
|
-
*
|
|
11619
|
-
* @summary Create
|
|
11620
|
-
* @param {
|
|
13191
|
+
* Creates an event for a group on the calendar
|
|
13192
|
+
* @summary Create a calendar event
|
|
13193
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13194
|
+
* @param {CreateCalendarEventRequest} createCalendarEventRequest
|
|
11621
13195
|
* @param {*} [options] Override http request option.
|
|
11622
13196
|
* @throws {RequiredError}
|
|
11623
|
-
* @memberof AvatarsApi
|
|
11624
13197
|
*/
|
|
11625
|
-
|
|
13198
|
+
createGroupCalendarEvent(groupId: string, createCalendarEventRequest: CreateCalendarEventRequest, options?: any): AxiosPromise<CalendarEvent>;
|
|
11626
13199
|
/**
|
|
11627
|
-
* Delete
|
|
11628
|
-
* @summary Delete
|
|
11629
|
-
* @param {string}
|
|
13200
|
+
* Delete a group calendar event
|
|
13201
|
+
* @summary Delete a calendar event
|
|
13202
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13203
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
13204
|
+
* @param {*} [options] Override http request option.
|
|
13205
|
+
* @throws {RequiredError}
|
|
13206
|
+
*/
|
|
13207
|
+
deleteGroupCalendarEvent(groupId: string, calendarId: string, options?: any): AxiosPromise<Success>;
|
|
13208
|
+
/**
|
|
13209
|
+
* Follow or unfollow an event on a group\'s calendar
|
|
13210
|
+
* @summary Follow a calendar event
|
|
13211
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13212
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
13213
|
+
* @param {FollowCalendarEventRequest} followCalendarEventRequest
|
|
13214
|
+
* @param {*} [options] Override http request option.
|
|
13215
|
+
* @throws {RequiredError}
|
|
13216
|
+
*/
|
|
13217
|
+
followGroupCalendarEvent(groupId: string, calendarId: string, followCalendarEventRequest: FollowCalendarEventRequest, options?: any): AxiosPromise<CalendarEvent>;
|
|
13218
|
+
/**
|
|
13219
|
+
* Get a list of a user\'s calendar events for the month in ?date
|
|
13220
|
+
* @summary List calendar events
|
|
13221
|
+
* @param {string} [date] The month to search in.
|
|
13222
|
+
* @param {number} [n] The number of objects to return.
|
|
13223
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
13224
|
+
* @param {*} [options] Override http request option.
|
|
13225
|
+
* @throws {RequiredError}
|
|
13226
|
+
*/
|
|
13227
|
+
getCalendarEvents(date?: string, n?: number, offset?: number, options?: any): AxiosPromise<PaginatedCalendarEventList>;
|
|
13228
|
+
/**
|
|
13229
|
+
* Get a list of a featured calendar events for the month in ?date
|
|
13230
|
+
* @summary List featured calendar events
|
|
13231
|
+
* @param {string} [date] The month to search in.
|
|
13232
|
+
* @param {number} [n] The number of objects to return.
|
|
13233
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
13234
|
+
* @param {*} [options] Override http request option.
|
|
13235
|
+
* @throws {RequiredError}
|
|
13236
|
+
*/
|
|
13237
|
+
getFeaturedCalendarEvents(date?: string, n?: number, offset?: number, options?: any): AxiosPromise<PaginatedCalendarEventList>;
|
|
13238
|
+
/**
|
|
13239
|
+
* Get a list of a followed calendar events for the month in ?date
|
|
13240
|
+
* @summary List followed calendar events
|
|
13241
|
+
* @param {string} [date] The month to search in.
|
|
13242
|
+
* @param {number} [n] The number of objects to return.
|
|
13243
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
13244
|
+
* @param {*} [options] Override http request option.
|
|
13245
|
+
* @throws {RequiredError}
|
|
13246
|
+
*/
|
|
13247
|
+
getFollowedCalendarEvents(date?: string, n?: number, offset?: number, options?: any): AxiosPromise<PaginatedCalendarEventList>;
|
|
13248
|
+
/**
|
|
13249
|
+
* Get a group calendar event
|
|
13250
|
+
* @summary Get a calendar event
|
|
13251
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13252
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
13253
|
+
* @param {*} [options] Override http request option.
|
|
13254
|
+
* @throws {RequiredError}
|
|
13255
|
+
*/
|
|
13256
|
+
getGroupCalendarEvent(groupId: string, calendarId: string, options?: any): AxiosPromise<CalendarEvent>;
|
|
13257
|
+
/**
|
|
13258
|
+
* Returns the specified calendar in iCalendar (ICS) format.
|
|
13259
|
+
* @summary Download calendar event as ICS
|
|
13260
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13261
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
13262
|
+
* @param {*} [options] Override http request option.
|
|
13263
|
+
* @throws {RequiredError}
|
|
13264
|
+
*/
|
|
13265
|
+
getGroupCalendarEventICS(groupId: string, calendarId: string, options?: any): AxiosPromise<File>;
|
|
13266
|
+
/**
|
|
13267
|
+
* Get a list of a group\'s calendar events
|
|
13268
|
+
* @summary List a group\'s calendar events
|
|
13269
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13270
|
+
* @param {string} [date] The month to search in.
|
|
13271
|
+
* @param {number} [n] The number of objects to return.
|
|
13272
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11630
13273
|
* @param {*} [options] Override http request option.
|
|
11631
13274
|
* @throws {RequiredError}
|
|
11632
|
-
* @memberof AvatarsApi
|
|
11633
13275
|
*/
|
|
11634
|
-
|
|
13276
|
+
getGroupCalendarEvents(groupId: string, date?: string, n?: number, offset?: number, options?: any): AxiosPromise<PaginatedCalendarEventList>;
|
|
11635
13277
|
/**
|
|
11636
|
-
*
|
|
11637
|
-
* @summary
|
|
11638
|
-
* @param {string}
|
|
13278
|
+
* Updates an event for a group on the calendar
|
|
13279
|
+
* @summary Update a calendar event
|
|
13280
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13281
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
13282
|
+
* @param {UpdateCalendarEventRequest} updateCalendarEventRequest
|
|
11639
13283
|
* @param {*} [options] Override http request option.
|
|
11640
13284
|
* @throws {RequiredError}
|
|
11641
|
-
* @memberof AvatarsApi
|
|
11642
13285
|
*/
|
|
11643
|
-
|
|
13286
|
+
updateGroupCalendarEvent(groupId: string, calendarId: string, updateCalendarEventRequest: UpdateCalendarEventRequest, options?: any): AxiosPromise<CalendarEvent>;
|
|
13287
|
+
};
|
|
13288
|
+
/**
|
|
13289
|
+
* CalendarApi - object-oriented interface
|
|
13290
|
+
* @export
|
|
13291
|
+
* @class CalendarApi
|
|
13292
|
+
* @extends {BaseAPI}
|
|
13293
|
+
*/
|
|
13294
|
+
export declare class CalendarApi extends BaseAPI {
|
|
11644
13295
|
/**
|
|
11645
|
-
*
|
|
11646
|
-
* @summary
|
|
11647
|
-
* @param {string}
|
|
13296
|
+
* Creates an event for a group on the calendar
|
|
13297
|
+
* @summary Create a calendar event
|
|
13298
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13299
|
+
* @param {CreateCalendarEventRequest} createCalendarEventRequest
|
|
11648
13300
|
* @param {*} [options] Override http request option.
|
|
11649
13301
|
* @throws {RequiredError}
|
|
11650
|
-
* @memberof
|
|
13302
|
+
* @memberof CalendarApi
|
|
11651
13303
|
*/
|
|
11652
|
-
|
|
13304
|
+
createGroupCalendarEvent(groupId: string, createCalendarEventRequest: CreateCalendarEventRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CalendarEvent, any>>;
|
|
11653
13305
|
/**
|
|
11654
|
-
*
|
|
11655
|
-
* @summary
|
|
11656
|
-
* @param {string}
|
|
13306
|
+
* Delete a group calendar event
|
|
13307
|
+
* @summary Delete a calendar event
|
|
13308
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13309
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
11657
13310
|
* @param {*} [options] Override http request option.
|
|
11658
13311
|
* @throws {RequiredError}
|
|
11659
|
-
* @memberof
|
|
13312
|
+
* @memberof CalendarApi
|
|
11660
13313
|
*/
|
|
11661
|
-
|
|
13314
|
+
deleteGroupCalendarEvent(groupId: string, calendarId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
11662
13315
|
/**
|
|
11663
|
-
*
|
|
11664
|
-
* @summary
|
|
11665
|
-
* @param {
|
|
11666
|
-
* @param {
|
|
11667
|
-
* @param {
|
|
11668
|
-
* @param {OrderOption} [order] Result ordering
|
|
11669
|
-
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11670
|
-
* @param {string} [search] Filters by world name.
|
|
11671
|
-
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
11672
|
-
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
11673
|
-
* @param {ReleaseStatus} [releaseStatus] Filter by ReleaseStatus.
|
|
11674
|
-
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
11675
|
-
* @param {string} [minUnityVersion] The minimum Unity version supported by the asset.
|
|
11676
|
-
* @param {string} [platform] The platform the asset supports.
|
|
11677
|
-
* @param {string} [userId] Target user to see information on, admin-only.
|
|
13316
|
+
* Follow or unfollow an event on a group\'s calendar
|
|
13317
|
+
* @summary Follow a calendar event
|
|
13318
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13319
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
13320
|
+
* @param {FollowCalendarEventRequest} followCalendarEventRequest
|
|
11678
13321
|
* @param {*} [options] Override http request option.
|
|
11679
13322
|
* @throws {RequiredError}
|
|
11680
|
-
* @memberof
|
|
13323
|
+
* @memberof CalendarApi
|
|
11681
13324
|
*/
|
|
11682
|
-
|
|
13325
|
+
followGroupCalendarEvent(groupId: string, calendarId: string, followCalendarEventRequest: FollowCalendarEventRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CalendarEvent, any>>;
|
|
11683
13326
|
/**
|
|
11684
|
-
*
|
|
11685
|
-
* @summary
|
|
13327
|
+
* Get a list of a user\'s calendar events for the month in ?date
|
|
13328
|
+
* @summary List calendar events
|
|
13329
|
+
* @param {string} [date] The month to search in.
|
|
13330
|
+
* @param {number} [n] The number of objects to return.
|
|
13331
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11686
13332
|
* @param {*} [options] Override http request option.
|
|
11687
13333
|
* @throws {RequiredError}
|
|
11688
|
-
* @memberof
|
|
13334
|
+
* @memberof CalendarApi
|
|
11689
13335
|
*/
|
|
11690
|
-
|
|
13336
|
+
getCalendarEvents(date?: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedCalendarEventList, any>>;
|
|
11691
13337
|
/**
|
|
11692
|
-
*
|
|
11693
|
-
* @summary List
|
|
13338
|
+
* Get a list of a featured calendar events for the month in ?date
|
|
13339
|
+
* @summary List featured calendar events
|
|
13340
|
+
* @param {string} [date] The month to search in.
|
|
11694
13341
|
* @param {number} [n] The number of objects to return.
|
|
11695
13342
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11696
13343
|
* @param {*} [options] Override http request option.
|
|
11697
13344
|
* @throws {RequiredError}
|
|
11698
|
-
* @memberof
|
|
13345
|
+
* @memberof CalendarApi
|
|
11699
13346
|
*/
|
|
11700
|
-
|
|
13347
|
+
getFeaturedCalendarEvents(date?: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedCalendarEventList, any>>;
|
|
11701
13348
|
/**
|
|
11702
|
-
* Get
|
|
11703
|
-
* @summary
|
|
11704
|
-
* @param {string}
|
|
13349
|
+
* Get a list of a followed calendar events for the month in ?date
|
|
13350
|
+
* @summary List followed calendar events
|
|
13351
|
+
* @param {string} [date] The month to search in.
|
|
13352
|
+
* @param {number} [n] The number of objects to return.
|
|
13353
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11705
13354
|
* @param {*} [options] Override http request option.
|
|
11706
13355
|
* @throws {RequiredError}
|
|
11707
|
-
* @memberof
|
|
13356
|
+
* @memberof CalendarApi
|
|
11708
13357
|
*/
|
|
11709
|
-
|
|
13358
|
+
getFollowedCalendarEvents(date?: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedCalendarEventList, any>>;
|
|
11710
13359
|
/**
|
|
11711
|
-
*
|
|
11712
|
-
* @summary
|
|
11713
|
-
* @param {
|
|
11714
|
-
* @param {
|
|
11715
|
-
* @param {'me'} [user] Set to `me` for searching own avatars.
|
|
11716
|
-
* @param {string} [userId] Filter by UserID.
|
|
11717
|
-
* @param {number} [n] The number of objects to return.
|
|
11718
|
-
* @param {OrderOption} [order] Result ordering
|
|
11719
|
-
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11720
|
-
* @param {string} [tag] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
11721
|
-
* @param {string} [notag] Tags to exclude (comma-separated).
|
|
11722
|
-
* @param {ReleaseStatus} [releaseStatus] Filter by ReleaseStatus.
|
|
11723
|
-
* @param {string} [maxUnityVersion] The maximum Unity version supported by the asset.
|
|
11724
|
-
* @param {string} [minUnityVersion] The minimum Unity version supported by the asset.
|
|
11725
|
-
* @param {string} [platform] The platform the asset supports.
|
|
13360
|
+
* Get a group calendar event
|
|
13361
|
+
* @summary Get a calendar event
|
|
13362
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13363
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
11726
13364
|
* @param {*} [options] Override http request option.
|
|
11727
13365
|
* @throws {RequiredError}
|
|
11728
|
-
* @memberof
|
|
13366
|
+
* @memberof CalendarApi
|
|
11729
13367
|
*/
|
|
11730
|
-
|
|
13368
|
+
getGroupCalendarEvent(groupId: string, calendarId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CalendarEvent, any>>;
|
|
11731
13369
|
/**
|
|
11732
|
-
*
|
|
11733
|
-
* @summary
|
|
11734
|
-
* @param {string}
|
|
13370
|
+
* Returns the specified calendar in iCalendar (ICS) format.
|
|
13371
|
+
* @summary Download calendar event as ICS
|
|
13372
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13373
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
11735
13374
|
* @param {*} [options] Override http request option.
|
|
11736
13375
|
* @throws {RequiredError}
|
|
11737
|
-
* @memberof
|
|
13376
|
+
* @memberof CalendarApi
|
|
11738
13377
|
*/
|
|
11739
|
-
|
|
13378
|
+
getGroupCalendarEventICS(groupId: string, calendarId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
11740
13379
|
/**
|
|
11741
|
-
*
|
|
11742
|
-
* @summary
|
|
11743
|
-
* @param {string}
|
|
13380
|
+
* Get a list of a group\'s calendar events
|
|
13381
|
+
* @summary List a group\'s calendar events
|
|
13382
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13383
|
+
* @param {string} [date] The month to search in.
|
|
13384
|
+
* @param {number} [n] The number of objects to return.
|
|
13385
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11744
13386
|
* @param {*} [options] Override http request option.
|
|
11745
|
-
* @deprecated
|
|
11746
13387
|
* @throws {RequiredError}
|
|
11747
|
-
* @memberof
|
|
13388
|
+
* @memberof CalendarApi
|
|
11748
13389
|
*/
|
|
11749
|
-
|
|
13390
|
+
getGroupCalendarEvents(groupId: string, date?: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedCalendarEventList, any>>;
|
|
11750
13391
|
/**
|
|
11751
|
-
*
|
|
11752
|
-
* @summary Update
|
|
11753
|
-
* @param {string}
|
|
11754
|
-
* @param {
|
|
13392
|
+
* Updates an event for a group on the calendar
|
|
13393
|
+
* @summary Update a calendar event
|
|
13394
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13395
|
+
* @param {string} calendarId Must be a valid calendar ID.
|
|
13396
|
+
* @param {UpdateCalendarEventRequest} updateCalendarEventRequest
|
|
11755
13397
|
* @param {*} [options] Override http request option.
|
|
11756
13398
|
* @throws {RequiredError}
|
|
11757
|
-
* @memberof
|
|
13399
|
+
* @memberof CalendarApi
|
|
11758
13400
|
*/
|
|
11759
|
-
|
|
13401
|
+
updateGroupCalendarEvent(groupId: string, calendarId: string, updateCalendarEventRequest: UpdateCalendarEventRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CalendarEvent, any>>;
|
|
11760
13402
|
}
|
|
11761
13403
|
/**
|
|
11762
13404
|
* EconomyApi - axios parameter creator
|
|
@@ -11803,7 +13445,7 @@ export declare const EconomyApiAxiosParamCreator: (configuration?: Configuration
|
|
|
11803
13445
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11804
13446
|
* @param {boolean} [hydrate] Populates some fields and changes types of others for certain objects.
|
|
11805
13447
|
* @param {string} [groupId] Must be a valid group ID.
|
|
11806
|
-
* @param {boolean} [active] Filter for users\' listings.
|
|
13448
|
+
* @param {boolean} [active] Filter for users\' listings and inventory bundles.
|
|
11807
13449
|
* @param {*} [options] Override http request option.
|
|
11808
13450
|
* @throws {RequiredError}
|
|
11809
13451
|
*/
|
|
@@ -11899,7 +13541,7 @@ export declare const EconomyApiFp: (configuration?: Configuration) => {
|
|
|
11899
13541
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11900
13542
|
* @param {boolean} [hydrate] Populates some fields and changes types of others for certain objects.
|
|
11901
13543
|
* @param {string} [groupId] Must be a valid group ID.
|
|
11902
|
-
* @param {boolean} [active] Filter for users\' listings.
|
|
13544
|
+
* @param {boolean} [active] Filter for users\' listings and inventory bundles.
|
|
11903
13545
|
* @param {*} [options] Override http request option.
|
|
11904
13546
|
* @throws {RequiredError}
|
|
11905
13547
|
*/
|
|
@@ -11995,7 +13637,7 @@ export declare const EconomyApiFactory: (configuration?: Configuration, basePath
|
|
|
11995
13637
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
11996
13638
|
* @param {boolean} [hydrate] Populates some fields and changes types of others for certain objects.
|
|
11997
13639
|
* @param {string} [groupId] Must be a valid group ID.
|
|
11998
|
-
* @param {boolean} [active] Filter for users\' listings.
|
|
13640
|
+
* @param {boolean} [active] Filter for users\' listings and inventory bundles.
|
|
11999
13641
|
* @param {*} [options] Override http request option.
|
|
12000
13642
|
* @throws {RequiredError}
|
|
12001
13643
|
*/
|
|
@@ -12097,7 +13739,7 @@ export declare class EconomyApi extends BaseAPI {
|
|
|
12097
13739
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
12098
13740
|
* @param {boolean} [hydrate] Populates some fields and changes types of others for certain objects.
|
|
12099
13741
|
* @param {string} [groupId] Must be a valid group ID.
|
|
12100
|
-
* @param {boolean} [active] Filter for users\' listings.
|
|
13742
|
+
* @param {boolean} [active] Filter for users\' listings and inventory bundles.
|
|
12101
13743
|
* @param {*} [options] Override http request option.
|
|
12102
13744
|
* @throws {RequiredError}
|
|
12103
13745
|
* @memberof EconomyApi
|
|
@@ -12552,6 +14194,14 @@ export declare const FilesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
12552
14194
|
* @throws {RequiredError}
|
|
12553
14195
|
*/
|
|
12554
14196
|
finishFileDataUpload: (fileId: string, versionId: number, fileType: 'file' | 'signature' | 'delta', finishFileDataUploadRequest?: FinishFileDataUploadRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14197
|
+
/**
|
|
14198
|
+
* Returns an AdminAssetBundle
|
|
14199
|
+
* @summary Get AdminAssetBundle
|
|
14200
|
+
* @param {string} adminAssetBundleId Must be a valid admin asset bundle ID.
|
|
14201
|
+
* @param {*} [options] Override http request option.
|
|
14202
|
+
* @throws {RequiredError}
|
|
14203
|
+
*/
|
|
14204
|
+
getAdminAssetBundle: (adminAssetBundleId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
12555
14205
|
/**
|
|
12556
14206
|
* Shows general information about the \"File\" object. Each File can have several \"Version\"\'s, and each Version can have multiple real files or \"Data\" blobs.
|
|
12557
14207
|
* @summary Show File
|
|
@@ -12708,6 +14358,14 @@ export declare const FilesApiFp: (configuration?: Configuration) => {
|
|
|
12708
14358
|
* @throws {RequiredError}
|
|
12709
14359
|
*/
|
|
12710
14360
|
finishFileDataUpload(fileId: string, versionId: number, fileType: 'file' | 'signature' | 'delta', finishFileDataUploadRequest?: FinishFileDataUploadRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
14361
|
+
/**
|
|
14362
|
+
* Returns an AdminAssetBundle
|
|
14363
|
+
* @summary Get AdminAssetBundle
|
|
14364
|
+
* @param {string} adminAssetBundleId Must be a valid admin asset bundle ID.
|
|
14365
|
+
* @param {*} [options] Override http request option.
|
|
14366
|
+
* @throws {RequiredError}
|
|
14367
|
+
*/
|
|
14368
|
+
getAdminAssetBundle(adminAssetBundleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAssetBundle>>;
|
|
12711
14369
|
/**
|
|
12712
14370
|
* Shows general information about the \"File\" object. Each File can have several \"Version\"\'s, and each Version can have multiple real files or \"Data\" blobs.
|
|
12713
14371
|
* @summary Show File
|
|
@@ -12864,6 +14522,14 @@ export declare const FilesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
12864
14522
|
* @throws {RequiredError}
|
|
12865
14523
|
*/
|
|
12866
14524
|
finishFileDataUpload(fileId: string, versionId: number, fileType: 'file' | 'signature' | 'delta', finishFileDataUploadRequest?: FinishFileDataUploadRequest, options?: any): AxiosPromise<any>;
|
|
14525
|
+
/**
|
|
14526
|
+
* Returns an AdminAssetBundle
|
|
14527
|
+
* @summary Get AdminAssetBundle
|
|
14528
|
+
* @param {string} adminAssetBundleId Must be a valid admin asset bundle ID.
|
|
14529
|
+
* @param {*} [options] Override http request option.
|
|
14530
|
+
* @throws {RequiredError}
|
|
14531
|
+
*/
|
|
14532
|
+
getAdminAssetBundle(adminAssetBundleId: string, options?: any): AxiosPromise<AdminAssetBundle>;
|
|
12867
14533
|
/**
|
|
12868
14534
|
* Shows general information about the \"File\" object. Each File can have several \"Version\"\'s, and each Version can have multiple real files or \"Data\" blobs.
|
|
12869
14535
|
* @summary Show File
|
|
@@ -13028,6 +14694,15 @@ export declare class FilesApi extends BaseAPI {
|
|
|
13028
14694
|
* @memberof FilesApi
|
|
13029
14695
|
*/
|
|
13030
14696
|
finishFileDataUpload(fileId: string, versionId: number, fileType: 'file' | 'signature' | 'delta', finishFileDataUploadRequest?: FinishFileDataUploadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
14697
|
+
/**
|
|
14698
|
+
* Returns an AdminAssetBundle
|
|
14699
|
+
* @summary Get AdminAssetBundle
|
|
14700
|
+
* @param {string} adminAssetBundleId Must be a valid admin asset bundle ID.
|
|
14701
|
+
* @param {*} [options] Override http request option.
|
|
14702
|
+
* @throws {RequiredError}
|
|
14703
|
+
* @memberof FilesApi
|
|
14704
|
+
*/
|
|
14705
|
+
getAdminAssetBundle(adminAssetBundleId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAssetBundle, any>>;
|
|
13031
14706
|
/**
|
|
13032
14707
|
* Shows general information about the \"File\" object. Each File can have several \"Version\"\'s, and each Version can have multiple real files or \"Data\" blobs.
|
|
13033
14708
|
* @summary Show File
|
|
@@ -15269,6 +16944,209 @@ export declare class InstancesApi extends BaseAPI {
|
|
|
15269
16944
|
*/
|
|
15270
16945
|
getShortName(worldId: string, instanceId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InstanceShortNameResponse, any>>;
|
|
15271
16946
|
}
|
|
16947
|
+
/**
|
|
16948
|
+
* InventoryApi - axios parameter creator
|
|
16949
|
+
* @export
|
|
16950
|
+
*/
|
|
16951
|
+
export declare const InventoryApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
16952
|
+
/**
|
|
16953
|
+
* Returns an Inventory object.
|
|
16954
|
+
* @summary Get Inventory
|
|
16955
|
+
* @param {number} [n] The number of objects to return.
|
|
16956
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
16957
|
+
* @param {'newest' | 'oldest'} [inventorySortOrder] Sort order for inventory retrieval.
|
|
16958
|
+
* @param {InventoryItemType} [inventoryItemType] Filter for inventory retrieval.
|
|
16959
|
+
* @param {*} [options] Override http request option.
|
|
16960
|
+
* @throws {RequiredError}
|
|
16961
|
+
*/
|
|
16962
|
+
getInventory: (n?: number, offset?: number, inventorySortOrder?: 'newest' | 'oldest', inventoryItemType?: InventoryItemType, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16963
|
+
/**
|
|
16964
|
+
* Returns a list of InventoryDrop objects.
|
|
16965
|
+
* @summary List Inventory Drops
|
|
16966
|
+
* @param {boolean} [active] Filter for users\' listings and inventory bundles.
|
|
16967
|
+
* @param {*} [options] Override http request option.
|
|
16968
|
+
* @throws {RequiredError}
|
|
16969
|
+
*/
|
|
16970
|
+
getInventoryDrops: (active?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16971
|
+
/**
|
|
16972
|
+
* Returns an InventoryTemplate object.
|
|
16973
|
+
* @summary Get Inventory Template
|
|
16974
|
+
* @param {string} inventoryTemplateId Must be a valid inventory template ID.
|
|
16975
|
+
* @param {*} [options] Override http request option.
|
|
16976
|
+
* @throws {RequiredError}
|
|
16977
|
+
*/
|
|
16978
|
+
getInventoryTemplate: (inventoryTemplateId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16979
|
+
/**
|
|
16980
|
+
* Returns an InventoryItem object held by the currently logged in user.
|
|
16981
|
+
* @summary Get Own Inventory Item
|
|
16982
|
+
* @param {string} inventoryItemId Must be a valid inventory item ID.
|
|
16983
|
+
* @param {*} [options] Override http request option.
|
|
16984
|
+
* @throws {RequiredError}
|
|
16985
|
+
*/
|
|
16986
|
+
getOwnInventoryItem: (inventoryItemId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16987
|
+
/**
|
|
16988
|
+
* Returns an InventorySpawn object.
|
|
16989
|
+
* @summary Spawn Inventory Item
|
|
16990
|
+
* @param {string} id Id for inventory item spawning.
|
|
16991
|
+
* @param {*} [options] Override http request option.
|
|
16992
|
+
* @throws {RequiredError}
|
|
16993
|
+
*/
|
|
16994
|
+
spawnInventoryItem: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16995
|
+
};
|
|
16996
|
+
/**
|
|
16997
|
+
* InventoryApi - functional programming interface
|
|
16998
|
+
* @export
|
|
16999
|
+
*/
|
|
17000
|
+
export declare const InventoryApiFp: (configuration?: Configuration) => {
|
|
17001
|
+
/**
|
|
17002
|
+
* Returns an Inventory object.
|
|
17003
|
+
* @summary Get Inventory
|
|
17004
|
+
* @param {number} [n] The number of objects to return.
|
|
17005
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
17006
|
+
* @param {'newest' | 'oldest'} [inventorySortOrder] Sort order for inventory retrieval.
|
|
17007
|
+
* @param {InventoryItemType} [inventoryItemType] Filter for inventory retrieval.
|
|
17008
|
+
* @param {*} [options] Override http request option.
|
|
17009
|
+
* @throws {RequiredError}
|
|
17010
|
+
*/
|
|
17011
|
+
getInventory(n?: number, offset?: number, inventorySortOrder?: 'newest' | 'oldest', inventoryItemType?: InventoryItemType, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Inventory>>;
|
|
17012
|
+
/**
|
|
17013
|
+
* Returns a list of InventoryDrop objects.
|
|
17014
|
+
* @summary List Inventory Drops
|
|
17015
|
+
* @param {boolean} [active] Filter for users\' listings and inventory bundles.
|
|
17016
|
+
* @param {*} [options] Override http request option.
|
|
17017
|
+
* @throws {RequiredError}
|
|
17018
|
+
*/
|
|
17019
|
+
getInventoryDrops(active?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InventoryDrop>>>;
|
|
17020
|
+
/**
|
|
17021
|
+
* Returns an InventoryTemplate object.
|
|
17022
|
+
* @summary Get Inventory Template
|
|
17023
|
+
* @param {string} inventoryTemplateId Must be a valid inventory template ID.
|
|
17024
|
+
* @param {*} [options] Override http request option.
|
|
17025
|
+
* @throws {RequiredError}
|
|
17026
|
+
*/
|
|
17027
|
+
getInventoryTemplate(inventoryTemplateId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InventoryTemplate>>;
|
|
17028
|
+
/**
|
|
17029
|
+
* Returns an InventoryItem object held by the currently logged in user.
|
|
17030
|
+
* @summary Get Own Inventory Item
|
|
17031
|
+
* @param {string} inventoryItemId Must be a valid inventory item ID.
|
|
17032
|
+
* @param {*} [options] Override http request option.
|
|
17033
|
+
* @throws {RequiredError}
|
|
17034
|
+
*/
|
|
17035
|
+
getOwnInventoryItem(inventoryItemId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InventoryItem>>;
|
|
17036
|
+
/**
|
|
17037
|
+
* Returns an InventorySpawn object.
|
|
17038
|
+
* @summary Spawn Inventory Item
|
|
17039
|
+
* @param {string} id Id for inventory item spawning.
|
|
17040
|
+
* @param {*} [options] Override http request option.
|
|
17041
|
+
* @throws {RequiredError}
|
|
17042
|
+
*/
|
|
17043
|
+
spawnInventoryItem(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InventorySpawn>>;
|
|
17044
|
+
};
|
|
17045
|
+
/**
|
|
17046
|
+
* InventoryApi - factory interface
|
|
17047
|
+
* @export
|
|
17048
|
+
*/
|
|
17049
|
+
export declare const InventoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
17050
|
+
/**
|
|
17051
|
+
* Returns an Inventory object.
|
|
17052
|
+
* @summary Get Inventory
|
|
17053
|
+
* @param {number} [n] The number of objects to return.
|
|
17054
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
17055
|
+
* @param {'newest' | 'oldest'} [inventorySortOrder] Sort order for inventory retrieval.
|
|
17056
|
+
* @param {InventoryItemType} [inventoryItemType] Filter for inventory retrieval.
|
|
17057
|
+
* @param {*} [options] Override http request option.
|
|
17058
|
+
* @throws {RequiredError}
|
|
17059
|
+
*/
|
|
17060
|
+
getInventory(n?: number, offset?: number, inventorySortOrder?: 'newest' | 'oldest', inventoryItemType?: InventoryItemType, options?: any): AxiosPromise<Inventory>;
|
|
17061
|
+
/**
|
|
17062
|
+
* Returns a list of InventoryDrop objects.
|
|
17063
|
+
* @summary List Inventory Drops
|
|
17064
|
+
* @param {boolean} [active] Filter for users\' listings and inventory bundles.
|
|
17065
|
+
* @param {*} [options] Override http request option.
|
|
17066
|
+
* @throws {RequiredError}
|
|
17067
|
+
*/
|
|
17068
|
+
getInventoryDrops(active?: boolean, options?: any): AxiosPromise<Array<InventoryDrop>>;
|
|
17069
|
+
/**
|
|
17070
|
+
* Returns an InventoryTemplate object.
|
|
17071
|
+
* @summary Get Inventory Template
|
|
17072
|
+
* @param {string} inventoryTemplateId Must be a valid inventory template ID.
|
|
17073
|
+
* @param {*} [options] Override http request option.
|
|
17074
|
+
* @throws {RequiredError}
|
|
17075
|
+
*/
|
|
17076
|
+
getInventoryTemplate(inventoryTemplateId: string, options?: any): AxiosPromise<InventoryTemplate>;
|
|
17077
|
+
/**
|
|
17078
|
+
* Returns an InventoryItem object held by the currently logged in user.
|
|
17079
|
+
* @summary Get Own Inventory Item
|
|
17080
|
+
* @param {string} inventoryItemId Must be a valid inventory item ID.
|
|
17081
|
+
* @param {*} [options] Override http request option.
|
|
17082
|
+
* @throws {RequiredError}
|
|
17083
|
+
*/
|
|
17084
|
+
getOwnInventoryItem(inventoryItemId: string, options?: any): AxiosPromise<InventoryItem>;
|
|
17085
|
+
/**
|
|
17086
|
+
* Returns an InventorySpawn object.
|
|
17087
|
+
* @summary Spawn Inventory Item
|
|
17088
|
+
* @param {string} id Id for inventory item spawning.
|
|
17089
|
+
* @param {*} [options] Override http request option.
|
|
17090
|
+
* @throws {RequiredError}
|
|
17091
|
+
*/
|
|
17092
|
+
spawnInventoryItem(id: string, options?: any): AxiosPromise<InventorySpawn>;
|
|
17093
|
+
};
|
|
17094
|
+
/**
|
|
17095
|
+
* InventoryApi - object-oriented interface
|
|
17096
|
+
* @export
|
|
17097
|
+
* @class InventoryApi
|
|
17098
|
+
* @extends {BaseAPI}
|
|
17099
|
+
*/
|
|
17100
|
+
export declare class InventoryApi extends BaseAPI {
|
|
17101
|
+
/**
|
|
17102
|
+
* Returns an Inventory object.
|
|
17103
|
+
* @summary Get Inventory
|
|
17104
|
+
* @param {number} [n] The number of objects to return.
|
|
17105
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
17106
|
+
* @param {'newest' | 'oldest'} [inventorySortOrder] Sort order for inventory retrieval.
|
|
17107
|
+
* @param {InventoryItemType} [inventoryItemType] Filter for inventory retrieval.
|
|
17108
|
+
* @param {*} [options] Override http request option.
|
|
17109
|
+
* @throws {RequiredError}
|
|
17110
|
+
* @memberof InventoryApi
|
|
17111
|
+
*/
|
|
17112
|
+
getInventory(n?: number, offset?: number, inventorySortOrder?: 'newest' | 'oldest', inventoryItemType?: InventoryItemType, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Inventory, any>>;
|
|
17113
|
+
/**
|
|
17114
|
+
* Returns a list of InventoryDrop objects.
|
|
17115
|
+
* @summary List Inventory Drops
|
|
17116
|
+
* @param {boolean} [active] Filter for users\' listings and inventory bundles.
|
|
17117
|
+
* @param {*} [options] Override http request option.
|
|
17118
|
+
* @throws {RequiredError}
|
|
17119
|
+
* @memberof InventoryApi
|
|
17120
|
+
*/
|
|
17121
|
+
getInventoryDrops(active?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InventoryDrop[], any>>;
|
|
17122
|
+
/**
|
|
17123
|
+
* Returns an InventoryTemplate object.
|
|
17124
|
+
* @summary Get Inventory Template
|
|
17125
|
+
* @param {string} inventoryTemplateId Must be a valid inventory template ID.
|
|
17126
|
+
* @param {*} [options] Override http request option.
|
|
17127
|
+
* @throws {RequiredError}
|
|
17128
|
+
* @memberof InventoryApi
|
|
17129
|
+
*/
|
|
17130
|
+
getInventoryTemplate(inventoryTemplateId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InventoryTemplate, any>>;
|
|
17131
|
+
/**
|
|
17132
|
+
* Returns an InventoryItem object held by the currently logged in user.
|
|
17133
|
+
* @summary Get Own Inventory Item
|
|
17134
|
+
* @param {string} inventoryItemId Must be a valid inventory item ID.
|
|
17135
|
+
* @param {*} [options] Override http request option.
|
|
17136
|
+
* @throws {RequiredError}
|
|
17137
|
+
* @memberof InventoryApi
|
|
17138
|
+
*/
|
|
17139
|
+
getOwnInventoryItem(inventoryItemId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InventoryItem, any>>;
|
|
17140
|
+
/**
|
|
17141
|
+
* Returns an InventorySpawn object.
|
|
17142
|
+
* @summary Spawn Inventory Item
|
|
17143
|
+
* @param {string} id Id for inventory item spawning.
|
|
17144
|
+
* @param {*} [options] Override http request option.
|
|
17145
|
+
* @throws {RequiredError}
|
|
17146
|
+
* @memberof InventoryApi
|
|
17147
|
+
*/
|
|
17148
|
+
spawnInventoryItem(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InventorySpawn, any>>;
|
|
17149
|
+
}
|
|
15272
17150
|
/**
|
|
15273
17151
|
* InviteApi - axios parameter creator
|
|
15274
17152
|
* @export
|
|
@@ -16787,6 +18665,65 @@ export declare class PrintsApi extends BaseAPI {
|
|
|
16787
18665
|
*/
|
|
16788
18666
|
uploadPrint(image: File, timestamp: string, note?: string, worldId?: string, worldName?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Print, any>>;
|
|
16789
18667
|
}
|
|
18668
|
+
/**
|
|
18669
|
+
* PropsApi - axios parameter creator
|
|
18670
|
+
* @export
|
|
18671
|
+
*/
|
|
18672
|
+
export declare const PropsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
18673
|
+
/**
|
|
18674
|
+
* Returns a Prop object.
|
|
18675
|
+
* @summary Get Prop
|
|
18676
|
+
* @param {string} propId Prop ID.
|
|
18677
|
+
* @param {*} [options] Override http request option.
|
|
18678
|
+
* @throws {RequiredError}
|
|
18679
|
+
*/
|
|
18680
|
+
getProp: (propId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
18681
|
+
};
|
|
18682
|
+
/**
|
|
18683
|
+
* PropsApi - functional programming interface
|
|
18684
|
+
* @export
|
|
18685
|
+
*/
|
|
18686
|
+
export declare const PropsApiFp: (configuration?: Configuration) => {
|
|
18687
|
+
/**
|
|
18688
|
+
* Returns a Prop object.
|
|
18689
|
+
* @summary Get Prop
|
|
18690
|
+
* @param {string} propId Prop ID.
|
|
18691
|
+
* @param {*} [options] Override http request option.
|
|
18692
|
+
* @throws {RequiredError}
|
|
18693
|
+
*/
|
|
18694
|
+
getProp(propId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Prop>>;
|
|
18695
|
+
};
|
|
18696
|
+
/**
|
|
18697
|
+
* PropsApi - factory interface
|
|
18698
|
+
* @export
|
|
18699
|
+
*/
|
|
18700
|
+
export declare const PropsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
18701
|
+
/**
|
|
18702
|
+
* Returns a Prop object.
|
|
18703
|
+
* @summary Get Prop
|
|
18704
|
+
* @param {string} propId Prop ID.
|
|
18705
|
+
* @param {*} [options] Override http request option.
|
|
18706
|
+
* @throws {RequiredError}
|
|
18707
|
+
*/
|
|
18708
|
+
getProp(propId: string, options?: any): AxiosPromise<Prop>;
|
|
18709
|
+
};
|
|
18710
|
+
/**
|
|
18711
|
+
* PropsApi - object-oriented interface
|
|
18712
|
+
* @export
|
|
18713
|
+
* @class PropsApi
|
|
18714
|
+
* @extends {BaseAPI}
|
|
18715
|
+
*/
|
|
18716
|
+
export declare class PropsApi extends BaseAPI {
|
|
18717
|
+
/**
|
|
18718
|
+
* Returns a Prop object.
|
|
18719
|
+
* @summary Get Prop
|
|
18720
|
+
* @param {string} propId Prop ID.
|
|
18721
|
+
* @param {*} [options] Override http request option.
|
|
18722
|
+
* @throws {RequiredError}
|
|
18723
|
+
* @memberof PropsApi
|
|
18724
|
+
*/
|
|
18725
|
+
getProp(propId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Prop, any>>;
|
|
18726
|
+
}
|
|
16790
18727
|
/**
|
|
16791
18728
|
* UsersApi - axios parameter creator
|
|
16792
18729
|
* @export
|
|
@@ -16840,7 +18777,7 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
16840
18777
|
* Get user\'s submitted feedback
|
|
16841
18778
|
* @summary Get User Feedback
|
|
16842
18779
|
* @param {string} userId Must be a valid user ID.
|
|
16843
|
-
* @param {boolean} [contentId] Filter for users\' previously submitted feedback, e.g., a groupId,
|
|
18780
|
+
* @param {boolean} [contentId] Filter for users\' previously submitted feedback, e.g., a groupId, userId, avatarId, etc.
|
|
16844
18781
|
* @param {number} [n] The number of objects to return.
|
|
16845
18782
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
16846
18783
|
* @param {*} [options] Override http request option.
|
|
@@ -16998,7 +18935,7 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16998
18935
|
* Get user\'s submitted feedback
|
|
16999
18936
|
* @summary Get User Feedback
|
|
17000
18937
|
* @param {string} userId Must be a valid user ID.
|
|
17001
|
-
* @param {boolean} [contentId] Filter for users\' previously submitted feedback, e.g., a groupId,
|
|
18938
|
+
* @param {boolean} [contentId] Filter for users\' previously submitted feedback, e.g., a groupId, userId, avatarId, etc.
|
|
17002
18939
|
* @param {number} [n] The number of objects to return.
|
|
17003
18940
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
17004
18941
|
* @param {*} [options] Override http request option.
|
|
@@ -17156,7 +19093,7 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
17156
19093
|
* Get user\'s submitted feedback
|
|
17157
19094
|
* @summary Get User Feedback
|
|
17158
19095
|
* @param {string} userId Must be a valid user ID.
|
|
17159
|
-
* @param {boolean} [contentId] Filter for users\' previously submitted feedback, e.g., a groupId,
|
|
19096
|
+
* @param {boolean} [contentId] Filter for users\' previously submitted feedback, e.g., a groupId, userId, avatarId, etc.
|
|
17160
19097
|
* @param {number} [n] The number of objects to return.
|
|
17161
19098
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
17162
19099
|
* @param {*} [options] Override http request option.
|
|
@@ -17321,7 +19258,7 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17321
19258
|
* Get user\'s submitted feedback
|
|
17322
19259
|
* @summary Get User Feedback
|
|
17323
19260
|
* @param {string} userId Must be a valid user ID.
|
|
17324
|
-
* @param {boolean} [contentId] Filter for users\' previously submitted feedback, e.g., a groupId,
|
|
19261
|
+
* @param {boolean} [contentId] Filter for users\' previously submitted feedback, e.g., a groupId, userId, avatarId, etc.
|
|
17325
19262
|
* @param {number} [n] The number of objects to return.
|
|
17326
19263
|
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
17327
19264
|
* @param {*} [options] Override http request option.
|