vrchat 1.5.3 → 1.6.6

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/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.5.3
4
+ * The version of the OpenAPI document: 1.6.6
5
5
  * Contact: me@ruby.js.org
6
6
  *
7
7
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -284,7 +284,7 @@ export interface APIConfig {
284
284
  */
285
285
  'gearDemoRoomId': string;
286
286
  /**
287
- *
287
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
288
288
  * @type {string}
289
289
  * @memberof APIConfig
290
290
  */
@@ -296,7 +296,7 @@ export interface APIConfig {
296
296
  */
297
297
  'homepageRedirectTarget': string;
298
298
  /**
299
- *
299
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
300
300
  * @type {string}
301
301
  * @memberof APIConfig
302
302
  */
@@ -403,13 +403,13 @@ export interface APIConfig {
403
403
  */
404
404
  'supportEmail': string;
405
405
  /**
406
- *
406
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
407
407
  * @type {string}
408
408
  * @memberof APIConfig
409
409
  */
410
410
  'timeOutWorldId': string;
411
411
  /**
412
- *
412
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
413
413
  * @type {string}
414
414
  * @memberof APIConfig
415
415
  */
@@ -647,7 +647,7 @@ export interface Avatar {
647
647
  */
648
648
  'assetUrlObject'?: object;
649
649
  /**
650
- *
650
+ * A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
651
651
  * @type {string}
652
652
  * @memberof Avatar
653
653
  */
@@ -899,7 +899,7 @@ export interface CreateWorldRequest {
899
899
  */
900
900
  'assetVersion'?: number;
901
901
  /**
902
- *
902
+ * A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
903
903
  * @type {string}
904
904
  * @memberof CreateWorldRequest
905
905
  */
@@ -923,7 +923,7 @@ export interface CreateWorldRequest {
923
923
  */
924
924
  'description'?: string;
925
925
  /**
926
- *
926
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
927
927
  * @type {string}
928
928
  * @memberof CreateWorldRequest
929
929
  */
@@ -1111,13 +1111,13 @@ export interface CurrentUser {
1111
1111
  */
1112
1112
  'hasPendingEmail': boolean;
1113
1113
  /**
1114
- *
1114
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
1115
1115
  * @type {string}
1116
1116
  * @memberof CurrentUser
1117
1117
  */
1118
1118
  'homeLocation': string;
1119
1119
  /**
1120
- *
1120
+ * A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
1121
1121
  * @type {string}
1122
1122
  * @memberof CurrentUser
1123
1123
  */
@@ -1420,7 +1420,7 @@ export interface FavoriteGroup {
1420
1420
  */
1421
1421
  'ownerDisplayName': string;
1422
1422
  /**
1423
- *
1423
+ * A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
1424
1424
  * @type {string}
1425
1425
  * @memberof FavoriteGroup
1426
1426
  */
@@ -1885,7 +1885,7 @@ export declare enum InfoPushDataClickableCommandEnum {
1885
1885
  CannedWorldSearch = "CannedWorldSearch"
1886
1886
  }
1887
1887
  /**
1888
- *
1888
+ * * `hidden` field is only present if InstanceType is `hidden` aka \"Friends+\", and is instance creator. * `friends` field is only present if InstanceType is `friends` aka \"Friends\", and is instance creator. * `private` field is only present if InstanceType is `private` aka \"Invite\" or \"Invite+\", and is instance creator.
1889
1889
  * @export
1890
1890
  * @interface Instance
1891
1891
  */
@@ -1909,9 +1909,10 @@ export interface Instance {
1909
1909
  */
1910
1910
  'capacity': number;
1911
1911
  /**
1912
- *
1912
+ * Always returns \"unknown\".
1913
1913
  * @type {string}
1914
1914
  * @memberof Instance
1915
+ * @deprecated
1915
1916
  */
1916
1917
  'clientNumber': string;
1917
1918
  /**
@@ -1921,7 +1922,7 @@ export interface Instance {
1921
1922
  */
1922
1923
  'full': boolean;
1923
1924
  /**
1924
- *
1925
+ * InstanceID be \"offline\" on User profiles if you are not friends with that user.
1925
1926
  * @type {string}
1926
1927
  * @memberof Instance
1927
1928
  */
@@ -1933,7 +1934,7 @@ export interface Instance {
1933
1934
  */
1934
1935
  'instanceId': string;
1935
1936
  /**
1936
- *
1937
+ * InstanceID be \"offline\" on User profiles if you are not friends with that user.
1937
1938
  * @type {string}
1938
1939
  * @memberof Instance
1939
1940
  */
@@ -1951,13 +1952,7 @@ export interface Instance {
1951
1952
  */
1952
1953
  'name': string;
1953
1954
  /**
1954
- *
1955
- * @type {string}
1956
- * @memberof Instance
1957
- */
1958
- 'nonce'?: string;
1959
- /**
1960
- *
1955
+ * A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
1961
1956
  * @type {string}
1962
1957
  * @memberof Instance
1963
1958
  */
@@ -1970,10 +1965,10 @@ export interface Instance {
1970
1965
  'permanent': boolean;
1971
1966
  /**
1972
1967
  *
1973
- * @type {string}
1968
+ * @type {Region}
1974
1969
  * @memberof Instance
1975
1970
  */
1976
- 'photonRegion': string;
1971
+ 'photonRegion': Region;
1977
1972
  /**
1978
1973
  *
1979
1974
  * @type {InstancePlatforms}
@@ -1982,10 +1977,10 @@ export interface Instance {
1982
1977
  'platforms': InstancePlatforms;
1983
1978
  /**
1984
1979
  *
1985
- * @type {string}
1980
+ * @type {Region}
1986
1981
  * @memberof Instance
1987
1982
  */
1988
- 'region': string;
1983
+ 'region': Region;
1989
1984
  /**
1990
1985
  *
1991
1986
  * @type {string}
@@ -1993,37 +1988,41 @@ export interface Instance {
1993
1988
  */
1994
1989
  'shortName': string;
1995
1990
  /**
1996
- *
1991
+ * The tags array on Instances usually contain the language tags of the people in the instance.
1997
1992
  * @type {Array<string>}
1998
1993
  * @memberof Instance
1999
1994
  */
2000
1995
  'tags': Array<string>;
2001
1996
  /**
2002
1997
  *
1998
+ * @type {InstanceType}
1999
+ * @memberof Instance
2000
+ */
2001
+ 'type': InstanceType;
2002
+ /**
2003
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
2003
2004
  * @type {string}
2004
2005
  * @memberof Instance
2005
2006
  */
2006
- 'type': string;
2007
+ 'worldId': string;
2007
2008
  /**
2008
- * Always empty on non-existing instances, and non-present on existing instances.
2009
- * @type {Array<object>}
2009
+ * A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
2010
+ * @type {string}
2010
2011
  * @memberof Instance
2011
- * @deprecated
2012
2012
  */
2013
- 'users'?: Array<object>;
2013
+ 'hidden'?: string;
2014
2014
  /**
2015
- * Only present on non-existing instances, and only contains a very small subject of World object. Use World API instead.
2016
- * @type {object}
2015
+ * A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
2016
+ * @type {string}
2017
2017
  * @memberof Instance
2018
- * @deprecated
2019
2018
  */
2020
- 'world'?: object;
2019
+ 'friends'?: string;
2021
2020
  /**
2022
- *
2021
+ * A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
2023
2022
  * @type {string}
2024
2023
  * @memberof Instance
2025
2024
  */
2026
- 'worldId': string;
2025
+ 'private'?: string;
2027
2026
  }
2028
2027
  /**
2029
2028
  *
@@ -2044,6 +2043,17 @@ export interface InstancePlatforms {
2044
2043
  */
2045
2044
  'standalonewindows': number;
2046
2045
  }
2046
+ /**
2047
+ *
2048
+ * @export
2049
+ * @enum {string}
2050
+ */
2051
+ export declare enum InstanceType {
2052
+ Public = "public",
2053
+ Hidden = "hidden",
2054
+ Friends = "friends",
2055
+ Private = "private"
2056
+ }
2047
2057
  /**
2048
2058
  *
2049
2059
  * @export
@@ -2111,11 +2121,17 @@ export declare enum InviteMessageType {
2111
2121
  */
2112
2122
  export interface InviteRequest {
2113
2123
  /**
2114
- *
2124
+ * InstanceID be \"offline\" on User profiles if you are not friends with that user.
2115
2125
  * @type {string}
2116
2126
  * @memberof InviteRequest
2117
2127
  */
2118
2128
  'instanceId': string;
2129
+ /**
2130
+ *
2131
+ * @type {number}
2132
+ * @memberof InviteRequest
2133
+ */
2134
+ 'messageSlot'?: number;
2119
2135
  }
2120
2136
  /**
2121
2137
  *
@@ -2274,7 +2290,7 @@ export interface LimitedUser {
2274
2290
  */
2275
2291
  'fallbackAvatar': string;
2276
2292
  /**
2277
- *
2293
+ * 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.
2278
2294
  * @type {string}
2279
2295
  * @memberof LimitedUser
2280
2296
  */
@@ -2347,7 +2363,7 @@ export interface LimitedUser {
2347
2363
  */
2348
2364
  export interface LimitedWorld {
2349
2365
  /**
2350
- *
2366
+ * 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.
2351
2367
  * @type {string}
2352
2368
  * @memberof LimitedWorld
2353
2369
  */
@@ -2383,7 +2399,7 @@ export interface LimitedWorld {
2383
2399
  */
2384
2400
  'heat': number;
2385
2401
  /**
2386
- *
2402
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
2387
2403
  * @type {string}
2388
2404
  * @memberof LimitedWorld
2389
2405
  */
@@ -2526,7 +2542,7 @@ export interface ModelFile {
2526
2542
  */
2527
2543
  'name': string;
2528
2544
  /**
2529
- *
2545
+ * 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.
2530
2546
  * @type {string}
2531
2547
  * @memberof ModelFile
2532
2548
  */
@@ -2551,7 +2567,7 @@ export interface ModelFile {
2551
2567
  */
2552
2568
  export interface ModerateUserRequest {
2553
2569
  /**
2554
- *
2570
+ * 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.
2555
2571
  * @type {string}
2556
2572
  * @memberof ModerateUserRequest
2557
2573
  */
@@ -2600,7 +2616,7 @@ export interface Notification {
2600
2616
  */
2601
2617
  'seen': boolean;
2602
2618
  /**
2603
- *
2619
+ * 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.
2604
2620
  * @type {string}
2605
2621
  * @memberof Notification
2606
2622
  */
@@ -2669,7 +2685,7 @@ export interface Permission {
2669
2685
  */
2670
2686
  'name': string;
2671
2687
  /**
2672
- *
2688
+ * 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.
2673
2689
  * @type {string}
2674
2690
  * @memberof Permission
2675
2691
  */
@@ -2706,7 +2722,7 @@ export interface PlayerModeration {
2706
2722
  */
2707
2723
  'sourceDisplayName': string;
2708
2724
  /**
2709
- *
2725
+ * 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.
2710
2726
  * @type {string}
2711
2727
  * @memberof PlayerModeration
2712
2728
  */
@@ -2718,7 +2734,7 @@ export interface PlayerModeration {
2718
2734
  */
2719
2735
  'targetDisplayName': string;
2720
2736
  /**
2721
- *
2737
+ * 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.
2722
2738
  * @type {string}
2723
2739
  * @memberof PlayerModeration
2724
2740
  */
@@ -2762,6 +2778,18 @@ export interface PublicAnnouncement {
2762
2778
  */
2763
2779
  'text': string;
2764
2780
  }
2781
+ /**
2782
+ * API/Photon region.
2783
+ * @export
2784
+ * @enum {string}
2785
+ */
2786
+ export declare enum Region {
2787
+ Us = "us",
2788
+ Use = "use",
2789
+ Eu = "eu",
2790
+ Jp = "jp",
2791
+ Unknown = "unknown"
2792
+ }
2765
2793
  /**
2766
2794
  *
2767
2795
  * @export
@@ -2772,6 +2800,19 @@ export declare enum ReleaseStatus {
2772
2800
  Private = "private",
2773
2801
  Hidden = "hidden"
2774
2802
  }
2803
+ /**
2804
+ *
2805
+ * @export
2806
+ * @interface RequestInviteRequest
2807
+ */
2808
+ export interface RequestInviteRequest {
2809
+ /**
2810
+ *
2811
+ * @type {number}
2812
+ * @memberof RequestInviteRequest
2813
+ */
2814
+ 'messageSlot'?: number;
2815
+ }
2775
2816
  /**
2776
2817
  *
2777
2818
  * @export
@@ -3367,7 +3408,7 @@ export interface UpdateWorldRequest {
3367
3408
  */
3368
3409
  'assetVersion'?: string;
3369
3410
  /**
3370
- *
3411
+ * 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.
3371
3412
  * @type {string}
3372
3413
  * @memberof UpdateWorldRequest
3373
3414
  */
@@ -3482,7 +3523,7 @@ export interface User {
3482
3523
  */
3483
3524
  'developerType': DeveloperType;
3484
3525
  /**
3485
- *
3526
+ * A users visual display name. This is what shows up in-game, and can different from their `username`. Changing display name is restricted to a cooldown period.
3486
3527
  * @type {string}
3487
3528
  * @memberof User
3488
3529
  */
@@ -3494,25 +3535,25 @@ export interface User {
3494
3535
  */
3495
3536
  'friendKey': string;
3496
3537
  /**
3497
- *
3538
+ * 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.
3498
3539
  * @type {string}
3499
3540
  * @memberof User
3500
3541
  */
3501
3542
  'id': string;
3502
3543
  /**
3503
- *
3544
+ * InstanceID be \"offline\" on User profiles if you are not friends with that user.
3504
3545
  * @type {string}
3505
3546
  * @memberof User
3506
3547
  */
3507
3548
  'instanceId'?: string;
3508
3549
  /**
3509
- *
3550
+ * Either their `friendKey`, or empty string if you are not friends. Unknown usage.
3510
3551
  * @type {boolean}
3511
3552
  * @memberof User
3512
3553
  */
3513
3554
  'isFriend': boolean;
3514
3555
  /**
3515
- *
3556
+ * Either a date-time or empty string.
3516
3557
  * @type {string}
3517
3558
  * @memberof User
3518
3559
  */
@@ -3524,7 +3565,7 @@ export interface User {
3524
3565
  */
3525
3566
  'last_platform': string;
3526
3567
  /**
3527
- *
3568
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
3528
3569
  * @type {string}
3529
3570
  * @memberof User
3530
3571
  */
@@ -3566,13 +3607,13 @@ export interface User {
3566
3607
  */
3567
3608
  'userIcon': string;
3568
3609
  /**
3569
- *
3610
+ * A users unique name, used during login. This is different from `displayName` which is what shows up in-game. A users `username` can never be changed.
3570
3611
  * @type {string}
3571
3612
  * @memberof User
3572
3613
  */
3573
3614
  'username': string;
3574
3615
  /**
3575
- *
3616
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
3576
3617
  * @type {string}
3577
3618
  * @memberof User
3578
3619
  */
@@ -3749,7 +3790,7 @@ export interface VerifyAuthTokenResult {
3749
3790
  */
3750
3791
  export interface World {
3751
3792
  /**
3752
- *
3793
+ * Empty if unauthenticated.
3753
3794
  * @type {string}
3754
3795
  * @memberof World
3755
3796
  */
@@ -3761,7 +3802,7 @@ export interface World {
3761
3802
  */
3762
3803
  'assetUrlObject': object;
3763
3804
  /**
3764
- *
3805
+ * 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.
3765
3806
  * @type {string}
3766
3807
  * @memberof World
3767
3808
  */
@@ -3809,7 +3850,7 @@ export interface World {
3809
3850
  */
3810
3851
  'heat': number;
3811
3852
  /**
3812
- *
3853
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
3813
3854
  * @type {string}
3814
3855
  * @memberof World
3815
3856
  */
@@ -3822,10 +3863,10 @@ export interface World {
3822
3863
  'imageUrl': string;
3823
3864
  /**
3824
3865
  *
3825
- * @type {Array<Array<object>>}
3866
+ * @type {Array<Array<any>>}
3826
3867
  * @memberof World
3827
3868
  */
3828
- 'instances'?: Array<Array<object>>;
3869
+ 'instances'?: Array<Array<any>>;
3829
3870
  /**
3830
3871
  *
3831
3872
  * @type {string}
@@ -3873,7 +3914,7 @@ export interface World {
3873
3914
  * @type {string}
3874
3915
  * @memberof World
3875
3916
  */
3876
- 'previewYoutubeId'?: string;
3917
+ 'previewYoutubeId'?: string | null;
3877
3918
  /**
3878
3919
  *
3879
3920
  * @type {number}
@@ -3917,7 +3958,7 @@ export interface World {
3917
3958
  */
3918
3959
  'unityPackageUrlObject': object;
3919
3960
  /**
3920
- *
3961
+ * Empty if unauthenticated.
3921
3962
  * @type {Array<UnityPackage>}
3922
3963
  * @memberof World
3923
3964
  */
@@ -3948,7 +3989,7 @@ export interface World {
3948
3989
  */
3949
3990
  export interface WorldMetadata {
3950
3991
  /**
3951
- *
3992
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
3952
3993
  * @type {string}
3953
3994
  * @memberof WorldMetadata
3954
3995
  */
@@ -5758,7 +5799,7 @@ export declare class FriendsApi extends BaseAPI {
5758
5799
  */
5759
5800
  export declare const InstancesApiAxiosParamCreator: (configuration?: Configuration) => {
5760
5801
  /**
5761
- * Returns an instance.
5802
+ * Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return \"null\"!
5762
5803
  * @summary Get Instance
5763
5804
  * @param {string} worldId
5764
5805
  * @param {string} instanceId
@@ -5791,7 +5832,7 @@ export declare const InstancesApiAxiosParamCreator: (configuration?: Configurati
5791
5832
  */
5792
5833
  export declare const InstancesApiFp: (configuration?: Configuration) => {
5793
5834
  /**
5794
- * Returns an instance.
5835
+ * Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return \"null\"!
5795
5836
  * @summary Get Instance
5796
5837
  * @param {string} worldId
5797
5838
  * @param {string} instanceId
@@ -5824,7 +5865,7 @@ export declare const InstancesApiFp: (configuration?: Configuration) => {
5824
5865
  */
5825
5866
  export declare const InstancesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5826
5867
  /**
5827
- * Returns an instance.
5868
+ * Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return \"null\"!
5828
5869
  * @summary Get Instance
5829
5870
  * @param {string} worldId
5830
5871
  * @param {string} instanceId
@@ -5859,7 +5900,7 @@ export declare const InstancesApiFactory: (configuration?: Configuration, basePa
5859
5900
  */
5860
5901
  export declare class InstancesApi extends BaseAPI {
5861
5902
  /**
5862
- * Returns an instance.
5903
+ * Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return \"null\"!
5863
5904
  * @summary Get Instance
5864
5905
  * @param {string} worldId
5865
5906
  * @param {string} instanceId
@@ -5926,10 +5967,11 @@ export declare const InviteApiAxiosParamCreator: (configuration?: Configuration)
5926
5967
  * Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
5927
5968
  * @summary Request Invite
5928
5969
  * @param {string} userId
5970
+ * @param {RequestInviteRequest} [requestInviteRequest] Slot number of the Request Message to use when request an invite.
5929
5971
  * @param {*} [options] Override http request option.
5930
5972
  * @throws {RequiredError}
5931
5973
  */
5932
- requestInvite: (userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5974
+ requestInvite: (userId: string, requestInviteRequest?: RequestInviteRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5933
5975
  /**
5934
5976
  * Resets a single Invite Message back to its original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users! Resetting a message respects the rate-limit, so it is not possible to reset within the 60 minutes countdown. Resetting it does however not set the rate-limit to 60 like when editing it. It is possible to edit it right after resetting it. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite The DELETE endpoint does not have/require any request body.
5935
5977
  * @summary Reset Invite Message
@@ -5944,7 +5986,7 @@ export declare const InviteApiAxiosParamCreator: (configuration?: Configuration)
5944
5986
  * Respond to an invite request by sending a world invite to the requesting user. `:notificationId` is the ID of the requesting notification.
5945
5987
  * @summary Respond Invite
5946
5988
  * @param {string} notificationId
5947
- * @param {InviteResponse} [inviteResponse] Instance ID when inviting a user.
5989
+ * @param {InviteResponse} [inviteResponse] Slot number of the Response Message to use when responding to a user.
5948
5990
  * @param {*} [options] Override http request option.
5949
5991
  * @throws {RequiredError}
5950
5992
  */
@@ -5998,10 +6040,11 @@ export declare const InviteApiFp: (configuration?: Configuration) => {
5998
6040
  * Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
5999
6041
  * @summary Request Invite
6000
6042
  * @param {string} userId
6043
+ * @param {RequestInviteRequest} [requestInviteRequest] Slot number of the Request Message to use when request an invite.
6001
6044
  * @param {*} [options] Override http request option.
6002
6045
  * @throws {RequiredError}
6003
6046
  */
6004
- requestInvite(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
6047
+ requestInvite(userId: string, requestInviteRequest?: RequestInviteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
6005
6048
  /**
6006
6049
  * Resets a single Invite Message back to its original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users! Resetting a message respects the rate-limit, so it is not possible to reset within the 60 minutes countdown. Resetting it does however not set the rate-limit to 60 like when editing it. It is possible to edit it right after resetting it. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite The DELETE endpoint does not have/require any request body.
6007
6050
  * @summary Reset Invite Message
@@ -6016,7 +6059,7 @@ export declare const InviteApiFp: (configuration?: Configuration) => {
6016
6059
  * Respond to an invite request by sending a world invite to the requesting user. `:notificationId` is the ID of the requesting notification.
6017
6060
  * @summary Respond Invite
6018
6061
  * @param {string} notificationId
6019
- * @param {InviteResponse} [inviteResponse] Instance ID when inviting a user.
6062
+ * @param {InviteResponse} [inviteResponse] Slot number of the Response Message to use when responding to a user.
6020
6063
  * @param {*} [options] Override http request option.
6021
6064
  * @throws {RequiredError}
6022
6065
  */
@@ -6070,10 +6113,11 @@ export declare const InviteApiFactory: (configuration?: Configuration, basePath?
6070
6113
  * Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
6071
6114
  * @summary Request Invite
6072
6115
  * @param {string} userId
6116
+ * @param {RequestInviteRequest} [requestInviteRequest] Slot number of the Request Message to use when request an invite.
6073
6117
  * @param {*} [options] Override http request option.
6074
6118
  * @throws {RequiredError}
6075
6119
  */
6076
- requestInvite(userId: string, options?: any): AxiosPromise<Notification>;
6120
+ requestInvite(userId: string, requestInviteRequest?: RequestInviteRequest, options?: any): AxiosPromise<Notification>;
6077
6121
  /**
6078
6122
  * Resets a single Invite Message back to its original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users! Resetting a message respects the rate-limit, so it is not possible to reset within the 60 minutes countdown. Resetting it does however not set the rate-limit to 60 like when editing it. It is possible to edit it right after resetting it. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite The DELETE endpoint does not have/require any request body.
6079
6123
  * @summary Reset Invite Message
@@ -6088,7 +6132,7 @@ export declare const InviteApiFactory: (configuration?: Configuration, basePath?
6088
6132
  * Respond to an invite request by sending a world invite to the requesting user. `:notificationId` is the ID of the requesting notification.
6089
6133
  * @summary Respond Invite
6090
6134
  * @param {string} notificationId
6091
- * @param {InviteResponse} [inviteResponse] Instance ID when inviting a user.
6135
+ * @param {InviteResponse} [inviteResponse] Slot number of the Response Message to use when responding to a user.
6092
6136
  * @param {*} [options] Override http request option.
6093
6137
  * @throws {RequiredError}
6094
6138
  */
@@ -6147,11 +6191,12 @@ export declare class InviteApi extends BaseAPI {
6147
6191
  * Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
6148
6192
  * @summary Request Invite
6149
6193
  * @param {string} userId
6194
+ * @param {RequestInviteRequest} [requestInviteRequest] Slot number of the Request Message to use when request an invite.
6150
6195
  * @param {*} [options] Override http request option.
6151
6196
  * @throws {RequiredError}
6152
6197
  * @memberof InviteApi
6153
6198
  */
6154
- requestInvite(userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification>>;
6199
+ requestInvite(userId: string, requestInviteRequest?: RequestInviteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification>>;
6155
6200
  /**
6156
6201
  * Resets a single Invite Message back to its original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users! Resetting a message respects the rate-limit, so it is not possible to reset within the 60 minutes countdown. Resetting it does however not set the rate-limit to 60 like when editing it. It is possible to edit it right after resetting it. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite The DELETE endpoint does not have/require any request body.
6157
6202
  * @summary Reset Invite Message
@@ -6167,7 +6212,7 @@ export declare class InviteApi extends BaseAPI {
6167
6212
  * Respond to an invite request by sending a world invite to the requesting user. `:notificationId` is the ID of the requesting notification.
6168
6213
  * @summary Respond Invite
6169
6214
  * @param {string} notificationId
6170
- * @param {InviteResponse} [inviteResponse] Instance ID when inviting a user.
6215
+ * @param {InviteResponse} [inviteResponse] Slot number of the Response Message to use when responding to a user.
6171
6216
  * @param {*} [options] Override http request option.
6172
6217
  * @throws {RequiredError}
6173
6218
  * @memberof InviteApi