vrchat 1.19.3 → 1.19.4
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 +994 -937
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/cookies_load.js +21 -5
- package/cookies_store.js +16 -6
- package/dist/api.d.ts +457 -429
- package/dist/api.js +1109 -1066
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* VRChat API Documentation
|
|
3
3
|
*
|
|
4
|
-
* The version of the OpenAPI document: 1.19.
|
|
4
|
+
* The version of the OpenAPI document: 1.19.4
|
|
5
5
|
* Contact: vrchatapi.lpv0t@aries.fyi
|
|
6
6
|
*
|
|
7
7
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -9146,6 +9146,19 @@ export interface UpdateGroupMemberRequest {
|
|
|
9146
9146
|
*/
|
|
9147
9147
|
'managerNotes'?: string;
|
|
9148
9148
|
}
|
|
9149
|
+
/**
|
|
9150
|
+
*
|
|
9151
|
+
* @export
|
|
9152
|
+
* @interface UpdateGroupRepresentationRequest
|
|
9153
|
+
*/
|
|
9154
|
+
export interface UpdateGroupRepresentationRequest {
|
|
9155
|
+
/**
|
|
9156
|
+
* Whether the user is representing the group.
|
|
9157
|
+
* @type {boolean}
|
|
9158
|
+
* @memberof UpdateGroupRepresentationRequest
|
|
9159
|
+
*/
|
|
9160
|
+
'isRepresenting': boolean;
|
|
9161
|
+
}
|
|
9149
9162
|
/**
|
|
9150
9163
|
*
|
|
9151
9164
|
* @export
|
|
@@ -10952,6 +10965,7 @@ export declare const AvatarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
10952
10965
|
* @summary Select Fallback Avatar
|
|
10953
10966
|
* @param {string} avatarId Must be a valid avatar ID.
|
|
10954
10967
|
* @param {*} [options] Override http request option.
|
|
10968
|
+
* @deprecated
|
|
10955
10969
|
* @throws {RequiredError}
|
|
10956
10970
|
*/
|
|
10957
10971
|
selectFallbackAvatar: (avatarId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -11087,6 +11101,7 @@ export declare const AvatarsApiFp: (configuration?: Configuration) => {
|
|
|
11087
11101
|
* @summary Select Fallback Avatar
|
|
11088
11102
|
* @param {string} avatarId Must be a valid avatar ID.
|
|
11089
11103
|
* @param {*} [options] Override http request option.
|
|
11104
|
+
* @deprecated
|
|
11090
11105
|
* @throws {RequiredError}
|
|
11091
11106
|
*/
|
|
11092
11107
|
selectFallbackAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>>;
|
|
@@ -11222,6 +11237,7 @@ export declare const AvatarsApiFactory: (configuration?: Configuration, basePath
|
|
|
11222
11237
|
* @summary Select Fallback Avatar
|
|
11223
11238
|
* @param {string} avatarId Must be a valid avatar ID.
|
|
11224
11239
|
* @param {*} [options] Override http request option.
|
|
11240
|
+
* @deprecated
|
|
11225
11241
|
* @throws {RequiredError}
|
|
11226
11242
|
*/
|
|
11227
11243
|
selectFallbackAvatar(avatarId: string, options?: any): AxiosPromise<CurrentUser>;
|
|
@@ -11370,6 +11386,7 @@ export declare class AvatarsApi extends BaseAPI {
|
|
|
11370
11386
|
* @summary Select Fallback Avatar
|
|
11371
11387
|
* @param {string} avatarId Must be a valid avatar ID.
|
|
11372
11388
|
* @param {*} [options] Override http request option.
|
|
11389
|
+
* @deprecated
|
|
11373
11390
|
* @throws {RequiredError}
|
|
11374
11391
|
* @memberof AvatarsApi
|
|
11375
11392
|
*/
|
|
@@ -13359,6 +13376,15 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
13359
13376
|
* @throws {RequiredError}
|
|
13360
13377
|
*/
|
|
13361
13378
|
updateGroupPost: (groupId: string, notificationId: string, createGroupPostRequest: CreateGroupPostRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13379
|
+
/**
|
|
13380
|
+
* Updates whether the user is representing the group. When `isRepresenting` is set to `true`, this flag will be set to `false` for all other groups
|
|
13381
|
+
* @summary Update Group Representation
|
|
13382
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13383
|
+
* @param {UpdateGroupRepresentationRequest} updateGroupRepresentationRequest
|
|
13384
|
+
* @param {*} [options] Override http request option.
|
|
13385
|
+
* @throws {RequiredError}
|
|
13386
|
+
*/
|
|
13387
|
+
updateGroupRepresentation: (groupId: string, updateGroupRepresentationRequest: UpdateGroupRepresentationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13362
13388
|
/**
|
|
13363
13389
|
* Updates a group role by ID.
|
|
13364
13390
|
* @summary Update Group Role
|
|
@@ -13770,6 +13796,15 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
|
|
|
13770
13796
|
* @throws {RequiredError}
|
|
13771
13797
|
*/
|
|
13772
13798
|
updateGroupPost(groupId: string, notificationId: string, createGroupPostRequest: CreateGroupPostRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupPost>>;
|
|
13799
|
+
/**
|
|
13800
|
+
* Updates whether the user is representing the group. When `isRepresenting` is set to `true`, this flag will be set to `false` for all other groups
|
|
13801
|
+
* @summary Update Group Representation
|
|
13802
|
+
* @param {string} groupId Must be a valid group ID.
|
|
13803
|
+
* @param {UpdateGroupRepresentationRequest} updateGroupRepresentationRequest
|
|
13804
|
+
* @param {*} [options] Override http request option.
|
|
13805
|
+
* @throws {RequiredError}
|
|
13806
|
+
*/
|
|
13807
|
+
updateGroupRepresentation(groupId: string, updateGroupRepresentationRequest: UpdateGroupRepresentationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>>;
|
|
13773
13808
|
/**
|
|
13774
13809
|
* Updates a group role by ID.
|
|
13775
13810
|
* @summary Update Group Role
|
|
@@ -14181,6 +14216,15 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
|
|
|
14181
14216
|
* @throws {RequiredError}
|
|
14182
14217
|
*/
|
|
14183
14218
|
updateGroupPost(groupId: string, notificationId: string, createGroupPostRequest: CreateGroupPostRequest, options?: any): AxiosPromise<GroupPost>;
|
|
14219
|
+
/**
|
|
14220
|
+
* Updates whether the user is representing the group. When `isRepresenting` is set to `true`, this flag will be set to `false` for all other groups
|
|
14221
|
+
* @summary Update Group Representation
|
|
14222
|
+
* @param {string} groupId Must be a valid group ID.
|
|
14223
|
+
* @param {UpdateGroupRepresentationRequest} updateGroupRepresentationRequest
|
|
14224
|
+
* @param {*} [options] Override http request option.
|
|
14225
|
+
* @throws {RequiredError}
|
|
14226
|
+
*/
|
|
14227
|
+
updateGroupRepresentation(groupId: string, updateGroupRepresentationRequest: UpdateGroupRepresentationRequest, options?: any): AxiosPromise<Success>;
|
|
14184
14228
|
/**
|
|
14185
14229
|
* Updates a group role by ID.
|
|
14186
14230
|
* @summary Update Group Role
|
|
@@ -14636,6 +14680,16 @@ export declare class GroupsApi extends BaseAPI {
|
|
|
14636
14680
|
* @memberof GroupsApi
|
|
14637
14681
|
*/
|
|
14638
14682
|
updateGroupPost(groupId: string, notificationId: string, createGroupPostRequest: CreateGroupPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupPost, any>>;
|
|
14683
|
+
/**
|
|
14684
|
+
* Updates whether the user is representing the group. When `isRepresenting` is set to `true`, this flag will be set to `false` for all other groups
|
|
14685
|
+
* @summary Update Group Representation
|
|
14686
|
+
* @param {string} groupId Must be a valid group ID.
|
|
14687
|
+
* @param {UpdateGroupRepresentationRequest} updateGroupRepresentationRequest
|
|
14688
|
+
* @param {*} [options] Override http request option.
|
|
14689
|
+
* @throws {RequiredError}
|
|
14690
|
+
* @memberof GroupsApi
|
|
14691
|
+
*/
|
|
14692
|
+
updateGroupRepresentation(groupId: string, updateGroupRepresentationRequest: UpdateGroupRepresentationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
14639
14693
|
/**
|
|
14640
14694
|
* Updates a group role by ID.
|
|
14641
14695
|
* @summary Update Group Role
|
|
@@ -15446,257 +15500,220 @@ export declare class JamsApi extends BaseAPI {
|
|
|
15446
15500
|
getJams(type?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Jam[], any>>;
|
|
15447
15501
|
}
|
|
15448
15502
|
/**
|
|
15449
|
-
*
|
|
15503
|
+
* MiscellaneousApi - axios parameter creator
|
|
15450
15504
|
* @export
|
|
15451
15505
|
*/
|
|
15452
|
-
export declare const
|
|
15506
|
+
export declare const MiscellaneousApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15453
15507
|
/**
|
|
15454
|
-
*
|
|
15455
|
-
* @summary
|
|
15456
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15508
|
+
* Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
|
|
15509
|
+
* @summary Get Assigned Permissions
|
|
15457
15510
|
* @param {*} [options] Override http request option.
|
|
15458
15511
|
* @throws {RequiredError}
|
|
15459
15512
|
*/
|
|
15460
|
-
|
|
15513
|
+
getAssignedPermissions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15461
15514
|
/**
|
|
15462
|
-
*
|
|
15463
|
-
* @summary
|
|
15515
|
+
* Fetches the CSS code to the frontend React website.
|
|
15516
|
+
* @summary Download CSS
|
|
15517
|
+
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
15518
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
15464
15519
|
* @param {*} [options] Override http request option.
|
|
15465
15520
|
* @throws {RequiredError}
|
|
15466
15521
|
*/
|
|
15467
|
-
|
|
15522
|
+
getCSS: (variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15468
15523
|
/**
|
|
15469
|
-
*
|
|
15470
|
-
* @summary
|
|
15471
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15524
|
+
* API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
|
|
15525
|
+
* @summary Fetch API Config
|
|
15472
15526
|
* @param {*} [options] Override http request option.
|
|
15473
15527
|
* @throws {RequiredError}
|
|
15474
15528
|
*/
|
|
15475
|
-
|
|
15529
|
+
getConfig: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15476
15530
|
/**
|
|
15477
|
-
*
|
|
15478
|
-
* @summary
|
|
15479
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15531
|
+
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
15532
|
+
* @summary Current Online Users
|
|
15480
15533
|
* @param {*} [options] Override http request option.
|
|
15481
15534
|
* @throws {RequiredError}
|
|
15482
15535
|
*/
|
|
15483
|
-
|
|
15536
|
+
getCurrentOnlineUsers: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15484
15537
|
/**
|
|
15485
|
-
*
|
|
15486
|
-
* @summary
|
|
15487
|
-
* @param {string} [type] Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.
|
|
15488
|
-
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
15489
|
-
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
15490
|
-
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
15491
|
-
* @param {number} [n] The number of objects to return.
|
|
15492
|
-
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
15538
|
+
* ~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
|
|
15539
|
+
* @summary Check API Health
|
|
15493
15540
|
* @param {*} [options] Override http request option.
|
|
15541
|
+
* @deprecated
|
|
15494
15542
|
* @throws {RequiredError}
|
|
15495
15543
|
*/
|
|
15496
|
-
|
|
15544
|
+
getHealth: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15497
15545
|
/**
|
|
15498
|
-
*
|
|
15499
|
-
* @summary
|
|
15500
|
-
* @param {string}
|
|
15546
|
+
* IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an \"any of\" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an \"all of\" search.
|
|
15547
|
+
* @summary Show Information Notices
|
|
15548
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
15549
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
15501
15550
|
* @param {*} [options] Override http request option.
|
|
15502
15551
|
* @throws {RequiredError}
|
|
15503
15552
|
*/
|
|
15504
|
-
|
|
15505
|
-
};
|
|
15506
|
-
/**
|
|
15507
|
-
* NotificationsApi - functional programming interface
|
|
15508
|
-
* @export
|
|
15509
|
-
*/
|
|
15510
|
-
export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
15553
|
+
getInfoPush: (require?: string, include?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15511
15554
|
/**
|
|
15512
|
-
*
|
|
15513
|
-
* @summary
|
|
15514
|
-
* @param {
|
|
15555
|
+
* Fetches the JavaScript code to the frontend React website.
|
|
15556
|
+
* @summary Download JavaScript
|
|
15557
|
+
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
15558
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
15515
15559
|
* @param {*} [options] Override http request option.
|
|
15516
15560
|
* @throws {RequiredError}
|
|
15517
15561
|
*/
|
|
15518
|
-
|
|
15562
|
+
getJavaScript: (variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15519
15563
|
/**
|
|
15520
|
-
*
|
|
15521
|
-
* @summary
|
|
15564
|
+
* Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
|
|
15565
|
+
* @summary Get Permission
|
|
15566
|
+
* @param {string} permissionId Must be a valid permission ID.
|
|
15522
15567
|
* @param {*} [options] Override http request option.
|
|
15523
15568
|
* @throws {RequiredError}
|
|
15524
15569
|
*/
|
|
15525
|
-
|
|
15570
|
+
getPermission: (permissionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15526
15571
|
/**
|
|
15527
|
-
*
|
|
15528
|
-
* @summary
|
|
15529
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15572
|
+
* Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
|
15573
|
+
* @summary Current System Time
|
|
15530
15574
|
* @param {*} [options] Override http request option.
|
|
15531
15575
|
* @throws {RequiredError}
|
|
15532
15576
|
*/
|
|
15533
|
-
|
|
15577
|
+
getSystemTime: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15578
|
+
};
|
|
15579
|
+
/**
|
|
15580
|
+
* MiscellaneousApi - functional programming interface
|
|
15581
|
+
* @export
|
|
15582
|
+
*/
|
|
15583
|
+
export declare const MiscellaneousApiFp: (configuration?: Configuration) => {
|
|
15534
15584
|
/**
|
|
15535
|
-
*
|
|
15536
|
-
* @summary
|
|
15537
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15585
|
+
* Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
|
|
15586
|
+
* @summary Get Assigned Permissions
|
|
15538
15587
|
* @param {*} [options] Override http request option.
|
|
15539
15588
|
* @throws {RequiredError}
|
|
15540
15589
|
*/
|
|
15541
|
-
|
|
15590
|
+
getAssignedPermissions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Permission>>>;
|
|
15542
15591
|
/**
|
|
15543
|
-
*
|
|
15544
|
-
* @summary
|
|
15545
|
-
* @param {
|
|
15546
|
-
* @param {
|
|
15547
|
-
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
15548
|
-
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
15549
|
-
* @param {number} [n] The number of objects to return.
|
|
15550
|
-
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
15592
|
+
* Fetches the CSS code to the frontend React website.
|
|
15593
|
+
* @summary Download CSS
|
|
15594
|
+
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
15595
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
15551
15596
|
* @param {*} [options] Override http request option.
|
|
15552
15597
|
* @throws {RequiredError}
|
|
15553
15598
|
*/
|
|
15554
|
-
|
|
15599
|
+
getCSS(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
15555
15600
|
/**
|
|
15556
|
-
*
|
|
15557
|
-
* @summary
|
|
15558
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15601
|
+
* API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
|
|
15602
|
+
* @summary Fetch API Config
|
|
15559
15603
|
* @param {*} [options] Override http request option.
|
|
15560
15604
|
* @throws {RequiredError}
|
|
15561
15605
|
*/
|
|
15562
|
-
|
|
15563
|
-
};
|
|
15564
|
-
/**
|
|
15565
|
-
* NotificationsApi - factory interface
|
|
15566
|
-
* @export
|
|
15567
|
-
*/
|
|
15568
|
-
export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
15606
|
+
getConfig(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIConfig>>;
|
|
15569
15607
|
/**
|
|
15570
|
-
*
|
|
15571
|
-
* @summary
|
|
15572
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15608
|
+
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
15609
|
+
* @summary Current Online Users
|
|
15573
15610
|
* @param {*} [options] Override http request option.
|
|
15574
15611
|
* @throws {RequiredError}
|
|
15575
15612
|
*/
|
|
15576
|
-
|
|
15613
|
+
getCurrentOnlineUsers(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<number>>;
|
|
15577
15614
|
/**
|
|
15578
|
-
*
|
|
15579
|
-
* @summary
|
|
15615
|
+
* ~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
|
|
15616
|
+
* @summary Check API Health
|
|
15580
15617
|
* @param {*} [options] Override http request option.
|
|
15618
|
+
* @deprecated
|
|
15581
15619
|
* @throws {RequiredError}
|
|
15582
15620
|
*/
|
|
15583
|
-
|
|
15621
|
+
getHealth(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIHealth>>;
|
|
15584
15622
|
/**
|
|
15585
|
-
*
|
|
15586
|
-
* @summary
|
|
15587
|
-
* @param {string}
|
|
15623
|
+
* IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an \"any of\" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an \"all of\" search.
|
|
15624
|
+
* @summary Show Information Notices
|
|
15625
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
15626
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
15588
15627
|
* @param {*} [options] Override http request option.
|
|
15589
15628
|
* @throws {RequiredError}
|
|
15590
15629
|
*/
|
|
15591
|
-
|
|
15630
|
+
getInfoPush(require?: string, include?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InfoPush>>>;
|
|
15592
15631
|
/**
|
|
15593
|
-
*
|
|
15594
|
-
* @summary
|
|
15595
|
-
* @param {
|
|
15632
|
+
* Fetches the JavaScript code to the frontend React website.
|
|
15633
|
+
* @summary Download JavaScript
|
|
15634
|
+
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
15635
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
15596
15636
|
* @param {*} [options] Override http request option.
|
|
15597
15637
|
* @throws {RequiredError}
|
|
15598
15638
|
*/
|
|
15599
|
-
|
|
15639
|
+
getJavaScript(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
15600
15640
|
/**
|
|
15601
|
-
*
|
|
15602
|
-
* @summary
|
|
15603
|
-
* @param {string}
|
|
15604
|
-
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
15605
|
-
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
15606
|
-
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
15607
|
-
* @param {number} [n] The number of objects to return.
|
|
15608
|
-
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
15641
|
+
* Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
|
|
15642
|
+
* @summary Get Permission
|
|
15643
|
+
* @param {string} permissionId Must be a valid permission ID.
|
|
15609
15644
|
* @param {*} [options] Override http request option.
|
|
15610
15645
|
* @throws {RequiredError}
|
|
15611
15646
|
*/
|
|
15612
|
-
|
|
15647
|
+
getPermission(permissionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Permission>>;
|
|
15613
15648
|
/**
|
|
15614
|
-
*
|
|
15615
|
-
* @summary
|
|
15616
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15649
|
+
* Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
|
15650
|
+
* @summary Current System Time
|
|
15617
15651
|
* @param {*} [options] Override http request option.
|
|
15618
15652
|
* @throws {RequiredError}
|
|
15619
15653
|
*/
|
|
15620
|
-
|
|
15654
|
+
getSystemTime(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
15621
15655
|
};
|
|
15622
15656
|
/**
|
|
15623
|
-
*
|
|
15657
|
+
* MiscellaneousApi - factory interface
|
|
15624
15658
|
* @export
|
|
15625
|
-
* @class NotificationsApi
|
|
15626
|
-
* @extends {BaseAPI}
|
|
15627
15659
|
*/
|
|
15628
|
-
export declare
|
|
15660
|
+
export declare const MiscellaneousApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
15629
15661
|
/**
|
|
15630
|
-
*
|
|
15631
|
-
* @summary
|
|
15632
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15662
|
+
* Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
|
|
15663
|
+
* @summary Get Assigned Permissions
|
|
15633
15664
|
* @param {*} [options] Override http request option.
|
|
15634
15665
|
* @throws {RequiredError}
|
|
15635
|
-
* @memberof NotificationsApi
|
|
15636
15666
|
*/
|
|
15637
|
-
|
|
15667
|
+
getAssignedPermissions(options?: any): AxiosPromise<Array<Permission>>;
|
|
15638
15668
|
/**
|
|
15639
|
-
*
|
|
15640
|
-
* @summary
|
|
15669
|
+
* Fetches the CSS code to the frontend React website.
|
|
15670
|
+
* @summary Download CSS
|
|
15671
|
+
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
15672
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
15641
15673
|
* @param {*} [options] Override http request option.
|
|
15642
15674
|
* @throws {RequiredError}
|
|
15643
|
-
* @memberof NotificationsApi
|
|
15644
15675
|
*/
|
|
15645
|
-
|
|
15676
|
+
getCSS(variant?: 'public' | 'internal', branch?: string, options?: any): AxiosPromise<string>;
|
|
15646
15677
|
/**
|
|
15647
|
-
*
|
|
15648
|
-
* @summary
|
|
15649
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15678
|
+
* API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
|
|
15679
|
+
* @summary Fetch API Config
|
|
15650
15680
|
* @param {*} [options] Override http request option.
|
|
15651
15681
|
* @throws {RequiredError}
|
|
15652
|
-
* @memberof NotificationsApi
|
|
15653
15682
|
*/
|
|
15654
|
-
|
|
15683
|
+
getConfig(options?: any): AxiosPromise<APIConfig>;
|
|
15655
15684
|
/**
|
|
15656
|
-
*
|
|
15657
|
-
* @summary
|
|
15658
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
15685
|
+
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
15686
|
+
* @summary Current Online Users
|
|
15659
15687
|
* @param {*} [options] Override http request option.
|
|
15660
15688
|
* @throws {RequiredError}
|
|
15661
|
-
* @memberof NotificationsApi
|
|
15662
15689
|
*/
|
|
15663
|
-
|
|
15690
|
+
getCurrentOnlineUsers(options?: any): AxiosPromise<number>;
|
|
15664
15691
|
/**
|
|
15665
|
-
*
|
|
15666
|
-
* @summary
|
|
15667
|
-
* @param {string} [type] Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.
|
|
15668
|
-
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
15669
|
-
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
15670
|
-
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
15671
|
-
* @param {number} [n] The number of objects to return.
|
|
15672
|
-
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
15692
|
+
* ~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
|
|
15693
|
+
* @summary Check API Health
|
|
15673
15694
|
* @param {*} [options] Override http request option.
|
|
15695
|
+
* @deprecated
|
|
15674
15696
|
* @throws {RequiredError}
|
|
15675
|
-
* @memberof NotificationsApi
|
|
15676
15697
|
*/
|
|
15677
|
-
|
|
15698
|
+
getHealth(options?: any): AxiosPromise<APIHealth>;
|
|
15678
15699
|
/**
|
|
15679
|
-
*
|
|
15680
|
-
* @summary
|
|
15681
|
-
* @param {string}
|
|
15700
|
+
* IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an \"any of\" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an \"all of\" search.
|
|
15701
|
+
* @summary Show Information Notices
|
|
15702
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
15703
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
15682
15704
|
* @param {*} [options] Override http request option.
|
|
15683
15705
|
* @throws {RequiredError}
|
|
15684
|
-
* @memberof NotificationsApi
|
|
15685
15706
|
*/
|
|
15686
|
-
|
|
15687
|
-
}
|
|
15688
|
-
/**
|
|
15689
|
-
* PermissionsApi - axios parameter creator
|
|
15690
|
-
* @export
|
|
15691
|
-
*/
|
|
15692
|
-
export declare const PermissionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15707
|
+
getInfoPush(require?: string, include?: string, options?: any): AxiosPromise<Array<InfoPush>>;
|
|
15693
15708
|
/**
|
|
15694
|
-
*
|
|
15695
|
-
* @summary
|
|
15709
|
+
* Fetches the JavaScript code to the frontend React website.
|
|
15710
|
+
* @summary Download JavaScript
|
|
15711
|
+
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
15712
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
15696
15713
|
* @param {*} [options] Override http request option.
|
|
15697
15714
|
* @throws {RequiredError}
|
|
15698
15715
|
*/
|
|
15699
|
-
|
|
15716
|
+
getJavaScript(variant?: 'public' | 'internal', branch?: string, options?: any): AxiosPromise<string>;
|
|
15700
15717
|
/**
|
|
15701
15718
|
* Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
|
|
15702
15719
|
* @summary Get Permission
|
|
@@ -15704,74 +15721,342 @@ export declare const PermissionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
15704
15721
|
* @param {*} [options] Override http request option.
|
|
15705
15722
|
* @throws {RequiredError}
|
|
15706
15723
|
*/
|
|
15707
|
-
getPermission
|
|
15724
|
+
getPermission(permissionId: string, options?: any): AxiosPromise<Permission>;
|
|
15725
|
+
/**
|
|
15726
|
+
* Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
|
15727
|
+
* @summary Current System Time
|
|
15728
|
+
* @param {*} [options] Override http request option.
|
|
15729
|
+
* @throws {RequiredError}
|
|
15730
|
+
*/
|
|
15731
|
+
getSystemTime(options?: any): AxiosPromise<string>;
|
|
15708
15732
|
};
|
|
15709
15733
|
/**
|
|
15710
|
-
*
|
|
15734
|
+
* MiscellaneousApi - object-oriented interface
|
|
15711
15735
|
* @export
|
|
15736
|
+
* @class MiscellaneousApi
|
|
15737
|
+
* @extends {BaseAPI}
|
|
15712
15738
|
*/
|
|
15713
|
-
export declare
|
|
15739
|
+
export declare class MiscellaneousApi extends BaseAPI {
|
|
15714
15740
|
/**
|
|
15715
15741
|
* Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
|
|
15716
15742
|
* @summary Get Assigned Permissions
|
|
15717
15743
|
* @param {*} [options] Override http request option.
|
|
15718
15744
|
* @throws {RequiredError}
|
|
15745
|
+
* @memberof MiscellaneousApi
|
|
15719
15746
|
*/
|
|
15720
|
-
getAssignedPermissions(options?: AxiosRequestConfig): Promise<(axios
|
|
15747
|
+
getAssignedPermissions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Permission[], any>>;
|
|
15748
|
+
/**
|
|
15749
|
+
* Fetches the CSS code to the frontend React website.
|
|
15750
|
+
* @summary Download CSS
|
|
15751
|
+
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
15752
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
15753
|
+
* @param {*} [options] Override http request option.
|
|
15754
|
+
* @throws {RequiredError}
|
|
15755
|
+
* @memberof MiscellaneousApi
|
|
15756
|
+
*/
|
|
15757
|
+
getCSS(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
15758
|
+
/**
|
|
15759
|
+
* API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
|
|
15760
|
+
* @summary Fetch API Config
|
|
15761
|
+
* @param {*} [options] Override http request option.
|
|
15762
|
+
* @throws {RequiredError}
|
|
15763
|
+
* @memberof MiscellaneousApi
|
|
15764
|
+
*/
|
|
15765
|
+
getConfig(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<APIConfig, any>>;
|
|
15766
|
+
/**
|
|
15767
|
+
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
15768
|
+
* @summary Current Online Users
|
|
15769
|
+
* @param {*} [options] Override http request option.
|
|
15770
|
+
* @throws {RequiredError}
|
|
15771
|
+
* @memberof MiscellaneousApi
|
|
15772
|
+
*/
|
|
15773
|
+
getCurrentOnlineUsers(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<number, any>>;
|
|
15774
|
+
/**
|
|
15775
|
+
* ~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
|
|
15776
|
+
* @summary Check API Health
|
|
15777
|
+
* @param {*} [options] Override http request option.
|
|
15778
|
+
* @deprecated
|
|
15779
|
+
* @throws {RequiredError}
|
|
15780
|
+
* @memberof MiscellaneousApi
|
|
15781
|
+
*/
|
|
15782
|
+
getHealth(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<APIHealth, any>>;
|
|
15783
|
+
/**
|
|
15784
|
+
* IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an \"any of\" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an \"all of\" search.
|
|
15785
|
+
* @summary Show Information Notices
|
|
15786
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
15787
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
15788
|
+
* @param {*} [options] Override http request option.
|
|
15789
|
+
* @throws {RequiredError}
|
|
15790
|
+
* @memberof MiscellaneousApi
|
|
15791
|
+
*/
|
|
15792
|
+
getInfoPush(require?: string, include?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InfoPush[], any>>;
|
|
15793
|
+
/**
|
|
15794
|
+
* Fetches the JavaScript code to the frontend React website.
|
|
15795
|
+
* @summary Download JavaScript
|
|
15796
|
+
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
15797
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
15798
|
+
* @param {*} [options] Override http request option.
|
|
15799
|
+
* @throws {RequiredError}
|
|
15800
|
+
* @memberof MiscellaneousApi
|
|
15801
|
+
*/
|
|
15802
|
+
getJavaScript(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
15721
15803
|
/**
|
|
15722
15804
|
* Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
|
|
15723
15805
|
* @summary Get Permission
|
|
15724
15806
|
* @param {string} permissionId Must be a valid permission ID.
|
|
15725
15807
|
* @param {*} [options] Override http request option.
|
|
15726
15808
|
* @throws {RequiredError}
|
|
15809
|
+
* @memberof MiscellaneousApi
|
|
15727
15810
|
*/
|
|
15728
|
-
getPermission(permissionId: string, options?: AxiosRequestConfig): Promise<(axios
|
|
15811
|
+
getPermission(permissionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Permission, any>>;
|
|
15812
|
+
/**
|
|
15813
|
+
* Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
|
15814
|
+
* @summary Current System Time
|
|
15815
|
+
* @param {*} [options] Override http request option.
|
|
15816
|
+
* @throws {RequiredError}
|
|
15817
|
+
* @memberof MiscellaneousApi
|
|
15818
|
+
*/
|
|
15819
|
+
getSystemTime(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
15820
|
+
}
|
|
15821
|
+
/**
|
|
15822
|
+
* NotificationsApi - axios parameter creator
|
|
15823
|
+
* @export
|
|
15824
|
+
*/
|
|
15825
|
+
export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15826
|
+
/**
|
|
15827
|
+
* Accept a friend request by notification `frq_` ID. Friend requests can be found using the NotificationsAPI `getNotifications` by filtering of type `friendRequest`.
|
|
15828
|
+
* @summary Accept Friend Request
|
|
15829
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15830
|
+
* @param {*} [options] Override http request option.
|
|
15831
|
+
* @throws {RequiredError}
|
|
15832
|
+
*/
|
|
15833
|
+
acceptFriendRequest: (notificationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15834
|
+
/**
|
|
15835
|
+
* Clear **all** notifications.
|
|
15836
|
+
* @summary Clear All Notifications
|
|
15837
|
+
* @param {*} [options] Override http request option.
|
|
15838
|
+
* @throws {RequiredError}
|
|
15839
|
+
*/
|
|
15840
|
+
clearNotifications: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15841
|
+
/**
|
|
15842
|
+
* Delete a notification.
|
|
15843
|
+
* @summary Delete Notification
|
|
15844
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15845
|
+
* @param {*} [options] Override http request option.
|
|
15846
|
+
* @throws {RequiredError}
|
|
15847
|
+
*/
|
|
15848
|
+
deleteNotification: (notificationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15849
|
+
/**
|
|
15850
|
+
* Get a notification by notification `not_` ID.
|
|
15851
|
+
* @summary Show notification
|
|
15852
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15853
|
+
* @param {*} [options] Override http request option.
|
|
15854
|
+
* @throws {RequiredError}
|
|
15855
|
+
*/
|
|
15856
|
+
getNotification: (notificationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15857
|
+
/**
|
|
15858
|
+
* Retrieve all of the current user\'s notifications.
|
|
15859
|
+
* @summary List Notifications
|
|
15860
|
+
* @param {string} [type] Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.
|
|
15861
|
+
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
15862
|
+
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
15863
|
+
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
15864
|
+
* @param {number} [n] The number of objects to return.
|
|
15865
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
15866
|
+
* @param {*} [options] Override http request option.
|
|
15867
|
+
* @throws {RequiredError}
|
|
15868
|
+
*/
|
|
15869
|
+
getNotifications: (type?: string, sent?: boolean, hidden?: boolean, after?: string, n?: number, offset?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15870
|
+
/**
|
|
15871
|
+
* Mark a notification as seen.
|
|
15872
|
+
* @summary Mark Notification As Read
|
|
15873
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15874
|
+
* @param {*} [options] Override http request option.
|
|
15875
|
+
* @throws {RequiredError}
|
|
15876
|
+
*/
|
|
15877
|
+
markNotificationAsRead: (notificationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15729
15878
|
};
|
|
15730
15879
|
/**
|
|
15731
|
-
*
|
|
15880
|
+
* NotificationsApi - functional programming interface
|
|
15732
15881
|
* @export
|
|
15733
15882
|
*/
|
|
15734
|
-
export declare const
|
|
15883
|
+
export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
15735
15884
|
/**
|
|
15736
|
-
*
|
|
15737
|
-
* @summary
|
|
15885
|
+
* Accept a friend request by notification `frq_` ID. Friend requests can be found using the NotificationsAPI `getNotifications` by filtering of type `friendRequest`.
|
|
15886
|
+
* @summary Accept Friend Request
|
|
15887
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15738
15888
|
* @param {*} [options] Override http request option.
|
|
15739
15889
|
* @throws {RequiredError}
|
|
15740
15890
|
*/
|
|
15741
|
-
|
|
15891
|
+
acceptFriendRequest(notificationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>>;
|
|
15742
15892
|
/**
|
|
15743
|
-
*
|
|
15744
|
-
* @summary
|
|
15745
|
-
* @param {string} permissionId Must be a valid permission ID.
|
|
15893
|
+
* Clear **all** notifications.
|
|
15894
|
+
* @summary Clear All Notifications
|
|
15746
15895
|
* @param {*} [options] Override http request option.
|
|
15747
15896
|
* @throws {RequiredError}
|
|
15748
15897
|
*/
|
|
15749
|
-
|
|
15898
|
+
clearNotifications(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>>;
|
|
15899
|
+
/**
|
|
15900
|
+
* Delete a notification.
|
|
15901
|
+
* @summary Delete Notification
|
|
15902
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15903
|
+
* @param {*} [options] Override http request option.
|
|
15904
|
+
* @throws {RequiredError}
|
|
15905
|
+
*/
|
|
15906
|
+
deleteNotification(notificationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
|
|
15907
|
+
/**
|
|
15908
|
+
* Get a notification by notification `not_` ID.
|
|
15909
|
+
* @summary Show notification
|
|
15910
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15911
|
+
* @param {*} [options] Override http request option.
|
|
15912
|
+
* @throws {RequiredError}
|
|
15913
|
+
*/
|
|
15914
|
+
getNotification(notificationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
|
|
15915
|
+
/**
|
|
15916
|
+
* Retrieve all of the current user\'s notifications.
|
|
15917
|
+
* @summary List Notifications
|
|
15918
|
+
* @param {string} [type] Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.
|
|
15919
|
+
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
15920
|
+
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
15921
|
+
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
15922
|
+
* @param {number} [n] The number of objects to return.
|
|
15923
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
15924
|
+
* @param {*} [options] Override http request option.
|
|
15925
|
+
* @throws {RequiredError}
|
|
15926
|
+
*/
|
|
15927
|
+
getNotifications(type?: string, sent?: boolean, hidden?: boolean, after?: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Notification>>>;
|
|
15928
|
+
/**
|
|
15929
|
+
* Mark a notification as seen.
|
|
15930
|
+
* @summary Mark Notification As Read
|
|
15931
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15932
|
+
* @param {*} [options] Override http request option.
|
|
15933
|
+
* @throws {RequiredError}
|
|
15934
|
+
*/
|
|
15935
|
+
markNotificationAsRead(notificationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
|
|
15750
15936
|
};
|
|
15751
15937
|
/**
|
|
15752
|
-
*
|
|
15938
|
+
* NotificationsApi - factory interface
|
|
15753
15939
|
* @export
|
|
15754
|
-
|
|
15940
|
+
*/
|
|
15941
|
+
export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
15942
|
+
/**
|
|
15943
|
+
* Accept a friend request by notification `frq_` ID. Friend requests can be found using the NotificationsAPI `getNotifications` by filtering of type `friendRequest`.
|
|
15944
|
+
* @summary Accept Friend Request
|
|
15945
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15946
|
+
* @param {*} [options] Override http request option.
|
|
15947
|
+
* @throws {RequiredError}
|
|
15948
|
+
*/
|
|
15949
|
+
acceptFriendRequest(notificationId: string, options?: any): AxiosPromise<Success>;
|
|
15950
|
+
/**
|
|
15951
|
+
* Clear **all** notifications.
|
|
15952
|
+
* @summary Clear All Notifications
|
|
15953
|
+
* @param {*} [options] Override http request option.
|
|
15954
|
+
* @throws {RequiredError}
|
|
15955
|
+
*/
|
|
15956
|
+
clearNotifications(options?: any): AxiosPromise<Success>;
|
|
15957
|
+
/**
|
|
15958
|
+
* Delete a notification.
|
|
15959
|
+
* @summary Delete Notification
|
|
15960
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15961
|
+
* @param {*} [options] Override http request option.
|
|
15962
|
+
* @throws {RequiredError}
|
|
15963
|
+
*/
|
|
15964
|
+
deleteNotification(notificationId: string, options?: any): AxiosPromise<Notification>;
|
|
15965
|
+
/**
|
|
15966
|
+
* Get a notification by notification `not_` ID.
|
|
15967
|
+
* @summary Show notification
|
|
15968
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15969
|
+
* @param {*} [options] Override http request option.
|
|
15970
|
+
* @throws {RequiredError}
|
|
15971
|
+
*/
|
|
15972
|
+
getNotification(notificationId: string, options?: any): AxiosPromise<Notification>;
|
|
15973
|
+
/**
|
|
15974
|
+
* Retrieve all of the current user\'s notifications.
|
|
15975
|
+
* @summary List Notifications
|
|
15976
|
+
* @param {string} [type] Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.
|
|
15977
|
+
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
15978
|
+
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
15979
|
+
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
15980
|
+
* @param {number} [n] The number of objects to return.
|
|
15981
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
15982
|
+
* @param {*} [options] Override http request option.
|
|
15983
|
+
* @throws {RequiredError}
|
|
15984
|
+
*/
|
|
15985
|
+
getNotifications(type?: string, sent?: boolean, hidden?: boolean, after?: string, n?: number, offset?: number, options?: any): AxiosPromise<Array<Notification>>;
|
|
15986
|
+
/**
|
|
15987
|
+
* Mark a notification as seen.
|
|
15988
|
+
* @summary Mark Notification As Read
|
|
15989
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15990
|
+
* @param {*} [options] Override http request option.
|
|
15991
|
+
* @throws {RequiredError}
|
|
15992
|
+
*/
|
|
15993
|
+
markNotificationAsRead(notificationId: string, options?: any): AxiosPromise<Notification>;
|
|
15994
|
+
};
|
|
15995
|
+
/**
|
|
15996
|
+
* NotificationsApi - object-oriented interface
|
|
15997
|
+
* @export
|
|
15998
|
+
* @class NotificationsApi
|
|
15755
15999
|
* @extends {BaseAPI}
|
|
15756
16000
|
*/
|
|
15757
|
-
export declare class
|
|
16001
|
+
export declare class NotificationsApi extends BaseAPI {
|
|
15758
16002
|
/**
|
|
15759
|
-
*
|
|
15760
|
-
* @summary
|
|
16003
|
+
* Accept a friend request by notification `frq_` ID. Friend requests can be found using the NotificationsAPI `getNotifications` by filtering of type `friendRequest`.
|
|
16004
|
+
* @summary Accept Friend Request
|
|
16005
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
16006
|
+
* @param {*} [options] Override http request option.
|
|
16007
|
+
* @throws {RequiredError}
|
|
16008
|
+
* @memberof NotificationsApi
|
|
16009
|
+
*/
|
|
16010
|
+
acceptFriendRequest(notificationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
16011
|
+
/**
|
|
16012
|
+
* Clear **all** notifications.
|
|
16013
|
+
* @summary Clear All Notifications
|
|
16014
|
+
* @param {*} [options] Override http request option.
|
|
16015
|
+
* @throws {RequiredError}
|
|
16016
|
+
* @memberof NotificationsApi
|
|
16017
|
+
*/
|
|
16018
|
+
clearNotifications(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
16019
|
+
/**
|
|
16020
|
+
* Delete a notification.
|
|
16021
|
+
* @summary Delete Notification
|
|
16022
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
16023
|
+
* @param {*} [options] Override http request option.
|
|
16024
|
+
* @throws {RequiredError}
|
|
16025
|
+
* @memberof NotificationsApi
|
|
16026
|
+
*/
|
|
16027
|
+
deleteNotification(notificationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification, any>>;
|
|
16028
|
+
/**
|
|
16029
|
+
* Get a notification by notification `not_` ID.
|
|
16030
|
+
* @summary Show notification
|
|
16031
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
16032
|
+
* @param {*} [options] Override http request option.
|
|
16033
|
+
* @throws {RequiredError}
|
|
16034
|
+
* @memberof NotificationsApi
|
|
16035
|
+
*/
|
|
16036
|
+
getNotification(notificationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification, any>>;
|
|
16037
|
+
/**
|
|
16038
|
+
* Retrieve all of the current user\'s notifications.
|
|
16039
|
+
* @summary List Notifications
|
|
16040
|
+
* @param {string} [type] Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.
|
|
16041
|
+
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
16042
|
+
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
16043
|
+
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
16044
|
+
* @param {number} [n] The number of objects to return.
|
|
16045
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
15761
16046
|
* @param {*} [options] Override http request option.
|
|
15762
16047
|
* @throws {RequiredError}
|
|
15763
|
-
* @memberof
|
|
16048
|
+
* @memberof NotificationsApi
|
|
15764
16049
|
*/
|
|
15765
|
-
|
|
16050
|
+
getNotifications(type?: string, sent?: boolean, hidden?: boolean, after?: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification[], any>>;
|
|
15766
16051
|
/**
|
|
15767
|
-
*
|
|
15768
|
-
* @summary
|
|
15769
|
-
* @param {string}
|
|
16052
|
+
* Mark a notification as seen.
|
|
16053
|
+
* @summary Mark Notification As Read
|
|
16054
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
15770
16055
|
* @param {*} [options] Override http request option.
|
|
15771
16056
|
* @throws {RequiredError}
|
|
15772
|
-
* @memberof
|
|
16057
|
+
* @memberof NotificationsApi
|
|
15773
16058
|
*/
|
|
15774
|
-
|
|
16059
|
+
markNotificationAsRead(notificationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification, any>>;
|
|
15775
16060
|
}
|
|
15776
16061
|
/**
|
|
15777
16062
|
* PlayermoderationApi - axios parameter creator
|
|
@@ -16146,263 +16431,6 @@ export declare class PrintsApi extends BaseAPI {
|
|
|
16146
16431
|
*/
|
|
16147
16432
|
uploadPrint(image: File, timestamp: string, note?: string, worldId?: string, worldName?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Print, any>>;
|
|
16148
16433
|
}
|
|
16149
|
-
/**
|
|
16150
|
-
* SystemApi - axios parameter creator
|
|
16151
|
-
* @export
|
|
16152
|
-
*/
|
|
16153
|
-
export declare const SystemApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
16154
|
-
/**
|
|
16155
|
-
* Fetches the CSS code to the frontend React website.
|
|
16156
|
-
* @summary Download CSS
|
|
16157
|
-
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
16158
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
16159
|
-
* @param {*} [options] Override http request option.
|
|
16160
|
-
* @throws {RequiredError}
|
|
16161
|
-
*/
|
|
16162
|
-
getCSS: (variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16163
|
-
/**
|
|
16164
|
-
* API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
|
|
16165
|
-
* @summary Fetch API Config
|
|
16166
|
-
* @param {*} [options] Override http request option.
|
|
16167
|
-
* @throws {RequiredError}
|
|
16168
|
-
*/
|
|
16169
|
-
getConfig: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16170
|
-
/**
|
|
16171
|
-
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
16172
|
-
* @summary Current Online Users
|
|
16173
|
-
* @param {*} [options] Override http request option.
|
|
16174
|
-
* @throws {RequiredError}
|
|
16175
|
-
*/
|
|
16176
|
-
getCurrentOnlineUsers: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16177
|
-
/**
|
|
16178
|
-
* ~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
|
|
16179
|
-
* @summary Check API Health
|
|
16180
|
-
* @param {*} [options] Override http request option.
|
|
16181
|
-
* @deprecated
|
|
16182
|
-
* @throws {RequiredError}
|
|
16183
|
-
*/
|
|
16184
|
-
getHealth: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16185
|
-
/**
|
|
16186
|
-
* IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an \"any of\" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an \"all of\" search.
|
|
16187
|
-
* @summary Show Information Notices
|
|
16188
|
-
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
16189
|
-
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
16190
|
-
* @param {*} [options] Override http request option.
|
|
16191
|
-
* @throws {RequiredError}
|
|
16192
|
-
*/
|
|
16193
|
-
getInfoPush: (require?: string, include?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16194
|
-
/**
|
|
16195
|
-
* Fetches the JavaScript code to the frontend React website.
|
|
16196
|
-
* @summary Download JavaScript
|
|
16197
|
-
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
16198
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
16199
|
-
* @param {*} [options] Override http request option.
|
|
16200
|
-
* @throws {RequiredError}
|
|
16201
|
-
*/
|
|
16202
|
-
getJavaScript: (variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16203
|
-
/**
|
|
16204
|
-
* Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
|
16205
|
-
* @summary Current System Time
|
|
16206
|
-
* @param {*} [options] Override http request option.
|
|
16207
|
-
* @throws {RequiredError}
|
|
16208
|
-
*/
|
|
16209
|
-
getSystemTime: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16210
|
-
};
|
|
16211
|
-
/**
|
|
16212
|
-
* SystemApi - functional programming interface
|
|
16213
|
-
* @export
|
|
16214
|
-
*/
|
|
16215
|
-
export declare const SystemApiFp: (configuration?: Configuration) => {
|
|
16216
|
-
/**
|
|
16217
|
-
* Fetches the CSS code to the frontend React website.
|
|
16218
|
-
* @summary Download CSS
|
|
16219
|
-
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
16220
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
16221
|
-
* @param {*} [options] Override http request option.
|
|
16222
|
-
* @throws {RequiredError}
|
|
16223
|
-
*/
|
|
16224
|
-
getCSS(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
16225
|
-
/**
|
|
16226
|
-
* API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
|
|
16227
|
-
* @summary Fetch API Config
|
|
16228
|
-
* @param {*} [options] Override http request option.
|
|
16229
|
-
* @throws {RequiredError}
|
|
16230
|
-
*/
|
|
16231
|
-
getConfig(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIConfig>>;
|
|
16232
|
-
/**
|
|
16233
|
-
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
16234
|
-
* @summary Current Online Users
|
|
16235
|
-
* @param {*} [options] Override http request option.
|
|
16236
|
-
* @throws {RequiredError}
|
|
16237
|
-
*/
|
|
16238
|
-
getCurrentOnlineUsers(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<number>>;
|
|
16239
|
-
/**
|
|
16240
|
-
* ~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
|
|
16241
|
-
* @summary Check API Health
|
|
16242
|
-
* @param {*} [options] Override http request option.
|
|
16243
|
-
* @deprecated
|
|
16244
|
-
* @throws {RequiredError}
|
|
16245
|
-
*/
|
|
16246
|
-
getHealth(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIHealth>>;
|
|
16247
|
-
/**
|
|
16248
|
-
* IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an \"any of\" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an \"all of\" search.
|
|
16249
|
-
* @summary Show Information Notices
|
|
16250
|
-
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
16251
|
-
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
16252
|
-
* @param {*} [options] Override http request option.
|
|
16253
|
-
* @throws {RequiredError}
|
|
16254
|
-
*/
|
|
16255
|
-
getInfoPush(require?: string, include?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InfoPush>>>;
|
|
16256
|
-
/**
|
|
16257
|
-
* Fetches the JavaScript code to the frontend React website.
|
|
16258
|
-
* @summary Download JavaScript
|
|
16259
|
-
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
16260
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
16261
|
-
* @param {*} [options] Override http request option.
|
|
16262
|
-
* @throws {RequiredError}
|
|
16263
|
-
*/
|
|
16264
|
-
getJavaScript(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
16265
|
-
/**
|
|
16266
|
-
* Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
|
16267
|
-
* @summary Current System Time
|
|
16268
|
-
* @param {*} [options] Override http request option.
|
|
16269
|
-
* @throws {RequiredError}
|
|
16270
|
-
*/
|
|
16271
|
-
getSystemTime(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
16272
|
-
};
|
|
16273
|
-
/**
|
|
16274
|
-
* SystemApi - factory interface
|
|
16275
|
-
* @export
|
|
16276
|
-
*/
|
|
16277
|
-
export declare const SystemApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
16278
|
-
/**
|
|
16279
|
-
* Fetches the CSS code to the frontend React website.
|
|
16280
|
-
* @summary Download CSS
|
|
16281
|
-
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
16282
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
16283
|
-
* @param {*} [options] Override http request option.
|
|
16284
|
-
* @throws {RequiredError}
|
|
16285
|
-
*/
|
|
16286
|
-
getCSS(variant?: 'public' | 'internal', branch?: string, options?: any): AxiosPromise<string>;
|
|
16287
|
-
/**
|
|
16288
|
-
* API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
|
|
16289
|
-
* @summary Fetch API Config
|
|
16290
|
-
* @param {*} [options] Override http request option.
|
|
16291
|
-
* @throws {RequiredError}
|
|
16292
|
-
*/
|
|
16293
|
-
getConfig(options?: any): AxiosPromise<APIConfig>;
|
|
16294
|
-
/**
|
|
16295
|
-
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
16296
|
-
* @summary Current Online Users
|
|
16297
|
-
* @param {*} [options] Override http request option.
|
|
16298
|
-
* @throws {RequiredError}
|
|
16299
|
-
*/
|
|
16300
|
-
getCurrentOnlineUsers(options?: any): AxiosPromise<number>;
|
|
16301
|
-
/**
|
|
16302
|
-
* ~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
|
|
16303
|
-
* @summary Check API Health
|
|
16304
|
-
* @param {*} [options] Override http request option.
|
|
16305
|
-
* @deprecated
|
|
16306
|
-
* @throws {RequiredError}
|
|
16307
|
-
*/
|
|
16308
|
-
getHealth(options?: any): AxiosPromise<APIHealth>;
|
|
16309
|
-
/**
|
|
16310
|
-
* IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an \"any of\" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an \"all of\" search.
|
|
16311
|
-
* @summary Show Information Notices
|
|
16312
|
-
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
16313
|
-
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
16314
|
-
* @param {*} [options] Override http request option.
|
|
16315
|
-
* @throws {RequiredError}
|
|
16316
|
-
*/
|
|
16317
|
-
getInfoPush(require?: string, include?: string, options?: any): AxiosPromise<Array<InfoPush>>;
|
|
16318
|
-
/**
|
|
16319
|
-
* Fetches the JavaScript code to the frontend React website.
|
|
16320
|
-
* @summary Download JavaScript
|
|
16321
|
-
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
16322
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
16323
|
-
* @param {*} [options] Override http request option.
|
|
16324
|
-
* @throws {RequiredError}
|
|
16325
|
-
*/
|
|
16326
|
-
getJavaScript(variant?: 'public' | 'internal', branch?: string, options?: any): AxiosPromise<string>;
|
|
16327
|
-
/**
|
|
16328
|
-
* Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
|
16329
|
-
* @summary Current System Time
|
|
16330
|
-
* @param {*} [options] Override http request option.
|
|
16331
|
-
* @throws {RequiredError}
|
|
16332
|
-
*/
|
|
16333
|
-
getSystemTime(options?: any): AxiosPromise<string>;
|
|
16334
|
-
};
|
|
16335
|
-
/**
|
|
16336
|
-
* SystemApi - object-oriented interface
|
|
16337
|
-
* @export
|
|
16338
|
-
* @class SystemApi
|
|
16339
|
-
* @extends {BaseAPI}
|
|
16340
|
-
*/
|
|
16341
|
-
export declare class SystemApi extends BaseAPI {
|
|
16342
|
-
/**
|
|
16343
|
-
* Fetches the CSS code to the frontend React website.
|
|
16344
|
-
* @summary Download CSS
|
|
16345
|
-
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
16346
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
16347
|
-
* @param {*} [options] Override http request option.
|
|
16348
|
-
* @throws {RequiredError}
|
|
16349
|
-
* @memberof SystemApi
|
|
16350
|
-
*/
|
|
16351
|
-
getCSS(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
16352
|
-
/**
|
|
16353
|
-
* API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
|
|
16354
|
-
* @summary Fetch API Config
|
|
16355
|
-
* @param {*} [options] Override http request option.
|
|
16356
|
-
* @throws {RequiredError}
|
|
16357
|
-
* @memberof SystemApi
|
|
16358
|
-
*/
|
|
16359
|
-
getConfig(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<APIConfig, any>>;
|
|
16360
|
-
/**
|
|
16361
|
-
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
16362
|
-
* @summary Current Online Users
|
|
16363
|
-
* @param {*} [options] Override http request option.
|
|
16364
|
-
* @throws {RequiredError}
|
|
16365
|
-
* @memberof SystemApi
|
|
16366
|
-
*/
|
|
16367
|
-
getCurrentOnlineUsers(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<number, any>>;
|
|
16368
|
-
/**
|
|
16369
|
-
* ~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
|
|
16370
|
-
* @summary Check API Health
|
|
16371
|
-
* @param {*} [options] Override http request option.
|
|
16372
|
-
* @deprecated
|
|
16373
|
-
* @throws {RequiredError}
|
|
16374
|
-
* @memberof SystemApi
|
|
16375
|
-
*/
|
|
16376
|
-
getHealth(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<APIHealth, any>>;
|
|
16377
|
-
/**
|
|
16378
|
-
* IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an \"any of\" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an \"all of\" search.
|
|
16379
|
-
* @summary Show Information Notices
|
|
16380
|
-
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
16381
|
-
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
16382
|
-
* @param {*} [options] Override http request option.
|
|
16383
|
-
* @throws {RequiredError}
|
|
16384
|
-
* @memberof SystemApi
|
|
16385
|
-
*/
|
|
16386
|
-
getInfoPush(require?: string, include?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InfoPush[], any>>;
|
|
16387
|
-
/**
|
|
16388
|
-
* Fetches the JavaScript code to the frontend React website.
|
|
16389
|
-
* @summary Download JavaScript
|
|
16390
|
-
* @param {'public' | 'internal'} [variant] Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
|
|
16391
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
16392
|
-
* @param {*} [options] Override http request option.
|
|
16393
|
-
* @throws {RequiredError}
|
|
16394
|
-
* @memberof SystemApi
|
|
16395
|
-
*/
|
|
16396
|
-
getJavaScript(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
16397
|
-
/**
|
|
16398
|
-
* Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
|
16399
|
-
* @summary Current System Time
|
|
16400
|
-
* @param {*} [options] Override http request option.
|
|
16401
|
-
* @throws {RequiredError}
|
|
16402
|
-
* @memberof SystemApi
|
|
16403
|
-
*/
|
|
16404
|
-
getSystemTime(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
16405
|
-
}
|
|
16406
16434
|
/**
|
|
16407
16435
|
* UsersApi - axios parameter creator
|
|
16408
16436
|
* @export
|