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/api.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* VRChat API Documentation
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 1.19.
|
|
6
|
+
* The version of the OpenAPI document: 1.19.4
|
|
7
7
|
* Contact: vrchatapi.lpv0t@aries.fyi
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -9288,6 +9288,19 @@ export interface UpdateGroupMemberRequest {
|
|
|
9288
9288
|
*/
|
|
9289
9289
|
'managerNotes'?: string;
|
|
9290
9290
|
}
|
|
9291
|
+
/**
|
|
9292
|
+
*
|
|
9293
|
+
* @export
|
|
9294
|
+
* @interface UpdateGroupRepresentationRequest
|
|
9295
|
+
*/
|
|
9296
|
+
export interface UpdateGroupRepresentationRequest {
|
|
9297
|
+
/**
|
|
9298
|
+
* Whether the user is representing the group.
|
|
9299
|
+
* @type {boolean}
|
|
9300
|
+
* @memberof UpdateGroupRepresentationRequest
|
|
9301
|
+
*/
|
|
9302
|
+
'isRepresenting': boolean;
|
|
9303
|
+
}
|
|
9291
9304
|
/**
|
|
9292
9305
|
*
|
|
9293
9306
|
* @export
|
|
@@ -12149,6 +12162,7 @@ export const AvatarsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
12149
12162
|
* @summary Select Fallback Avatar
|
|
12150
12163
|
* @param {string} avatarId Must be a valid avatar ID.
|
|
12151
12164
|
* @param {*} [options] Override http request option.
|
|
12165
|
+
* @deprecated
|
|
12152
12166
|
* @throws {RequiredError}
|
|
12153
12167
|
*/
|
|
12154
12168
|
selectFallbackAvatar: async (avatarId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
@@ -12380,6 +12394,7 @@ export const AvatarsApiFp = function(configuration?: Configuration) {
|
|
|
12380
12394
|
* @summary Select Fallback Avatar
|
|
12381
12395
|
* @param {string} avatarId Must be a valid avatar ID.
|
|
12382
12396
|
* @param {*} [options] Override http request option.
|
|
12397
|
+
* @deprecated
|
|
12383
12398
|
* @throws {RequiredError}
|
|
12384
12399
|
*/
|
|
12385
12400
|
async selectFallbackAvatar(avatarId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrentUser>> {
|
|
@@ -12547,6 +12562,7 @@ export const AvatarsApiFactory = function (configuration?: Configuration, basePa
|
|
|
12547
12562
|
* @summary Select Fallback Avatar
|
|
12548
12563
|
* @param {string} avatarId Must be a valid avatar ID.
|
|
12549
12564
|
* @param {*} [options] Override http request option.
|
|
12565
|
+
* @deprecated
|
|
12550
12566
|
* @throws {RequiredError}
|
|
12551
12567
|
*/
|
|
12552
12568
|
selectFallbackAvatar(avatarId: string, options?: any): AxiosPromise<CurrentUser> {
|
|
@@ -12734,6 +12750,7 @@ export class AvatarsApi extends BaseAPI {
|
|
|
12734
12750
|
* @summary Select Fallback Avatar
|
|
12735
12751
|
* @param {string} avatarId Must be a valid avatar ID.
|
|
12736
12752
|
* @param {*} [options] Override http request option.
|
|
12753
|
+
* @deprecated
|
|
12737
12754
|
* @throws {RequiredError}
|
|
12738
12755
|
* @memberof AvatarsApi
|
|
12739
12756
|
*/
|
|
@@ -17777,6 +17794,48 @@ export const GroupsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
17777
17794
|
options: localVarRequestOptions,
|
|
17778
17795
|
};
|
|
17779
17796
|
},
|
|
17797
|
+
/**
|
|
17798
|
+
* 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
|
|
17799
|
+
* @summary Update Group Representation
|
|
17800
|
+
* @param {string} groupId Must be a valid group ID.
|
|
17801
|
+
* @param {UpdateGroupRepresentationRequest} updateGroupRepresentationRequest
|
|
17802
|
+
* @param {*} [options] Override http request option.
|
|
17803
|
+
* @throws {RequiredError}
|
|
17804
|
+
*/
|
|
17805
|
+
updateGroupRepresentation: async (groupId: string, updateGroupRepresentationRequest: UpdateGroupRepresentationRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
17806
|
+
// verify required parameter 'groupId' is not null or undefined
|
|
17807
|
+
assertParamExists('updateGroupRepresentation', 'groupId', groupId)
|
|
17808
|
+
// verify required parameter 'updateGroupRepresentationRequest' is not null or undefined
|
|
17809
|
+
assertParamExists('updateGroupRepresentation', 'updateGroupRepresentationRequest', updateGroupRepresentationRequest)
|
|
17810
|
+
const localVarPath = `/groups/{groupId}/representation`
|
|
17811
|
+
.replace(`{${"groupId"}}`, encodeURIComponent(String(groupId)));
|
|
17812
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17813
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17814
|
+
let baseOptions;
|
|
17815
|
+
if (configuration) {
|
|
17816
|
+
baseOptions = configuration.baseOptions;
|
|
17817
|
+
}
|
|
17818
|
+
|
|
17819
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
17820
|
+
const localVarHeaderParameter = {} as any;
|
|
17821
|
+
const localVarQueryParameter = {} as any;
|
|
17822
|
+
|
|
17823
|
+
// authentication authCookie required
|
|
17824
|
+
|
|
17825
|
+
|
|
17826
|
+
|
|
17827
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
17828
|
+
|
|
17829
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17830
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17831
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
17832
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateGroupRepresentationRequest, localVarRequestOptions, configuration)
|
|
17833
|
+
|
|
17834
|
+
return {
|
|
17835
|
+
url: toPathString(localVarUrlObj),
|
|
17836
|
+
options: localVarRequestOptions,
|
|
17837
|
+
};
|
|
17838
|
+
},
|
|
17780
17839
|
/**
|
|
17781
17840
|
* Updates a group role by ID.
|
|
17782
17841
|
* @summary Update Group Role
|
|
@@ -18350,6 +18409,18 @@ export const GroupsApiFp = function(configuration?: Configuration) {
|
|
|
18350
18409
|
const localVarAxiosArgs = await localVarAxiosParamCreator.updateGroupPost(groupId, notificationId, createGroupPostRequest, options);
|
|
18351
18410
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
18352
18411
|
},
|
|
18412
|
+
/**
|
|
18413
|
+
* 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
|
|
18414
|
+
* @summary Update Group Representation
|
|
18415
|
+
* @param {string} groupId Must be a valid group ID.
|
|
18416
|
+
* @param {UpdateGroupRepresentationRequest} updateGroupRepresentationRequest
|
|
18417
|
+
* @param {*} [options] Override http request option.
|
|
18418
|
+
* @throws {RequiredError}
|
|
18419
|
+
*/
|
|
18420
|
+
async updateGroupRepresentation(groupId: string, updateGroupRepresentationRequest: UpdateGroupRepresentationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>> {
|
|
18421
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateGroupRepresentation(groupId, updateGroupRepresentationRequest, options);
|
|
18422
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
18423
|
+
},
|
|
18353
18424
|
/**
|
|
18354
18425
|
* Updates a group role by ID.
|
|
18355
18426
|
* @summary Update Group Role
|
|
@@ -18850,6 +18921,17 @@ export const GroupsApiFactory = function (configuration?: Configuration, basePat
|
|
|
18850
18921
|
updateGroupPost(groupId: string, notificationId: string, createGroupPostRequest: CreateGroupPostRequest, options?: any): AxiosPromise<GroupPost> {
|
|
18851
18922
|
return localVarFp.updateGroupPost(groupId, notificationId, createGroupPostRequest, options).then((request) => request(axios, basePath));
|
|
18852
18923
|
},
|
|
18924
|
+
/**
|
|
18925
|
+
* 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
|
|
18926
|
+
* @summary Update Group Representation
|
|
18927
|
+
* @param {string} groupId Must be a valid group ID.
|
|
18928
|
+
* @param {UpdateGroupRepresentationRequest} updateGroupRepresentationRequest
|
|
18929
|
+
* @param {*} [options] Override http request option.
|
|
18930
|
+
* @throws {RequiredError}
|
|
18931
|
+
*/
|
|
18932
|
+
updateGroupRepresentation(groupId: string, updateGroupRepresentationRequest: UpdateGroupRepresentationRequest, options?: any): AxiosPromise<Success> {
|
|
18933
|
+
return localVarFp.updateGroupRepresentation(groupId, updateGroupRepresentationRequest, options).then((request) => request(axios, basePath));
|
|
18934
|
+
},
|
|
18853
18935
|
/**
|
|
18854
18936
|
* Updates a group role by ID.
|
|
18855
18937
|
* @summary Update Group Role
|
|
@@ -19433,6 +19515,19 @@ export class GroupsApi extends BaseAPI {
|
|
|
19433
19515
|
return GroupsApiFp(this.configuration).updateGroupPost(groupId, notificationId, createGroupPostRequest, options).then((request) => request(this.axios, this.basePath));
|
|
19434
19516
|
}
|
|
19435
19517
|
|
|
19518
|
+
/**
|
|
19519
|
+
* 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
|
|
19520
|
+
* @summary Update Group Representation
|
|
19521
|
+
* @param {string} groupId Must be a valid group ID.
|
|
19522
|
+
* @param {UpdateGroupRepresentationRequest} updateGroupRepresentationRequest
|
|
19523
|
+
* @param {*} [options] Override http request option.
|
|
19524
|
+
* @throws {RequiredError}
|
|
19525
|
+
* @memberof GroupsApi
|
|
19526
|
+
*/
|
|
19527
|
+
public updateGroupRepresentation(groupId: string, updateGroupRepresentationRequest: UpdateGroupRepresentationRequest, options?: AxiosRequestConfig) {
|
|
19528
|
+
return GroupsApiFp(this.configuration).updateGroupRepresentation(groupId, updateGroupRepresentationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
19529
|
+
}
|
|
19530
|
+
|
|
19436
19531
|
/**
|
|
19437
19532
|
* Updates a group role by ID.
|
|
19438
19533
|
* @summary Update Group Role
|
|
@@ -21077,23 +21172,19 @@ export class JamsApi extends BaseAPI {
|
|
|
21077
21172
|
|
|
21078
21173
|
|
|
21079
21174
|
/**
|
|
21080
|
-
*
|
|
21175
|
+
* MiscellaneousApi - axios parameter creator
|
|
21081
21176
|
* @export
|
|
21082
21177
|
*/
|
|
21083
|
-
export const
|
|
21178
|
+
export const MiscellaneousApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
21084
21179
|
return {
|
|
21085
21180
|
/**
|
|
21086
|
-
*
|
|
21087
|
-
* @summary
|
|
21088
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
21181
|
+
* Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
|
|
21182
|
+
* @summary Get Assigned Permissions
|
|
21089
21183
|
* @param {*} [options] Override http request option.
|
|
21090
21184
|
* @throws {RequiredError}
|
|
21091
21185
|
*/
|
|
21092
|
-
|
|
21093
|
-
|
|
21094
|
-
assertParamExists('acceptFriendRequest', 'notificationId', notificationId)
|
|
21095
|
-
const localVarPath = `/auth/user/notifications/{notificationId}/accept`
|
|
21096
|
-
.replace(`{${"notificationId"}}`, encodeURIComponent(String(notificationId)));
|
|
21186
|
+
getAssignedPermissions: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
21187
|
+
const localVarPath = `/auth/permissions`;
|
|
21097
21188
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21098
21189
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21099
21190
|
let baseOptions;
|
|
@@ -21101,7 +21192,7 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
21101
21192
|
baseOptions = configuration.baseOptions;
|
|
21102
21193
|
}
|
|
21103
21194
|
|
|
21104
|
-
const localVarRequestOptions = { method: '
|
|
21195
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
21105
21196
|
const localVarHeaderParameter = {} as any;
|
|
21106
21197
|
const localVarQueryParameter = {} as any;
|
|
21107
21198
|
|
|
@@ -21119,13 +21210,15 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
21119
21210
|
};
|
|
21120
21211
|
},
|
|
21121
21212
|
/**
|
|
21122
|
-
*
|
|
21123
|
-
* @summary
|
|
21213
|
+
* Fetches the CSS code to the frontend React website.
|
|
21214
|
+
* @summary Download CSS
|
|
21215
|
+
* @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.
|
|
21216
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
21124
21217
|
* @param {*} [options] Override http request option.
|
|
21125
21218
|
* @throws {RequiredError}
|
|
21126
21219
|
*/
|
|
21127
|
-
|
|
21128
|
-
const localVarPath = `/
|
|
21220
|
+
getCSS: async (variant?: 'public' | 'internal', branch?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
21221
|
+
const localVarPath = `/css/app.css`;
|
|
21129
21222
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21130
21223
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21131
21224
|
let baseOptions;
|
|
@@ -21133,11 +21226,17 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
21133
21226
|
baseOptions = configuration.baseOptions;
|
|
21134
21227
|
}
|
|
21135
21228
|
|
|
21136
|
-
const localVarRequestOptions = { method: '
|
|
21229
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
21137
21230
|
const localVarHeaderParameter = {} as any;
|
|
21138
21231
|
const localVarQueryParameter = {} as any;
|
|
21139
21232
|
|
|
21140
|
-
|
|
21233
|
+
if (variant !== undefined) {
|
|
21234
|
+
localVarQueryParameter['variant'] = variant;
|
|
21235
|
+
}
|
|
21236
|
+
|
|
21237
|
+
if (branch !== undefined) {
|
|
21238
|
+
localVarQueryParameter['branch'] = branch;
|
|
21239
|
+
}
|
|
21141
21240
|
|
|
21142
21241
|
|
|
21143
21242
|
|
|
@@ -21151,17 +21250,13 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
21151
21250
|
};
|
|
21152
21251
|
},
|
|
21153
21252
|
/**
|
|
21154
|
-
*
|
|
21155
|
-
* @summary
|
|
21156
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
21253
|
+
* 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.
|
|
21254
|
+
* @summary Fetch API Config
|
|
21157
21255
|
* @param {*} [options] Override http request option.
|
|
21158
21256
|
* @throws {RequiredError}
|
|
21159
21257
|
*/
|
|
21160
|
-
|
|
21161
|
-
|
|
21162
|
-
assertParamExists('deleteNotification', 'notificationId', notificationId)
|
|
21163
|
-
const localVarPath = `/auth/user/notifications/{notificationId}/hide`
|
|
21164
|
-
.replace(`{${"notificationId"}}`, encodeURIComponent(String(notificationId)));
|
|
21258
|
+
getConfig: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
21259
|
+
const localVarPath = `/config`;
|
|
21165
21260
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21166
21261
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21167
21262
|
let baseOptions;
|
|
@@ -21169,12 +21264,10 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
21169
21264
|
baseOptions = configuration.baseOptions;
|
|
21170
21265
|
}
|
|
21171
21266
|
|
|
21172
|
-
const localVarRequestOptions = { method: '
|
|
21267
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
21173
21268
|
const localVarHeaderParameter = {} as any;
|
|
21174
21269
|
const localVarQueryParameter = {} as any;
|
|
21175
21270
|
|
|
21176
|
-
// authentication authCookie required
|
|
21177
|
-
|
|
21178
21271
|
|
|
21179
21272
|
|
|
21180
21273
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -21187,17 +21280,13 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
21187
21280
|
};
|
|
21188
21281
|
},
|
|
21189
21282
|
/**
|
|
21190
|
-
*
|
|
21191
|
-
* @summary
|
|
21192
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
21283
|
+
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
21284
|
+
* @summary Current Online Users
|
|
21193
21285
|
* @param {*} [options] Override http request option.
|
|
21194
21286
|
* @throws {RequiredError}
|
|
21195
21287
|
*/
|
|
21196
|
-
|
|
21197
|
-
|
|
21198
|
-
assertParamExists('getNotification', 'notificationId', notificationId)
|
|
21199
|
-
const localVarPath = `/auth/user/notifications/{notificationId}`
|
|
21200
|
-
.replace(`{${"notificationId"}}`, encodeURIComponent(String(notificationId)));
|
|
21288
|
+
getCurrentOnlineUsers: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
21289
|
+
const localVarPath = `/visits`;
|
|
21201
21290
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21202
21291
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21203
21292
|
let baseOptions;
|
|
@@ -21209,8 +21298,6 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
21209
21298
|
const localVarHeaderParameter = {} as any;
|
|
21210
21299
|
const localVarQueryParameter = {} as any;
|
|
21211
21300
|
|
|
21212
|
-
// authentication authCookie required
|
|
21213
|
-
|
|
21214
21301
|
|
|
21215
21302
|
|
|
21216
21303
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -21223,19 +21310,14 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
21223
21310
|
};
|
|
21224
21311
|
},
|
|
21225
21312
|
/**
|
|
21226
|
-
*
|
|
21227
|
-
* @summary
|
|
21228
|
-
* @param {string} [type] Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.
|
|
21229
|
-
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
21230
|
-
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
21231
|
-
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
21232
|
-
* @param {number} [n] The number of objects to return.
|
|
21233
|
-
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
21313
|
+
* ~~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.
|
|
21314
|
+
* @summary Check API Health
|
|
21234
21315
|
* @param {*} [options] Override http request option.
|
|
21316
|
+
* @deprecated
|
|
21235
21317
|
* @throws {RequiredError}
|
|
21236
21318
|
*/
|
|
21237
|
-
|
|
21238
|
-
const localVarPath = `/
|
|
21319
|
+
getHealth: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
21320
|
+
const localVarPath = `/health`;
|
|
21239
21321
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21240
21322
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21241
21323
|
let baseOptions;
|
|
@@ -21247,30 +21329,84 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
21247
21329
|
const localVarHeaderParameter = {} as any;
|
|
21248
21330
|
const localVarQueryParameter = {} as any;
|
|
21249
21331
|
|
|
21250
|
-
// authentication authCookie required
|
|
21251
21332
|
|
|
21252
|
-
|
|
21253
|
-
|
|
21333
|
+
|
|
21334
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
21335
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
21336
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
21337
|
+
|
|
21338
|
+
return {
|
|
21339
|
+
url: toPathString(localVarUrlObj),
|
|
21340
|
+
options: localVarRequestOptions,
|
|
21341
|
+
};
|
|
21342
|
+
},
|
|
21343
|
+
/**
|
|
21344
|
+
* 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.
|
|
21345
|
+
* @summary Show Information Notices
|
|
21346
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
21347
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
21348
|
+
* @param {*} [options] Override http request option.
|
|
21349
|
+
* @throws {RequiredError}
|
|
21350
|
+
*/
|
|
21351
|
+
getInfoPush: async (require?: string, include?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
21352
|
+
const localVarPath = `/infoPush`;
|
|
21353
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21354
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21355
|
+
let baseOptions;
|
|
21356
|
+
if (configuration) {
|
|
21357
|
+
baseOptions = configuration.baseOptions;
|
|
21254
21358
|
}
|
|
21255
21359
|
|
|
21256
|
-
|
|
21257
|
-
|
|
21360
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
21361
|
+
const localVarHeaderParameter = {} as any;
|
|
21362
|
+
const localVarQueryParameter = {} as any;
|
|
21363
|
+
|
|
21364
|
+
if (require !== undefined) {
|
|
21365
|
+
localVarQueryParameter['require'] = require;
|
|
21258
21366
|
}
|
|
21259
21367
|
|
|
21260
|
-
if (
|
|
21261
|
-
localVarQueryParameter['
|
|
21368
|
+
if (include !== undefined) {
|
|
21369
|
+
localVarQueryParameter['include'] = include;
|
|
21262
21370
|
}
|
|
21263
21371
|
|
|
21264
|
-
|
|
21265
|
-
|
|
21372
|
+
|
|
21373
|
+
|
|
21374
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
21375
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
21376
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
21377
|
+
|
|
21378
|
+
return {
|
|
21379
|
+
url: toPathString(localVarUrlObj),
|
|
21380
|
+
options: localVarRequestOptions,
|
|
21381
|
+
};
|
|
21382
|
+
},
|
|
21383
|
+
/**
|
|
21384
|
+
* Fetches the JavaScript code to the frontend React website.
|
|
21385
|
+
* @summary Download JavaScript
|
|
21386
|
+
* @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.
|
|
21387
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
21388
|
+
* @param {*} [options] Override http request option.
|
|
21389
|
+
* @throws {RequiredError}
|
|
21390
|
+
*/
|
|
21391
|
+
getJavaScript: async (variant?: 'public' | 'internal', branch?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
21392
|
+
const localVarPath = `/js/app.js`;
|
|
21393
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21394
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21395
|
+
let baseOptions;
|
|
21396
|
+
if (configuration) {
|
|
21397
|
+
baseOptions = configuration.baseOptions;
|
|
21266
21398
|
}
|
|
21267
21399
|
|
|
21268
|
-
|
|
21269
|
-
|
|
21400
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
21401
|
+
const localVarHeaderParameter = {} as any;
|
|
21402
|
+
const localVarQueryParameter = {} as any;
|
|
21403
|
+
|
|
21404
|
+
if (variant !== undefined) {
|
|
21405
|
+
localVarQueryParameter['variant'] = variant;
|
|
21270
21406
|
}
|
|
21271
21407
|
|
|
21272
|
-
if (
|
|
21273
|
-
localVarQueryParameter['
|
|
21408
|
+
if (branch !== undefined) {
|
|
21409
|
+
localVarQueryParameter['branch'] = branch;
|
|
21274
21410
|
}
|
|
21275
21411
|
|
|
21276
21412
|
|
|
@@ -21285,17 +21421,17 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
21285
21421
|
};
|
|
21286
21422
|
},
|
|
21287
21423
|
/**
|
|
21288
|
-
*
|
|
21289
|
-
* @summary
|
|
21290
|
-
* @param {string}
|
|
21424
|
+
* Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
|
|
21425
|
+
* @summary Get Permission
|
|
21426
|
+
* @param {string} permissionId Must be a valid permission ID.
|
|
21291
21427
|
* @param {*} [options] Override http request option.
|
|
21292
21428
|
* @throws {RequiredError}
|
|
21293
21429
|
*/
|
|
21294
|
-
|
|
21295
|
-
// verify required parameter '
|
|
21296
|
-
assertParamExists('
|
|
21297
|
-
const localVarPath = `/
|
|
21298
|
-
.replace(`{${"
|
|
21430
|
+
getPermission: async (permissionId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
21431
|
+
// verify required parameter 'permissionId' is not null or undefined
|
|
21432
|
+
assertParamExists('getPermission', 'permissionId', permissionId)
|
|
21433
|
+
const localVarPath = `/permissions/{permissionId}`
|
|
21434
|
+
.replace(`{${"permissionId"}}`, encodeURIComponent(String(permissionId)));
|
|
21299
21435
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21300
21436
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21301
21437
|
let baseOptions;
|
|
@@ -21303,7 +21439,7 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
21303
21439
|
baseOptions = configuration.baseOptions;
|
|
21304
21440
|
}
|
|
21305
21441
|
|
|
21306
|
-
const localVarRequestOptions = { method: '
|
|
21442
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
21307
21443
|
const localVarHeaderParameter = {} as any;
|
|
21308
21444
|
const localVarQueryParameter = {} as any;
|
|
21309
21445
|
|
|
@@ -21320,262 +21456,380 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
21320
21456
|
options: localVarRequestOptions,
|
|
21321
21457
|
};
|
|
21322
21458
|
},
|
|
21323
|
-
}
|
|
21324
|
-
};
|
|
21325
|
-
|
|
21326
|
-
/**
|
|
21327
|
-
* NotificationsApi - functional programming interface
|
|
21328
|
-
* @export
|
|
21329
|
-
*/
|
|
21330
|
-
export const NotificationsApiFp = function(configuration?: Configuration) {
|
|
21331
|
-
const localVarAxiosParamCreator = NotificationsApiAxiosParamCreator(configuration)
|
|
21332
|
-
return {
|
|
21333
21459
|
/**
|
|
21334
|
-
*
|
|
21335
|
-
* @summary
|
|
21336
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
21460
|
+
* Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
|
21461
|
+
* @summary Current System Time
|
|
21337
21462
|
* @param {*} [options] Override http request option.
|
|
21338
21463
|
* @throws {RequiredError}
|
|
21339
21464
|
*/
|
|
21340
|
-
async
|
|
21341
|
-
const
|
|
21465
|
+
getSystemTime: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
21466
|
+
const localVarPath = `/time`;
|
|
21467
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21468
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21469
|
+
let baseOptions;
|
|
21470
|
+
if (configuration) {
|
|
21471
|
+
baseOptions = configuration.baseOptions;
|
|
21472
|
+
}
|
|
21473
|
+
|
|
21474
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
21475
|
+
const localVarHeaderParameter = {} as any;
|
|
21476
|
+
const localVarQueryParameter = {} as any;
|
|
21477
|
+
|
|
21478
|
+
|
|
21479
|
+
|
|
21480
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
21481
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
21482
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
21483
|
+
|
|
21484
|
+
return {
|
|
21485
|
+
url: toPathString(localVarUrlObj),
|
|
21486
|
+
options: localVarRequestOptions,
|
|
21487
|
+
};
|
|
21488
|
+
},
|
|
21489
|
+
}
|
|
21490
|
+
};
|
|
21491
|
+
|
|
21492
|
+
/**
|
|
21493
|
+
* MiscellaneousApi - functional programming interface
|
|
21494
|
+
* @export
|
|
21495
|
+
*/
|
|
21496
|
+
export const MiscellaneousApiFp = function(configuration?: Configuration) {
|
|
21497
|
+
const localVarAxiosParamCreator = MiscellaneousApiAxiosParamCreator(configuration)
|
|
21498
|
+
return {
|
|
21499
|
+
/**
|
|
21500
|
+
* Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
|
|
21501
|
+
* @summary Get Assigned Permissions
|
|
21502
|
+
* @param {*} [options] Override http request option.
|
|
21503
|
+
* @throws {RequiredError}
|
|
21504
|
+
*/
|
|
21505
|
+
async getAssignedPermissions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Permission>>> {
|
|
21506
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAssignedPermissions(options);
|
|
21342
21507
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
21343
21508
|
},
|
|
21344
21509
|
/**
|
|
21345
|
-
*
|
|
21346
|
-
* @summary
|
|
21510
|
+
* Fetches the CSS code to the frontend React website.
|
|
21511
|
+
* @summary Download CSS
|
|
21512
|
+
* @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.
|
|
21513
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
21347
21514
|
* @param {*} [options] Override http request option.
|
|
21348
21515
|
* @throws {RequiredError}
|
|
21349
21516
|
*/
|
|
21350
|
-
async
|
|
21351
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
21517
|
+
async getCSS(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
|
|
21518
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCSS(variant, branch, options);
|
|
21352
21519
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
21353
21520
|
},
|
|
21354
21521
|
/**
|
|
21355
|
-
*
|
|
21356
|
-
* @summary
|
|
21357
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
21522
|
+
* 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.
|
|
21523
|
+
* @summary Fetch API Config
|
|
21358
21524
|
* @param {*} [options] Override http request option.
|
|
21359
21525
|
* @throws {RequiredError}
|
|
21360
21526
|
*/
|
|
21361
|
-
async
|
|
21362
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
21527
|
+
async getConfig(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIConfig>> {
|
|
21528
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getConfig(options);
|
|
21363
21529
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
21364
21530
|
},
|
|
21365
21531
|
/**
|
|
21366
|
-
*
|
|
21367
|
-
* @summary
|
|
21368
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
21532
|
+
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
21533
|
+
* @summary Current Online Users
|
|
21369
21534
|
* @param {*} [options] Override http request option.
|
|
21370
21535
|
* @throws {RequiredError}
|
|
21371
21536
|
*/
|
|
21372
|
-
async
|
|
21373
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
21537
|
+
async getCurrentOnlineUsers(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<number>> {
|
|
21538
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCurrentOnlineUsers(options);
|
|
21374
21539
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
21375
21540
|
},
|
|
21376
21541
|
/**
|
|
21377
|
-
*
|
|
21378
|
-
* @summary
|
|
21379
|
-
* @param {string} [type] Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.
|
|
21380
|
-
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
21381
|
-
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
21382
|
-
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
21383
|
-
* @param {number} [n] The number of objects to return.
|
|
21384
|
-
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
21542
|
+
* ~~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.
|
|
21543
|
+
* @summary Check API Health
|
|
21385
21544
|
* @param {*} [options] Override http request option.
|
|
21545
|
+
* @deprecated
|
|
21386
21546
|
* @throws {RequiredError}
|
|
21387
21547
|
*/
|
|
21388
|
-
async
|
|
21389
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
21548
|
+
async getHealth(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIHealth>> {
|
|
21549
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getHealth(options);
|
|
21390
21550
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
21391
21551
|
},
|
|
21392
21552
|
/**
|
|
21393
|
-
*
|
|
21394
|
-
* @summary
|
|
21395
|
-
* @param {string}
|
|
21553
|
+
* 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.
|
|
21554
|
+
* @summary Show Information Notices
|
|
21555
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
21556
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
21396
21557
|
* @param {*} [options] Override http request option.
|
|
21397
21558
|
* @throws {RequiredError}
|
|
21398
21559
|
*/
|
|
21399
|
-
async
|
|
21400
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
21560
|
+
async getInfoPush(require?: string, include?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InfoPush>>> {
|
|
21561
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getInfoPush(require, include, options);
|
|
21562
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
21563
|
+
},
|
|
21564
|
+
/**
|
|
21565
|
+
* Fetches the JavaScript code to the frontend React website.
|
|
21566
|
+
* @summary Download JavaScript
|
|
21567
|
+
* @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.
|
|
21568
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
21569
|
+
* @param {*} [options] Override http request option.
|
|
21570
|
+
* @throws {RequiredError}
|
|
21571
|
+
*/
|
|
21572
|
+
async getJavaScript(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
|
|
21573
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getJavaScript(variant, branch, options);
|
|
21574
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
21575
|
+
},
|
|
21576
|
+
/**
|
|
21577
|
+
* Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
|
|
21578
|
+
* @summary Get Permission
|
|
21579
|
+
* @param {string} permissionId Must be a valid permission ID.
|
|
21580
|
+
* @param {*} [options] Override http request option.
|
|
21581
|
+
* @throws {RequiredError}
|
|
21582
|
+
*/
|
|
21583
|
+
async getPermission(permissionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Permission>> {
|
|
21584
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPermission(permissionId, options);
|
|
21585
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
21586
|
+
},
|
|
21587
|
+
/**
|
|
21588
|
+
* Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
|
21589
|
+
* @summary Current System Time
|
|
21590
|
+
* @param {*} [options] Override http request option.
|
|
21591
|
+
* @throws {RequiredError}
|
|
21592
|
+
*/
|
|
21593
|
+
async getSystemTime(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
|
|
21594
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSystemTime(options);
|
|
21401
21595
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
21402
21596
|
},
|
|
21403
21597
|
}
|
|
21404
21598
|
};
|
|
21405
21599
|
|
|
21406
21600
|
/**
|
|
21407
|
-
*
|
|
21601
|
+
* MiscellaneousApi - factory interface
|
|
21408
21602
|
* @export
|
|
21409
21603
|
*/
|
|
21410
|
-
export const
|
|
21411
|
-
const localVarFp =
|
|
21604
|
+
export const MiscellaneousApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
21605
|
+
const localVarFp = MiscellaneousApiFp(configuration)
|
|
21412
21606
|
return {
|
|
21413
21607
|
/**
|
|
21414
|
-
*
|
|
21415
|
-
* @summary
|
|
21416
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
21608
|
+
* Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
|
|
21609
|
+
* @summary Get Assigned Permissions
|
|
21417
21610
|
* @param {*} [options] Override http request option.
|
|
21418
21611
|
* @throws {RequiredError}
|
|
21419
21612
|
*/
|
|
21420
|
-
|
|
21421
|
-
return localVarFp.
|
|
21613
|
+
getAssignedPermissions(options?: any): AxiosPromise<Array<Permission>> {
|
|
21614
|
+
return localVarFp.getAssignedPermissions(options).then((request) => request(axios, basePath));
|
|
21422
21615
|
},
|
|
21423
21616
|
/**
|
|
21424
|
-
*
|
|
21425
|
-
* @summary
|
|
21617
|
+
* Fetches the CSS code to the frontend React website.
|
|
21618
|
+
* @summary Download CSS
|
|
21619
|
+
* @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.
|
|
21620
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
21426
21621
|
* @param {*} [options] Override http request option.
|
|
21427
21622
|
* @throws {RequiredError}
|
|
21428
21623
|
*/
|
|
21429
|
-
|
|
21430
|
-
return localVarFp.
|
|
21624
|
+
getCSS(variant?: 'public' | 'internal', branch?: string, options?: any): AxiosPromise<string> {
|
|
21625
|
+
return localVarFp.getCSS(variant, branch, options).then((request) => request(axios, basePath));
|
|
21431
21626
|
},
|
|
21432
21627
|
/**
|
|
21433
|
-
*
|
|
21434
|
-
* @summary
|
|
21435
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
21628
|
+
* 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.
|
|
21629
|
+
* @summary Fetch API Config
|
|
21436
21630
|
* @param {*} [options] Override http request option.
|
|
21437
21631
|
* @throws {RequiredError}
|
|
21438
21632
|
*/
|
|
21439
|
-
|
|
21440
|
-
return localVarFp.
|
|
21633
|
+
getConfig(options?: any): AxiosPromise<APIConfig> {
|
|
21634
|
+
return localVarFp.getConfig(options).then((request) => request(axios, basePath));
|
|
21441
21635
|
},
|
|
21442
21636
|
/**
|
|
21443
|
-
*
|
|
21444
|
-
* @summary
|
|
21445
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
21637
|
+
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
21638
|
+
* @summary Current Online Users
|
|
21446
21639
|
* @param {*} [options] Override http request option.
|
|
21447
21640
|
* @throws {RequiredError}
|
|
21448
21641
|
*/
|
|
21449
|
-
|
|
21450
|
-
return localVarFp.
|
|
21642
|
+
getCurrentOnlineUsers(options?: any): AxiosPromise<number> {
|
|
21643
|
+
return localVarFp.getCurrentOnlineUsers(options).then((request) => request(axios, basePath));
|
|
21451
21644
|
},
|
|
21452
21645
|
/**
|
|
21453
|
-
*
|
|
21454
|
-
* @summary
|
|
21455
|
-
* @param {string} [type] Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.
|
|
21456
|
-
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
21457
|
-
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
21458
|
-
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
21459
|
-
* @param {number} [n] The number of objects to return.
|
|
21460
|
-
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
21646
|
+
* ~~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.
|
|
21647
|
+
* @summary Check API Health
|
|
21461
21648
|
* @param {*} [options] Override http request option.
|
|
21649
|
+
* @deprecated
|
|
21462
21650
|
* @throws {RequiredError}
|
|
21463
21651
|
*/
|
|
21464
|
-
|
|
21465
|
-
return localVarFp.
|
|
21652
|
+
getHealth(options?: any): AxiosPromise<APIHealth> {
|
|
21653
|
+
return localVarFp.getHealth(options).then((request) => request(axios, basePath));
|
|
21466
21654
|
},
|
|
21467
21655
|
/**
|
|
21468
|
-
*
|
|
21469
|
-
* @summary
|
|
21470
|
-
* @param {string}
|
|
21656
|
+
* 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.
|
|
21657
|
+
* @summary Show Information Notices
|
|
21658
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
21659
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
21471
21660
|
* @param {*} [options] Override http request option.
|
|
21472
21661
|
* @throws {RequiredError}
|
|
21473
21662
|
*/
|
|
21474
|
-
|
|
21475
|
-
return localVarFp.
|
|
21663
|
+
getInfoPush(require?: string, include?: string, options?: any): AxiosPromise<Array<InfoPush>> {
|
|
21664
|
+
return localVarFp.getInfoPush(require, include, options).then((request) => request(axios, basePath));
|
|
21665
|
+
},
|
|
21666
|
+
/**
|
|
21667
|
+
* Fetches the JavaScript code to the frontend React website.
|
|
21668
|
+
* @summary Download JavaScript
|
|
21669
|
+
* @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.
|
|
21670
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
21671
|
+
* @param {*} [options] Override http request option.
|
|
21672
|
+
* @throws {RequiredError}
|
|
21673
|
+
*/
|
|
21674
|
+
getJavaScript(variant?: 'public' | 'internal', branch?: string, options?: any): AxiosPromise<string> {
|
|
21675
|
+
return localVarFp.getJavaScript(variant, branch, options).then((request) => request(axios, basePath));
|
|
21676
|
+
},
|
|
21677
|
+
/**
|
|
21678
|
+
* Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
|
|
21679
|
+
* @summary Get Permission
|
|
21680
|
+
* @param {string} permissionId Must be a valid permission ID.
|
|
21681
|
+
* @param {*} [options] Override http request option.
|
|
21682
|
+
* @throws {RequiredError}
|
|
21683
|
+
*/
|
|
21684
|
+
getPermission(permissionId: string, options?: any): AxiosPromise<Permission> {
|
|
21685
|
+
return localVarFp.getPermission(permissionId, options).then((request) => request(axios, basePath));
|
|
21686
|
+
},
|
|
21687
|
+
/**
|
|
21688
|
+
* Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
|
21689
|
+
* @summary Current System Time
|
|
21690
|
+
* @param {*} [options] Override http request option.
|
|
21691
|
+
* @throws {RequiredError}
|
|
21692
|
+
*/
|
|
21693
|
+
getSystemTime(options?: any): AxiosPromise<string> {
|
|
21694
|
+
return localVarFp.getSystemTime(options).then((request) => request(axios, basePath));
|
|
21476
21695
|
},
|
|
21477
21696
|
};
|
|
21478
21697
|
};
|
|
21479
21698
|
|
|
21480
21699
|
/**
|
|
21481
|
-
*
|
|
21700
|
+
* MiscellaneousApi - object-oriented interface
|
|
21482
21701
|
* @export
|
|
21483
|
-
* @class
|
|
21702
|
+
* @class MiscellaneousApi
|
|
21484
21703
|
* @extends {BaseAPI}
|
|
21485
21704
|
*/
|
|
21486
|
-
export class
|
|
21705
|
+
export class MiscellaneousApi extends BaseAPI {
|
|
21487
21706
|
/**
|
|
21488
|
-
*
|
|
21489
|
-
* @summary
|
|
21490
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
21707
|
+
* Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
|
|
21708
|
+
* @summary Get Assigned Permissions
|
|
21491
21709
|
* @param {*} [options] Override http request option.
|
|
21492
21710
|
* @throws {RequiredError}
|
|
21493
|
-
* @memberof
|
|
21711
|
+
* @memberof MiscellaneousApi
|
|
21494
21712
|
*/
|
|
21495
|
-
public
|
|
21496
|
-
return
|
|
21713
|
+
public getAssignedPermissions(options?: AxiosRequestConfig) {
|
|
21714
|
+
return MiscellaneousApiFp(this.configuration).getAssignedPermissions(options).then((request) => request(this.axios, this.basePath));
|
|
21497
21715
|
}
|
|
21498
21716
|
|
|
21499
21717
|
/**
|
|
21500
|
-
*
|
|
21501
|
-
* @summary
|
|
21718
|
+
* Fetches the CSS code to the frontend React website.
|
|
21719
|
+
* @summary Download CSS
|
|
21720
|
+
* @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.
|
|
21721
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
21502
21722
|
* @param {*} [options] Override http request option.
|
|
21503
21723
|
* @throws {RequiredError}
|
|
21504
|
-
* @memberof
|
|
21724
|
+
* @memberof MiscellaneousApi
|
|
21505
21725
|
*/
|
|
21506
|
-
public
|
|
21507
|
-
return
|
|
21726
|
+
public getCSS(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig) {
|
|
21727
|
+
return MiscellaneousApiFp(this.configuration).getCSS(variant, branch, options).then((request) => request(this.axios, this.basePath));
|
|
21508
21728
|
}
|
|
21509
21729
|
|
|
21510
21730
|
/**
|
|
21511
|
-
*
|
|
21512
|
-
* @summary
|
|
21513
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
21731
|
+
* 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.
|
|
21732
|
+
* @summary Fetch API Config
|
|
21514
21733
|
* @param {*} [options] Override http request option.
|
|
21515
21734
|
* @throws {RequiredError}
|
|
21516
|
-
* @memberof
|
|
21735
|
+
* @memberof MiscellaneousApi
|
|
21517
21736
|
*/
|
|
21518
|
-
public
|
|
21519
|
-
return
|
|
21737
|
+
public getConfig(options?: AxiosRequestConfig) {
|
|
21738
|
+
return MiscellaneousApiFp(this.configuration).getConfig(options).then((request) => request(this.axios, this.basePath));
|
|
21520
21739
|
}
|
|
21521
21740
|
|
|
21522
21741
|
/**
|
|
21523
|
-
*
|
|
21524
|
-
* @summary
|
|
21525
|
-
* @param {string} notificationId Must be a valid notification ID.
|
|
21742
|
+
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
21743
|
+
* @summary Current Online Users
|
|
21526
21744
|
* @param {*} [options] Override http request option.
|
|
21527
21745
|
* @throws {RequiredError}
|
|
21528
|
-
* @memberof
|
|
21746
|
+
* @memberof MiscellaneousApi
|
|
21529
21747
|
*/
|
|
21530
|
-
public
|
|
21531
|
-
return
|
|
21748
|
+
public getCurrentOnlineUsers(options?: AxiosRequestConfig) {
|
|
21749
|
+
return MiscellaneousApiFp(this.configuration).getCurrentOnlineUsers(options).then((request) => request(this.axios, this.basePath));
|
|
21532
21750
|
}
|
|
21533
21751
|
|
|
21534
21752
|
/**
|
|
21535
|
-
*
|
|
21536
|
-
* @summary
|
|
21537
|
-
* @param {string} [type] Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.
|
|
21538
|
-
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
21539
|
-
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
21540
|
-
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
21541
|
-
* @param {number} [n] The number of objects to return.
|
|
21542
|
-
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
21753
|
+
* ~~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.
|
|
21754
|
+
* @summary Check API Health
|
|
21543
21755
|
* @param {*} [options] Override http request option.
|
|
21756
|
+
* @deprecated
|
|
21544
21757
|
* @throws {RequiredError}
|
|
21545
|
-
* @memberof
|
|
21758
|
+
* @memberof MiscellaneousApi
|
|
21546
21759
|
*/
|
|
21547
|
-
public
|
|
21548
|
-
return
|
|
21760
|
+
public getHealth(options?: AxiosRequestConfig) {
|
|
21761
|
+
return MiscellaneousApiFp(this.configuration).getHealth(options).then((request) => request(this.axios, this.basePath));
|
|
21549
21762
|
}
|
|
21550
21763
|
|
|
21551
21764
|
/**
|
|
21552
|
-
*
|
|
21553
|
-
* @summary
|
|
21554
|
-
* @param {string}
|
|
21765
|
+
* 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.
|
|
21766
|
+
* @summary Show Information Notices
|
|
21767
|
+
* @param {string} [require] Tags to include (comma-separated). All of the tags needs to be present.
|
|
21768
|
+
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
21555
21769
|
* @param {*} [options] Override http request option.
|
|
21556
21770
|
* @throws {RequiredError}
|
|
21557
|
-
* @memberof
|
|
21771
|
+
* @memberof MiscellaneousApi
|
|
21558
21772
|
*/
|
|
21559
|
-
public
|
|
21560
|
-
return
|
|
21773
|
+
public getInfoPush(require?: string, include?: string, options?: AxiosRequestConfig) {
|
|
21774
|
+
return MiscellaneousApiFp(this.configuration).getInfoPush(require, include, options).then((request) => request(this.axios, this.basePath));
|
|
21775
|
+
}
|
|
21776
|
+
|
|
21777
|
+
/**
|
|
21778
|
+
* Fetches the JavaScript code to the frontend React website.
|
|
21779
|
+
* @summary Download JavaScript
|
|
21780
|
+
* @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.
|
|
21781
|
+
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
21782
|
+
* @param {*} [options] Override http request option.
|
|
21783
|
+
* @throws {RequiredError}
|
|
21784
|
+
* @memberof MiscellaneousApi
|
|
21785
|
+
*/
|
|
21786
|
+
public getJavaScript(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig) {
|
|
21787
|
+
return MiscellaneousApiFp(this.configuration).getJavaScript(variant, branch, options).then((request) => request(this.axios, this.basePath));
|
|
21788
|
+
}
|
|
21789
|
+
|
|
21790
|
+
/**
|
|
21791
|
+
* Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
|
|
21792
|
+
* @summary Get Permission
|
|
21793
|
+
* @param {string} permissionId Must be a valid permission ID.
|
|
21794
|
+
* @param {*} [options] Override http request option.
|
|
21795
|
+
* @throws {RequiredError}
|
|
21796
|
+
* @memberof MiscellaneousApi
|
|
21797
|
+
*/
|
|
21798
|
+
public getPermission(permissionId: string, options?: AxiosRequestConfig) {
|
|
21799
|
+
return MiscellaneousApiFp(this.configuration).getPermission(permissionId, options).then((request) => request(this.axios, this.basePath));
|
|
21800
|
+
}
|
|
21801
|
+
|
|
21802
|
+
/**
|
|
21803
|
+
* Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
|
21804
|
+
* @summary Current System Time
|
|
21805
|
+
* @param {*} [options] Override http request option.
|
|
21806
|
+
* @throws {RequiredError}
|
|
21807
|
+
* @memberof MiscellaneousApi
|
|
21808
|
+
*/
|
|
21809
|
+
public getSystemTime(options?: AxiosRequestConfig) {
|
|
21810
|
+
return MiscellaneousApiFp(this.configuration).getSystemTime(options).then((request) => request(this.axios, this.basePath));
|
|
21561
21811
|
}
|
|
21562
21812
|
}
|
|
21563
21813
|
|
|
21564
21814
|
|
|
21565
21815
|
/**
|
|
21566
|
-
*
|
|
21816
|
+
* NotificationsApi - axios parameter creator
|
|
21567
21817
|
* @export
|
|
21568
21818
|
*/
|
|
21569
|
-
export const
|
|
21819
|
+
export const NotificationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
21570
21820
|
return {
|
|
21571
21821
|
/**
|
|
21572
|
-
*
|
|
21573
|
-
* @summary
|
|
21822
|
+
* Accept a friend request by notification `frq_` ID. Friend requests can be found using the NotificationsAPI `getNotifications` by filtering of type `friendRequest`.
|
|
21823
|
+
* @summary Accept Friend Request
|
|
21824
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
21574
21825
|
* @param {*} [options] Override http request option.
|
|
21575
21826
|
* @throws {RequiredError}
|
|
21576
21827
|
*/
|
|
21577
|
-
|
|
21578
|
-
|
|
21828
|
+
acceptFriendRequest: async (notificationId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
21829
|
+
// verify required parameter 'notificationId' is not null or undefined
|
|
21830
|
+
assertParamExists('acceptFriendRequest', 'notificationId', notificationId)
|
|
21831
|
+
const localVarPath = `/auth/user/notifications/{notificationId}/accept`
|
|
21832
|
+
.replace(`{${"notificationId"}}`, encodeURIComponent(String(notificationId)));
|
|
21579
21833
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21580
21834
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21581
21835
|
let baseOptions;
|
|
@@ -21583,7 +21837,7 @@ export const PermissionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
21583
21837
|
baseOptions = configuration.baseOptions;
|
|
21584
21838
|
}
|
|
21585
21839
|
|
|
21586
|
-
const localVarRequestOptions = { method: '
|
|
21840
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
21587
21841
|
const localVarHeaderParameter = {} as any;
|
|
21588
21842
|
const localVarQueryParameter = {} as any;
|
|
21589
21843
|
|
|
@@ -21601,17 +21855,13 @@ export const PermissionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
21601
21855
|
};
|
|
21602
21856
|
},
|
|
21603
21857
|
/**
|
|
21604
|
-
*
|
|
21605
|
-
* @summary
|
|
21606
|
-
* @param {string} permissionId Must be a valid permission ID.
|
|
21858
|
+
* Clear **all** notifications.
|
|
21859
|
+
* @summary Clear All Notifications
|
|
21607
21860
|
* @param {*} [options] Override http request option.
|
|
21608
21861
|
* @throws {RequiredError}
|
|
21609
21862
|
*/
|
|
21610
|
-
|
|
21611
|
-
|
|
21612
|
-
assertParamExists('getPermission', 'permissionId', permissionId)
|
|
21613
|
-
const localVarPath = `/permissions/{permissionId}`
|
|
21614
|
-
.replace(`{${"permissionId"}}`, encodeURIComponent(String(permissionId)));
|
|
21863
|
+
clearNotifications: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
21864
|
+
const localVarPath = `/auth/user/notifications/clear`;
|
|
21615
21865
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21616
21866
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21617
21867
|
let baseOptions;
|
|
@@ -21619,7 +21869,7 @@ export const PermissionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
21619
21869
|
baseOptions = configuration.baseOptions;
|
|
21620
21870
|
}
|
|
21621
21871
|
|
|
21622
|
-
const localVarRequestOptions = { method: '
|
|
21872
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
21623
21873
|
const localVarHeaderParameter = {} as any;
|
|
21624
21874
|
const localVarQueryParameter = {} as any;
|
|
21625
21875
|
|
|
@@ -21636,115 +21886,18 @@ export const PermissionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
21636
21886
|
options: localVarRequestOptions,
|
|
21637
21887
|
};
|
|
21638
21888
|
},
|
|
21639
|
-
}
|
|
21640
|
-
};
|
|
21641
|
-
|
|
21642
|
-
/**
|
|
21643
|
-
* PermissionsApi - functional programming interface
|
|
21644
|
-
* @export
|
|
21645
|
-
*/
|
|
21646
|
-
export const PermissionsApiFp = function(configuration?: Configuration) {
|
|
21647
|
-
const localVarAxiosParamCreator = PermissionsApiAxiosParamCreator(configuration)
|
|
21648
|
-
return {
|
|
21649
|
-
/**
|
|
21650
|
-
* Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
|
|
21651
|
-
* @summary Get Assigned Permissions
|
|
21652
|
-
* @param {*} [options] Override http request option.
|
|
21653
|
-
* @throws {RequiredError}
|
|
21654
|
-
*/
|
|
21655
|
-
async getAssignedPermissions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Permission>>> {
|
|
21656
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getAssignedPermissions(options);
|
|
21657
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
21658
|
-
},
|
|
21659
|
-
/**
|
|
21660
|
-
* Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
|
|
21661
|
-
* @summary Get Permission
|
|
21662
|
-
* @param {string} permissionId Must be a valid permission ID.
|
|
21663
|
-
* @param {*} [options] Override http request option.
|
|
21664
|
-
* @throws {RequiredError}
|
|
21665
|
-
*/
|
|
21666
|
-
async getPermission(permissionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Permission>> {
|
|
21667
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getPermission(permissionId, options);
|
|
21668
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
21669
|
-
},
|
|
21670
|
-
}
|
|
21671
|
-
};
|
|
21672
|
-
|
|
21673
|
-
/**
|
|
21674
|
-
* PermissionsApi - factory interface
|
|
21675
|
-
* @export
|
|
21676
|
-
*/
|
|
21677
|
-
export const PermissionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
21678
|
-
const localVarFp = PermissionsApiFp(configuration)
|
|
21679
|
-
return {
|
|
21680
|
-
/**
|
|
21681
|
-
* Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
|
|
21682
|
-
* @summary Get Assigned Permissions
|
|
21683
|
-
* @param {*} [options] Override http request option.
|
|
21684
|
-
* @throws {RequiredError}
|
|
21685
|
-
*/
|
|
21686
|
-
getAssignedPermissions(options?: any): AxiosPromise<Array<Permission>> {
|
|
21687
|
-
return localVarFp.getAssignedPermissions(options).then((request) => request(axios, basePath));
|
|
21688
|
-
},
|
|
21689
|
-
/**
|
|
21690
|
-
* Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
|
|
21691
|
-
* @summary Get Permission
|
|
21692
|
-
* @param {string} permissionId Must be a valid permission ID.
|
|
21693
|
-
* @param {*} [options] Override http request option.
|
|
21694
|
-
* @throws {RequiredError}
|
|
21695
|
-
*/
|
|
21696
|
-
getPermission(permissionId: string, options?: any): AxiosPromise<Permission> {
|
|
21697
|
-
return localVarFp.getPermission(permissionId, options).then((request) => request(axios, basePath));
|
|
21698
|
-
},
|
|
21699
|
-
};
|
|
21700
|
-
};
|
|
21701
|
-
|
|
21702
|
-
/**
|
|
21703
|
-
* PermissionsApi - object-oriented interface
|
|
21704
|
-
* @export
|
|
21705
|
-
* @class PermissionsApi
|
|
21706
|
-
* @extends {BaseAPI}
|
|
21707
|
-
*/
|
|
21708
|
-
export class PermissionsApi extends BaseAPI {
|
|
21709
|
-
/**
|
|
21710
|
-
* Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
|
|
21711
|
-
* @summary Get Assigned Permissions
|
|
21712
|
-
* @param {*} [options] Override http request option.
|
|
21713
|
-
* @throws {RequiredError}
|
|
21714
|
-
* @memberof PermissionsApi
|
|
21715
|
-
*/
|
|
21716
|
-
public getAssignedPermissions(options?: AxiosRequestConfig) {
|
|
21717
|
-
return PermissionsApiFp(this.configuration).getAssignedPermissions(options).then((request) => request(this.axios, this.basePath));
|
|
21718
|
-
}
|
|
21719
|
-
|
|
21720
|
-
/**
|
|
21721
|
-
* Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
|
|
21722
|
-
* @summary Get Permission
|
|
21723
|
-
* @param {string} permissionId Must be a valid permission ID.
|
|
21724
|
-
* @param {*} [options] Override http request option.
|
|
21725
|
-
* @throws {RequiredError}
|
|
21726
|
-
* @memberof PermissionsApi
|
|
21727
|
-
*/
|
|
21728
|
-
public getPermission(permissionId: string, options?: AxiosRequestConfig) {
|
|
21729
|
-
return PermissionsApiFp(this.configuration).getPermission(permissionId, options).then((request) => request(this.axios, this.basePath));
|
|
21730
|
-
}
|
|
21731
|
-
}
|
|
21732
|
-
|
|
21733
|
-
|
|
21734
|
-
/**
|
|
21735
|
-
* PlayermoderationApi - axios parameter creator
|
|
21736
|
-
* @export
|
|
21737
|
-
*/
|
|
21738
|
-
export const PlayermoderationApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
21739
|
-
return {
|
|
21740
21889
|
/**
|
|
21741
|
-
*
|
|
21742
|
-
* @summary
|
|
21890
|
+
* Delete a notification.
|
|
21891
|
+
* @summary Delete Notification
|
|
21892
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
21743
21893
|
* @param {*} [options] Override http request option.
|
|
21744
21894
|
* @throws {RequiredError}
|
|
21745
21895
|
*/
|
|
21746
|
-
|
|
21747
|
-
|
|
21896
|
+
deleteNotification: async (notificationId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
21897
|
+
// verify required parameter 'notificationId' is not null or undefined
|
|
21898
|
+
assertParamExists('deleteNotification', 'notificationId', notificationId)
|
|
21899
|
+
const localVarPath = `/auth/user/notifications/{notificationId}/hide`
|
|
21900
|
+
.replace(`{${"notificationId"}}`, encodeURIComponent(String(notificationId)));
|
|
21748
21901
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21749
21902
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21750
21903
|
let baseOptions;
|
|
@@ -21752,7 +21905,7 @@ export const PlayermoderationApiAxiosParamCreator = function (configuration?: Co
|
|
|
21752
21905
|
baseOptions = configuration.baseOptions;
|
|
21753
21906
|
}
|
|
21754
21907
|
|
|
21755
|
-
const localVarRequestOptions = { method: '
|
|
21908
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
21756
21909
|
const localVarHeaderParameter = {} as any;
|
|
21757
21910
|
const localVarQueryParameter = {} as any;
|
|
21758
21911
|
|
|
@@ -21770,15 +21923,17 @@ export const PlayermoderationApiAxiosParamCreator = function (configuration?: Co
|
|
|
21770
21923
|
};
|
|
21771
21924
|
},
|
|
21772
21925
|
/**
|
|
21773
|
-
*
|
|
21774
|
-
* @summary
|
|
21775
|
-
* @param {string}
|
|
21776
|
-
* @param {string} [targetUserId] Must be valid UserID.
|
|
21926
|
+
* Get a notification by notification `not_` ID.
|
|
21927
|
+
* @summary Show notification
|
|
21928
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
21777
21929
|
* @param {*} [options] Override http request option.
|
|
21778
21930
|
* @throws {RequiredError}
|
|
21779
21931
|
*/
|
|
21780
|
-
|
|
21781
|
-
|
|
21932
|
+
getNotification: async (notificationId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
21933
|
+
// verify required parameter 'notificationId' is not null or undefined
|
|
21934
|
+
assertParamExists('getNotification', 'notificationId', notificationId)
|
|
21935
|
+
const localVarPath = `/auth/user/notifications/{notificationId}`
|
|
21936
|
+
.replace(`{${"notificationId"}}`, encodeURIComponent(String(notificationId)));
|
|
21782
21937
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21783
21938
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21784
21939
|
let baseOptions;
|
|
@@ -21792,14 +21947,6 @@ export const PlayermoderationApiAxiosParamCreator = function (configuration?: Co
|
|
|
21792
21947
|
|
|
21793
21948
|
// authentication authCookie required
|
|
21794
21949
|
|
|
21795
|
-
if (type !== undefined) {
|
|
21796
|
-
localVarQueryParameter['type'] = type;
|
|
21797
|
-
}
|
|
21798
|
-
|
|
21799
|
-
if (targetUserId !== undefined) {
|
|
21800
|
-
localVarQueryParameter['targetUserId'] = targetUserId;
|
|
21801
|
-
}
|
|
21802
|
-
|
|
21803
21950
|
|
|
21804
21951
|
|
|
21805
21952
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -21812,16 +21959,19 @@ export const PlayermoderationApiAxiosParamCreator = function (configuration?: Co
|
|
|
21812
21959
|
};
|
|
21813
21960
|
},
|
|
21814
21961
|
/**
|
|
21815
|
-
*
|
|
21816
|
-
* @summary
|
|
21817
|
-
* @param {
|
|
21962
|
+
* Retrieve all of the current user\'s notifications.
|
|
21963
|
+
* @summary List Notifications
|
|
21964
|
+
* @param {string} [type] Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.
|
|
21965
|
+
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
21966
|
+
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
21967
|
+
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
21968
|
+
* @param {number} [n] The number of objects to return.
|
|
21969
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
21818
21970
|
* @param {*} [options] Override http request option.
|
|
21819
21971
|
* @throws {RequiredError}
|
|
21820
21972
|
*/
|
|
21821
|
-
|
|
21822
|
-
|
|
21823
|
-
assertParamExists('moderateUser', 'moderateUserRequest', moderateUserRequest)
|
|
21824
|
-
const localVarPath = `/auth/user/playermoderations`;
|
|
21973
|
+
getNotifications: async (type?: string, sent?: boolean, hidden?: boolean, after?: string, n?: number, offset?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
21974
|
+
const localVarPath = `/auth/user/notifications`;
|
|
21825
21975
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21826
21976
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21827
21977
|
let baseOptions;
|
|
@@ -21829,20 +21979,41 @@ export const PlayermoderationApiAxiosParamCreator = function (configuration?: Co
|
|
|
21829
21979
|
baseOptions = configuration.baseOptions;
|
|
21830
21980
|
}
|
|
21831
21981
|
|
|
21832
|
-
const localVarRequestOptions = { method: '
|
|
21982
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
21833
21983
|
const localVarHeaderParameter = {} as any;
|
|
21834
21984
|
const localVarQueryParameter = {} as any;
|
|
21835
21985
|
|
|
21836
21986
|
// authentication authCookie required
|
|
21837
21987
|
|
|
21988
|
+
if (type !== undefined) {
|
|
21989
|
+
localVarQueryParameter['type'] = type;
|
|
21990
|
+
}
|
|
21838
21991
|
|
|
21839
|
-
|
|
21840
|
-
|
|
21992
|
+
if (sent !== undefined) {
|
|
21993
|
+
localVarQueryParameter['sent'] = sent;
|
|
21994
|
+
}
|
|
21841
21995
|
|
|
21842
|
-
|
|
21843
|
-
|
|
21844
|
-
|
|
21845
|
-
|
|
21996
|
+
if (hidden !== undefined) {
|
|
21997
|
+
localVarQueryParameter['hidden'] = hidden;
|
|
21998
|
+
}
|
|
21999
|
+
|
|
22000
|
+
if (after !== undefined) {
|
|
22001
|
+
localVarQueryParameter['after'] = after;
|
|
22002
|
+
}
|
|
22003
|
+
|
|
22004
|
+
if (n !== undefined) {
|
|
22005
|
+
localVarQueryParameter['n'] = n;
|
|
22006
|
+
}
|
|
22007
|
+
|
|
22008
|
+
if (offset !== undefined) {
|
|
22009
|
+
localVarQueryParameter['offset'] = offset;
|
|
22010
|
+
}
|
|
22011
|
+
|
|
22012
|
+
|
|
22013
|
+
|
|
22014
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
22015
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22016
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
21846
22017
|
|
|
21847
22018
|
return {
|
|
21848
22019
|
url: toPathString(localVarUrlObj),
|
|
@@ -21850,16 +22021,17 @@ export const PlayermoderationApiAxiosParamCreator = function (configuration?: Co
|
|
|
21850
22021
|
};
|
|
21851
22022
|
},
|
|
21852
22023
|
/**
|
|
21853
|
-
*
|
|
21854
|
-
* @summary
|
|
21855
|
-
* @param {
|
|
22024
|
+
* Mark a notification as seen.
|
|
22025
|
+
* @summary Mark Notification As Read
|
|
22026
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
21856
22027
|
* @param {*} [options] Override http request option.
|
|
21857
22028
|
* @throws {RequiredError}
|
|
21858
22029
|
*/
|
|
21859
|
-
|
|
21860
|
-
// verify required parameter '
|
|
21861
|
-
assertParamExists('
|
|
21862
|
-
const localVarPath = `/auth/user/
|
|
22030
|
+
markNotificationAsRead: async (notificationId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
22031
|
+
// verify required parameter 'notificationId' is not null or undefined
|
|
22032
|
+
assertParamExists('markNotificationAsRead', 'notificationId', notificationId)
|
|
22033
|
+
const localVarPath = `/auth/user/notifications/{notificationId}/see`
|
|
22034
|
+
.replace(`{${"notificationId"}}`, encodeURIComponent(String(notificationId)));
|
|
21863
22035
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21864
22036
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21865
22037
|
let baseOptions;
|
|
@@ -21875,12 +22047,9 @@ export const PlayermoderationApiAxiosParamCreator = function (configuration?: Co
|
|
|
21875
22047
|
|
|
21876
22048
|
|
|
21877
22049
|
|
|
21878
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
21879
|
-
|
|
21880
22050
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
21881
22051
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
21882
22052
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
21883
|
-
localVarRequestOptions.data = serializeDataIfNeeded(moderateUserRequest, localVarRequestOptions, configuration)
|
|
21884
22053
|
|
|
21885
22054
|
return {
|
|
21886
22055
|
url: toPathString(localVarUrlObj),
|
|
@@ -21891,224 +22060,258 @@ export const PlayermoderationApiAxiosParamCreator = function (configuration?: Co
|
|
|
21891
22060
|
};
|
|
21892
22061
|
|
|
21893
22062
|
/**
|
|
21894
|
-
*
|
|
22063
|
+
* NotificationsApi - functional programming interface
|
|
21895
22064
|
* @export
|
|
21896
22065
|
*/
|
|
21897
|
-
export const
|
|
21898
|
-
const localVarAxiosParamCreator =
|
|
22066
|
+
export const NotificationsApiFp = function(configuration?: Configuration) {
|
|
22067
|
+
const localVarAxiosParamCreator = NotificationsApiAxiosParamCreator(configuration)
|
|
21899
22068
|
return {
|
|
21900
22069
|
/**
|
|
21901
|
-
*
|
|
21902
|
-
* @summary
|
|
22070
|
+
* Accept a friend request by notification `frq_` ID. Friend requests can be found using the NotificationsAPI `getNotifications` by filtering of type `friendRequest`.
|
|
22071
|
+
* @summary Accept Friend Request
|
|
22072
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
21903
22073
|
* @param {*} [options] Override http request option.
|
|
21904
22074
|
* @throws {RequiredError}
|
|
21905
22075
|
*/
|
|
21906
|
-
async
|
|
21907
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
22076
|
+
async acceptFriendRequest(notificationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>> {
|
|
22077
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.acceptFriendRequest(notificationId, options);
|
|
21908
22078
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
21909
22079
|
},
|
|
21910
22080
|
/**
|
|
21911
|
-
*
|
|
21912
|
-
* @summary
|
|
21913
|
-
* @param {string} [type] Must be one of PlayerModerationType, except unblock. Unblocking simply removes a block.
|
|
21914
|
-
* @param {string} [targetUserId] Must be valid UserID.
|
|
22081
|
+
* Clear **all** notifications.
|
|
22082
|
+
* @summary Clear All Notifications
|
|
21915
22083
|
* @param {*} [options] Override http request option.
|
|
21916
22084
|
* @throws {RequiredError}
|
|
21917
22085
|
*/
|
|
21918
|
-
async
|
|
21919
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
22086
|
+
async clearNotifications(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>> {
|
|
22087
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.clearNotifications(options);
|
|
21920
22088
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
21921
22089
|
},
|
|
21922
22090
|
/**
|
|
21923
|
-
*
|
|
21924
|
-
* @summary
|
|
21925
|
-
* @param {
|
|
22091
|
+
* Delete a notification.
|
|
22092
|
+
* @summary Delete Notification
|
|
22093
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
21926
22094
|
* @param {*} [options] Override http request option.
|
|
21927
22095
|
* @throws {RequiredError}
|
|
21928
22096
|
*/
|
|
21929
|
-
async
|
|
21930
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
22097
|
+
async deleteNotification(notificationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>> {
|
|
22098
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNotification(notificationId, options);
|
|
21931
22099
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
21932
22100
|
},
|
|
21933
22101
|
/**
|
|
21934
|
-
*
|
|
21935
|
-
* @summary
|
|
21936
|
-
* @param {
|
|
22102
|
+
* Get a notification by notification `not_` ID.
|
|
22103
|
+
* @summary Show notification
|
|
22104
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
21937
22105
|
* @param {*} [options] Override http request option.
|
|
21938
22106
|
* @throws {RequiredError}
|
|
21939
22107
|
*/
|
|
21940
|
-
async
|
|
21941
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
22108
|
+
async getNotification(notificationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>> {
|
|
22109
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getNotification(notificationId, options);
|
|
22110
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
22111
|
+
},
|
|
22112
|
+
/**
|
|
22113
|
+
* Retrieve all of the current user\'s notifications.
|
|
22114
|
+
* @summary List Notifications
|
|
22115
|
+
* @param {string} [type] Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.
|
|
22116
|
+
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
22117
|
+
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
22118
|
+
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
22119
|
+
* @param {number} [n] The number of objects to return.
|
|
22120
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
22121
|
+
* @param {*} [options] Override http request option.
|
|
22122
|
+
* @throws {RequiredError}
|
|
22123
|
+
*/
|
|
22124
|
+
async getNotifications(type?: string, sent?: boolean, hidden?: boolean, after?: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Notification>>> {
|
|
22125
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getNotifications(type, sent, hidden, after, n, offset, options);
|
|
22126
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
22127
|
+
},
|
|
22128
|
+
/**
|
|
22129
|
+
* Mark a notification as seen.
|
|
22130
|
+
* @summary Mark Notification As Read
|
|
22131
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
22132
|
+
* @param {*} [options] Override http request option.
|
|
22133
|
+
* @throws {RequiredError}
|
|
22134
|
+
*/
|
|
22135
|
+
async markNotificationAsRead(notificationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>> {
|
|
22136
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.markNotificationAsRead(notificationId, options);
|
|
21942
22137
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
21943
22138
|
},
|
|
21944
22139
|
}
|
|
21945
22140
|
};
|
|
21946
22141
|
|
|
21947
22142
|
/**
|
|
21948
|
-
*
|
|
22143
|
+
* NotificationsApi - factory interface
|
|
21949
22144
|
* @export
|
|
21950
22145
|
*/
|
|
21951
|
-
export const
|
|
21952
|
-
const localVarFp =
|
|
22146
|
+
export const NotificationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
22147
|
+
const localVarFp = NotificationsApiFp(configuration)
|
|
21953
22148
|
return {
|
|
21954
22149
|
/**
|
|
21955
|
-
*
|
|
21956
|
-
* @summary
|
|
22150
|
+
* Accept a friend request by notification `frq_` ID. Friend requests can be found using the NotificationsAPI `getNotifications` by filtering of type `friendRequest`.
|
|
22151
|
+
* @summary Accept Friend Request
|
|
22152
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
21957
22153
|
* @param {*} [options] Override http request option.
|
|
21958
22154
|
* @throws {RequiredError}
|
|
21959
22155
|
*/
|
|
21960
|
-
|
|
21961
|
-
return localVarFp.
|
|
22156
|
+
acceptFriendRequest(notificationId: string, options?: any): AxiosPromise<Success> {
|
|
22157
|
+
return localVarFp.acceptFriendRequest(notificationId, options).then((request) => request(axios, basePath));
|
|
21962
22158
|
},
|
|
21963
22159
|
/**
|
|
21964
|
-
*
|
|
21965
|
-
* @summary
|
|
21966
|
-
* @param {string} [type] Must be one of PlayerModerationType, except unblock. Unblocking simply removes a block.
|
|
21967
|
-
* @param {string} [targetUserId] Must be valid UserID.
|
|
22160
|
+
* Clear **all** notifications.
|
|
22161
|
+
* @summary Clear All Notifications
|
|
21968
22162
|
* @param {*} [options] Override http request option.
|
|
21969
22163
|
* @throws {RequiredError}
|
|
21970
22164
|
*/
|
|
21971
|
-
|
|
21972
|
-
return localVarFp.
|
|
22165
|
+
clearNotifications(options?: any): AxiosPromise<Success> {
|
|
22166
|
+
return localVarFp.clearNotifications(options).then((request) => request(axios, basePath));
|
|
21973
22167
|
},
|
|
21974
22168
|
/**
|
|
21975
|
-
*
|
|
21976
|
-
* @summary
|
|
21977
|
-
* @param {
|
|
22169
|
+
* Delete a notification.
|
|
22170
|
+
* @summary Delete Notification
|
|
22171
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
21978
22172
|
* @param {*} [options] Override http request option.
|
|
21979
22173
|
* @throws {RequiredError}
|
|
21980
22174
|
*/
|
|
21981
|
-
|
|
21982
|
-
return localVarFp.
|
|
22175
|
+
deleteNotification(notificationId: string, options?: any): AxiosPromise<Notification> {
|
|
22176
|
+
return localVarFp.deleteNotification(notificationId, options).then((request) => request(axios, basePath));
|
|
21983
22177
|
},
|
|
21984
22178
|
/**
|
|
21985
|
-
*
|
|
21986
|
-
* @summary
|
|
21987
|
-
* @param {
|
|
22179
|
+
* Get a notification by notification `not_` ID.
|
|
22180
|
+
* @summary Show notification
|
|
22181
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
21988
22182
|
* @param {*} [options] Override http request option.
|
|
21989
22183
|
* @throws {RequiredError}
|
|
21990
22184
|
*/
|
|
21991
|
-
|
|
21992
|
-
return localVarFp.
|
|
22185
|
+
getNotification(notificationId: string, options?: any): AxiosPromise<Notification> {
|
|
22186
|
+
return localVarFp.getNotification(notificationId, options).then((request) => request(axios, basePath));
|
|
22187
|
+
},
|
|
22188
|
+
/**
|
|
22189
|
+
* Retrieve all of the current user\'s notifications.
|
|
22190
|
+
* @summary List Notifications
|
|
22191
|
+
* @param {string} [type] Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.
|
|
22192
|
+
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
22193
|
+
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
22194
|
+
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
22195
|
+
* @param {number} [n] The number of objects to return.
|
|
22196
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
22197
|
+
* @param {*} [options] Override http request option.
|
|
22198
|
+
* @throws {RequiredError}
|
|
22199
|
+
*/
|
|
22200
|
+
getNotifications(type?: string, sent?: boolean, hidden?: boolean, after?: string, n?: number, offset?: number, options?: any): AxiosPromise<Array<Notification>> {
|
|
22201
|
+
return localVarFp.getNotifications(type, sent, hidden, after, n, offset, options).then((request) => request(axios, basePath));
|
|
22202
|
+
},
|
|
22203
|
+
/**
|
|
22204
|
+
* Mark a notification as seen.
|
|
22205
|
+
* @summary Mark Notification As Read
|
|
22206
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
22207
|
+
* @param {*} [options] Override http request option.
|
|
22208
|
+
* @throws {RequiredError}
|
|
22209
|
+
*/
|
|
22210
|
+
markNotificationAsRead(notificationId: string, options?: any): AxiosPromise<Notification> {
|
|
22211
|
+
return localVarFp.markNotificationAsRead(notificationId, options).then((request) => request(axios, basePath));
|
|
21993
22212
|
},
|
|
21994
22213
|
};
|
|
21995
22214
|
};
|
|
21996
22215
|
|
|
21997
22216
|
/**
|
|
21998
|
-
*
|
|
22217
|
+
* NotificationsApi - object-oriented interface
|
|
21999
22218
|
* @export
|
|
22000
|
-
* @class
|
|
22219
|
+
* @class NotificationsApi
|
|
22001
22220
|
* @extends {BaseAPI}
|
|
22002
22221
|
*/
|
|
22003
|
-
export class
|
|
22222
|
+
export class NotificationsApi extends BaseAPI {
|
|
22004
22223
|
/**
|
|
22005
|
-
*
|
|
22006
|
-
* @summary
|
|
22224
|
+
* Accept a friend request by notification `frq_` ID. Friend requests can be found using the NotificationsAPI `getNotifications` by filtering of type `friendRequest`.
|
|
22225
|
+
* @summary Accept Friend Request
|
|
22226
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
22007
22227
|
* @param {*} [options] Override http request option.
|
|
22008
22228
|
* @throws {RequiredError}
|
|
22009
|
-
* @memberof
|
|
22229
|
+
* @memberof NotificationsApi
|
|
22010
22230
|
*/
|
|
22011
|
-
public
|
|
22012
|
-
return
|
|
22231
|
+
public acceptFriendRequest(notificationId: string, options?: AxiosRequestConfig) {
|
|
22232
|
+
return NotificationsApiFp(this.configuration).acceptFriendRequest(notificationId, options).then((request) => request(this.axios, this.basePath));
|
|
22013
22233
|
}
|
|
22014
22234
|
|
|
22015
22235
|
/**
|
|
22016
|
-
*
|
|
22017
|
-
* @summary
|
|
22018
|
-
* @param {string} [type] Must be one of PlayerModerationType, except unblock. Unblocking simply removes a block.
|
|
22019
|
-
* @param {string} [targetUserId] Must be valid UserID.
|
|
22236
|
+
* Clear **all** notifications.
|
|
22237
|
+
* @summary Clear All Notifications
|
|
22020
22238
|
* @param {*} [options] Override http request option.
|
|
22021
22239
|
* @throws {RequiredError}
|
|
22022
|
-
* @memberof
|
|
22240
|
+
* @memberof NotificationsApi
|
|
22023
22241
|
*/
|
|
22024
|
-
public
|
|
22025
|
-
return
|
|
22242
|
+
public clearNotifications(options?: AxiosRequestConfig) {
|
|
22243
|
+
return NotificationsApiFp(this.configuration).clearNotifications(options).then((request) => request(this.axios, this.basePath));
|
|
22026
22244
|
}
|
|
22027
22245
|
|
|
22028
22246
|
/**
|
|
22029
|
-
*
|
|
22030
|
-
* @summary
|
|
22031
|
-
* @param {
|
|
22247
|
+
* Delete a notification.
|
|
22248
|
+
* @summary Delete Notification
|
|
22249
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
22032
22250
|
* @param {*} [options] Override http request option.
|
|
22033
22251
|
* @throws {RequiredError}
|
|
22034
|
-
* @memberof
|
|
22252
|
+
* @memberof NotificationsApi
|
|
22035
22253
|
*/
|
|
22036
|
-
public
|
|
22037
|
-
return
|
|
22254
|
+
public deleteNotification(notificationId: string, options?: AxiosRequestConfig) {
|
|
22255
|
+
return NotificationsApiFp(this.configuration).deleteNotification(notificationId, options).then((request) => request(this.axios, this.basePath));
|
|
22038
22256
|
}
|
|
22039
22257
|
|
|
22040
22258
|
/**
|
|
22041
|
-
*
|
|
22042
|
-
* @summary
|
|
22043
|
-
* @param {
|
|
22259
|
+
* Get a notification by notification `not_` ID.
|
|
22260
|
+
* @summary Show notification
|
|
22261
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
22044
22262
|
* @param {*} [options] Override http request option.
|
|
22045
22263
|
* @throws {RequiredError}
|
|
22046
|
-
* @memberof
|
|
22264
|
+
* @memberof NotificationsApi
|
|
22047
22265
|
*/
|
|
22048
|
-
public
|
|
22049
|
-
return
|
|
22266
|
+
public getNotification(notificationId: string, options?: AxiosRequestConfig) {
|
|
22267
|
+
return NotificationsApiFp(this.configuration).getNotification(notificationId, options).then((request) => request(this.axios, this.basePath));
|
|
22050
22268
|
}
|
|
22051
|
-
}
|
|
22052
22269
|
|
|
22270
|
+
/**
|
|
22271
|
+
* Retrieve all of the current user\'s notifications.
|
|
22272
|
+
* @summary List Notifications
|
|
22273
|
+
* @param {string} [type] Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.
|
|
22274
|
+
* @param {boolean} [sent] Return notifications sent by the user. Must be false or omitted.
|
|
22275
|
+
* @param {boolean} [hidden] Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.
|
|
22276
|
+
* @param {string} [after] Only return notifications sent after this Date. Ignored if type is `friendRequest`.
|
|
22277
|
+
* @param {number} [n] The number of objects to return.
|
|
22278
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
22279
|
+
* @param {*} [options] Override http request option.
|
|
22280
|
+
* @throws {RequiredError}
|
|
22281
|
+
* @memberof NotificationsApi
|
|
22282
|
+
*/
|
|
22283
|
+
public getNotifications(type?: string, sent?: boolean, hidden?: boolean, after?: string, n?: number, offset?: number, options?: AxiosRequestConfig) {
|
|
22284
|
+
return NotificationsApiFp(this.configuration).getNotifications(type, sent, hidden, after, n, offset, options).then((request) => request(this.axios, this.basePath));
|
|
22285
|
+
}
|
|
22053
22286
|
|
|
22054
|
-
/**
|
|
22055
|
-
|
|
22056
|
-
|
|
22057
|
-
|
|
22058
|
-
|
|
22059
|
-
|
|
22060
|
-
|
|
22061
|
-
|
|
22062
|
-
|
|
22063
|
-
|
|
22064
|
-
|
|
22065
|
-
|
|
22066
|
-
*/
|
|
22067
|
-
deletePrint: async (printId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
22068
|
-
// verify required parameter 'printId' is not null or undefined
|
|
22069
|
-
assertParamExists('deletePrint', 'printId', printId)
|
|
22070
|
-
const localVarPath = `/prints/{printId}`
|
|
22071
|
-
.replace(`{${"printId"}}`, encodeURIComponent(String(printId)));
|
|
22072
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22073
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22074
|
-
let baseOptions;
|
|
22075
|
-
if (configuration) {
|
|
22076
|
-
baseOptions = configuration.baseOptions;
|
|
22077
|
-
}
|
|
22078
|
-
|
|
22079
|
-
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
22080
|
-
const localVarHeaderParameter = {} as any;
|
|
22081
|
-
const localVarQueryParameter = {} as any;
|
|
22082
|
-
|
|
22083
|
-
// authentication authCookie required
|
|
22084
|
-
|
|
22287
|
+
/**
|
|
22288
|
+
* Mark a notification as seen.
|
|
22289
|
+
* @summary Mark Notification As Read
|
|
22290
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
22291
|
+
* @param {*} [options] Override http request option.
|
|
22292
|
+
* @throws {RequiredError}
|
|
22293
|
+
* @memberof NotificationsApi
|
|
22294
|
+
*/
|
|
22295
|
+
public markNotificationAsRead(notificationId: string, options?: AxiosRequestConfig) {
|
|
22296
|
+
return NotificationsApiFp(this.configuration).markNotificationAsRead(notificationId, options).then((request) => request(this.axios, this.basePath));
|
|
22297
|
+
}
|
|
22298
|
+
}
|
|
22085
22299
|
|
|
22086
|
-
|
|
22087
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
22088
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22089
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
22090
22300
|
|
|
22091
|
-
|
|
22092
|
-
|
|
22093
|
-
|
|
22094
|
-
|
|
22095
|
-
|
|
22301
|
+
/**
|
|
22302
|
+
* PlayermoderationApi - axios parameter creator
|
|
22303
|
+
* @export
|
|
22304
|
+
*/
|
|
22305
|
+
export const PlayermoderationApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
22306
|
+
return {
|
|
22096
22307
|
/**
|
|
22097
|
-
*
|
|
22098
|
-
* @summary
|
|
22099
|
-
* @param {string} printId Print ID.
|
|
22100
|
-
* @param {File} image The binary blob of the png file.
|
|
22101
|
-
* @param {string} [note] The caption for the image.
|
|
22308
|
+
* ⚠️ **This will delete every single player moderation you\'ve ever made.**
|
|
22309
|
+
* @summary Clear All Player Moderations
|
|
22102
22310
|
* @param {*} [options] Override http request option.
|
|
22103
22311
|
* @throws {RequiredError}
|
|
22104
22312
|
*/
|
|
22105
|
-
|
|
22106
|
-
|
|
22107
|
-
assertParamExists('editPrint', 'printId', printId)
|
|
22108
|
-
// verify required parameter 'image' is not null or undefined
|
|
22109
|
-
assertParamExists('editPrint', 'image', image)
|
|
22110
|
-
const localVarPath = `/prints/{printId}`
|
|
22111
|
-
.replace(`{${"printId"}}`, encodeURIComponent(String(printId)));
|
|
22313
|
+
clearAllPlayerModerations: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
22314
|
+
const localVarPath = `/auth/user/playermoderations`;
|
|
22112
22315
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22113
22316
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22114
22317
|
let baseOptions;
|
|
@@ -22116,29 +22319,17 @@ export const PrintsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22116
22319
|
baseOptions = configuration.baseOptions;
|
|
22117
22320
|
}
|
|
22118
22321
|
|
|
22119
|
-
const localVarRequestOptions = { method: '
|
|
22322
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
22120
22323
|
const localVarHeaderParameter = {} as any;
|
|
22121
22324
|
const localVarQueryParameter = {} as any;
|
|
22122
|
-
const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
|
|
22123
22325
|
|
|
22124
22326
|
// authentication authCookie required
|
|
22125
22327
|
|
|
22126
22328
|
|
|
22127
|
-
if (image !== undefined) {
|
|
22128
|
-
localVarFormParams.append('image', image as any);
|
|
22129
|
-
}
|
|
22130
|
-
|
|
22131
|
-
if (note !== undefined) {
|
|
22132
|
-
localVarFormParams.append('note', note as any);
|
|
22133
|
-
}
|
|
22134
|
-
|
|
22135
|
-
|
|
22136
|
-
localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
|
|
22137
22329
|
|
|
22138
22330
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
22139
22331
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22140
22332
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
22141
|
-
localVarRequestOptions.data = localVarFormParams;
|
|
22142
22333
|
|
|
22143
22334
|
return {
|
|
22144
22335
|
url: toPathString(localVarUrlObj),
|
|
@@ -22146,17 +22337,15 @@ export const PrintsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22146
22337
|
};
|
|
22147
22338
|
},
|
|
22148
22339
|
/**
|
|
22149
|
-
* Returns a
|
|
22150
|
-
* @summary
|
|
22151
|
-
* @param {string}
|
|
22340
|
+
* Returns a list of all player moderations made by **you**. This endpoint does not have pagination, and will return *all* results. Use query parameters to limit your query if needed.
|
|
22341
|
+
* @summary Search Player Moderations
|
|
22342
|
+
* @param {string} [type] Must be one of PlayerModerationType, except unblock. Unblocking simply removes a block.
|
|
22343
|
+
* @param {string} [targetUserId] Must be valid UserID.
|
|
22152
22344
|
* @param {*} [options] Override http request option.
|
|
22153
22345
|
* @throws {RequiredError}
|
|
22154
22346
|
*/
|
|
22155
|
-
|
|
22156
|
-
|
|
22157
|
-
assertParamExists('getPrint', 'printId', printId)
|
|
22158
|
-
const localVarPath = `/prints/{printId}`
|
|
22159
|
-
.replace(`{${"printId"}}`, encodeURIComponent(String(printId)));
|
|
22347
|
+
getPlayerModerations: async (type?: string, targetUserId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
22348
|
+
const localVarPath = `/auth/user/playermoderations`;
|
|
22160
22349
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22161
22350
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22162
22351
|
let baseOptions;
|
|
@@ -22170,6 +22359,14 @@ export const PrintsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22170
22359
|
|
|
22171
22360
|
// authentication authCookie required
|
|
22172
22361
|
|
|
22362
|
+
if (type !== undefined) {
|
|
22363
|
+
localVarQueryParameter['type'] = type;
|
|
22364
|
+
}
|
|
22365
|
+
|
|
22366
|
+
if (targetUserId !== undefined) {
|
|
22367
|
+
localVarQueryParameter['targetUserId'] = targetUserId;
|
|
22368
|
+
}
|
|
22369
|
+
|
|
22173
22370
|
|
|
22174
22371
|
|
|
22175
22372
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -22182,17 +22379,16 @@ export const PrintsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22182
22379
|
};
|
|
22183
22380
|
},
|
|
22184
22381
|
/**
|
|
22185
|
-
*
|
|
22186
|
-
* @summary
|
|
22187
|
-
* @param {
|
|
22382
|
+
* Moderate a user, e.g. unmute them or show their avatar. Please see the [Player Moderation docs](https://vrchatapi.github.io/docs/api/#tag--playermoderation) on what playerModerations are, and how they differ from staff moderations.
|
|
22383
|
+
* @summary Moderate User
|
|
22384
|
+
* @param {ModerateUserRequest} moderateUserRequest
|
|
22188
22385
|
* @param {*} [options] Override http request option.
|
|
22189
22386
|
* @throws {RequiredError}
|
|
22190
22387
|
*/
|
|
22191
|
-
|
|
22192
|
-
// verify required parameter '
|
|
22193
|
-
assertParamExists('
|
|
22194
|
-
const localVarPath = `/
|
|
22195
|
-
.replace(`{${"userId"}}`, encodeURIComponent(String(userId)));
|
|
22388
|
+
moderateUser: async (moderateUserRequest: ModerateUserRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
22389
|
+
// verify required parameter 'moderateUserRequest' is not null or undefined
|
|
22390
|
+
assertParamExists('moderateUser', 'moderateUserRequest', moderateUserRequest)
|
|
22391
|
+
const localVarPath = `/auth/user/playermoderations`;
|
|
22196
22392
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22197
22393
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22198
22394
|
let baseOptions;
|
|
@@ -22200,7 +22396,7 @@ export const PrintsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22200
22396
|
baseOptions = configuration.baseOptions;
|
|
22201
22397
|
}
|
|
22202
22398
|
|
|
22203
|
-
const localVarRequestOptions = { method: '
|
|
22399
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
22204
22400
|
const localVarHeaderParameter = {} as any;
|
|
22205
22401
|
const localVarQueryParameter = {} as any;
|
|
22206
22402
|
|
|
@@ -22208,9 +22404,12 @@ export const PrintsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22208
22404
|
|
|
22209
22405
|
|
|
22210
22406
|
|
|
22407
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
22408
|
+
|
|
22211
22409
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
22212
22410
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22213
22411
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
22412
|
+
localVarRequestOptions.data = serializeDataIfNeeded(moderateUserRequest, localVarRequestOptions, configuration)
|
|
22214
22413
|
|
|
22215
22414
|
return {
|
|
22216
22415
|
url: toPathString(localVarUrlObj),
|
|
@@ -22218,22 +22417,16 @@ export const PrintsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22218
22417
|
};
|
|
22219
22418
|
},
|
|
22220
22419
|
/**
|
|
22221
|
-
*
|
|
22222
|
-
* @summary
|
|
22223
|
-
* @param {
|
|
22224
|
-
* @param {string} timestamp The time the image was captured.
|
|
22225
|
-
* @param {string} [note] The caption for the image.
|
|
22226
|
-
* @param {string} [worldId] The id of the world in which the image was captured.
|
|
22227
|
-
* @param {string} [worldName] The name of the world in which the image was captured.
|
|
22420
|
+
* Removes a player moderation previously added through `moderateUser`. E.g if you previously have shown their avatar, but now want to reset it to default.
|
|
22421
|
+
* @summary Unmoderate User
|
|
22422
|
+
* @param {ModerateUserRequest} moderateUserRequest
|
|
22228
22423
|
* @param {*} [options] Override http request option.
|
|
22229
22424
|
* @throws {RequiredError}
|
|
22230
22425
|
*/
|
|
22231
|
-
|
|
22232
|
-
// verify required parameter '
|
|
22233
|
-
assertParamExists('
|
|
22234
|
-
|
|
22235
|
-
assertParamExists('uploadPrint', 'timestamp', timestamp)
|
|
22236
|
-
const localVarPath = `/prints`;
|
|
22426
|
+
unmoderateUser: async (moderateUserRequest: ModerateUserRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
22427
|
+
// verify required parameter 'moderateUserRequest' is not null or undefined
|
|
22428
|
+
assertParamExists('unmoderateUser', 'moderateUserRequest', moderateUserRequest)
|
|
22429
|
+
const localVarPath = `/auth/user/unplayermoderate`;
|
|
22237
22430
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22238
22431
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22239
22432
|
let baseOptions;
|
|
@@ -22241,41 +22434,20 @@ export const PrintsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22241
22434
|
baseOptions = configuration.baseOptions;
|
|
22242
22435
|
}
|
|
22243
22436
|
|
|
22244
|
-
const localVarRequestOptions = { method: '
|
|
22437
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
22245
22438
|
const localVarHeaderParameter = {} as any;
|
|
22246
22439
|
const localVarQueryParameter = {} as any;
|
|
22247
|
-
const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
|
|
22248
22440
|
|
|
22249
22441
|
// authentication authCookie required
|
|
22250
22442
|
|
|
22251
22443
|
|
|
22252
|
-
if (image !== undefined) {
|
|
22253
|
-
localVarFormParams.append('image', image as any);
|
|
22254
|
-
}
|
|
22255
|
-
|
|
22256
|
-
if (timestamp !== undefined) {
|
|
22257
|
-
localVarFormParams.append('timestamp', timestamp as any);
|
|
22258
|
-
}
|
|
22259
|
-
|
|
22260
|
-
if (note !== undefined) {
|
|
22261
|
-
localVarFormParams.append('note', note as any);
|
|
22262
|
-
}
|
|
22263
|
-
|
|
22264
|
-
if (worldId !== undefined) {
|
|
22265
|
-
localVarFormParams.append('worldId', worldId as any);
|
|
22266
|
-
}
|
|
22267
|
-
|
|
22268
|
-
if (worldName !== undefined) {
|
|
22269
|
-
localVarFormParams.append('worldName', worldName as any);
|
|
22270
|
-
}
|
|
22271
|
-
|
|
22272
|
-
|
|
22273
|
-
localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
|
|
22274
22444
|
|
|
22445
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
22446
|
+
|
|
22275
22447
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
22276
22448
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22277
22449
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
22278
|
-
localVarRequestOptions.data =
|
|
22450
|
+
localVarRequestOptions.data = serializeDataIfNeeded(moderateUserRequest, localVarRequestOptions, configuration)
|
|
22279
22451
|
|
|
22280
22452
|
return {
|
|
22281
22453
|
url: toPathString(localVarUrlObj),
|
|
@@ -22286,233 +22458,184 @@ export const PrintsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22286
22458
|
};
|
|
22287
22459
|
|
|
22288
22460
|
/**
|
|
22289
|
-
*
|
|
22461
|
+
* PlayermoderationApi - functional programming interface
|
|
22290
22462
|
* @export
|
|
22291
22463
|
*/
|
|
22292
|
-
export const
|
|
22293
|
-
const localVarAxiosParamCreator =
|
|
22464
|
+
export const PlayermoderationApiFp = function(configuration?: Configuration) {
|
|
22465
|
+
const localVarAxiosParamCreator = PlayermoderationApiAxiosParamCreator(configuration)
|
|
22294
22466
|
return {
|
|
22295
22467
|
/**
|
|
22296
|
-
*
|
|
22297
|
-
* @summary
|
|
22298
|
-
* @param {string} printId Print ID.
|
|
22299
|
-
* @param {*} [options] Override http request option.
|
|
22300
|
-
* @throws {RequiredError}
|
|
22301
|
-
*/
|
|
22302
|
-
async deletePrint(printId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
22303
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.deletePrint(printId, options);
|
|
22304
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
22305
|
-
},
|
|
22306
|
-
/**
|
|
22307
|
-
* Edits a print.
|
|
22308
|
-
* @summary Edit Print
|
|
22309
|
-
* @param {string} printId Print ID.
|
|
22310
|
-
* @param {File} image The binary blob of the png file.
|
|
22311
|
-
* @param {string} [note] The caption for the image.
|
|
22468
|
+
* ⚠️ **This will delete every single player moderation you\'ve ever made.**
|
|
22469
|
+
* @summary Clear All Player Moderations
|
|
22312
22470
|
* @param {*} [options] Override http request option.
|
|
22313
22471
|
* @throws {RequiredError}
|
|
22314
22472
|
*/
|
|
22315
|
-
async
|
|
22316
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
22473
|
+
async clearAllPlayerModerations(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>> {
|
|
22474
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.clearAllPlayerModerations(options);
|
|
22317
22475
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
22318
22476
|
},
|
|
22319
22477
|
/**
|
|
22320
|
-
* Returns a
|
|
22321
|
-
* @summary
|
|
22322
|
-
* @param {string}
|
|
22478
|
+
* Returns a list of all player moderations made by **you**. This endpoint does not have pagination, and will return *all* results. Use query parameters to limit your query if needed.
|
|
22479
|
+
* @summary Search Player Moderations
|
|
22480
|
+
* @param {string} [type] Must be one of PlayerModerationType, except unblock. Unblocking simply removes a block.
|
|
22481
|
+
* @param {string} [targetUserId] Must be valid UserID.
|
|
22323
22482
|
* @param {*} [options] Override http request option.
|
|
22324
22483
|
* @throws {RequiredError}
|
|
22325
22484
|
*/
|
|
22326
|
-
async
|
|
22327
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
22485
|
+
async getPlayerModerations(type?: string, targetUserId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PlayerModeration>>> {
|
|
22486
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlayerModerations(type, targetUserId, options);
|
|
22328
22487
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
22329
22488
|
},
|
|
22330
22489
|
/**
|
|
22331
|
-
*
|
|
22332
|
-
* @summary
|
|
22333
|
-
* @param {
|
|
22490
|
+
* Moderate a user, e.g. unmute them or show their avatar. Please see the [Player Moderation docs](https://vrchatapi.github.io/docs/api/#tag--playermoderation) on what playerModerations are, and how they differ from staff moderations.
|
|
22491
|
+
* @summary Moderate User
|
|
22492
|
+
* @param {ModerateUserRequest} moderateUserRequest
|
|
22334
22493
|
* @param {*} [options] Override http request option.
|
|
22335
22494
|
* @throws {RequiredError}
|
|
22336
22495
|
*/
|
|
22337
|
-
async
|
|
22338
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
22496
|
+
async moderateUser(moderateUserRequest: ModerateUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerModeration>> {
|
|
22497
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.moderateUser(moderateUserRequest, options);
|
|
22339
22498
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
22340
22499
|
},
|
|
22341
22500
|
/**
|
|
22342
|
-
*
|
|
22343
|
-
* @summary
|
|
22344
|
-
* @param {
|
|
22345
|
-
* @param {string} timestamp The time the image was captured.
|
|
22346
|
-
* @param {string} [note] The caption for the image.
|
|
22347
|
-
* @param {string} [worldId] The id of the world in which the image was captured.
|
|
22348
|
-
* @param {string} [worldName] The name of the world in which the image was captured.
|
|
22501
|
+
* Removes a player moderation previously added through `moderateUser`. E.g if you previously have shown their avatar, but now want to reset it to default.
|
|
22502
|
+
* @summary Unmoderate User
|
|
22503
|
+
* @param {ModerateUserRequest} moderateUserRequest
|
|
22349
22504
|
* @param {*} [options] Override http request option.
|
|
22350
22505
|
* @throws {RequiredError}
|
|
22351
22506
|
*/
|
|
22352
|
-
async
|
|
22353
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
22507
|
+
async unmoderateUser(moderateUserRequest: ModerateUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>> {
|
|
22508
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.unmoderateUser(moderateUserRequest, options);
|
|
22354
22509
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
22355
22510
|
},
|
|
22356
22511
|
}
|
|
22357
22512
|
};
|
|
22358
22513
|
|
|
22359
22514
|
/**
|
|
22360
|
-
*
|
|
22515
|
+
* PlayermoderationApi - factory interface
|
|
22361
22516
|
* @export
|
|
22362
22517
|
*/
|
|
22363
|
-
export const
|
|
22364
|
-
const localVarFp =
|
|
22518
|
+
export const PlayermoderationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
22519
|
+
const localVarFp = PlayermoderationApiFp(configuration)
|
|
22365
22520
|
return {
|
|
22366
22521
|
/**
|
|
22367
|
-
*
|
|
22368
|
-
* @summary
|
|
22369
|
-
* @param {string} printId Print ID.
|
|
22370
|
-
* @param {*} [options] Override http request option.
|
|
22371
|
-
* @throws {RequiredError}
|
|
22372
|
-
*/
|
|
22373
|
-
deletePrint(printId: string, options?: any): AxiosPromise<void> {
|
|
22374
|
-
return localVarFp.deletePrint(printId, options).then((request) => request(axios, basePath));
|
|
22375
|
-
},
|
|
22376
|
-
/**
|
|
22377
|
-
* Edits a print.
|
|
22378
|
-
* @summary Edit Print
|
|
22379
|
-
* @param {string} printId Print ID.
|
|
22380
|
-
* @param {File} image The binary blob of the png file.
|
|
22381
|
-
* @param {string} [note] The caption for the image.
|
|
22522
|
+
* ⚠️ **This will delete every single player moderation you\'ve ever made.**
|
|
22523
|
+
* @summary Clear All Player Moderations
|
|
22382
22524
|
* @param {*} [options] Override http request option.
|
|
22383
22525
|
* @throws {RequiredError}
|
|
22384
22526
|
*/
|
|
22385
|
-
|
|
22386
|
-
return localVarFp.
|
|
22527
|
+
clearAllPlayerModerations(options?: any): AxiosPromise<Success> {
|
|
22528
|
+
return localVarFp.clearAllPlayerModerations(options).then((request) => request(axios, basePath));
|
|
22387
22529
|
},
|
|
22388
22530
|
/**
|
|
22389
|
-
* Returns a
|
|
22390
|
-
* @summary
|
|
22391
|
-
* @param {string}
|
|
22531
|
+
* Returns a list of all player moderations made by **you**. This endpoint does not have pagination, and will return *all* results. Use query parameters to limit your query if needed.
|
|
22532
|
+
* @summary Search Player Moderations
|
|
22533
|
+
* @param {string} [type] Must be one of PlayerModerationType, except unblock. Unblocking simply removes a block.
|
|
22534
|
+
* @param {string} [targetUserId] Must be valid UserID.
|
|
22392
22535
|
* @param {*} [options] Override http request option.
|
|
22393
22536
|
* @throws {RequiredError}
|
|
22394
22537
|
*/
|
|
22395
|
-
|
|
22396
|
-
return localVarFp.
|
|
22538
|
+
getPlayerModerations(type?: string, targetUserId?: string, options?: any): AxiosPromise<Array<PlayerModeration>> {
|
|
22539
|
+
return localVarFp.getPlayerModerations(type, targetUserId, options).then((request) => request(axios, basePath));
|
|
22397
22540
|
},
|
|
22398
22541
|
/**
|
|
22399
|
-
*
|
|
22400
|
-
* @summary
|
|
22401
|
-
* @param {
|
|
22542
|
+
* Moderate a user, e.g. unmute them or show their avatar. Please see the [Player Moderation docs](https://vrchatapi.github.io/docs/api/#tag--playermoderation) on what playerModerations are, and how they differ from staff moderations.
|
|
22543
|
+
* @summary Moderate User
|
|
22544
|
+
* @param {ModerateUserRequest} moderateUserRequest
|
|
22402
22545
|
* @param {*} [options] Override http request option.
|
|
22403
22546
|
* @throws {RequiredError}
|
|
22404
22547
|
*/
|
|
22405
|
-
|
|
22406
|
-
return localVarFp.
|
|
22548
|
+
moderateUser(moderateUserRequest: ModerateUserRequest, options?: any): AxiosPromise<PlayerModeration> {
|
|
22549
|
+
return localVarFp.moderateUser(moderateUserRequest, options).then((request) => request(axios, basePath));
|
|
22407
22550
|
},
|
|
22408
22551
|
/**
|
|
22409
|
-
*
|
|
22410
|
-
* @summary
|
|
22411
|
-
* @param {
|
|
22412
|
-
* @param {string} timestamp The time the image was captured.
|
|
22413
|
-
* @param {string} [note] The caption for the image.
|
|
22414
|
-
* @param {string} [worldId] The id of the world in which the image was captured.
|
|
22415
|
-
* @param {string} [worldName] The name of the world in which the image was captured.
|
|
22552
|
+
* Removes a player moderation previously added through `moderateUser`. E.g if you previously have shown their avatar, but now want to reset it to default.
|
|
22553
|
+
* @summary Unmoderate User
|
|
22554
|
+
* @param {ModerateUserRequest} moderateUserRequest
|
|
22416
22555
|
* @param {*} [options] Override http request option.
|
|
22417
22556
|
* @throws {RequiredError}
|
|
22418
22557
|
*/
|
|
22419
|
-
|
|
22420
|
-
return localVarFp.
|
|
22558
|
+
unmoderateUser(moderateUserRequest: ModerateUserRequest, options?: any): AxiosPromise<Success> {
|
|
22559
|
+
return localVarFp.unmoderateUser(moderateUserRequest, options).then((request) => request(axios, basePath));
|
|
22421
22560
|
},
|
|
22422
22561
|
};
|
|
22423
22562
|
};
|
|
22424
22563
|
|
|
22425
22564
|
/**
|
|
22426
|
-
*
|
|
22565
|
+
* PlayermoderationApi - object-oriented interface
|
|
22427
22566
|
* @export
|
|
22428
|
-
* @class
|
|
22567
|
+
* @class PlayermoderationApi
|
|
22429
22568
|
* @extends {BaseAPI}
|
|
22430
22569
|
*/
|
|
22431
|
-
export class
|
|
22432
|
-
/**
|
|
22433
|
-
* Returns a print.
|
|
22434
|
-
* @summary Delete Print
|
|
22435
|
-
* @param {string} printId Print ID.
|
|
22436
|
-
* @param {*} [options] Override http request option.
|
|
22437
|
-
* @throws {RequiredError}
|
|
22438
|
-
* @memberof PrintsApi
|
|
22439
|
-
*/
|
|
22440
|
-
public deletePrint(printId: string, options?: AxiosRequestConfig) {
|
|
22441
|
-
return PrintsApiFp(this.configuration).deletePrint(printId, options).then((request) => request(this.axios, this.basePath));
|
|
22442
|
-
}
|
|
22443
|
-
|
|
22570
|
+
export class PlayermoderationApi extends BaseAPI {
|
|
22444
22571
|
/**
|
|
22445
|
-
*
|
|
22446
|
-
* @summary
|
|
22447
|
-
* @param {string} printId Print ID.
|
|
22448
|
-
* @param {File} image The binary blob of the png file.
|
|
22449
|
-
* @param {string} [note] The caption for the image.
|
|
22572
|
+
* ⚠️ **This will delete every single player moderation you\'ve ever made.**
|
|
22573
|
+
* @summary Clear All Player Moderations
|
|
22450
22574
|
* @param {*} [options] Override http request option.
|
|
22451
22575
|
* @throws {RequiredError}
|
|
22452
|
-
* @memberof
|
|
22576
|
+
* @memberof PlayermoderationApi
|
|
22453
22577
|
*/
|
|
22454
|
-
public
|
|
22455
|
-
return
|
|
22578
|
+
public clearAllPlayerModerations(options?: AxiosRequestConfig) {
|
|
22579
|
+
return PlayermoderationApiFp(this.configuration).clearAllPlayerModerations(options).then((request) => request(this.axios, this.basePath));
|
|
22456
22580
|
}
|
|
22457
22581
|
|
|
22458
22582
|
/**
|
|
22459
|
-
* Returns a
|
|
22460
|
-
* @summary
|
|
22461
|
-
* @param {string}
|
|
22583
|
+
* Returns a list of all player moderations made by **you**. This endpoint does not have pagination, and will return *all* results. Use query parameters to limit your query if needed.
|
|
22584
|
+
* @summary Search Player Moderations
|
|
22585
|
+
* @param {string} [type] Must be one of PlayerModerationType, except unblock. Unblocking simply removes a block.
|
|
22586
|
+
* @param {string} [targetUserId] Must be valid UserID.
|
|
22462
22587
|
* @param {*} [options] Override http request option.
|
|
22463
22588
|
* @throws {RequiredError}
|
|
22464
|
-
* @memberof
|
|
22589
|
+
* @memberof PlayermoderationApi
|
|
22465
22590
|
*/
|
|
22466
|
-
public
|
|
22467
|
-
return
|
|
22591
|
+
public getPlayerModerations(type?: string, targetUserId?: string, options?: AxiosRequestConfig) {
|
|
22592
|
+
return PlayermoderationApiFp(this.configuration).getPlayerModerations(type, targetUserId, options).then((request) => request(this.axios, this.basePath));
|
|
22468
22593
|
}
|
|
22469
22594
|
|
|
22470
22595
|
/**
|
|
22471
|
-
*
|
|
22472
|
-
* @summary
|
|
22473
|
-
* @param {
|
|
22596
|
+
* Moderate a user, e.g. unmute them or show their avatar. Please see the [Player Moderation docs](https://vrchatapi.github.io/docs/api/#tag--playermoderation) on what playerModerations are, and how they differ from staff moderations.
|
|
22597
|
+
* @summary Moderate User
|
|
22598
|
+
* @param {ModerateUserRequest} moderateUserRequest
|
|
22474
22599
|
* @param {*} [options] Override http request option.
|
|
22475
22600
|
* @throws {RequiredError}
|
|
22476
|
-
* @memberof
|
|
22601
|
+
* @memberof PlayermoderationApi
|
|
22477
22602
|
*/
|
|
22478
|
-
public
|
|
22479
|
-
return
|
|
22603
|
+
public moderateUser(moderateUserRequest: ModerateUserRequest, options?: AxiosRequestConfig) {
|
|
22604
|
+
return PlayermoderationApiFp(this.configuration).moderateUser(moderateUserRequest, options).then((request) => request(this.axios, this.basePath));
|
|
22480
22605
|
}
|
|
22481
22606
|
|
|
22482
22607
|
/**
|
|
22483
|
-
*
|
|
22484
|
-
* @summary
|
|
22485
|
-
* @param {
|
|
22486
|
-
* @param {string} timestamp The time the image was captured.
|
|
22487
|
-
* @param {string} [note] The caption for the image.
|
|
22488
|
-
* @param {string} [worldId] The id of the world in which the image was captured.
|
|
22489
|
-
* @param {string} [worldName] The name of the world in which the image was captured.
|
|
22608
|
+
* Removes a player moderation previously added through `moderateUser`. E.g if you previously have shown their avatar, but now want to reset it to default.
|
|
22609
|
+
* @summary Unmoderate User
|
|
22610
|
+
* @param {ModerateUserRequest} moderateUserRequest
|
|
22490
22611
|
* @param {*} [options] Override http request option.
|
|
22491
22612
|
* @throws {RequiredError}
|
|
22492
|
-
* @memberof
|
|
22613
|
+
* @memberof PlayermoderationApi
|
|
22493
22614
|
*/
|
|
22494
|
-
public
|
|
22495
|
-
return
|
|
22615
|
+
public unmoderateUser(moderateUserRequest: ModerateUserRequest, options?: AxiosRequestConfig) {
|
|
22616
|
+
return PlayermoderationApiFp(this.configuration).unmoderateUser(moderateUserRequest, options).then((request) => request(this.axios, this.basePath));
|
|
22496
22617
|
}
|
|
22497
22618
|
}
|
|
22498
22619
|
|
|
22499
22620
|
|
|
22500
22621
|
/**
|
|
22501
|
-
*
|
|
22622
|
+
* PrintsApi - axios parameter creator
|
|
22502
22623
|
* @export
|
|
22503
22624
|
*/
|
|
22504
|
-
export const
|
|
22625
|
+
export const PrintsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
22505
22626
|
return {
|
|
22506
22627
|
/**
|
|
22507
|
-
*
|
|
22508
|
-
* @summary
|
|
22509
|
-
* @param {
|
|
22510
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
22628
|
+
* Returns a print.
|
|
22629
|
+
* @summary Delete Print
|
|
22630
|
+
* @param {string} printId Print ID.
|
|
22511
22631
|
* @param {*} [options] Override http request option.
|
|
22512
22632
|
* @throws {RequiredError}
|
|
22513
22633
|
*/
|
|
22514
|
-
|
|
22515
|
-
|
|
22634
|
+
deletePrint: async (printId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
22635
|
+
// verify required parameter 'printId' is not null or undefined
|
|
22636
|
+
assertParamExists('deletePrint', 'printId', printId)
|
|
22637
|
+
const localVarPath = `/prints/{printId}`
|
|
22638
|
+
.replace(`{${"printId"}}`, encodeURIComponent(String(printId)));
|
|
22516
22639
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22517
22640
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22518
22641
|
let baseOptions;
|
|
@@ -22520,17 +22643,11 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22520
22643
|
baseOptions = configuration.baseOptions;
|
|
22521
22644
|
}
|
|
22522
22645
|
|
|
22523
|
-
const localVarRequestOptions = { method: '
|
|
22646
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
22524
22647
|
const localVarHeaderParameter = {} as any;
|
|
22525
22648
|
const localVarQueryParameter = {} as any;
|
|
22526
22649
|
|
|
22527
|
-
|
|
22528
|
-
localVarQueryParameter['variant'] = variant;
|
|
22529
|
-
}
|
|
22530
|
-
|
|
22531
|
-
if (branch !== undefined) {
|
|
22532
|
-
localVarQueryParameter['branch'] = branch;
|
|
22533
|
-
}
|
|
22650
|
+
// authentication authCookie required
|
|
22534
22651
|
|
|
22535
22652
|
|
|
22536
22653
|
|
|
@@ -22544,13 +22661,21 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22544
22661
|
};
|
|
22545
22662
|
},
|
|
22546
22663
|
/**
|
|
22547
|
-
*
|
|
22548
|
-
* @summary
|
|
22664
|
+
* Edits a print.
|
|
22665
|
+
* @summary Edit Print
|
|
22666
|
+
* @param {string} printId Print ID.
|
|
22667
|
+
* @param {File} image The binary blob of the png file.
|
|
22668
|
+
* @param {string} [note] The caption for the image.
|
|
22549
22669
|
* @param {*} [options] Override http request option.
|
|
22550
22670
|
* @throws {RequiredError}
|
|
22551
22671
|
*/
|
|
22552
|
-
|
|
22553
|
-
|
|
22672
|
+
editPrint: async (printId: string, image: File, note?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
22673
|
+
// verify required parameter 'printId' is not null or undefined
|
|
22674
|
+
assertParamExists('editPrint', 'printId', printId)
|
|
22675
|
+
// verify required parameter 'image' is not null or undefined
|
|
22676
|
+
assertParamExists('editPrint', 'image', image)
|
|
22677
|
+
const localVarPath = `/prints/{printId}`
|
|
22678
|
+
.replace(`{${"printId"}}`, encodeURIComponent(String(printId)));
|
|
22554
22679
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22555
22680
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22556
22681
|
let baseOptions;
|
|
@@ -22558,45 +22683,29 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22558
22683
|
baseOptions = configuration.baseOptions;
|
|
22559
22684
|
}
|
|
22560
22685
|
|
|
22561
|
-
const localVarRequestOptions = { method: '
|
|
22686
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
22562
22687
|
const localVarHeaderParameter = {} as any;
|
|
22563
22688
|
const localVarQueryParameter = {} as any;
|
|
22689
|
+
const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
|
|
22564
22690
|
|
|
22691
|
+
// authentication authCookie required
|
|
22565
22692
|
|
|
22566
|
-
|
|
22567
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
22568
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22569
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
22570
22693
|
|
|
22571
|
-
|
|
22572
|
-
|
|
22573
|
-
options: localVarRequestOptions,
|
|
22574
|
-
};
|
|
22575
|
-
},
|
|
22576
|
-
/**
|
|
22577
|
-
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
22578
|
-
* @summary Current Online Users
|
|
22579
|
-
* @param {*} [options] Override http request option.
|
|
22580
|
-
* @throws {RequiredError}
|
|
22581
|
-
*/
|
|
22582
|
-
getCurrentOnlineUsers: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
22583
|
-
const localVarPath = `/visits`;
|
|
22584
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22585
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22586
|
-
let baseOptions;
|
|
22587
|
-
if (configuration) {
|
|
22588
|
-
baseOptions = configuration.baseOptions;
|
|
22694
|
+
if (image !== undefined) {
|
|
22695
|
+
localVarFormParams.append('image', image as any);
|
|
22589
22696
|
}
|
|
22590
|
-
|
|
22591
|
-
|
|
22592
|
-
|
|
22593
|
-
|
|
22594
|
-
|
|
22595
|
-
|
|
22697
|
+
|
|
22698
|
+
if (note !== undefined) {
|
|
22699
|
+
localVarFormParams.append('note', note as any);
|
|
22700
|
+
}
|
|
22701
|
+
|
|
22702
|
+
|
|
22703
|
+
localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
|
|
22596
22704
|
|
|
22597
22705
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
22598
22706
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22599
22707
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
22708
|
+
localVarRequestOptions.data = localVarFormParams;
|
|
22600
22709
|
|
|
22601
22710
|
return {
|
|
22602
22711
|
url: toPathString(localVarUrlObj),
|
|
@@ -22604,14 +22713,17 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22604
22713
|
};
|
|
22605
22714
|
},
|
|
22606
22715
|
/**
|
|
22607
|
-
*
|
|
22608
|
-
* @summary
|
|
22716
|
+
* Returns a print.
|
|
22717
|
+
* @summary Get Print
|
|
22718
|
+
* @param {string} printId Print ID.
|
|
22609
22719
|
* @param {*} [options] Override http request option.
|
|
22610
|
-
* @deprecated
|
|
22611
22720
|
* @throws {RequiredError}
|
|
22612
22721
|
*/
|
|
22613
|
-
|
|
22614
|
-
|
|
22722
|
+
getPrint: async (printId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
22723
|
+
// verify required parameter 'printId' is not null or undefined
|
|
22724
|
+
assertParamExists('getPrint', 'printId', printId)
|
|
22725
|
+
const localVarPath = `/prints/{printId}`
|
|
22726
|
+
.replace(`{${"printId"}}`, encodeURIComponent(String(printId)));
|
|
22615
22727
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22616
22728
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22617
22729
|
let baseOptions;
|
|
@@ -22623,6 +22735,8 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22623
22735
|
const localVarHeaderParameter = {} as any;
|
|
22624
22736
|
const localVarQueryParameter = {} as any;
|
|
22625
22737
|
|
|
22738
|
+
// authentication authCookie required
|
|
22739
|
+
|
|
22626
22740
|
|
|
22627
22741
|
|
|
22628
22742
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -22635,15 +22749,17 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22635
22749
|
};
|
|
22636
22750
|
},
|
|
22637
22751
|
/**
|
|
22638
|
-
*
|
|
22639
|
-
* @summary
|
|
22640
|
-
* @param {string}
|
|
22641
|
-
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
22752
|
+
* Returns a list of all prints of the user. User id has to be your own userId, as you can\'t request other user\'s prints.
|
|
22753
|
+
* @summary Get Own Prints
|
|
22754
|
+
* @param {string} userId Must be a valid user ID.
|
|
22642
22755
|
* @param {*} [options] Override http request option.
|
|
22643
22756
|
* @throws {RequiredError}
|
|
22644
22757
|
*/
|
|
22645
|
-
|
|
22646
|
-
|
|
22758
|
+
getUserPrints: async (userId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
22759
|
+
// verify required parameter 'userId' is not null or undefined
|
|
22760
|
+
assertParamExists('getUserPrints', 'userId', userId)
|
|
22761
|
+
const localVarPath = `/prints/user/{userId}`
|
|
22762
|
+
.replace(`{${"userId"}}`, encodeURIComponent(String(userId)));
|
|
22647
22763
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22648
22764
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22649
22765
|
let baseOptions;
|
|
@@ -22655,13 +22771,7 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22655
22771
|
const localVarHeaderParameter = {} as any;
|
|
22656
22772
|
const localVarQueryParameter = {} as any;
|
|
22657
22773
|
|
|
22658
|
-
|
|
22659
|
-
localVarQueryParameter['require'] = require;
|
|
22660
|
-
}
|
|
22661
|
-
|
|
22662
|
-
if (include !== undefined) {
|
|
22663
|
-
localVarQueryParameter['include'] = include;
|
|
22664
|
-
}
|
|
22774
|
+
// authentication authCookie required
|
|
22665
22775
|
|
|
22666
22776
|
|
|
22667
22777
|
|
|
@@ -22675,15 +22785,22 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22675
22785
|
};
|
|
22676
22786
|
},
|
|
22677
22787
|
/**
|
|
22678
|
-
*
|
|
22679
|
-
* @summary
|
|
22680
|
-
* @param {
|
|
22681
|
-
* @param {string}
|
|
22788
|
+
* Uploads and creates a print.
|
|
22789
|
+
* @summary Upload Print
|
|
22790
|
+
* @param {File} image The binary blob of the png file.
|
|
22791
|
+
* @param {string} timestamp The time the image was captured.
|
|
22792
|
+
* @param {string} [note] The caption for the image.
|
|
22793
|
+
* @param {string} [worldId] The id of the world in which the image was captured.
|
|
22794
|
+
* @param {string} [worldName] The name of the world in which the image was captured.
|
|
22682
22795
|
* @param {*} [options] Override http request option.
|
|
22683
22796
|
* @throws {RequiredError}
|
|
22684
22797
|
*/
|
|
22685
|
-
|
|
22686
|
-
|
|
22798
|
+
uploadPrint: async (image: File, timestamp: string, note?: string, worldId?: string, worldName?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
22799
|
+
// verify required parameter 'image' is not null or undefined
|
|
22800
|
+
assertParamExists('uploadPrint', 'image', image)
|
|
22801
|
+
// verify required parameter 'timestamp' is not null or undefined
|
|
22802
|
+
assertParamExists('uploadPrint', 'timestamp', timestamp)
|
|
22803
|
+
const localVarPath = `/prints`;
|
|
22687
22804
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22688
22805
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22689
22806
|
let baseOptions;
|
|
@@ -22691,53 +22808,41 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22691
22808
|
baseOptions = configuration.baseOptions;
|
|
22692
22809
|
}
|
|
22693
22810
|
|
|
22694
|
-
const localVarRequestOptions = { method: '
|
|
22811
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
22695
22812
|
const localVarHeaderParameter = {} as any;
|
|
22696
22813
|
const localVarQueryParameter = {} as any;
|
|
22814
|
+
const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
|
|
22697
22815
|
|
|
22698
|
-
|
|
22699
|
-
localVarQueryParameter['variant'] = variant;
|
|
22700
|
-
}
|
|
22701
|
-
|
|
22702
|
-
if (branch !== undefined) {
|
|
22703
|
-
localVarQueryParameter['branch'] = branch;
|
|
22704
|
-
}
|
|
22816
|
+
// authentication authCookie required
|
|
22705
22817
|
|
|
22706
22818
|
|
|
22819
|
+
if (image !== undefined) {
|
|
22820
|
+
localVarFormParams.append('image', image as any);
|
|
22821
|
+
}
|
|
22707
22822
|
|
|
22708
|
-
|
|
22709
|
-
|
|
22710
|
-
|
|
22711
|
-
|
|
22712
|
-
|
|
22713
|
-
|
|
22714
|
-
|
|
22715
|
-
|
|
22716
|
-
|
|
22717
|
-
|
|
22718
|
-
* Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
|
22719
|
-
* @summary Current System Time
|
|
22720
|
-
* @param {*} [options] Override http request option.
|
|
22721
|
-
* @throws {RequiredError}
|
|
22722
|
-
*/
|
|
22723
|
-
getSystemTime: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
22724
|
-
const localVarPath = `/time`;
|
|
22725
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22726
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22727
|
-
let baseOptions;
|
|
22728
|
-
if (configuration) {
|
|
22729
|
-
baseOptions = configuration.baseOptions;
|
|
22823
|
+
if (timestamp !== undefined) {
|
|
22824
|
+
localVarFormParams.append('timestamp', timestamp as any);
|
|
22825
|
+
}
|
|
22826
|
+
|
|
22827
|
+
if (note !== undefined) {
|
|
22828
|
+
localVarFormParams.append('note', note as any);
|
|
22829
|
+
}
|
|
22830
|
+
|
|
22831
|
+
if (worldId !== undefined) {
|
|
22832
|
+
localVarFormParams.append('worldId', worldId as any);
|
|
22730
22833
|
}
|
|
22731
|
-
|
|
22732
|
-
|
|
22733
|
-
|
|
22734
|
-
|
|
22735
|
-
|
|
22736
|
-
|
|
22834
|
+
|
|
22835
|
+
if (worldName !== undefined) {
|
|
22836
|
+
localVarFormParams.append('worldName', worldName as any);
|
|
22837
|
+
}
|
|
22838
|
+
|
|
22839
|
+
|
|
22840
|
+
localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
|
|
22737
22841
|
|
|
22738
22842
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
22739
22843
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22740
22844
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
22845
|
+
localVarRequestOptions.data = localVarFormParams;
|
|
22741
22846
|
|
|
22742
22847
|
return {
|
|
22743
22848
|
url: toPathString(localVarUrlObj),
|
|
@@ -22748,261 +22853,213 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
22748
22853
|
};
|
|
22749
22854
|
|
|
22750
22855
|
/**
|
|
22751
|
-
*
|
|
22856
|
+
* PrintsApi - functional programming interface
|
|
22752
22857
|
* @export
|
|
22753
22858
|
*/
|
|
22754
|
-
export const
|
|
22755
|
-
const localVarAxiosParamCreator =
|
|
22859
|
+
export const PrintsApiFp = function(configuration?: Configuration) {
|
|
22860
|
+
const localVarAxiosParamCreator = PrintsApiAxiosParamCreator(configuration)
|
|
22756
22861
|
return {
|
|
22757
22862
|
/**
|
|
22758
|
-
*
|
|
22759
|
-
* @summary
|
|
22760
|
-
* @param {
|
|
22761
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
22762
|
-
* @param {*} [options] Override http request option.
|
|
22763
|
-
* @throws {RequiredError}
|
|
22764
|
-
*/
|
|
22765
|
-
async getCSS(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
|
|
22766
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getCSS(variant, branch, options);
|
|
22767
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
22768
|
-
},
|
|
22769
|
-
/**
|
|
22770
|
-
* 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.
|
|
22771
|
-
* @summary Fetch API Config
|
|
22772
|
-
* @param {*} [options] Override http request option.
|
|
22773
|
-
* @throws {RequiredError}
|
|
22774
|
-
*/
|
|
22775
|
-
async getConfig(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIConfig>> {
|
|
22776
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getConfig(options);
|
|
22777
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
22778
|
-
},
|
|
22779
|
-
/**
|
|
22780
|
-
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
22781
|
-
* @summary Current Online Users
|
|
22863
|
+
* Returns a print.
|
|
22864
|
+
* @summary Delete Print
|
|
22865
|
+
* @param {string} printId Print ID.
|
|
22782
22866
|
* @param {*} [options] Override http request option.
|
|
22783
22867
|
* @throws {RequiredError}
|
|
22784
22868
|
*/
|
|
22785
|
-
async
|
|
22786
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
22869
|
+
async deletePrint(printId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
22870
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deletePrint(printId, options);
|
|
22787
22871
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
22788
22872
|
},
|
|
22789
22873
|
/**
|
|
22790
|
-
*
|
|
22791
|
-
* @summary
|
|
22874
|
+
* Edits a print.
|
|
22875
|
+
* @summary Edit Print
|
|
22876
|
+
* @param {string} printId Print ID.
|
|
22877
|
+
* @param {File} image The binary blob of the png file.
|
|
22878
|
+
* @param {string} [note] The caption for the image.
|
|
22792
22879
|
* @param {*} [options] Override http request option.
|
|
22793
|
-
* @deprecated
|
|
22794
22880
|
* @throws {RequiredError}
|
|
22795
22881
|
*/
|
|
22796
|
-
async
|
|
22797
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
22882
|
+
async editPrint(printId: string, image: File, note?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Print>> {
|
|
22883
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.editPrint(printId, image, note, options);
|
|
22798
22884
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
22799
22885
|
},
|
|
22800
22886
|
/**
|
|
22801
|
-
*
|
|
22802
|
-
* @summary
|
|
22803
|
-
* @param {string}
|
|
22804
|
-
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
22887
|
+
* Returns a print.
|
|
22888
|
+
* @summary Get Print
|
|
22889
|
+
* @param {string} printId Print ID.
|
|
22805
22890
|
* @param {*} [options] Override http request option.
|
|
22806
22891
|
* @throws {RequiredError}
|
|
22807
22892
|
*/
|
|
22808
|
-
async
|
|
22809
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
22893
|
+
async getPrint(printId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Print>> {
|
|
22894
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPrint(printId, options);
|
|
22810
22895
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
22811
22896
|
},
|
|
22812
22897
|
/**
|
|
22813
|
-
*
|
|
22814
|
-
* @summary
|
|
22815
|
-
* @param {
|
|
22816
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
22898
|
+
* Returns a list of all prints of the user. User id has to be your own userId, as you can\'t request other user\'s prints.
|
|
22899
|
+
* @summary Get Own Prints
|
|
22900
|
+
* @param {string} userId Must be a valid user ID.
|
|
22817
22901
|
* @param {*} [options] Override http request option.
|
|
22818
22902
|
* @throws {RequiredError}
|
|
22819
22903
|
*/
|
|
22820
|
-
async
|
|
22821
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
22904
|
+
async getUserPrints(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Print>>> {
|
|
22905
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getUserPrints(userId, options);
|
|
22822
22906
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
22823
22907
|
},
|
|
22824
22908
|
/**
|
|
22825
|
-
*
|
|
22826
|
-
* @summary
|
|
22909
|
+
* Uploads and creates a print.
|
|
22910
|
+
* @summary Upload Print
|
|
22911
|
+
* @param {File} image The binary blob of the png file.
|
|
22912
|
+
* @param {string} timestamp The time the image was captured.
|
|
22913
|
+
* @param {string} [note] The caption for the image.
|
|
22914
|
+
* @param {string} [worldId] The id of the world in which the image was captured.
|
|
22915
|
+
* @param {string} [worldName] The name of the world in which the image was captured.
|
|
22827
22916
|
* @param {*} [options] Override http request option.
|
|
22828
22917
|
* @throws {RequiredError}
|
|
22829
22918
|
*/
|
|
22830
|
-
async
|
|
22831
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
22919
|
+
async uploadPrint(image: File, timestamp: string, note?: string, worldId?: string, worldName?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Print>> {
|
|
22920
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.uploadPrint(image, timestamp, note, worldId, worldName, options);
|
|
22832
22921
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
22833
22922
|
},
|
|
22834
22923
|
}
|
|
22835
22924
|
};
|
|
22836
22925
|
|
|
22837
22926
|
/**
|
|
22838
|
-
*
|
|
22927
|
+
* PrintsApi - factory interface
|
|
22839
22928
|
* @export
|
|
22840
22929
|
*/
|
|
22841
|
-
export const
|
|
22842
|
-
const localVarFp =
|
|
22930
|
+
export const PrintsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
22931
|
+
const localVarFp = PrintsApiFp(configuration)
|
|
22843
22932
|
return {
|
|
22844
22933
|
/**
|
|
22845
|
-
*
|
|
22846
|
-
* @summary
|
|
22847
|
-
* @param {
|
|
22848
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
22849
|
-
* @param {*} [options] Override http request option.
|
|
22850
|
-
* @throws {RequiredError}
|
|
22851
|
-
*/
|
|
22852
|
-
getCSS(variant?: 'public' | 'internal', branch?: string, options?: any): AxiosPromise<string> {
|
|
22853
|
-
return localVarFp.getCSS(variant, branch, options).then((request) => request(axios, basePath));
|
|
22854
|
-
},
|
|
22855
|
-
/**
|
|
22856
|
-
* 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.
|
|
22857
|
-
* @summary Fetch API Config
|
|
22858
|
-
* @param {*} [options] Override http request option.
|
|
22859
|
-
* @throws {RequiredError}
|
|
22860
|
-
*/
|
|
22861
|
-
getConfig(options?: any): AxiosPromise<APIConfig> {
|
|
22862
|
-
return localVarFp.getConfig(options).then((request) => request(axios, basePath));
|
|
22863
|
-
},
|
|
22864
|
-
/**
|
|
22865
|
-
* Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
|
22866
|
-
* @summary Current Online Users
|
|
22934
|
+
* Returns a print.
|
|
22935
|
+
* @summary Delete Print
|
|
22936
|
+
* @param {string} printId Print ID.
|
|
22867
22937
|
* @param {*} [options] Override http request option.
|
|
22868
22938
|
* @throws {RequiredError}
|
|
22869
22939
|
*/
|
|
22870
|
-
|
|
22871
|
-
return localVarFp.
|
|
22940
|
+
deletePrint(printId: string, options?: any): AxiosPromise<void> {
|
|
22941
|
+
return localVarFp.deletePrint(printId, options).then((request) => request(axios, basePath));
|
|
22872
22942
|
},
|
|
22873
22943
|
/**
|
|
22874
|
-
*
|
|
22875
|
-
* @summary
|
|
22944
|
+
* Edits a print.
|
|
22945
|
+
* @summary Edit Print
|
|
22946
|
+
* @param {string} printId Print ID.
|
|
22947
|
+
* @param {File} image The binary blob of the png file.
|
|
22948
|
+
* @param {string} [note] The caption for the image.
|
|
22876
22949
|
* @param {*} [options] Override http request option.
|
|
22877
|
-
* @deprecated
|
|
22878
22950
|
* @throws {RequiredError}
|
|
22879
22951
|
*/
|
|
22880
|
-
|
|
22881
|
-
return localVarFp.
|
|
22952
|
+
editPrint(printId: string, image: File, note?: string, options?: any): AxiosPromise<Print> {
|
|
22953
|
+
return localVarFp.editPrint(printId, image, note, options).then((request) => request(axios, basePath));
|
|
22882
22954
|
},
|
|
22883
22955
|
/**
|
|
22884
|
-
*
|
|
22885
|
-
* @summary
|
|
22886
|
-
* @param {string}
|
|
22887
|
-
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
22956
|
+
* Returns a print.
|
|
22957
|
+
* @summary Get Print
|
|
22958
|
+
* @param {string} printId Print ID.
|
|
22888
22959
|
* @param {*} [options] Override http request option.
|
|
22889
22960
|
* @throws {RequiredError}
|
|
22890
22961
|
*/
|
|
22891
|
-
|
|
22892
|
-
return localVarFp.
|
|
22962
|
+
getPrint(printId: string, options?: any): AxiosPromise<Print> {
|
|
22963
|
+
return localVarFp.getPrint(printId, options).then((request) => request(axios, basePath));
|
|
22893
22964
|
},
|
|
22894
22965
|
/**
|
|
22895
|
-
*
|
|
22896
|
-
* @summary
|
|
22897
|
-
* @param {
|
|
22898
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
22966
|
+
* Returns a list of all prints of the user. User id has to be your own userId, as you can\'t request other user\'s prints.
|
|
22967
|
+
* @summary Get Own Prints
|
|
22968
|
+
* @param {string} userId Must be a valid user ID.
|
|
22899
22969
|
* @param {*} [options] Override http request option.
|
|
22900
22970
|
* @throws {RequiredError}
|
|
22901
22971
|
*/
|
|
22902
|
-
|
|
22903
|
-
return localVarFp.
|
|
22972
|
+
getUserPrints(userId: string, options?: any): AxiosPromise<Array<Print>> {
|
|
22973
|
+
return localVarFp.getUserPrints(userId, options).then((request) => request(axios, basePath));
|
|
22904
22974
|
},
|
|
22905
22975
|
/**
|
|
22906
|
-
*
|
|
22907
|
-
* @summary
|
|
22976
|
+
* Uploads and creates a print.
|
|
22977
|
+
* @summary Upload Print
|
|
22978
|
+
* @param {File} image The binary blob of the png file.
|
|
22979
|
+
* @param {string} timestamp The time the image was captured.
|
|
22980
|
+
* @param {string} [note] The caption for the image.
|
|
22981
|
+
* @param {string} [worldId] The id of the world in which the image was captured.
|
|
22982
|
+
* @param {string} [worldName] The name of the world in which the image was captured.
|
|
22908
22983
|
* @param {*} [options] Override http request option.
|
|
22909
22984
|
* @throws {RequiredError}
|
|
22910
22985
|
*/
|
|
22911
|
-
|
|
22912
|
-
return localVarFp.
|
|
22986
|
+
uploadPrint(image: File, timestamp: string, note?: string, worldId?: string, worldName?: string, options?: any): AxiosPromise<Print> {
|
|
22987
|
+
return localVarFp.uploadPrint(image, timestamp, note, worldId, worldName, options).then((request) => request(axios, basePath));
|
|
22913
22988
|
},
|
|
22914
22989
|
};
|
|
22915
22990
|
};
|
|
22916
22991
|
|
|
22917
22992
|
/**
|
|
22918
|
-
*
|
|
22993
|
+
* PrintsApi - object-oriented interface
|
|
22919
22994
|
* @export
|
|
22920
|
-
* @class
|
|
22995
|
+
* @class PrintsApi
|
|
22921
22996
|
* @extends {BaseAPI}
|
|
22922
22997
|
*/
|
|
22923
|
-
export class
|
|
22924
|
-
/**
|
|
22925
|
-
* Fetches the CSS code to the frontend React website.
|
|
22926
|
-
* @summary Download CSS
|
|
22927
|
-
* @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.
|
|
22928
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
22929
|
-
* @param {*} [options] Override http request option.
|
|
22930
|
-
* @throws {RequiredError}
|
|
22931
|
-
* @memberof SystemApi
|
|
22932
|
-
*/
|
|
22933
|
-
public getCSS(variant?: 'public' | 'internal', branch?: string, options?: AxiosRequestConfig) {
|
|
22934
|
-
return SystemApiFp(this.configuration).getCSS(variant, branch, options).then((request) => request(this.axios, this.basePath));
|
|
22935
|
-
}
|
|
22936
|
-
|
|
22937
|
-
/**
|
|
22938
|
-
* 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.
|
|
22939
|
-
* @summary Fetch API Config
|
|
22940
|
-
* @param {*} [options] Override http request option.
|
|
22941
|
-
* @throws {RequiredError}
|
|
22942
|
-
* @memberof SystemApi
|
|
22943
|
-
*/
|
|
22944
|
-
public getConfig(options?: AxiosRequestConfig) {
|
|
22945
|
-
return SystemApiFp(this.configuration).getConfig(options).then((request) => request(this.axios, this.basePath));
|
|
22946
|
-
}
|
|
22947
|
-
|
|
22998
|
+
export class PrintsApi extends BaseAPI {
|
|
22948
22999
|
/**
|
|
22949
|
-
* Returns
|
|
22950
|
-
* @summary
|
|
23000
|
+
* Returns a print.
|
|
23001
|
+
* @summary Delete Print
|
|
23002
|
+
* @param {string} printId Print ID.
|
|
22951
23003
|
* @param {*} [options] Override http request option.
|
|
22952
23004
|
* @throws {RequiredError}
|
|
22953
|
-
* @memberof
|
|
23005
|
+
* @memberof PrintsApi
|
|
22954
23006
|
*/
|
|
22955
|
-
public
|
|
22956
|
-
return
|
|
23007
|
+
public deletePrint(printId: string, options?: AxiosRequestConfig) {
|
|
23008
|
+
return PrintsApiFp(this.configuration).deletePrint(printId, options).then((request) => request(this.axios, this.basePath));
|
|
22957
23009
|
}
|
|
22958
23010
|
|
|
22959
23011
|
/**
|
|
22960
|
-
*
|
|
22961
|
-
* @summary
|
|
23012
|
+
* Edits a print.
|
|
23013
|
+
* @summary Edit Print
|
|
23014
|
+
* @param {string} printId Print ID.
|
|
23015
|
+
* @param {File} image The binary blob of the png file.
|
|
23016
|
+
* @param {string} [note] The caption for the image.
|
|
22962
23017
|
* @param {*} [options] Override http request option.
|
|
22963
|
-
* @deprecated
|
|
22964
23018
|
* @throws {RequiredError}
|
|
22965
|
-
* @memberof
|
|
23019
|
+
* @memberof PrintsApi
|
|
22966
23020
|
*/
|
|
22967
|
-
public
|
|
22968
|
-
return
|
|
23021
|
+
public editPrint(printId: string, image: File, note?: string, options?: AxiosRequestConfig) {
|
|
23022
|
+
return PrintsApiFp(this.configuration).editPrint(printId, image, note, options).then((request) => request(this.axios, this.basePath));
|
|
22969
23023
|
}
|
|
22970
23024
|
|
|
22971
23025
|
/**
|
|
22972
|
-
*
|
|
22973
|
-
* @summary
|
|
22974
|
-
* @param {string}
|
|
22975
|
-
* @param {string} [include] Tags to include (comma-separated). Any of the tags needs to be present.
|
|
23026
|
+
* Returns a print.
|
|
23027
|
+
* @summary Get Print
|
|
23028
|
+
* @param {string} printId Print ID.
|
|
22976
23029
|
* @param {*} [options] Override http request option.
|
|
22977
23030
|
* @throws {RequiredError}
|
|
22978
|
-
* @memberof
|
|
23031
|
+
* @memberof PrintsApi
|
|
22979
23032
|
*/
|
|
22980
|
-
public
|
|
22981
|
-
return
|
|
23033
|
+
public getPrint(printId: string, options?: AxiosRequestConfig) {
|
|
23034
|
+
return PrintsApiFp(this.configuration).getPrint(printId, options).then((request) => request(this.axios, this.basePath));
|
|
22982
23035
|
}
|
|
22983
23036
|
|
|
22984
23037
|
/**
|
|
22985
|
-
*
|
|
22986
|
-
* @summary
|
|
22987
|
-
* @param {
|
|
22988
|
-
* @param {string} [branch] Specifies which git branch the site should load frontend source code from.
|
|
23038
|
+
* Returns a list of all prints of the user. User id has to be your own userId, as you can\'t request other user\'s prints.
|
|
23039
|
+
* @summary Get Own Prints
|
|
23040
|
+
* @param {string} userId Must be a valid user ID.
|
|
22989
23041
|
* @param {*} [options] Override http request option.
|
|
22990
23042
|
* @throws {RequiredError}
|
|
22991
|
-
* @memberof
|
|
23043
|
+
* @memberof PrintsApi
|
|
22992
23044
|
*/
|
|
22993
|
-
public
|
|
22994
|
-
return
|
|
23045
|
+
public getUserPrints(userId: string, options?: AxiosRequestConfig) {
|
|
23046
|
+
return PrintsApiFp(this.configuration).getUserPrints(userId, options).then((request) => request(this.axios, this.basePath));
|
|
22995
23047
|
}
|
|
22996
23048
|
|
|
22997
23049
|
/**
|
|
22998
|
-
*
|
|
22999
|
-
* @summary
|
|
23050
|
+
* Uploads and creates a print.
|
|
23051
|
+
* @summary Upload Print
|
|
23052
|
+
* @param {File} image The binary blob of the png file.
|
|
23053
|
+
* @param {string} timestamp The time the image was captured.
|
|
23054
|
+
* @param {string} [note] The caption for the image.
|
|
23055
|
+
* @param {string} [worldId] The id of the world in which the image was captured.
|
|
23056
|
+
* @param {string} [worldName] The name of the world in which the image was captured.
|
|
23000
23057
|
* @param {*} [options] Override http request option.
|
|
23001
23058
|
* @throws {RequiredError}
|
|
23002
|
-
* @memberof
|
|
23059
|
+
* @memberof PrintsApi
|
|
23003
23060
|
*/
|
|
23004
|
-
public
|
|
23005
|
-
return
|
|
23061
|
+
public uploadPrint(image: File, timestamp: string, note?: string, worldId?: string, worldName?: string, options?: AxiosRequestConfig) {
|
|
23062
|
+
return PrintsApiFp(this.configuration).uploadPrint(image, timestamp, note, worldId, worldName, options).then((request) => request(this.axios, this.basePath));
|
|
23006
23063
|
}
|
|
23007
23064
|
}
|
|
23008
23065
|
|