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/api.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  /**
4
4
  * VRChat API Documentation
5
5
  *
6
- * The version of the OpenAPI document: 1.5.3
6
+ * The version of the OpenAPI document: 1.6.6
7
7
  * Contact: me@ruby.js.org
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -294,7 +294,7 @@ export interface APIConfig {
294
294
  */
295
295
  'gearDemoRoomId': string;
296
296
  /**
297
- *
297
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
298
298
  * @type {string}
299
299
  * @memberof APIConfig
300
300
  */
@@ -306,7 +306,7 @@ export interface APIConfig {
306
306
  */
307
307
  'homepageRedirectTarget': string;
308
308
  /**
309
- *
309
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
310
310
  * @type {string}
311
311
  * @memberof APIConfig
312
312
  */
@@ -413,13 +413,13 @@ export interface APIConfig {
413
413
  */
414
414
  'supportEmail': string;
415
415
  /**
416
- *
416
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
417
417
  * @type {string}
418
418
  * @memberof APIConfig
419
419
  */
420
420
  'timeOutWorldId': string;
421
421
  /**
422
- *
422
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
423
423
  * @type {string}
424
424
  * @memberof APIConfig
425
425
  */
@@ -657,7 +657,7 @@ export interface Avatar {
657
657
  */
658
658
  'assetUrlObject'?: object;
659
659
  /**
660
- *
660
+ * A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
661
661
  * @type {string}
662
662
  * @memberof Avatar
663
663
  */
@@ -909,7 +909,7 @@ export interface CreateWorldRequest {
909
909
  */
910
910
  'assetVersion'?: number;
911
911
  /**
912
- *
912
+ * A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
913
913
  * @type {string}
914
914
  * @memberof CreateWorldRequest
915
915
  */
@@ -933,7 +933,7 @@ export interface CreateWorldRequest {
933
933
  */
934
934
  'description'?: string;
935
935
  /**
936
- *
936
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
937
937
  * @type {string}
938
938
  * @memberof CreateWorldRequest
939
939
  */
@@ -1121,13 +1121,13 @@ export interface CurrentUser {
1121
1121
  */
1122
1122
  'hasPendingEmail': boolean;
1123
1123
  /**
1124
- *
1124
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
1125
1125
  * @type {string}
1126
1126
  * @memberof CurrentUser
1127
1127
  */
1128
1128
  'homeLocation': string;
1129
1129
  /**
1130
- *
1130
+ * A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
1131
1131
  * @type {string}
1132
1132
  * @memberof CurrentUser
1133
1133
  */
@@ -1434,7 +1434,7 @@ export interface FavoriteGroup {
1434
1434
  */
1435
1435
  'ownerDisplayName': string;
1436
1436
  /**
1437
- *
1437
+ * A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
1438
1438
  * @type {string}
1439
1439
  * @memberof FavoriteGroup
1440
1440
  */
@@ -1909,7 +1909,7 @@ export enum InfoPushDataClickableCommandEnum {
1909
1909
  }
1910
1910
 
1911
1911
  /**
1912
- *
1912
+ * * `hidden` field is only present if InstanceType is `hidden` aka \"Friends+\", and is instance creator. * `friends` field is only present if InstanceType is `friends` aka \"Friends\", and is instance creator. * `private` field is only present if InstanceType is `private` aka \"Invite\" or \"Invite+\", and is instance creator.
1913
1913
  * @export
1914
1914
  * @interface Instance
1915
1915
  */
@@ -1933,9 +1933,10 @@ export interface Instance {
1933
1933
  */
1934
1934
  'capacity': number;
1935
1935
  /**
1936
- *
1936
+ * Always returns \"unknown\".
1937
1937
  * @type {string}
1938
1938
  * @memberof Instance
1939
+ * @deprecated
1939
1940
  */
1940
1941
  'clientNumber': string;
1941
1942
  /**
@@ -1945,7 +1946,7 @@ export interface Instance {
1945
1946
  */
1946
1947
  'full': boolean;
1947
1948
  /**
1948
- *
1949
+ * InstanceID be \"offline\" on User profiles if you are not friends with that user.
1949
1950
  * @type {string}
1950
1951
  * @memberof Instance
1951
1952
  */
@@ -1957,7 +1958,7 @@ export interface Instance {
1957
1958
  */
1958
1959
  'instanceId': string;
1959
1960
  /**
1960
- *
1961
+ * InstanceID be \"offline\" on User profiles if you are not friends with that user.
1961
1962
  * @type {string}
1962
1963
  * @memberof Instance
1963
1964
  */
@@ -1975,13 +1976,7 @@ export interface Instance {
1975
1976
  */
1976
1977
  'name': string;
1977
1978
  /**
1978
- *
1979
- * @type {string}
1980
- * @memberof Instance
1981
- */
1982
- 'nonce'?: string;
1983
- /**
1984
- *
1979
+ * A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
1985
1980
  * @type {string}
1986
1981
  * @memberof Instance
1987
1982
  */
@@ -1994,10 +1989,10 @@ export interface Instance {
1994
1989
  'permanent': boolean;
1995
1990
  /**
1996
1991
  *
1997
- * @type {string}
1992
+ * @type {Region}
1998
1993
  * @memberof Instance
1999
1994
  */
2000
- 'photonRegion': string;
1995
+ 'photonRegion': Region;
2001
1996
  /**
2002
1997
  *
2003
1998
  * @type {InstancePlatforms}
@@ -2006,10 +2001,10 @@ export interface Instance {
2006
2001
  'platforms': InstancePlatforms;
2007
2002
  /**
2008
2003
  *
2009
- * @type {string}
2004
+ * @type {Region}
2010
2005
  * @memberof Instance
2011
2006
  */
2012
- 'region': string;
2007
+ 'region': Region;
2013
2008
  /**
2014
2009
  *
2015
2010
  * @type {string}
@@ -2017,37 +2012,41 @@ export interface Instance {
2017
2012
  */
2018
2013
  'shortName': string;
2019
2014
  /**
2020
- *
2015
+ * The tags array on Instances usually contain the language tags of the people in the instance.
2021
2016
  * @type {Array<string>}
2022
2017
  * @memberof Instance
2023
2018
  */
2024
2019
  'tags': Array<string>;
2025
2020
  /**
2026
2021
  *
2022
+ * @type {InstanceType}
2023
+ * @memberof Instance
2024
+ */
2025
+ 'type': InstanceType;
2026
+ /**
2027
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
2027
2028
  * @type {string}
2028
2029
  * @memberof Instance
2029
2030
  */
2030
- 'type': string;
2031
+ 'worldId': string;
2031
2032
  /**
2032
- * Always empty on non-existing instances, and non-present on existing instances.
2033
- * @type {Array<object>}
2033
+ * A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
2034
+ * @type {string}
2034
2035
  * @memberof Instance
2035
- * @deprecated
2036
2036
  */
2037
- 'users'?: Array<object>;
2037
+ 'hidden'?: string;
2038
2038
  /**
2039
- * Only present on non-existing instances, and only contains a very small subject of World object. Use World API instead.
2040
- * @type {object}
2039
+ * A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
2040
+ * @type {string}
2041
2041
  * @memberof Instance
2042
- * @deprecated
2043
2042
  */
2044
- 'world'?: object;
2043
+ 'friends'?: string;
2045
2044
  /**
2046
- *
2045
+ * A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
2047
2046
  * @type {string}
2048
2047
  * @memberof Instance
2049
2048
  */
2050
- 'worldId': string;
2049
+ 'private'?: string;
2051
2050
  }
2052
2051
  /**
2053
2052
  *
@@ -2068,6 +2067,19 @@ export interface InstancePlatforms {
2068
2067
  */
2069
2068
  'standalonewindows': number;
2070
2069
  }
2070
+ /**
2071
+ *
2072
+ * @export
2073
+ * @enum {string}
2074
+ */
2075
+
2076
+ export enum InstanceType {
2077
+ Public = 'public',
2078
+ Hidden = 'hidden',
2079
+ Friends = 'friends',
2080
+ Private = 'private'
2081
+ }
2082
+
2071
2083
  /**
2072
2084
  *
2073
2085
  * @export
@@ -2137,11 +2149,17 @@ export enum InviteMessageType {
2137
2149
  */
2138
2150
  export interface InviteRequest {
2139
2151
  /**
2140
- *
2152
+ * InstanceID be \"offline\" on User profiles if you are not friends with that user.
2141
2153
  * @type {string}
2142
2154
  * @memberof InviteRequest
2143
2155
  */
2144
2156
  'instanceId': string;
2157
+ /**
2158
+ *
2159
+ * @type {number}
2160
+ * @memberof InviteRequest
2161
+ */
2162
+ 'messageSlot'?: number;
2145
2163
  }
2146
2164
  /**
2147
2165
  *
@@ -2304,7 +2322,7 @@ export interface LimitedUser {
2304
2322
  */
2305
2323
  'fallbackAvatar': string;
2306
2324
  /**
2307
- *
2325
+ * 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.
2308
2326
  * @type {string}
2309
2327
  * @memberof LimitedUser
2310
2328
  */
@@ -2377,7 +2395,7 @@ export interface LimitedUser {
2377
2395
  */
2378
2396
  export interface LimitedWorld {
2379
2397
  /**
2380
- *
2398
+ * 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.
2381
2399
  * @type {string}
2382
2400
  * @memberof LimitedWorld
2383
2401
  */
@@ -2413,7 +2431,7 @@ export interface LimitedWorld {
2413
2431
  */
2414
2432
  'heat': number;
2415
2433
  /**
2416
- *
2434
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
2417
2435
  * @type {string}
2418
2436
  * @memberof LimitedWorld
2419
2437
  */
@@ -2558,7 +2576,7 @@ export interface ModelFile {
2558
2576
  */
2559
2577
  'name': string;
2560
2578
  /**
2561
- *
2579
+ * 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.
2562
2580
  * @type {string}
2563
2581
  * @memberof ModelFile
2564
2582
  */
@@ -2583,7 +2601,7 @@ export interface ModelFile {
2583
2601
  */
2584
2602
  export interface ModerateUserRequest {
2585
2603
  /**
2586
- *
2604
+ * 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.
2587
2605
  * @type {string}
2588
2606
  * @memberof ModerateUserRequest
2589
2607
  */
@@ -2632,7 +2650,7 @@ export interface Notification {
2632
2650
  */
2633
2651
  'seen': boolean;
2634
2652
  /**
2635
- *
2653
+ * 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.
2636
2654
  * @type {string}
2637
2655
  * @memberof Notification
2638
2656
  */
@@ -2703,7 +2721,7 @@ export interface Permission {
2703
2721
  */
2704
2722
  'name': string;
2705
2723
  /**
2706
- *
2724
+ * 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.
2707
2725
  * @type {string}
2708
2726
  * @memberof Permission
2709
2727
  */
@@ -2740,7 +2758,7 @@ export interface PlayerModeration {
2740
2758
  */
2741
2759
  'sourceDisplayName': string;
2742
2760
  /**
2743
- *
2761
+ * 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.
2744
2762
  * @type {string}
2745
2763
  * @memberof PlayerModeration
2746
2764
  */
@@ -2752,7 +2770,7 @@ export interface PlayerModeration {
2752
2770
  */
2753
2771
  'targetDisplayName': string;
2754
2772
  /**
2755
- *
2773
+ * 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.
2756
2774
  * @type {string}
2757
2775
  * @memberof PlayerModeration
2758
2776
  */
@@ -2798,6 +2816,20 @@ export interface PublicAnnouncement {
2798
2816
  */
2799
2817
  'text': string;
2800
2818
  }
2819
+ /**
2820
+ * API/Photon region.
2821
+ * @export
2822
+ * @enum {string}
2823
+ */
2824
+
2825
+ export enum Region {
2826
+ Us = 'us',
2827
+ Use = 'use',
2828
+ Eu = 'eu',
2829
+ Jp = 'jp',
2830
+ Unknown = 'unknown'
2831
+ }
2832
+
2801
2833
  /**
2802
2834
  *
2803
2835
  * @export
@@ -2810,6 +2842,19 @@ export enum ReleaseStatus {
2810
2842
  Hidden = 'hidden'
2811
2843
  }
2812
2844
 
2845
+ /**
2846
+ *
2847
+ * @export
2848
+ * @interface RequestInviteRequest
2849
+ */
2850
+ export interface RequestInviteRequest {
2851
+ /**
2852
+ *
2853
+ * @type {number}
2854
+ * @memberof RequestInviteRequest
2855
+ */
2856
+ 'messageSlot'?: number;
2857
+ }
2813
2858
  /**
2814
2859
  *
2815
2860
  * @export
@@ -3409,7 +3454,7 @@ export interface UpdateWorldRequest {
3409
3454
  */
3410
3455
  'assetVersion'?: string;
3411
3456
  /**
3412
- *
3457
+ * 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.
3413
3458
  * @type {string}
3414
3459
  * @memberof UpdateWorldRequest
3415
3460
  */
@@ -3524,7 +3569,7 @@ export interface User {
3524
3569
  */
3525
3570
  'developerType': DeveloperType;
3526
3571
  /**
3527
- *
3572
+ * 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.
3528
3573
  * @type {string}
3529
3574
  * @memberof User
3530
3575
  */
@@ -3536,25 +3581,25 @@ export interface User {
3536
3581
  */
3537
3582
  'friendKey': string;
3538
3583
  /**
3539
- *
3584
+ * 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.
3540
3585
  * @type {string}
3541
3586
  * @memberof User
3542
3587
  */
3543
3588
  'id': string;
3544
3589
  /**
3545
- *
3590
+ * InstanceID be \"offline\" on User profiles if you are not friends with that user.
3546
3591
  * @type {string}
3547
3592
  * @memberof User
3548
3593
  */
3549
3594
  'instanceId'?: string;
3550
3595
  /**
3551
- *
3596
+ * Either their `friendKey`, or empty string if you are not friends. Unknown usage.
3552
3597
  * @type {boolean}
3553
3598
  * @memberof User
3554
3599
  */
3555
3600
  'isFriend': boolean;
3556
3601
  /**
3557
- *
3602
+ * Either a date-time or empty string.
3558
3603
  * @type {string}
3559
3604
  * @memberof User
3560
3605
  */
@@ -3566,7 +3611,7 @@ export interface User {
3566
3611
  */
3567
3612
  'last_platform': string;
3568
3613
  /**
3569
- *
3614
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
3570
3615
  * @type {string}
3571
3616
  * @memberof User
3572
3617
  */
@@ -3608,13 +3653,13 @@ export interface User {
3608
3653
  */
3609
3654
  'userIcon': string;
3610
3655
  /**
3611
- *
3656
+ * 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.
3612
3657
  * @type {string}
3613
3658
  * @memberof User
3614
3659
  */
3615
3660
  'username': string;
3616
3661
  /**
3617
- *
3662
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
3618
3663
  * @type {string}
3619
3664
  * @memberof User
3620
3665
  */
@@ -3795,7 +3840,7 @@ export interface VerifyAuthTokenResult {
3795
3840
  */
3796
3841
  export interface World {
3797
3842
  /**
3798
- *
3843
+ * Empty if unauthenticated.
3799
3844
  * @type {string}
3800
3845
  * @memberof World
3801
3846
  */
@@ -3807,7 +3852,7 @@ export interface World {
3807
3852
  */
3808
3853
  'assetUrlObject': object;
3809
3854
  /**
3810
- *
3855
+ * 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.
3811
3856
  * @type {string}
3812
3857
  * @memberof World
3813
3858
  */
@@ -3855,7 +3900,7 @@ export interface World {
3855
3900
  */
3856
3901
  'heat': number;
3857
3902
  /**
3858
- *
3903
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
3859
3904
  * @type {string}
3860
3905
  * @memberof World
3861
3906
  */
@@ -3868,10 +3913,10 @@ export interface World {
3868
3913
  'imageUrl': string;
3869
3914
  /**
3870
3915
  *
3871
- * @type {Array<Array<object>>}
3916
+ * @type {Array<Array<any>>}
3872
3917
  * @memberof World
3873
3918
  */
3874
- 'instances'?: Array<Array<object>>;
3919
+ 'instances'?: Array<Array<any>>;
3875
3920
  /**
3876
3921
  *
3877
3922
  * @type {string}
@@ -3919,7 +3964,7 @@ export interface World {
3919
3964
  * @type {string}
3920
3965
  * @memberof World
3921
3966
  */
3922
- 'previewYoutubeId'?: string;
3967
+ 'previewYoutubeId'?: string | null;
3923
3968
  /**
3924
3969
  *
3925
3970
  * @type {number}
@@ -3963,7 +4008,7 @@ export interface World {
3963
4008
  */
3964
4009
  'unityPackageUrlObject': object;
3965
4010
  /**
3966
- *
4011
+ * Empty if unauthenticated.
3967
4012
  * @type {Array<UnityPackage>}
3968
4013
  * @memberof World
3969
4014
  */
@@ -3994,7 +4039,7 @@ export interface World {
3994
4039
  */
3995
4040
  export interface WorldMetadata {
3996
4041
  /**
3997
- *
4042
+ * WorldID be \"offline\" on User profiles if you are not friends with that user.
3998
4043
  * @type {string}
3999
4044
  * @memberof WorldMetadata
4000
4045
  */
@@ -7703,7 +7748,7 @@ export class FriendsApi extends BaseAPI {
7703
7748
  export const InstancesApiAxiosParamCreator = function (configuration?: Configuration) {
7704
7749
  return {
7705
7750
  /**
7706
- * Returns an instance.
7751
+ * 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\"!
7707
7752
  * @summary Get Instance
7708
7753
  * @param {string} worldId
7709
7754
  * @param {string} instanceId
@@ -7839,7 +7884,7 @@ export const InstancesApiFp = function(configuration?: Configuration) {
7839
7884
  const localVarAxiosParamCreator = InstancesApiAxiosParamCreator(configuration)
7840
7885
  return {
7841
7886
  /**
7842
- * Returns an instance.
7887
+ * 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\"!
7843
7888
  * @summary Get Instance
7844
7889
  * @param {string} worldId
7845
7890
  * @param {string} instanceId
@@ -7885,7 +7930,7 @@ export const InstancesApiFactory = function (configuration?: Configuration, base
7885
7930
  const localVarFp = InstancesApiFp(configuration)
7886
7931
  return {
7887
7932
  /**
7888
- * Returns an instance.
7933
+ * 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\"!
7889
7934
  * @summary Get Instance
7890
7935
  * @param {string} worldId
7891
7936
  * @param {string} instanceId
@@ -7928,7 +7973,7 @@ export const InstancesApiFactory = function (configuration?: Configuration, base
7928
7973
  */
7929
7974
  export class InstancesApi extends BaseAPI {
7930
7975
  /**
7931
- * Returns an instance.
7976
+ * 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\"!
7932
7977
  * @summary Get Instance
7933
7978
  * @param {string} worldId
7934
7979
  * @param {string} instanceId
@@ -8108,10 +8153,11 @@ export const InviteApiAxiosParamCreator = function (configuration?: Configuratio
8108
8153
  * Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
8109
8154
  * @summary Request Invite
8110
8155
  * @param {string} userId
8156
+ * @param {RequestInviteRequest} [requestInviteRequest] Slot number of the Request Message to use when request an invite.
8111
8157
  * @param {*} [options] Override http request option.
8112
8158
  * @throws {RequiredError}
8113
8159
  */
8114
- requestInvite: async (userId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
8160
+ requestInvite: async (userId: string, requestInviteRequest?: RequestInviteRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
8115
8161
  // verify required parameter 'userId' is not null or undefined
8116
8162
  assertParamExists('requestInvite', 'userId', userId)
8117
8163
  const localVarPath = `/requestInvite/{userId}`
@@ -8133,9 +8179,12 @@ export const InviteApiAxiosParamCreator = function (configuration?: Configuratio
8133
8179
 
8134
8180
 
8135
8181
 
8182
+ localVarHeaderParameter['Content-Type'] = 'application/json';
8183
+
8136
8184
  setSearchParams(localVarUrlObj, localVarQueryParameter);
8137
8185
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8138
8186
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
8187
+ localVarRequestOptions.data = serializeDataIfNeeded(requestInviteRequest, localVarRequestOptions, configuration)
8139
8188
 
8140
8189
  return {
8141
8190
  url: toPathString(localVarUrlObj),
@@ -8192,7 +8241,7 @@ export const InviteApiAxiosParamCreator = function (configuration?: Configuratio
8192
8241
  * Respond to an invite request by sending a world invite to the requesting user. `:notificationId` is the ID of the requesting notification.
8193
8242
  * @summary Respond Invite
8194
8243
  * @param {string} notificationId
8195
- * @param {InviteResponse} [inviteResponse] Instance ID when inviting a user.
8244
+ * @param {InviteResponse} [inviteResponse] Slot number of the Response Message to use when responding to a user.
8196
8245
  * @param {*} [options] Override http request option.
8197
8246
  * @throws {RequiredError}
8198
8247
  */
@@ -8331,11 +8380,12 @@ export const InviteApiFp = function(configuration?: Configuration) {
8331
8380
  * Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
8332
8381
  * @summary Request Invite
8333
8382
  * @param {string} userId
8383
+ * @param {RequestInviteRequest} [requestInviteRequest] Slot number of the Request Message to use when request an invite.
8334
8384
  * @param {*} [options] Override http request option.
8335
8385
  * @throws {RequiredError}
8336
8386
  */
8337
- async requestInvite(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>> {
8338
- const localVarAxiosArgs = await localVarAxiosParamCreator.requestInvite(userId, options);
8387
+ async requestInvite(userId: string, requestInviteRequest?: RequestInviteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>> {
8388
+ const localVarAxiosArgs = await localVarAxiosParamCreator.requestInvite(userId, requestInviteRequest, options);
8339
8389
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
8340
8390
  },
8341
8391
  /**
@@ -8355,7 +8405,7 @@ export const InviteApiFp = function(configuration?: Configuration) {
8355
8405
  * Respond to an invite request by sending a world invite to the requesting user. `:notificationId` is the ID of the requesting notification.
8356
8406
  * @summary Respond Invite
8357
8407
  * @param {string} notificationId
8358
- * @param {InviteResponse} [inviteResponse] Instance ID when inviting a user.
8408
+ * @param {InviteResponse} [inviteResponse] Slot number of the Response Message to use when responding to a user.
8359
8409
  * @param {*} [options] Override http request option.
8360
8410
  * @throws {RequiredError}
8361
8411
  */
@@ -8425,11 +8475,12 @@ export const InviteApiFactory = function (configuration?: Configuration, basePat
8425
8475
  * Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
8426
8476
  * @summary Request Invite
8427
8477
  * @param {string} userId
8478
+ * @param {RequestInviteRequest} [requestInviteRequest] Slot number of the Request Message to use when request an invite.
8428
8479
  * @param {*} [options] Override http request option.
8429
8480
  * @throws {RequiredError}
8430
8481
  */
8431
- requestInvite(userId: string, options?: any): AxiosPromise<Notification> {
8432
- return localVarFp.requestInvite(userId, options).then((request) => request(axios, basePath));
8482
+ requestInvite(userId: string, requestInviteRequest?: RequestInviteRequest, options?: any): AxiosPromise<Notification> {
8483
+ return localVarFp.requestInvite(userId, requestInviteRequest, options).then((request) => request(axios, basePath));
8433
8484
  },
8434
8485
  /**
8435
8486
  * 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.
@@ -8447,7 +8498,7 @@ export const InviteApiFactory = function (configuration?: Configuration, basePat
8447
8498
  * Respond to an invite request by sending a world invite to the requesting user. `:notificationId` is the ID of the requesting notification.
8448
8499
  * @summary Respond Invite
8449
8500
  * @param {string} notificationId
8450
- * @param {InviteResponse} [inviteResponse] Instance ID when inviting a user.
8501
+ * @param {InviteResponse} [inviteResponse] Slot number of the Response Message to use when responding to a user.
8451
8502
  * @param {*} [options] Override http request option.
8452
8503
  * @throws {RequiredError}
8453
8504
  */
@@ -8521,12 +8572,13 @@ export class InviteApi extends BaseAPI {
8521
8572
  * Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
8522
8573
  * @summary Request Invite
8523
8574
  * @param {string} userId
8575
+ * @param {RequestInviteRequest} [requestInviteRequest] Slot number of the Request Message to use when request an invite.
8524
8576
  * @param {*} [options] Override http request option.
8525
8577
  * @throws {RequiredError}
8526
8578
  * @memberof InviteApi
8527
8579
  */
8528
- public requestInvite(userId: string, options?: AxiosRequestConfig) {
8529
- return InviteApiFp(this.configuration).requestInvite(userId, options).then((request) => request(this.axios, this.basePath));
8580
+ public requestInvite(userId: string, requestInviteRequest?: RequestInviteRequest, options?: AxiosRequestConfig) {
8581
+ return InviteApiFp(this.configuration).requestInvite(userId, requestInviteRequest, options).then((request) => request(this.axios, this.basePath));
8530
8582
  }
8531
8583
 
8532
8584
  /**
@@ -8547,7 +8599,7 @@ export class InviteApi extends BaseAPI {
8547
8599
  * Respond to an invite request by sending a world invite to the requesting user. `:notificationId` is the ID of the requesting notification.
8548
8600
  * @summary Respond Invite
8549
8601
  * @param {string} notificationId
8550
- * @param {InviteResponse} [inviteResponse] Instance ID when inviting a user.
8602
+ * @param {InviteResponse} [inviteResponse] Slot number of the Response Message to use when responding to a user.
8551
8603
  * @param {*} [options] Override http request option.
8552
8604
  * @throws {RequiredError}
8553
8605
  * @memberof InviteApi
package/base.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  /**
4
4
  * VRChat API Documentation
5
5
  *
6
- * The version of the OpenAPI document: 1.5.3
6
+ * The version of the OpenAPI document: 1.6.6
7
7
  * Contact: me@ruby.js.org
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/common.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  /**
4
4
  * VRChat API Documentation
5
5
  *
6
- * The version of the OpenAPI document: 1.5.3
6
+ * The version of the OpenAPI document: 1.6.6
7
7
  * Contact: me@ruby.js.org
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/configuration.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  /**
4
4
  * VRChat API Documentation
5
5
  *
6
- * The version of the OpenAPI document: 1.5.3
6
+ * The version of the OpenAPI document: 1.6.6
7
7
  * Contact: me@ruby.js.org
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).