vrchat 1.7.6 → 1.8.0

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.7.6
6
+ * The version of the OpenAPI document: 1.8.0
7
7
  * Contact: me@ariesclark.com
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1265,11 +1265,12 @@ export interface CurrentUser {
1265
1265
  */
1266
1266
  'userIcon': string;
1267
1267
  /**
1268
- *
1268
+ * -| **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429).
1269
1269
  * @type {string}
1270
1270
  * @memberof CurrentUser
1271
+ * @deprecated
1271
1272
  */
1272
- 'username': string;
1273
+ 'username'?: string;
1273
1274
  }
1274
1275
  /**
1275
1276
  * Used to identify which API deployment cluster is currently responding. `blue` and `green` are used by Production. `grape`and `cherry` are used during Development. [Blue Green Deployment by Martin Fowler](https://martinfowler.com/bliki/BlueGreenDeployment.html)
@@ -2402,11 +2403,12 @@ export interface LimitedUser {
2402
2403
  */
2403
2404
  'userIcon': string;
2404
2405
  /**
2405
- *
2406
+ * -| **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429).
2406
2407
  * @type {string}
2407
2408
  * @memberof LimitedUser
2409
+ * @deprecated
2408
2410
  */
2409
- 'username': string;
2411
+ 'username'?: string;
2410
2412
  /**
2411
2413
  *
2412
2414
  * @type {string}
@@ -2688,11 +2690,12 @@ export interface Notification {
2688
2690
  */
2689
2691
  'senderUserId': string;
2690
2692
  /**
2691
- *
2693
+ * -| **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429).
2692
2694
  * @type {string}
2693
2695
  * @memberof Notification
2696
+ * @deprecated
2694
2697
  */
2695
- 'senderUsername': string;
2698
+ 'senderUsername'?: string;
2696
2699
  /**
2697
2700
  *
2698
2701
  * @type {NotificationType}
@@ -2952,11 +2955,12 @@ export interface SentNotification {
2952
2955
  */
2953
2956
  'senderUserId': string;
2954
2957
  /**
2955
- *
2958
+ * -| **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429).
2956
2959
  * @type {string}
2957
2960
  * @memberof SentNotification
2961
+ * @deprecated
2958
2962
  */
2959
- 'senderUsername': string;
2963
+ 'senderUsername'?: string;
2960
2964
  /**
2961
2965
  *
2962
2966
  * @type {NotificationType}
@@ -3779,11 +3783,12 @@ export interface User {
3779
3783
  */
3780
3784
  'userIcon': string;
3781
3785
  /**
3782
- * 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.
3786
+ * -| 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.\' **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429).
3783
3787
  * @type {string}
3784
3788
  * @memberof User
3789
+ * @deprecated
3785
3790
  */
3786
- 'username': string;
3791
+ 'username'?: string;
3787
3792
  /**
3788
3793
  * WorldID be \"offline\" on User profiles if you are not friends with that user.
3789
3794
  * @type {string}
@@ -4026,7 +4031,7 @@ export interface World {
4026
4031
  */
4027
4032
  'imageUrl': string;
4028
4033
  /**
4029
- *
4034
+ * Will always be an empty list when unauthenticated.
4030
4035
  * @type {Array<Array<any>>}
4031
4036
  * @memberof World
4032
4037
  */
@@ -4050,7 +4055,7 @@ export interface World {
4050
4055
  */
4051
4056
  'namespace': string;
4052
4057
  /**
4053
- *
4058
+ * Will always be `0` when unauthenticated.
4054
4059
  * @type {number}
4055
4060
  * @memberof World
4056
4061
  */
@@ -4074,13 +4079,13 @@ export interface World {
4074
4079
  */
4075
4080
  'previewYoutubeId'?: string | null;
4076
4081
  /**
4077
- *
4082
+ * Will always be `0` when unauthenticated.
4078
4083
  * @type {number}
4079
4084
  * @memberof World
4080
4085
  */
4081
4086
  'privateOccupants'?: number;
4082
4087
  /**
4083
- *
4088
+ * Will always be `0` when unauthenticated.
4084
4089
  * @type {number}
4085
4090
  * @memberof World
4086
4091
  */
@@ -8993,7 +8998,7 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
8993
8998
  /**
8994
8999
  * Retrieve all of the current user\'s notifications.
8995
9000
  * @summary List Notifications
8996
- * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all).
9001
+ * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all). This parameter no longer does anything, and is deprecated.
8997
9002
  * @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
8998
9003
  * @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type &#x60;friendRequest&#x60;.
8999
9004
  * @param {string} [after] Only return notifications sent after this Date. Ignored if type is &#x60;friendRequest&#x60;.
@@ -9137,7 +9142,7 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
9137
9142
  /**
9138
9143
  * Retrieve all of the current user\'s notifications.
9139
9144
  * @summary List Notifications
9140
- * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all).
9145
+ * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all). This parameter no longer does anything, and is deprecated.
9141
9146
  * @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
9142
9147
  * @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type &#x60;friendRequest&#x60;.
9143
9148
  * @param {string} [after] Only return notifications sent after this Date. Ignored if type is &#x60;friendRequest&#x60;.
@@ -9203,7 +9208,7 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
9203
9208
  /**
9204
9209
  * Retrieve all of the current user\'s notifications.
9205
9210
  * @summary List Notifications
9206
- * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all).
9211
+ * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all). This parameter no longer does anything, and is deprecated.
9207
9212
  * @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
9208
9213
  * @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type &#x60;friendRequest&#x60;.
9209
9214
  * @param {string} [after] Only return notifications sent after this Date. Ignored if type is &#x60;friendRequest&#x60;.
@@ -9273,7 +9278,7 @@ export class NotificationsApi extends BaseAPI {
9273
9278
  /**
9274
9279
  * Retrieve all of the current user\'s notifications.
9275
9280
  * @summary List Notifications
9276
- * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all).
9281
+ * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all). This parameter no longer does anything, and is deprecated.
9277
9282
  * @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
9278
9283
  * @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type &#x60;friendRequest&#x60;.
9279
9284
  * @param {string} [after] Only return notifications sent after this Date. Ignored if type is &#x60;friendRequest&#x60;.
@@ -10495,10 +10500,11 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration
10495
10500
  };
10496
10501
  },
10497
10502
  /**
10498
- * Get public user information about a specific user using their name.
10503
+ * ~~Get public user information about a specific user using their name.~~ **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). This endpoint now require Admin Credentials.
10499
10504
  * @summary Get User by Username
10500
10505
  * @param {string} username
10501
10506
  * @param {*} [options] Override http request option.
10507
+ * @deprecated
10502
10508
  * @throws {RequiredError}
10503
10509
  */
10504
10510
  getUserByName: async (username: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -10650,10 +10656,11 @@ export const UsersApiFp = function(configuration?: Configuration) {
10650
10656
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
10651
10657
  },
10652
10658
  /**
10653
- * Get public user information about a specific user using their name.
10659
+ * ~~Get public user information about a specific user using their name.~~ **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). This endpoint now require Admin Credentials.
10654
10660
  * @summary Get User by Username
10655
10661
  * @param {string} username
10656
10662
  * @param {*} [options] Override http request option.
10663
+ * @deprecated
10657
10664
  * @throws {RequiredError}
10658
10665
  */
10659
10666
  async getUserByName(username: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>> {
@@ -10707,10 +10714,11 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath
10707
10714
  return localVarFp.getUser(userId, options).then((request) => request(axios, basePath));
10708
10715
  },
10709
10716
  /**
10710
- * Get public user information about a specific user using their name.
10717
+ * ~~Get public user information about a specific user using their name.~~ **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). This endpoint now require Admin Credentials.
10711
10718
  * @summary Get User by Username
10712
10719
  * @param {string} username
10713
10720
  * @param {*} [options] Override http request option.
10721
+ * @deprecated
10714
10722
  * @throws {RequiredError}
10715
10723
  */
10716
10724
  getUserByName(username: string, options?: any): AxiosPromise<User> {
@@ -10763,10 +10771,11 @@ export class UsersApi extends BaseAPI {
10763
10771
  }
10764
10772
 
10765
10773
  /**
10766
- * Get public user information about a specific user using their name.
10774
+ * ~~Get public user information about a specific user using their name.~~ **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). This endpoint now require Admin Credentials.
10767
10775
  * @summary Get User by Username
10768
10776
  * @param {string} username
10769
10777
  * @param {*} [options] Override http request option.
10778
+ * @deprecated
10770
10779
  * @throws {RequiredError}
10771
10780
  * @memberof UsersApi
10772
10781
  */
@@ -11175,7 +11184,7 @@ export const WorldsApiAxiosParamCreator = function (configuration?: Configuratio
11175
11184
  };
11176
11185
  },
11177
11186
  /**
11178
- * Get information about a specific World.
11187
+ * Get information about a specific World. Works unauthenticated but when so will always return `0` for certain fields.
11179
11188
  * @summary Get World by ID
11180
11189
  * @param {string} worldId
11181
11190
  * @param {*} [options] Override http request option.
@@ -11652,7 +11661,7 @@ export const WorldsApiFp = function(configuration?: Configuration) {
11652
11661
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
11653
11662
  },
11654
11663
  /**
11655
- * Get information about a specific World.
11664
+ * Get information about a specific World. Works unauthenticated but when so will always return `0` for certain fields.
11656
11665
  * @summary Get World by ID
11657
11666
  * @param {string} worldId
11658
11667
  * @param {*} [options] Override http request option.
@@ -11851,7 +11860,7 @@ export const WorldsApiFactory = function (configuration?: Configuration, basePat
11851
11860
  return localVarFp.getRecentWorlds(featured, sort, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, userId, options).then((request) => request(axios, basePath));
11852
11861
  },
11853
11862
  /**
11854
- * Get information about a specific World.
11863
+ * Get information about a specific World. Works unauthenticated but when so will always return `0` for certain fields.
11855
11864
  * @summary Get World by ID
11856
11865
  * @param {string} worldId
11857
11866
  * @param {*} [options] Override http request option.
@@ -12052,7 +12061,7 @@ export class WorldsApi extends BaseAPI {
12052
12061
  }
12053
12062
 
12054
12063
  /**
12055
- * Get information about a specific World.
12064
+ * Get information about a specific World. Works unauthenticated but when so will always return `0` for certain fields.
12056
12065
  * @summary Get World by ID
12057
12066
  * @param {string} worldId
12058
12067
  * @param {*} [options] Override http request option.
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.7.6
6
+ * The version of the OpenAPI document: 1.8.0
7
7
  * Contact: me@ariesclark.com
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.7.6
6
+ * The version of the OpenAPI document: 1.8.0
7
7
  * Contact: me@ariesclark.com
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.7.6
6
+ * The version of the OpenAPI document: 1.8.0
7
7
  * Contact: me@ariesclark.com
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
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.7.6
4
+ * The version of the OpenAPI document: 1.8.0
5
5
  * Contact: me@ariesclark.com
6
6
  *
7
7
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1255,11 +1255,12 @@ export interface CurrentUser {
1255
1255
  */
1256
1256
  'userIcon': string;
1257
1257
  /**
1258
- *
1258
+ * -| **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429).
1259
1259
  * @type {string}
1260
1260
  * @memberof CurrentUser
1261
+ * @deprecated
1261
1262
  */
1262
- 'username': string;
1263
+ 'username'?: string;
1263
1264
  }
1264
1265
  /**
1265
1266
  * Used to identify which API deployment cluster is currently responding. `blue` and `green` are used by Production. `grape`and `cherry` are used during Development. [Blue Green Deployment by Martin Fowler](https://martinfowler.com/bliki/BlueGreenDeployment.html)
@@ -2370,11 +2371,12 @@ export interface LimitedUser {
2370
2371
  */
2371
2372
  'userIcon': string;
2372
2373
  /**
2373
- *
2374
+ * -| **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429).
2374
2375
  * @type {string}
2375
2376
  * @memberof LimitedUser
2377
+ * @deprecated
2376
2378
  */
2377
- 'username': string;
2379
+ 'username'?: string;
2378
2380
  /**
2379
2381
  *
2380
2382
  * @type {string}
@@ -2654,11 +2656,12 @@ export interface Notification {
2654
2656
  */
2655
2657
  'senderUserId': string;
2656
2658
  /**
2657
- *
2659
+ * -| **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429).
2658
2660
  * @type {string}
2659
2661
  * @memberof Notification
2662
+ * @deprecated
2660
2663
  */
2661
- 'senderUsername': string;
2664
+ 'senderUsername'?: string;
2662
2665
  /**
2663
2666
  *
2664
2667
  * @type {NotificationType}
@@ -2910,11 +2913,12 @@ export interface SentNotification {
2910
2913
  */
2911
2914
  'senderUserId': string;
2912
2915
  /**
2913
- *
2916
+ * -| **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429).
2914
2917
  * @type {string}
2915
2918
  * @memberof SentNotification
2919
+ * @deprecated
2916
2920
  */
2917
- 'senderUsername': string;
2921
+ 'senderUsername'?: string;
2918
2922
  /**
2919
2923
  *
2920
2924
  * @type {NotificationType}
@@ -3733,11 +3737,12 @@ export interface User {
3733
3737
  */
3734
3738
  'userIcon': string;
3735
3739
  /**
3736
- * 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.
3740
+ * -| 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.\' **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429).
3737
3741
  * @type {string}
3738
3742
  * @memberof User
3743
+ * @deprecated
3739
3744
  */
3740
- 'username': string;
3745
+ 'username'?: string;
3741
3746
  /**
3742
3747
  * WorldID be \"offline\" on User profiles if you are not friends with that user.
3743
3748
  * @type {string}
@@ -3976,7 +3981,7 @@ export interface World {
3976
3981
  */
3977
3982
  'imageUrl': string;
3978
3983
  /**
3979
- *
3984
+ * Will always be an empty list when unauthenticated.
3980
3985
  * @type {Array<Array<any>>}
3981
3986
  * @memberof World
3982
3987
  */
@@ -4000,7 +4005,7 @@ export interface World {
4000
4005
  */
4001
4006
  'namespace': string;
4002
4007
  /**
4003
- *
4008
+ * Will always be `0` when unauthenticated.
4004
4009
  * @type {number}
4005
4010
  * @memberof World
4006
4011
  */
@@ -4024,13 +4029,13 @@ export interface World {
4024
4029
  */
4025
4030
  'previewYoutubeId'?: string | null;
4026
4031
  /**
4027
- *
4032
+ * Will always be `0` when unauthenticated.
4028
4033
  * @type {number}
4029
4034
  * @memberof World
4030
4035
  */
4031
4036
  'privateOccupants'?: number;
4032
4037
  /**
4033
- *
4038
+ * Will always be `0` when unauthenticated.
4034
4039
  * @type {number}
4035
4040
  * @memberof World
4036
4041
  */
@@ -6434,7 +6439,7 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
6434
6439
  /**
6435
6440
  * Retrieve all of the current user\'s notifications.
6436
6441
  * @summary List Notifications
6437
- * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all).
6442
+ * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all). This parameter no longer does anything, and is deprecated.
6438
6443
  * @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
6439
6444
  * @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type &#x60;friendRequest&#x60;.
6440
6445
  * @param {string} [after] Only return notifications sent after this Date. Ignored if type is &#x60;friendRequest&#x60;.
@@ -6484,7 +6489,7 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
6484
6489
  /**
6485
6490
  * Retrieve all of the current user\'s notifications.
6486
6491
  * @summary List Notifications
6487
- * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all).
6492
+ * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all). This parameter no longer does anything, and is deprecated.
6488
6493
  * @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
6489
6494
  * @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type &#x60;friendRequest&#x60;.
6490
6495
  * @param {string} [after] Only return notifications sent after this Date. Ignored if type is &#x60;friendRequest&#x60;.
@@ -6534,7 +6539,7 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
6534
6539
  /**
6535
6540
  * Retrieve all of the current user\'s notifications.
6536
6541
  * @summary List Notifications
6537
- * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all).
6542
+ * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all). This parameter no longer does anything, and is deprecated.
6538
6543
  * @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
6539
6544
  * @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type &#x60;friendRequest&#x60;.
6540
6545
  * @param {string} [after] Only return notifications sent after this Date. Ignored if type is &#x60;friendRequest&#x60;.
@@ -6589,7 +6594,7 @@ export declare class NotificationsApi extends BaseAPI {
6589
6594
  /**
6590
6595
  * Retrieve all of the current user\'s notifications.
6591
6596
  * @summary List Notifications
6592
- * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all).
6597
+ * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all). This parameter no longer does anything, and is deprecated.
6593
6598
  * @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
6594
6599
  * @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type &#x60;friendRequest&#x60;.
6595
6600
  * @param {string} [after] Only return notifications sent after this Date. Ignored if type is &#x60;friendRequest&#x60;.
@@ -7193,10 +7198,11 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
7193
7198
  */
7194
7199
  getUser: (userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7195
7200
  /**
7196
- * Get public user information about a specific user using their name.
7201
+ * ~~Get public user information about a specific user using their name.~~ **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). This endpoint now require Admin Credentials.
7197
7202
  * @summary Get User by Username
7198
7203
  * @param {string} username
7199
7204
  * @param {*} [options] Override http request option.
7205
+ * @deprecated
7200
7206
  * @throws {RequiredError}
7201
7207
  */
7202
7208
  getUserByName: (username: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
@@ -7235,10 +7241,11 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
7235
7241
  */
7236
7242
  getUser(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>;
7237
7243
  /**
7238
- * Get public user information about a specific user using their name.
7244
+ * ~~Get public user information about a specific user using their name.~~ **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). This endpoint now require Admin Credentials.
7239
7245
  * @summary Get User by Username
7240
7246
  * @param {string} username
7241
7247
  * @param {*} [options] Override http request option.
7248
+ * @deprecated
7242
7249
  * @throws {RequiredError}
7243
7250
  */
7244
7251
  getUserByName(username: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>;
@@ -7277,10 +7284,11 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
7277
7284
  */
7278
7285
  getUser(userId: string, options?: any): AxiosPromise<User>;
7279
7286
  /**
7280
- * Get public user information about a specific user using their name.
7287
+ * ~~Get public user information about a specific user using their name.~~ **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). This endpoint now require Admin Credentials.
7281
7288
  * @summary Get User by Username
7282
7289
  * @param {string} username
7283
7290
  * @param {*} [options] Override http request option.
7291
+ * @deprecated
7284
7292
  * @throws {RequiredError}
7285
7293
  */
7286
7294
  getUserByName(username: string, options?: any): AxiosPromise<User>;
@@ -7322,10 +7330,11 @@ export declare class UsersApi extends BaseAPI {
7322
7330
  */
7323
7331
  getUser(userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<User>>;
7324
7332
  /**
7325
- * Get public user information about a specific user using their name.
7333
+ * ~~Get public user information about a specific user using their name.~~ **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). This endpoint now require Admin Credentials.
7326
7334
  * @summary Get User by Username
7327
7335
  * @param {string} username
7328
7336
  * @param {*} [options] Override http request option.
7337
+ * @deprecated
7329
7338
  * @throws {RequiredError}
7330
7339
  * @memberof UsersApi
7331
7340
  */
@@ -7434,7 +7443,7 @@ export declare const WorldsApiAxiosParamCreator: (configuration?: Configuration)
7434
7443
  */
7435
7444
  getRecentWorlds: (featured?: boolean, sort?: 'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name', n?: number, order?: 'ascending' | 'descending', offset?: number, search?: string, tag?: string, notag?: string, releaseStatus?: 'public' | 'private' | 'hidden' | 'all', maxUnityVersion?: string, minUnityVersion?: string, platform?: string, userId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7436
7445
  /**
7437
- * Get information about a specific World.
7446
+ * Get information about a specific World. Works unauthenticated but when so will always return `0` for certain fields.
7438
7447
  * @summary Get World by ID
7439
7448
  * @param {string} worldId
7440
7449
  * @param {*} [options] Override http request option.
@@ -7595,7 +7604,7 @@ export declare const WorldsApiFp: (configuration?: Configuration) => {
7595
7604
  */
7596
7605
  getRecentWorlds(featured?: boolean, sort?: 'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name', n?: number, order?: 'ascending' | 'descending', offset?: number, search?: string, tag?: string, notag?: string, releaseStatus?: 'public' | 'private' | 'hidden' | 'all', maxUnityVersion?: string, minUnityVersion?: string, platform?: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<LimitedWorld>>>;
7597
7606
  /**
7598
- * Get information about a specific World.
7607
+ * Get information about a specific World. Works unauthenticated but when so will always return `0` for certain fields.
7599
7608
  * @summary Get World by ID
7600
7609
  * @param {string} worldId
7601
7610
  * @param {*} [options] Override http request option.
@@ -7756,7 +7765,7 @@ export declare const WorldsApiFactory: (configuration?: Configuration, basePath?
7756
7765
  */
7757
7766
  getRecentWorlds(featured?: boolean, sort?: 'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name', n?: number, order?: 'ascending' | 'descending', offset?: number, search?: string, tag?: string, notag?: string, releaseStatus?: 'public' | 'private' | 'hidden' | 'all', maxUnityVersion?: string, minUnityVersion?: string, platform?: string, userId?: string, options?: any): AxiosPromise<Array<LimitedWorld>>;
7758
7767
  /**
7759
- * Get information about a specific World.
7768
+ * Get information about a specific World. Works unauthenticated but when so will always return `0` for certain fields.
7760
7769
  * @summary Get World by ID
7761
7770
  * @param {string} worldId
7762
7771
  * @param {*} [options] Override http request option.
@@ -7924,7 +7933,7 @@ export declare class WorldsApi extends BaseAPI {
7924
7933
  */
7925
7934
  getRecentWorlds(featured?: boolean, sort?: 'popularity' | 'heat' | 'trust' | 'shuffle' | 'random' | 'favorites' | 'reportScore' | 'reportCount' | 'publicationDate' | 'labsPublicationDate' | 'created' | '_created_at' | 'updated' | '_updated_at' | 'order' | 'relevance' | 'magic' | 'name', n?: number, order?: 'ascending' | 'descending', offset?: number, search?: string, tag?: string, notag?: string, releaseStatus?: 'public' | 'private' | 'hidden' | 'all', maxUnityVersion?: string, minUnityVersion?: string, platform?: string, userId?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LimitedWorld[]>>;
7926
7935
  /**
7927
- * Get information about a specific World.
7936
+ * Get information about a specific World. Works unauthenticated but when so will always return `0` for certain fields.
7928
7937
  * @summary Get World by ID
7929
7938
  * @param {string} worldId
7930
7939
  * @param {*} [options] Override http request option.
package/dist/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  /**
5
5
  * VRChat API Documentation
6
6
  *
7
- * The version of the OpenAPI document: 1.7.6
7
+ * The version of the OpenAPI document: 1.8.0
8
8
  * Contact: me@ariesclark.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5453,7 +5453,7 @@ exports.NotificationsApiAxiosParamCreator = function (configuration) {
5453
5453
  /**
5454
5454
  * Retrieve all of the current user\'s notifications.
5455
5455
  * @summary List Notifications
5456
- * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all).
5456
+ * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all). This parameter no longer does anything, and is deprecated.
5457
5457
  * @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
5458
5458
  * @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type &#x60;friendRequest&#x60;.
5459
5459
  * @param {string} [after] Only return notifications sent after this Date. Ignored if type is &#x60;friendRequest&#x60;.
@@ -5611,7 +5611,7 @@ exports.NotificationsApiFp = function (configuration) {
5611
5611
  /**
5612
5612
  * Retrieve all of the current user\'s notifications.
5613
5613
  * @summary List Notifications
5614
- * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all).
5614
+ * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all). This parameter no longer does anything, and is deprecated.
5615
5615
  * @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
5616
5616
  * @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type &#x60;friendRequest&#x60;.
5617
5617
  * @param {string} [after] Only return notifications sent after this Date. Ignored if type is &#x60;friendRequest&#x60;.
@@ -5694,7 +5694,7 @@ exports.NotificationsApiFactory = function (configuration, basePath, axios) {
5694
5694
  /**
5695
5695
  * Retrieve all of the current user\'s notifications.
5696
5696
  * @summary List Notifications
5697
- * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all).
5697
+ * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all). This parameter no longer does anything, and is deprecated.
5698
5698
  * @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
5699
5699
  * @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type &#x60;friendRequest&#x60;.
5700
5700
  * @param {string} [after] Only return notifications sent after this Date. Ignored if type is &#x60;friendRequest&#x60;.
@@ -5767,7 +5767,7 @@ var NotificationsApi = /** @class */ (function (_super) {
5767
5767
  /**
5768
5768
  * Retrieve all of the current user\'s notifications.
5769
5769
  * @summary List Notifications
5770
- * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all).
5770
+ * @param {string} [type] Only send notifications of this type (can use &#x60;all&#x60; for all). This parameter no longer does anything, and is deprecated.
5771
5771
  * @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
5772
5772
  * @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type &#x60;friendRequest&#x60;.
5773
5773
  * @param {string} [after] Only return notifications sent after this Date. Ignored if type is &#x60;friendRequest&#x60;.
@@ -7091,10 +7091,11 @@ exports.UsersApiAxiosParamCreator = function (configuration) {
7091
7091
  });
7092
7092
  },
7093
7093
  /**
7094
- * Get public user information about a specific user using their name.
7094
+ * ~~Get public user information about a specific user using their name.~~ **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). This endpoint now require Admin Credentials.
7095
7095
  * @summary Get User by Username
7096
7096
  * @param {string} username
7097
7097
  * @param {*} [options] Override http request option.
7098
+ * @deprecated
7098
7099
  * @throws {RequiredError}
7099
7100
  */
7100
7101
  getUserByName: function (username, options) {
@@ -7240,10 +7241,11 @@ exports.UsersApiFp = function (configuration) {
7240
7241
  });
7241
7242
  },
7242
7243
  /**
7243
- * Get public user information about a specific user using their name.
7244
+ * ~~Get public user information about a specific user using their name.~~ **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). This endpoint now require Admin Credentials.
7244
7245
  * @summary Get User by Username
7245
7246
  * @param {string} username
7246
7247
  * @param {*} [options] Override http request option.
7248
+ * @deprecated
7247
7249
  * @throws {RequiredError}
7248
7250
  */
7249
7251
  getUserByName: function (username, options) {
@@ -7323,10 +7325,11 @@ exports.UsersApiFactory = function (configuration, basePath, axios) {
7323
7325
  return localVarFp.getUser(userId, options).then(function (request) { return request(axios, basePath); });
7324
7326
  },
7325
7327
  /**
7326
- * Get public user information about a specific user using their name.
7328
+ * ~~Get public user information about a specific user using their name.~~ **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). This endpoint now require Admin Credentials.
7327
7329
  * @summary Get User by Username
7328
7330
  * @param {string} username
7329
7331
  * @param {*} [options] Override http request option.
7332
+ * @deprecated
7330
7333
  * @throws {RequiredError}
7331
7334
  */
7332
7335
  getUserByName: function (username, options) {
@@ -7382,10 +7385,11 @@ var UsersApi = /** @class */ (function (_super) {
7382
7385
  return exports.UsersApiFp(this.configuration).getUser(userId, options).then(function (request) { return request(_this.axios, _this.basePath); });
7383
7386
  };
7384
7387
  /**
7385
- * Get public user information about a specific user using their name.
7388
+ * ~~Get public user information about a specific user using their name.~~ **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). This endpoint now require Admin Credentials.
7386
7389
  * @summary Get User by Username
7387
7390
  * @param {string} username
7388
7391
  * @param {*} [options] Override http request option.
7392
+ * @deprecated
7389
7393
  * @throws {RequiredError}
7390
7394
  * @memberof UsersApi
7391
7395
  */
@@ -7744,7 +7748,7 @@ exports.WorldsApiAxiosParamCreator = function (configuration) {
7744
7748
  });
7745
7749
  },
7746
7750
  /**
7747
- * Get information about a specific World.
7751
+ * Get information about a specific World. Works unauthenticated but when so will always return `0` for certain fields.
7748
7752
  * @summary Get World by ID
7749
7753
  * @param {string} worldId
7750
7754
  * @param {*} [options] Override http request option.
@@ -8227,7 +8231,7 @@ exports.WorldsApiFp = function (configuration) {
8227
8231
  });
8228
8232
  },
8229
8233
  /**
8230
- * Get information about a specific World.
8234
+ * Get information about a specific World. Works unauthenticated but when so will always return `0` for certain fields.
8231
8235
  * @summary Get World by ID
8232
8236
  * @param {string} worldId
8233
8237
  * @param {*} [options] Override http request option.
@@ -8497,7 +8501,7 @@ exports.WorldsApiFactory = function (configuration, basePath, axios) {
8497
8501
  return localVarFp.getRecentWorlds(featured, sort, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, userId, options).then(function (request) { return request(axios, basePath); });
8498
8502
  },
8499
8503
  /**
8500
- * Get information about a specific World.
8504
+ * Get information about a specific World. Works unauthenticated but when so will always return `0` for certain fields.
8501
8505
  * @summary Get World by ID
8502
8506
  * @param {string} worldId
8503
8507
  * @param {*} [options] Override http request option.
@@ -8701,7 +8705,7 @@ var WorldsApi = /** @class */ (function (_super) {
8701
8705
  return exports.WorldsApiFp(this.configuration).getRecentWorlds(featured, sort, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, userId, options).then(function (request) { return request(_this.axios, _this.basePath); });
8702
8706
  };
8703
8707
  /**
8704
- * Get information about a specific World.
8708
+ * Get information about a specific World. Works unauthenticated but when so will always return `0` for certain fields.
8705
8709
  * @summary Get World by ID
8706
8710
  * @param {string} worldId
8707
8711
  * @param {*} [options] Override http request option.
package/dist/base.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * VRChat API Documentation
3
3
  *
4
- * The version of the OpenAPI document: 1.7.6
4
+ * The version of the OpenAPI document: 1.8.0
5
5
  * Contact: me@ariesclark.com
6
6
  *
7
7
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/base.js CHANGED
@@ -4,7 +4,7 @@
4
4
  /**
5
5
  * VRChat API Documentation
6
6
  *
7
- * The version of the OpenAPI document: 1.7.6
7
+ * The version of the OpenAPI document: 1.8.0
8
8
  * Contact: me@ariesclark.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * VRChat API Documentation
3
3
  *
4
- * The version of the OpenAPI document: 1.7.6
4
+ * The version of the OpenAPI document: 1.8.0
5
5
  * Contact: me@ariesclark.com
6
6
  *
7
7
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.js CHANGED
@@ -4,7 +4,7 @@
4
4
  /**
5
5
  * VRChat API Documentation
6
6
  *
7
- * The version of the OpenAPI document: 1.7.6
7
+ * The version of the OpenAPI document: 1.8.0
8
8
  * Contact: me@ariesclark.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * VRChat API Documentation
3
3
  *
4
- * The version of the OpenAPI document: 1.7.6
4
+ * The version of the OpenAPI document: 1.8.0
5
5
  * Contact: me@ariesclark.com
6
6
  *
7
7
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  /**
5
5
  * VRChat API Documentation
6
6
  *
7
- * The version of the OpenAPI document: 1.7.6
7
+ * The version of the OpenAPI document: 1.8.0
8
8
  * Contact: me@ariesclark.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * VRChat API Documentation
3
3
  *
4
- * The version of the OpenAPI document: 1.7.6
4
+ * The version of the OpenAPI document: 1.8.0
5
5
  * Contact: me@ariesclark.com
6
6
  *
7
7
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.js CHANGED
@@ -4,7 +4,7 @@
4
4
  /**
5
5
  * VRChat API Documentation
6
6
  *
7
- * The version of the OpenAPI document: 1.7.6
7
+ * The version of the OpenAPI document: 1.8.0
8
8
  * Contact: me@ariesclark.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/index.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  /**
4
4
  * VRChat API Documentation
5
5
  *
6
- * The version of the OpenAPI document: 1.7.6
6
+ * The version of the OpenAPI document: 1.8.0
7
7
  * Contact: me@ariesclark.com
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vrchat",
3
- "version": "1.7.6",
3
+ "version": "1.8.0",
4
4
  "description": "🟡🔵 VRChat API Library for JavaScript and TypeScript",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [