vrchat 1.17.1 → 1.17.3
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 +719 -14
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +497 -12
- package/dist/api.js +464 -14
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* VRChat API Documentation
|
|
3
3
|
*
|
|
4
|
-
* The version of the OpenAPI document: 1.17.
|
|
4
|
+
* The version of the OpenAPI document: 1.17.3
|
|
5
5
|
* Contact: vrchatapi.lpv0t@aries.fyi
|
|
6
6
|
*
|
|
7
7
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1087,6 +1087,49 @@ export interface CreateGroupInviteRequest {
|
|
|
1087
1087
|
*/
|
|
1088
1088
|
'confirmOverrideBlock'?: boolean;
|
|
1089
1089
|
}
|
|
1090
|
+
/**
|
|
1091
|
+
*
|
|
1092
|
+
* @export
|
|
1093
|
+
* @interface CreateGroupPostRequest
|
|
1094
|
+
*/
|
|
1095
|
+
export interface CreateGroupPostRequest {
|
|
1096
|
+
/**
|
|
1097
|
+
* Post title
|
|
1098
|
+
* @type {string}
|
|
1099
|
+
* @memberof CreateGroupPostRequest
|
|
1100
|
+
*/
|
|
1101
|
+
'title': string;
|
|
1102
|
+
/**
|
|
1103
|
+
* Post text
|
|
1104
|
+
* @type {string}
|
|
1105
|
+
* @memberof CreateGroupPostRequest
|
|
1106
|
+
*/
|
|
1107
|
+
'text': string;
|
|
1108
|
+
/**
|
|
1109
|
+
*
|
|
1110
|
+
* @type {string}
|
|
1111
|
+
* @memberof CreateGroupPostRequest
|
|
1112
|
+
*/
|
|
1113
|
+
'imageId'?: string;
|
|
1114
|
+
/**
|
|
1115
|
+
* Send notification to group members.
|
|
1116
|
+
* @type {boolean}
|
|
1117
|
+
* @memberof CreateGroupPostRequest
|
|
1118
|
+
*/
|
|
1119
|
+
'sendNotification': boolean;
|
|
1120
|
+
/**
|
|
1121
|
+
*
|
|
1122
|
+
* @type {Array<string>}
|
|
1123
|
+
* @memberof CreateGroupPostRequest
|
|
1124
|
+
*/
|
|
1125
|
+
'roleIds'?: Array<string>;
|
|
1126
|
+
/**
|
|
1127
|
+
*
|
|
1128
|
+
* @type {GroupPostVisibility}
|
|
1129
|
+
* @memberof CreateGroupPostRequest
|
|
1130
|
+
*/
|
|
1131
|
+
'visibility': GroupPostVisibility;
|
|
1132
|
+
}
|
|
1090
1133
|
/**
|
|
1091
1134
|
*
|
|
1092
1135
|
* @export
|
|
@@ -1179,6 +1222,61 @@ export interface CreateGroupRoleRequest {
|
|
|
1179
1222
|
*/
|
|
1180
1223
|
'permissions'?: Array<string>;
|
|
1181
1224
|
}
|
|
1225
|
+
/**
|
|
1226
|
+
*
|
|
1227
|
+
* @export
|
|
1228
|
+
* @interface CreateInstanceRequest
|
|
1229
|
+
*/
|
|
1230
|
+
export interface CreateInstanceRequest {
|
|
1231
|
+
/**
|
|
1232
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
1233
|
+
* @type {string}
|
|
1234
|
+
* @memberof CreateInstanceRequest
|
|
1235
|
+
*/
|
|
1236
|
+
'worldId': string;
|
|
1237
|
+
/**
|
|
1238
|
+
*
|
|
1239
|
+
* @type {InstanceType}
|
|
1240
|
+
* @memberof CreateInstanceRequest
|
|
1241
|
+
*/
|
|
1242
|
+
'type': InstanceType;
|
|
1243
|
+
/**
|
|
1244
|
+
*
|
|
1245
|
+
* @type {Region}
|
|
1246
|
+
* @memberof CreateInstanceRequest
|
|
1247
|
+
*/
|
|
1248
|
+
'region': Region;
|
|
1249
|
+
/**
|
|
1250
|
+
* A groupId if the instance type is \"group\", null if instance type is public, or a userId otherwise
|
|
1251
|
+
* @type {string}
|
|
1252
|
+
* @memberof CreateInstanceRequest
|
|
1253
|
+
*/
|
|
1254
|
+
'ownerId'?: string | null;
|
|
1255
|
+
/**
|
|
1256
|
+
* Group roleIds that are allowed to join if the type is \"group\" and groupAccessType is \"member\"
|
|
1257
|
+
* @type {Array<string>}
|
|
1258
|
+
* @memberof CreateInstanceRequest
|
|
1259
|
+
*/
|
|
1260
|
+
'roleIds'?: Array<string>;
|
|
1261
|
+
/**
|
|
1262
|
+
*
|
|
1263
|
+
* @type {GroupAccessType}
|
|
1264
|
+
* @memberof CreateInstanceRequest
|
|
1265
|
+
*/
|
|
1266
|
+
'groupAccessType'?: GroupAccessType;
|
|
1267
|
+
/**
|
|
1268
|
+
*
|
|
1269
|
+
* @type {boolean}
|
|
1270
|
+
* @memberof CreateInstanceRequest
|
|
1271
|
+
*/
|
|
1272
|
+
'queueEnabled'?: boolean;
|
|
1273
|
+
/**
|
|
1274
|
+
* The time after which users won\'t be allowed to join the instance
|
|
1275
|
+
* @type {string}
|
|
1276
|
+
* @memberof CreateInstanceRequest
|
|
1277
|
+
*/
|
|
1278
|
+
'closedAt'?: string;
|
|
1279
|
+
}
|
|
1182
1280
|
/**
|
|
1183
1281
|
*
|
|
1184
1282
|
* @export
|
|
@@ -2990,6 +3088,95 @@ export interface GroupPermission {
|
|
|
2990
3088
|
*/
|
|
2991
3089
|
'allowedToAdd'?: boolean;
|
|
2992
3090
|
}
|
|
3091
|
+
/**
|
|
3092
|
+
*
|
|
3093
|
+
* @export
|
|
3094
|
+
* @interface GroupPost
|
|
3095
|
+
*/
|
|
3096
|
+
export interface GroupPost {
|
|
3097
|
+
/**
|
|
3098
|
+
*
|
|
3099
|
+
* @type {string}
|
|
3100
|
+
* @memberof GroupPost
|
|
3101
|
+
*/
|
|
3102
|
+
'id'?: string;
|
|
3103
|
+
/**
|
|
3104
|
+
*
|
|
3105
|
+
* @type {string}
|
|
3106
|
+
* @memberof GroupPost
|
|
3107
|
+
*/
|
|
3108
|
+
'groupId'?: string;
|
|
3109
|
+
/**
|
|
3110
|
+
* A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
|
|
3111
|
+
* @type {string}
|
|
3112
|
+
* @memberof GroupPost
|
|
3113
|
+
*/
|
|
3114
|
+
'authorId'?: string;
|
|
3115
|
+
/**
|
|
3116
|
+
* A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
|
|
3117
|
+
* @type {string}
|
|
3118
|
+
* @memberof GroupPost
|
|
3119
|
+
*/
|
|
3120
|
+
'editorId'?: string;
|
|
3121
|
+
/**
|
|
3122
|
+
*
|
|
3123
|
+
* @type {GroupPostVisibility}
|
|
3124
|
+
* @memberof GroupPost
|
|
3125
|
+
*/
|
|
3126
|
+
'visibility'?: GroupPostVisibility;
|
|
3127
|
+
/**
|
|
3128
|
+
*
|
|
3129
|
+
* @type {Array<string>}
|
|
3130
|
+
* @memberof GroupPost
|
|
3131
|
+
*/
|
|
3132
|
+
'roleId'?: Array<string>;
|
|
3133
|
+
/**
|
|
3134
|
+
*
|
|
3135
|
+
* @type {string}
|
|
3136
|
+
* @memberof GroupPost
|
|
3137
|
+
*/
|
|
3138
|
+
'title'?: string;
|
|
3139
|
+
/**
|
|
3140
|
+
*
|
|
3141
|
+
* @type {string}
|
|
3142
|
+
* @memberof GroupPost
|
|
3143
|
+
*/
|
|
3144
|
+
'text'?: string;
|
|
3145
|
+
/**
|
|
3146
|
+
*
|
|
3147
|
+
* @type {string}
|
|
3148
|
+
* @memberof GroupPost
|
|
3149
|
+
*/
|
|
3150
|
+
'imageId'?: string;
|
|
3151
|
+
/**
|
|
3152
|
+
*
|
|
3153
|
+
* @type {string}
|
|
3154
|
+
* @memberof GroupPost
|
|
3155
|
+
*/
|
|
3156
|
+
'imageUrl'?: string | null;
|
|
3157
|
+
/**
|
|
3158
|
+
*
|
|
3159
|
+
* @type {string}
|
|
3160
|
+
* @memberof GroupPost
|
|
3161
|
+
*/
|
|
3162
|
+
'createdAt'?: string;
|
|
3163
|
+
/**
|
|
3164
|
+
*
|
|
3165
|
+
* @type {string}
|
|
3166
|
+
* @memberof GroupPost
|
|
3167
|
+
*/
|
|
3168
|
+
'updatedAt'?: string;
|
|
3169
|
+
}
|
|
3170
|
+
/**
|
|
3171
|
+
*
|
|
3172
|
+
* @export
|
|
3173
|
+
* @enum {string}
|
|
3174
|
+
*/
|
|
3175
|
+
export declare const GroupPostVisibility: {
|
|
3176
|
+
readonly Group: "group";
|
|
3177
|
+
readonly Public: "public";
|
|
3178
|
+
};
|
|
3179
|
+
export type GroupPostVisibility = typeof GroupPostVisibility[keyof typeof GroupPostVisibility];
|
|
2993
3180
|
/**
|
|
2994
3181
|
*
|
|
2995
3182
|
* @export
|
|
@@ -4292,6 +4479,107 @@ export interface Notification {
|
|
|
4292
4479
|
*/
|
|
4293
4480
|
'type': NotificationType;
|
|
4294
4481
|
}
|
|
4482
|
+
/**
|
|
4483
|
+
*
|
|
4484
|
+
* @export
|
|
4485
|
+
* @interface NotificationDetailInvite
|
|
4486
|
+
*/
|
|
4487
|
+
export interface NotificationDetailInvite {
|
|
4488
|
+
/**
|
|
4489
|
+
*
|
|
4490
|
+
* @type {string}
|
|
4491
|
+
* @memberof NotificationDetailInvite
|
|
4492
|
+
*/
|
|
4493
|
+
'inviteMessage'?: string;
|
|
4494
|
+
/**
|
|
4495
|
+
* WorldID be \"offline\" on User profiles if you are not friends with that user.
|
|
4496
|
+
* @type {string}
|
|
4497
|
+
* @memberof NotificationDetailInvite
|
|
4498
|
+
*/
|
|
4499
|
+
'worldId': string;
|
|
4500
|
+
/**
|
|
4501
|
+
*
|
|
4502
|
+
* @type {string}
|
|
4503
|
+
* @memberof NotificationDetailInvite
|
|
4504
|
+
*/
|
|
4505
|
+
'worldName': string;
|
|
4506
|
+
}
|
|
4507
|
+
/**
|
|
4508
|
+
*
|
|
4509
|
+
* @export
|
|
4510
|
+
* @interface NotificationDetailInviteResponse
|
|
4511
|
+
*/
|
|
4512
|
+
export interface NotificationDetailInviteResponse {
|
|
4513
|
+
/**
|
|
4514
|
+
*
|
|
4515
|
+
* @type {string}
|
|
4516
|
+
* @memberof NotificationDetailInviteResponse
|
|
4517
|
+
*/
|
|
4518
|
+
'inResponseTo': string;
|
|
4519
|
+
/**
|
|
4520
|
+
*
|
|
4521
|
+
* @type {string}
|
|
4522
|
+
* @memberof NotificationDetailInviteResponse
|
|
4523
|
+
*/
|
|
4524
|
+
'responseMessage': string;
|
|
4525
|
+
}
|
|
4526
|
+
/**
|
|
4527
|
+
*
|
|
4528
|
+
* @export
|
|
4529
|
+
* @interface NotificationDetailRequestInvite
|
|
4530
|
+
*/
|
|
4531
|
+
export interface NotificationDetailRequestInvite {
|
|
4532
|
+
/**
|
|
4533
|
+
* TODO: Does this still exist?
|
|
4534
|
+
* @type {string}
|
|
4535
|
+
* @memberof NotificationDetailRequestInvite
|
|
4536
|
+
*/
|
|
4537
|
+
'platform'?: string;
|
|
4538
|
+
/**
|
|
4539
|
+
* Used when using InviteMessage Slot.
|
|
4540
|
+
* @type {string}
|
|
4541
|
+
* @memberof NotificationDetailRequestInvite
|
|
4542
|
+
*/
|
|
4543
|
+
'requestMessage'?: string;
|
|
4544
|
+
}
|
|
4545
|
+
/**
|
|
4546
|
+
*
|
|
4547
|
+
* @export
|
|
4548
|
+
* @interface NotificationDetailRequestInviteResponse
|
|
4549
|
+
*/
|
|
4550
|
+
export interface NotificationDetailRequestInviteResponse {
|
|
4551
|
+
/**
|
|
4552
|
+
*
|
|
4553
|
+
* @type {string}
|
|
4554
|
+
* @memberof NotificationDetailRequestInviteResponse
|
|
4555
|
+
*/
|
|
4556
|
+
'inResponseTo': string;
|
|
4557
|
+
/**
|
|
4558
|
+
* Used when using InviteMessage Slot.
|
|
4559
|
+
* @type {string}
|
|
4560
|
+
* @memberof NotificationDetailRequestInviteResponse
|
|
4561
|
+
*/
|
|
4562
|
+
'requestMessage'?: string;
|
|
4563
|
+
}
|
|
4564
|
+
/**
|
|
4565
|
+
*
|
|
4566
|
+
* @export
|
|
4567
|
+
* @interface NotificationDetailVoteToKick
|
|
4568
|
+
*/
|
|
4569
|
+
export interface NotificationDetailVoteToKick {
|
|
4570
|
+
/**
|
|
4571
|
+
* A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
|
|
4572
|
+
* @type {string}
|
|
4573
|
+
* @memberof NotificationDetailVoteToKick
|
|
4574
|
+
*/
|
|
4575
|
+
'initiatorUserId': string;
|
|
4576
|
+
/**
|
|
4577
|
+
* A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
|
|
4578
|
+
* @type {string}
|
|
4579
|
+
* @memberof NotificationDetailVoteToKick
|
|
4580
|
+
*/
|
|
4581
|
+
'userToKickId': string;
|
|
4582
|
+
}
|
|
4295
4583
|
/**
|
|
4296
4584
|
*
|
|
4297
4585
|
* @export
|
|
@@ -8002,6 +8290,15 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
8002
8290
|
* @throws {RequiredError}
|
|
8003
8291
|
*/
|
|
8004
8292
|
addGroupMemberRole: (groupId: string, userId: string, groupRoleId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8293
|
+
/**
|
|
8294
|
+
* Create a post in a Group.
|
|
8295
|
+
* @summary Create a post in a Group
|
|
8296
|
+
* @param {string} groupId Must be a valid group ID.
|
|
8297
|
+
* @param {CreateGroupPostRequest} createGroupPostRequest
|
|
8298
|
+
* @param {*} [options] Override http request option.
|
|
8299
|
+
* @throws {RequiredError}
|
|
8300
|
+
*/
|
|
8301
|
+
addGroupPost: (groupId: string, createGroupPostRequest: CreateGroupPostRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8005
8302
|
/**
|
|
8006
8303
|
* Bans a user from a Group.
|
|
8007
8304
|
* @summary Ban Group Member
|
|
@@ -8107,6 +8404,15 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
8107
8404
|
* @throws {RequiredError}
|
|
8108
8405
|
*/
|
|
8109
8406
|
deleteGroupInvite: (groupId: string, userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8407
|
+
/**
|
|
8408
|
+
* Delete a Group post
|
|
8409
|
+
* @summary Delete a Group post
|
|
8410
|
+
* @param {string} groupId Must be a valid group ID.
|
|
8411
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
8412
|
+
* @param {*} [options] Override http request option.
|
|
8413
|
+
* @throws {RequiredError}
|
|
8414
|
+
*/
|
|
8415
|
+
deleteGroupPost: (groupId: string, notificationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8110
8416
|
/**
|
|
8111
8417
|
* Deletes a Group Role by ID and returns the remaining roles.
|
|
8112
8418
|
* @summary Delete Group Role
|
|
@@ -8213,6 +8519,17 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
8213
8519
|
* @throws {RequiredError}
|
|
8214
8520
|
*/
|
|
8215
8521
|
getGroupPermissions: (groupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8522
|
+
/**
|
|
8523
|
+
* Get posts from a Group
|
|
8524
|
+
* @summary Get posts from a Group
|
|
8525
|
+
* @param {string} groupId Must be a valid group ID.
|
|
8526
|
+
* @param {number} [n] The number of objects to return.
|
|
8527
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
8528
|
+
* @param {boolean} [publicOnly] See public posts only.
|
|
8529
|
+
* @param {*} [options] Override http request option.
|
|
8530
|
+
* @throws {RequiredError}
|
|
8531
|
+
*/
|
|
8532
|
+
getGroupPost: (groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8216
8533
|
/**
|
|
8217
8534
|
* Returns a list of members that have requested to join the Group.
|
|
8218
8535
|
* @summary Get Group Join Requests
|
|
@@ -8324,6 +8641,16 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
8324
8641
|
* @throws {RequiredError}
|
|
8325
8642
|
*/
|
|
8326
8643
|
updateGroupMember: (groupId: string, userId: string, updateGroupMemberRequest?: UpdateGroupMemberRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8644
|
+
/**
|
|
8645
|
+
* Edits a Group post
|
|
8646
|
+
* @summary Edits a Group post
|
|
8647
|
+
* @param {string} groupId Must be a valid group ID.
|
|
8648
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
8649
|
+
* @param {CreateGroupPostRequest} createGroupPostRequest
|
|
8650
|
+
* @param {*} [options] Override http request option.
|
|
8651
|
+
* @throws {RequiredError}
|
|
8652
|
+
*/
|
|
8653
|
+
updateGroupPost: (groupId: string, notificationId: string, createGroupPostRequest: CreateGroupPostRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8327
8654
|
/**
|
|
8328
8655
|
* Updates a group role by ID.
|
|
8329
8656
|
* @summary Update Group Role
|
|
@@ -8360,6 +8687,15 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
|
|
|
8360
8687
|
* @throws {RequiredError}
|
|
8361
8688
|
*/
|
|
8362
8689
|
addGroupMemberRole(groupId: string, userId: string, groupRoleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
8690
|
+
/**
|
|
8691
|
+
* Create a post in a Group.
|
|
8692
|
+
* @summary Create a post in a Group
|
|
8693
|
+
* @param {string} groupId Must be a valid group ID.
|
|
8694
|
+
* @param {CreateGroupPostRequest} createGroupPostRequest
|
|
8695
|
+
* @param {*} [options] Override http request option.
|
|
8696
|
+
* @throws {RequiredError}
|
|
8697
|
+
*/
|
|
8698
|
+
addGroupPost(groupId: string, createGroupPostRequest: CreateGroupPostRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupPost>>;
|
|
8363
8699
|
/**
|
|
8364
8700
|
* Bans a user from a Group.
|
|
8365
8701
|
* @summary Ban Group Member
|
|
@@ -8465,6 +8801,15 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
|
|
|
8465
8801
|
* @throws {RequiredError}
|
|
8466
8802
|
*/
|
|
8467
8803
|
deleteGroupInvite(groupId: string, userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8804
|
+
/**
|
|
8805
|
+
* Delete a Group post
|
|
8806
|
+
* @summary Delete a Group post
|
|
8807
|
+
* @param {string} groupId Must be a valid group ID.
|
|
8808
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
8809
|
+
* @param {*} [options] Override http request option.
|
|
8810
|
+
* @throws {RequiredError}
|
|
8811
|
+
*/
|
|
8812
|
+
deleteGroupPost(groupId: string, notificationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>>;
|
|
8468
8813
|
/**
|
|
8469
8814
|
* Deletes a Group Role by ID and returns the remaining roles.
|
|
8470
8815
|
* @summary Delete Group Role
|
|
@@ -8571,6 +8916,17 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
|
|
|
8571
8916
|
* @throws {RequiredError}
|
|
8572
8917
|
*/
|
|
8573
8918
|
getGroupPermissions(groupId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GroupPermission>>>;
|
|
8919
|
+
/**
|
|
8920
|
+
* Get posts from a Group
|
|
8921
|
+
* @summary Get posts from a Group
|
|
8922
|
+
* @param {string} groupId Must be a valid group ID.
|
|
8923
|
+
* @param {number} [n] The number of objects to return.
|
|
8924
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
8925
|
+
* @param {boolean} [publicOnly] See public posts only.
|
|
8926
|
+
* @param {*} [options] Override http request option.
|
|
8927
|
+
* @throws {RequiredError}
|
|
8928
|
+
*/
|
|
8929
|
+
getGroupPost(groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupPost>>;
|
|
8574
8930
|
/**
|
|
8575
8931
|
* Returns a list of members that have requested to join the Group.
|
|
8576
8932
|
* @summary Get Group Join Requests
|
|
@@ -8682,6 +9038,16 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
|
|
|
8682
9038
|
* @throws {RequiredError}
|
|
8683
9039
|
*/
|
|
8684
9040
|
updateGroupMember(groupId: string, userId: string, updateGroupMemberRequest?: UpdateGroupMemberRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupLimitedMember>>;
|
|
9041
|
+
/**
|
|
9042
|
+
* Edits a Group post
|
|
9043
|
+
* @summary Edits a Group post
|
|
9044
|
+
* @param {string} groupId Must be a valid group ID.
|
|
9045
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
9046
|
+
* @param {CreateGroupPostRequest} createGroupPostRequest
|
|
9047
|
+
* @param {*} [options] Override http request option.
|
|
9048
|
+
* @throws {RequiredError}
|
|
9049
|
+
*/
|
|
9050
|
+
updateGroupPost(groupId: string, notificationId: string, createGroupPostRequest: CreateGroupPostRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupPost>>;
|
|
8685
9051
|
/**
|
|
8686
9052
|
* Updates a group role by ID.
|
|
8687
9053
|
* @summary Update Group Role
|
|
@@ -8718,6 +9084,15 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
|
|
|
8718
9084
|
* @throws {RequiredError}
|
|
8719
9085
|
*/
|
|
8720
9086
|
addGroupMemberRole(groupId: string, userId: string, groupRoleId: string, options?: any): AxiosPromise<Array<string>>;
|
|
9087
|
+
/**
|
|
9088
|
+
* Create a post in a Group.
|
|
9089
|
+
* @summary Create a post in a Group
|
|
9090
|
+
* @param {string} groupId Must be a valid group ID.
|
|
9091
|
+
* @param {CreateGroupPostRequest} createGroupPostRequest
|
|
9092
|
+
* @param {*} [options] Override http request option.
|
|
9093
|
+
* @throws {RequiredError}
|
|
9094
|
+
*/
|
|
9095
|
+
addGroupPost(groupId: string, createGroupPostRequest: CreateGroupPostRequest, options?: any): AxiosPromise<GroupPost>;
|
|
8721
9096
|
/**
|
|
8722
9097
|
* Bans a user from a Group.
|
|
8723
9098
|
* @summary Ban Group Member
|
|
@@ -8823,6 +9198,15 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
|
|
|
8823
9198
|
* @throws {RequiredError}
|
|
8824
9199
|
*/
|
|
8825
9200
|
deleteGroupInvite(groupId: string, userId: string, options?: any): AxiosPromise<void>;
|
|
9201
|
+
/**
|
|
9202
|
+
* Delete a Group post
|
|
9203
|
+
* @summary Delete a Group post
|
|
9204
|
+
* @param {string} groupId Must be a valid group ID.
|
|
9205
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
9206
|
+
* @param {*} [options] Override http request option.
|
|
9207
|
+
* @throws {RequiredError}
|
|
9208
|
+
*/
|
|
9209
|
+
deleteGroupPost(groupId: string, notificationId: string, options?: any): AxiosPromise<Success>;
|
|
8826
9210
|
/**
|
|
8827
9211
|
* Deletes a Group Role by ID and returns the remaining roles.
|
|
8828
9212
|
* @summary Delete Group Role
|
|
@@ -8929,6 +9313,17 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
|
|
|
8929
9313
|
* @throws {RequiredError}
|
|
8930
9314
|
*/
|
|
8931
9315
|
getGroupPermissions(groupId: string, options?: any): AxiosPromise<Array<GroupPermission>>;
|
|
9316
|
+
/**
|
|
9317
|
+
* Get posts from a Group
|
|
9318
|
+
* @summary Get posts from a Group
|
|
9319
|
+
* @param {string} groupId Must be a valid group ID.
|
|
9320
|
+
* @param {number} [n] The number of objects to return.
|
|
9321
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
9322
|
+
* @param {boolean} [publicOnly] See public posts only.
|
|
9323
|
+
* @param {*} [options] Override http request option.
|
|
9324
|
+
* @throws {RequiredError}
|
|
9325
|
+
*/
|
|
9326
|
+
getGroupPost(groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: any): AxiosPromise<GroupPost>;
|
|
8932
9327
|
/**
|
|
8933
9328
|
* Returns a list of members that have requested to join the Group.
|
|
8934
9329
|
* @summary Get Group Join Requests
|
|
@@ -9040,6 +9435,16 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
|
|
|
9040
9435
|
* @throws {RequiredError}
|
|
9041
9436
|
*/
|
|
9042
9437
|
updateGroupMember(groupId: string, userId: string, updateGroupMemberRequest?: UpdateGroupMemberRequest, options?: any): AxiosPromise<GroupLimitedMember>;
|
|
9438
|
+
/**
|
|
9439
|
+
* Edits a Group post
|
|
9440
|
+
* @summary Edits a Group post
|
|
9441
|
+
* @param {string} groupId Must be a valid group ID.
|
|
9442
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
9443
|
+
* @param {CreateGroupPostRequest} createGroupPostRequest
|
|
9444
|
+
* @param {*} [options] Override http request option.
|
|
9445
|
+
* @throws {RequiredError}
|
|
9446
|
+
*/
|
|
9447
|
+
updateGroupPost(groupId: string, notificationId: string, createGroupPostRequest: CreateGroupPostRequest, options?: any): AxiosPromise<GroupPost>;
|
|
9043
9448
|
/**
|
|
9044
9449
|
* Updates a group role by ID.
|
|
9045
9450
|
* @summary Update Group Role
|
|
@@ -9080,6 +9485,16 @@ export declare class GroupsApi extends BaseAPI {
|
|
|
9080
9485
|
* @memberof GroupsApi
|
|
9081
9486
|
*/
|
|
9082
9487
|
addGroupMemberRole(groupId: string, userId: string, groupRoleId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
9488
|
+
/**
|
|
9489
|
+
* Create a post in a Group.
|
|
9490
|
+
* @summary Create a post in a Group
|
|
9491
|
+
* @param {string} groupId Must be a valid group ID.
|
|
9492
|
+
* @param {CreateGroupPostRequest} createGroupPostRequest
|
|
9493
|
+
* @param {*} [options] Override http request option.
|
|
9494
|
+
* @throws {RequiredError}
|
|
9495
|
+
* @memberof GroupsApi
|
|
9496
|
+
*/
|
|
9497
|
+
addGroupPost(groupId: string, createGroupPostRequest: CreateGroupPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupPost, any>>;
|
|
9083
9498
|
/**
|
|
9084
9499
|
* Bans a user from a Group.
|
|
9085
9500
|
* @summary Ban Group Member
|
|
@@ -9197,6 +9612,16 @@ export declare class GroupsApi extends BaseAPI {
|
|
|
9197
9612
|
* @memberof GroupsApi
|
|
9198
9613
|
*/
|
|
9199
9614
|
deleteGroupInvite(groupId: string, userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9615
|
+
/**
|
|
9616
|
+
* Delete a Group post
|
|
9617
|
+
* @summary Delete a Group post
|
|
9618
|
+
* @param {string} groupId Must be a valid group ID.
|
|
9619
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
9620
|
+
* @param {*} [options] Override http request option.
|
|
9621
|
+
* @throws {RequiredError}
|
|
9622
|
+
* @memberof GroupsApi
|
|
9623
|
+
*/
|
|
9624
|
+
deleteGroupPost(groupId: string, notificationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
|
|
9200
9625
|
/**
|
|
9201
9626
|
* Deletes a Group Role by ID and returns the remaining roles.
|
|
9202
9627
|
* @summary Delete Group Role
|
|
@@ -9314,6 +9739,18 @@ export declare class GroupsApi extends BaseAPI {
|
|
|
9314
9739
|
* @memberof GroupsApi
|
|
9315
9740
|
*/
|
|
9316
9741
|
getGroupPermissions(groupId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupPermission[], any>>;
|
|
9742
|
+
/**
|
|
9743
|
+
* Get posts from a Group
|
|
9744
|
+
* @summary Get posts from a Group
|
|
9745
|
+
* @param {string} groupId Must be a valid group ID.
|
|
9746
|
+
* @param {number} [n] The number of objects to return.
|
|
9747
|
+
* @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
|
|
9748
|
+
* @param {boolean} [publicOnly] See public posts only.
|
|
9749
|
+
* @param {*} [options] Override http request option.
|
|
9750
|
+
* @throws {RequiredError}
|
|
9751
|
+
* @memberof GroupsApi
|
|
9752
|
+
*/
|
|
9753
|
+
getGroupPost(groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupPost, any>>;
|
|
9317
9754
|
/**
|
|
9318
9755
|
* Returns a list of members that have requested to join the Group.
|
|
9319
9756
|
* @summary Get Group Join Requests
|
|
@@ -9437,6 +9874,17 @@ export declare class GroupsApi extends BaseAPI {
|
|
|
9437
9874
|
* @memberof GroupsApi
|
|
9438
9875
|
*/
|
|
9439
9876
|
updateGroupMember(groupId: string, userId: string, updateGroupMemberRequest?: UpdateGroupMemberRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupLimitedMember, any>>;
|
|
9877
|
+
/**
|
|
9878
|
+
* Edits a Group post
|
|
9879
|
+
* @summary Edits a Group post
|
|
9880
|
+
* @param {string} groupId Must be a valid group ID.
|
|
9881
|
+
* @param {string} notificationId Must be a valid notification ID.
|
|
9882
|
+
* @param {CreateGroupPostRequest} createGroupPostRequest
|
|
9883
|
+
* @param {*} [options] Override http request option.
|
|
9884
|
+
* @throws {RequiredError}
|
|
9885
|
+
* @memberof GroupsApi
|
|
9886
|
+
*/
|
|
9887
|
+
updateGroupPost(groupId: string, notificationId: string, createGroupPostRequest: CreateGroupPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupPost, any>>;
|
|
9440
9888
|
/**
|
|
9441
9889
|
* Updates a group role by ID.
|
|
9442
9890
|
* @summary Update Group Role
|
|
@@ -9455,15 +9903,24 @@ export declare class GroupsApi extends BaseAPI {
|
|
|
9455
9903
|
*/
|
|
9456
9904
|
export declare const InstancesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
9457
9905
|
/**
|
|
9458
|
-
* Close an instance. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-moderate` permission.
|
|
9906
|
+
* Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-moderate` permission.
|
|
9459
9907
|
* @summary Close Instance
|
|
9460
9908
|
* @param {string} worldId Must be a valid world ID.
|
|
9461
9909
|
* @param {string} instanceId Must be a valid instance ID.
|
|
9462
9910
|
* @param {boolean} [hardClose] Whether to hard close the instance. Defaults to false.
|
|
9911
|
+
* @param {string} [closedAt] The time after which users won\'t be allowed to join the instances. If omitted, the instance will be closed immediately.
|
|
9912
|
+
* @param {*} [options] Override http request option.
|
|
9913
|
+
* @throws {RequiredError}
|
|
9914
|
+
*/
|
|
9915
|
+
closeInstance: (worldId: string, instanceId: string, hardClose?: boolean, closedAt?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9916
|
+
/**
|
|
9917
|
+
* Create an instance
|
|
9918
|
+
* @summary Create Instance
|
|
9919
|
+
* @param {CreateInstanceRequest} createInstanceRequest
|
|
9463
9920
|
* @param {*} [options] Override http request option.
|
|
9464
9921
|
* @throws {RequiredError}
|
|
9465
9922
|
*/
|
|
9466
|
-
|
|
9923
|
+
createInstance: (createInstanceRequest: CreateInstanceRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9467
9924
|
/**
|
|
9468
9925
|
* Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return \"null\"!
|
|
9469
9926
|
* @summary Get Instance
|
|
@@ -9506,15 +9963,24 @@ export declare const InstancesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
9506
9963
|
*/
|
|
9507
9964
|
export declare const InstancesApiFp: (configuration?: Configuration) => {
|
|
9508
9965
|
/**
|
|
9509
|
-
* Close an instance. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-moderate` permission.
|
|
9966
|
+
* Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-moderate` permission.
|
|
9510
9967
|
* @summary Close Instance
|
|
9511
9968
|
* @param {string} worldId Must be a valid world ID.
|
|
9512
9969
|
* @param {string} instanceId Must be a valid instance ID.
|
|
9513
9970
|
* @param {boolean} [hardClose] Whether to hard close the instance. Defaults to false.
|
|
9971
|
+
* @param {string} [closedAt] The time after which users won\'t be allowed to join the instances. If omitted, the instance will be closed immediately.
|
|
9972
|
+
* @param {*} [options] Override http request option.
|
|
9973
|
+
* @throws {RequiredError}
|
|
9974
|
+
*/
|
|
9975
|
+
closeInstance(worldId: string, instanceId: string, hardClose?: boolean, closedAt?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Instance>>;
|
|
9976
|
+
/**
|
|
9977
|
+
* Create an instance
|
|
9978
|
+
* @summary Create Instance
|
|
9979
|
+
* @param {CreateInstanceRequest} createInstanceRequest
|
|
9514
9980
|
* @param {*} [options] Override http request option.
|
|
9515
9981
|
* @throws {RequiredError}
|
|
9516
9982
|
*/
|
|
9517
|
-
|
|
9983
|
+
createInstance(createInstanceRequest: CreateInstanceRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Instance>>;
|
|
9518
9984
|
/**
|
|
9519
9985
|
* Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return \"null\"!
|
|
9520
9986
|
* @summary Get Instance
|
|
@@ -9557,15 +10023,24 @@ export declare const InstancesApiFp: (configuration?: Configuration) => {
|
|
|
9557
10023
|
*/
|
|
9558
10024
|
export declare const InstancesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9559
10025
|
/**
|
|
9560
|
-
* Close an instance. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-moderate` permission.
|
|
10026
|
+
* Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-moderate` permission.
|
|
9561
10027
|
* @summary Close Instance
|
|
9562
10028
|
* @param {string} worldId Must be a valid world ID.
|
|
9563
10029
|
* @param {string} instanceId Must be a valid instance ID.
|
|
9564
10030
|
* @param {boolean} [hardClose] Whether to hard close the instance. Defaults to false.
|
|
10031
|
+
* @param {string} [closedAt] The time after which users won\'t be allowed to join the instances. If omitted, the instance will be closed immediately.
|
|
10032
|
+
* @param {*} [options] Override http request option.
|
|
10033
|
+
* @throws {RequiredError}
|
|
10034
|
+
*/
|
|
10035
|
+
closeInstance(worldId: string, instanceId: string, hardClose?: boolean, closedAt?: string, options?: any): AxiosPromise<Instance>;
|
|
10036
|
+
/**
|
|
10037
|
+
* Create an instance
|
|
10038
|
+
* @summary Create Instance
|
|
10039
|
+
* @param {CreateInstanceRequest} createInstanceRequest
|
|
9565
10040
|
* @param {*} [options] Override http request option.
|
|
9566
10041
|
* @throws {RequiredError}
|
|
9567
10042
|
*/
|
|
9568
|
-
|
|
10043
|
+
createInstance(createInstanceRequest: CreateInstanceRequest, options?: any): AxiosPromise<Instance>;
|
|
9569
10044
|
/**
|
|
9570
10045
|
* Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return \"null\"!
|
|
9571
10046
|
* @summary Get Instance
|
|
@@ -9610,16 +10085,26 @@ export declare const InstancesApiFactory: (configuration?: Configuration, basePa
|
|
|
9610
10085
|
*/
|
|
9611
10086
|
export declare class InstancesApi extends BaseAPI {
|
|
9612
10087
|
/**
|
|
9613
|
-
* Close an instance. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-moderate` permission.
|
|
10088
|
+
* Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-moderate` permission.
|
|
9614
10089
|
* @summary Close Instance
|
|
9615
10090
|
* @param {string} worldId Must be a valid world ID.
|
|
9616
10091
|
* @param {string} instanceId Must be a valid instance ID.
|
|
9617
10092
|
* @param {boolean} [hardClose] Whether to hard close the instance. Defaults to false.
|
|
10093
|
+
* @param {string} [closedAt] The time after which users won\'t be allowed to join the instances. If omitted, the instance will be closed immediately.
|
|
10094
|
+
* @param {*} [options] Override http request option.
|
|
10095
|
+
* @throws {RequiredError}
|
|
10096
|
+
* @memberof InstancesApi
|
|
10097
|
+
*/
|
|
10098
|
+
closeInstance(worldId: string, instanceId: string, hardClose?: boolean, closedAt?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Instance, any>>;
|
|
10099
|
+
/**
|
|
10100
|
+
* Create an instance
|
|
10101
|
+
* @summary Create Instance
|
|
10102
|
+
* @param {CreateInstanceRequest} createInstanceRequest
|
|
9618
10103
|
* @param {*} [options] Override http request option.
|
|
9619
10104
|
* @throws {RequiredError}
|
|
9620
10105
|
* @memberof InstancesApi
|
|
9621
10106
|
*/
|
|
9622
|
-
|
|
10107
|
+
createInstance(createInstanceRequest: CreateInstanceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Instance, any>>;
|
|
9623
10108
|
/**
|
|
9624
10109
|
* Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return \"null\"!
|
|
9625
10110
|
* @summary Get Instance
|
|
@@ -10878,7 +11363,7 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
10878
11363
|
* @param {*} [options] Override http request option.
|
|
10879
11364
|
* @throws {RequiredError}
|
|
10880
11365
|
*/
|
|
10881
|
-
getUserGroups(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
11366
|
+
getUserGroups(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<LimitedGroup>>>;
|
|
10882
11367
|
/**
|
|
10883
11368
|
* Returns the current group that the user is currently representing
|
|
10884
11369
|
* @summary Get user\'s current represented group
|
|
@@ -10945,7 +11430,7 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
10945
11430
|
* @param {*} [options] Override http request option.
|
|
10946
11431
|
* @throws {RequiredError}
|
|
10947
11432
|
*/
|
|
10948
|
-
getUserGroups(userId: string, options?: any): AxiosPromise<Array<
|
|
11433
|
+
getUserGroups(userId: string, options?: any): AxiosPromise<Array<LimitedGroup>>;
|
|
10949
11434
|
/**
|
|
10950
11435
|
* Returns the current group that the user is currently representing
|
|
10951
11436
|
* @summary Get user\'s current represented group
|
|
@@ -11018,7 +11503,7 @@ export declare class UsersApi extends BaseAPI {
|
|
|
11018
11503
|
* @throws {RequiredError}
|
|
11019
11504
|
* @memberof UsersApi
|
|
11020
11505
|
*/
|
|
11021
|
-
getUserGroups(userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11506
|
+
getUserGroups(userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LimitedGroup[], any>>;
|
|
11022
11507
|
/**
|
|
11023
11508
|
* Returns the current group that the user is currently representing
|
|
11024
11509
|
* @summary Get user\'s current represented group
|