vrchat 1.17.0 → 1.17.2

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/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.0
4
+ * The version of the OpenAPI document: 1.17.2
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
@@ -2553,6 +2596,37 @@ export interface GroupGalleryImage {
2553
2596
  */
2554
2597
  'approvedAt'?: string;
2555
2598
  }
2599
+ /**
2600
+ *
2601
+ * @export
2602
+ * @interface GroupInstance
2603
+ */
2604
+ export interface GroupInstance {
2605
+ /**
2606
+ *
2607
+ * @type {string}
2608
+ * @memberof GroupInstance
2609
+ */
2610
+ 'instanceId': string;
2611
+ /**
2612
+ * InstanceID can be \"offline\" on User profiles if you are not friends with that user and \"private\" if you are friends and user is in private instance.
2613
+ * @type {string}
2614
+ * @memberof GroupInstance
2615
+ */
2616
+ 'location': string;
2617
+ /**
2618
+ *
2619
+ * @type {World}
2620
+ * @memberof GroupInstance
2621
+ */
2622
+ 'world': World;
2623
+ /**
2624
+ *
2625
+ * @type {number}
2626
+ * @memberof GroupInstance
2627
+ */
2628
+ 'memberCount': number;
2629
+ }
2556
2630
  /**
2557
2631
  *
2558
2632
  * @export
@@ -2798,7 +2872,7 @@ export interface GroupMemberLimitedUser {
2798
2872
  * @type {string}
2799
2873
  * @memberof GroupMemberLimitedUser
2800
2874
  */
2801
- 'thumbnailUrl'?: string;
2875
+ 'thumbnailUrl'?: string | null;
2802
2876
  /**
2803
2877
  *
2804
2878
  * @type {string}
@@ -2959,6 +3033,95 @@ export interface GroupPermission {
2959
3033
  */
2960
3034
  'allowedToAdd'?: boolean;
2961
3035
  }
3036
+ /**
3037
+ *
3038
+ * @export
3039
+ * @interface GroupPost
3040
+ */
3041
+ export interface GroupPost {
3042
+ /**
3043
+ *
3044
+ * @type {string}
3045
+ * @memberof GroupPost
3046
+ */
3047
+ 'id'?: string;
3048
+ /**
3049
+ *
3050
+ * @type {string}
3051
+ * @memberof GroupPost
3052
+ */
3053
+ 'groupId'?: string;
3054
+ /**
3055
+ * 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.
3056
+ * @type {string}
3057
+ * @memberof GroupPost
3058
+ */
3059
+ 'authorId'?: string;
3060
+ /**
3061
+ * 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.
3062
+ * @type {string}
3063
+ * @memberof GroupPost
3064
+ */
3065
+ 'editorId'?: string;
3066
+ /**
3067
+ *
3068
+ * @type {GroupPostVisibility}
3069
+ * @memberof GroupPost
3070
+ */
3071
+ 'visibility'?: GroupPostVisibility;
3072
+ /**
3073
+ *
3074
+ * @type {Array<string>}
3075
+ * @memberof GroupPost
3076
+ */
3077
+ 'roleId'?: Array<string>;
3078
+ /**
3079
+ *
3080
+ * @type {string}
3081
+ * @memberof GroupPost
3082
+ */
3083
+ 'title'?: string;
3084
+ /**
3085
+ *
3086
+ * @type {string}
3087
+ * @memberof GroupPost
3088
+ */
3089
+ 'text'?: string;
3090
+ /**
3091
+ *
3092
+ * @type {string}
3093
+ * @memberof GroupPost
3094
+ */
3095
+ 'imageId'?: string;
3096
+ /**
3097
+ *
3098
+ * @type {string}
3099
+ * @memberof GroupPost
3100
+ */
3101
+ 'imageUrl'?: string | null;
3102
+ /**
3103
+ *
3104
+ * @type {string}
3105
+ * @memberof GroupPost
3106
+ */
3107
+ 'createdAt'?: string;
3108
+ /**
3109
+ *
3110
+ * @type {string}
3111
+ * @memberof GroupPost
3112
+ */
3113
+ 'updatedAt'?: string;
3114
+ }
3115
+ /**
3116
+ *
3117
+ * @export
3118
+ * @enum {string}
3119
+ */
3120
+ export declare const GroupPostVisibility: {
3121
+ readonly Group: "group";
3122
+ readonly Public: "public";
3123
+ };
3124
+ export type GroupPostVisibility = typeof GroupPostVisibility[keyof typeof GroupPostVisibility];
2962
3125
  /**
2963
3126
  *
2964
3127
  * @export
@@ -7971,6 +8134,15 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
7971
8134
  * @throws {RequiredError}
7972
8135
  */
7973
8136
  addGroupMemberRole: (groupId: string, userId: string, groupRoleId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8137
+ /**
8138
+ * Create a post in a Group.
8139
+ * @summary Create a post in a Group
8140
+ * @param {string} groupId Must be a valid group ID.
8141
+ * @param {CreateGroupPostRequest} createGroupPostRequest
8142
+ * @param {*} [options] Override http request option.
8143
+ * @throws {RequiredError}
8144
+ */
8145
+ addGroupPost: (groupId: string, createGroupPostRequest: CreateGroupPostRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7974
8146
  /**
7975
8147
  * Bans a user from a Group.
7976
8148
  * @summary Ban Group Member
@@ -8076,6 +8248,15 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
8076
8248
  * @throws {RequiredError}
8077
8249
  */
8078
8250
  deleteGroupInvite: (groupId: string, userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8251
+ /**
8252
+ * Delete a Group post
8253
+ * @summary Delete a Group post
8254
+ * @param {string} groupId Must be a valid group ID.
8255
+ * @param {string} notificationId Must be a valid notification ID.
8256
+ * @param {*} [options] Override http request option.
8257
+ * @throws {RequiredError}
8258
+ */
8259
+ deleteGroupPost: (groupId: string, notificationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8079
8260
  /**
8080
8261
  * Deletes a Group Role by ID and returns the remaining roles.
8081
8262
  * @summary Delete Group Role
@@ -8136,6 +8317,14 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
8136
8317
  * @throws {RequiredError}
8137
8318
  */
8138
8319
  getGroupGalleryImages: (groupId: string, groupGalleryId: string, n?: number, offset?: number, approved?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8320
+ /**
8321
+ * Returns a list of group instances
8322
+ * @summary Get Group Instances
8323
+ * @param {string} groupId Must be a valid group ID.
8324
+ * @param {*} [options] Override http request option.
8325
+ * @throws {RequiredError}
8326
+ */
8327
+ getGroupInstances: (groupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8139
8328
  /**
8140
8329
  * Returns a list of members that have been invited to the Group.
8141
8330
  * @summary Get Group Invites Sent
@@ -8174,6 +8363,17 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
8174
8363
  * @throws {RequiredError}
8175
8364
  */
8176
8365
  getGroupPermissions: (groupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8366
+ /**
8367
+ * Get posts from a Group
8368
+ * @summary Get posts from a Group
8369
+ * @param {string} groupId Must be a valid group ID.
8370
+ * @param {number} [n] The number of objects to return.
8371
+ * @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
8372
+ * @param {boolean} [publicOnly] See public posts only.
8373
+ * @param {*} [options] Override http request option.
8374
+ * @throws {RequiredError}
8375
+ */
8376
+ getGroupPost: (groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8177
8377
  /**
8178
8378
  * Returns a list of members that have requested to join the Group.
8179
8379
  * @summary Get Group Join Requests
@@ -8321,6 +8521,15 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
8321
8521
  * @throws {RequiredError}
8322
8522
  */
8323
8523
  addGroupMemberRole(groupId: string, userId: string, groupRoleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
8524
+ /**
8525
+ * Create a post in a Group.
8526
+ * @summary Create a post in a Group
8527
+ * @param {string} groupId Must be a valid group ID.
8528
+ * @param {CreateGroupPostRequest} createGroupPostRequest
8529
+ * @param {*} [options] Override http request option.
8530
+ * @throws {RequiredError}
8531
+ */
8532
+ addGroupPost(groupId: string, createGroupPostRequest: CreateGroupPostRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupPost>>;
8324
8533
  /**
8325
8534
  * Bans a user from a Group.
8326
8535
  * @summary Ban Group Member
@@ -8426,6 +8635,15 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
8426
8635
  * @throws {RequiredError}
8427
8636
  */
8428
8637
  deleteGroupInvite(groupId: string, userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8638
+ /**
8639
+ * Delete a Group post
8640
+ * @summary Delete a Group post
8641
+ * @param {string} groupId Must be a valid group ID.
8642
+ * @param {string} notificationId Must be a valid notification ID.
8643
+ * @param {*} [options] Override http request option.
8644
+ * @throws {RequiredError}
8645
+ */
8646
+ deleteGroupPost(groupId: string, notificationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Success>>;
8429
8647
  /**
8430
8648
  * Deletes a Group Role by ID and returns the remaining roles.
8431
8649
  * @summary Delete Group Role
@@ -8486,6 +8704,14 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
8486
8704
  * @throws {RequiredError}
8487
8705
  */
8488
8706
  getGroupGalleryImages(groupId: string, groupGalleryId: string, n?: number, offset?: number, approved?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GroupGalleryImage>>>;
8707
+ /**
8708
+ * Returns a list of group instances
8709
+ * @summary Get Group Instances
8710
+ * @param {string} groupId Must be a valid group ID.
8711
+ * @param {*} [options] Override http request option.
8712
+ * @throws {RequiredError}
8713
+ */
8714
+ getGroupInstances(groupId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GroupInstance>>>;
8489
8715
  /**
8490
8716
  * Returns a list of members that have been invited to the Group.
8491
8717
  * @summary Get Group Invites Sent
@@ -8524,6 +8750,17 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
8524
8750
  * @throws {RequiredError}
8525
8751
  */
8526
8752
  getGroupPermissions(groupId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GroupPermission>>>;
8753
+ /**
8754
+ * Get posts from a Group
8755
+ * @summary Get posts from a Group
8756
+ * @param {string} groupId Must be a valid group ID.
8757
+ * @param {number} [n] The number of objects to return.
8758
+ * @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
8759
+ * @param {boolean} [publicOnly] See public posts only.
8760
+ * @param {*} [options] Override http request option.
8761
+ * @throws {RequiredError}
8762
+ */
8763
+ getGroupPost(groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupPost>>;
8527
8764
  /**
8528
8765
  * Returns a list of members that have requested to join the Group.
8529
8766
  * @summary Get Group Join Requests
@@ -8671,6 +8908,15 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
8671
8908
  * @throws {RequiredError}
8672
8909
  */
8673
8910
  addGroupMemberRole(groupId: string, userId: string, groupRoleId: string, options?: any): AxiosPromise<Array<string>>;
8911
+ /**
8912
+ * Create a post in a Group.
8913
+ * @summary Create a post in a Group
8914
+ * @param {string} groupId Must be a valid group ID.
8915
+ * @param {CreateGroupPostRequest} createGroupPostRequest
8916
+ * @param {*} [options] Override http request option.
8917
+ * @throws {RequiredError}
8918
+ */
8919
+ addGroupPost(groupId: string, createGroupPostRequest: CreateGroupPostRequest, options?: any): AxiosPromise<GroupPost>;
8674
8920
  /**
8675
8921
  * Bans a user from a Group.
8676
8922
  * @summary Ban Group Member
@@ -8776,6 +9022,15 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
8776
9022
  * @throws {RequiredError}
8777
9023
  */
8778
9024
  deleteGroupInvite(groupId: string, userId: string, options?: any): AxiosPromise<void>;
9025
+ /**
9026
+ * Delete a Group post
9027
+ * @summary Delete a Group post
9028
+ * @param {string} groupId Must be a valid group ID.
9029
+ * @param {string} notificationId Must be a valid notification ID.
9030
+ * @param {*} [options] Override http request option.
9031
+ * @throws {RequiredError}
9032
+ */
9033
+ deleteGroupPost(groupId: string, notificationId: string, options?: any): AxiosPromise<Success>;
8779
9034
  /**
8780
9035
  * Deletes a Group Role by ID and returns the remaining roles.
8781
9036
  * @summary Delete Group Role
@@ -8836,6 +9091,14 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
8836
9091
  * @throws {RequiredError}
8837
9092
  */
8838
9093
  getGroupGalleryImages(groupId: string, groupGalleryId: string, n?: number, offset?: number, approved?: boolean, options?: any): AxiosPromise<Array<GroupGalleryImage>>;
9094
+ /**
9095
+ * Returns a list of group instances
9096
+ * @summary Get Group Instances
9097
+ * @param {string} groupId Must be a valid group ID.
9098
+ * @param {*} [options] Override http request option.
9099
+ * @throws {RequiredError}
9100
+ */
9101
+ getGroupInstances(groupId: string, options?: any): AxiosPromise<Array<GroupInstance>>;
8839
9102
  /**
8840
9103
  * Returns a list of members that have been invited to the Group.
8841
9104
  * @summary Get Group Invites Sent
@@ -8874,6 +9137,17 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
8874
9137
  * @throws {RequiredError}
8875
9138
  */
8876
9139
  getGroupPermissions(groupId: string, options?: any): AxiosPromise<Array<GroupPermission>>;
9140
+ /**
9141
+ * Get posts from a Group
9142
+ * @summary Get posts from a Group
9143
+ * @param {string} groupId Must be a valid group ID.
9144
+ * @param {number} [n] The number of objects to return.
9145
+ * @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
9146
+ * @param {boolean} [publicOnly] See public posts only.
9147
+ * @param {*} [options] Override http request option.
9148
+ * @throws {RequiredError}
9149
+ */
9150
+ getGroupPost(groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: any): AxiosPromise<GroupPost>;
8877
9151
  /**
8878
9152
  * Returns a list of members that have requested to join the Group.
8879
9153
  * @summary Get Group Join Requests
@@ -9025,6 +9299,16 @@ export declare class GroupsApi extends BaseAPI {
9025
9299
  * @memberof GroupsApi
9026
9300
  */
9027
9301
  addGroupMemberRole(groupId: string, userId: string, groupRoleId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
9302
+ /**
9303
+ * Create a post in a Group.
9304
+ * @summary Create a post in a Group
9305
+ * @param {string} groupId Must be a valid group ID.
9306
+ * @param {CreateGroupPostRequest} createGroupPostRequest
9307
+ * @param {*} [options] Override http request option.
9308
+ * @throws {RequiredError}
9309
+ * @memberof GroupsApi
9310
+ */
9311
+ addGroupPost(groupId: string, createGroupPostRequest: CreateGroupPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupPost, any>>;
9028
9312
  /**
9029
9313
  * Bans a user from a Group.
9030
9314
  * @summary Ban Group Member
@@ -9142,6 +9426,16 @@ export declare class GroupsApi extends BaseAPI {
9142
9426
  * @memberof GroupsApi
9143
9427
  */
9144
9428
  deleteGroupInvite(groupId: string, userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
9429
+ /**
9430
+ * Delete a Group post
9431
+ * @summary Delete a Group post
9432
+ * @param {string} groupId Must be a valid group ID.
9433
+ * @param {string} notificationId Must be a valid notification ID.
9434
+ * @param {*} [options] Override http request option.
9435
+ * @throws {RequiredError}
9436
+ * @memberof GroupsApi
9437
+ */
9438
+ deleteGroupPost(groupId: string, notificationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Success, any>>;
9145
9439
  /**
9146
9440
  * Deletes a Group Role by ID and returns the remaining roles.
9147
9441
  * @summary Delete Group Role
@@ -9208,6 +9502,15 @@ export declare class GroupsApi extends BaseAPI {
9208
9502
  * @memberof GroupsApi
9209
9503
  */
9210
9504
  getGroupGalleryImages(groupId: string, groupGalleryId: string, n?: number, offset?: number, approved?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupGalleryImage[], any>>;
9505
+ /**
9506
+ * Returns a list of group instances
9507
+ * @summary Get Group Instances
9508
+ * @param {string} groupId Must be a valid group ID.
9509
+ * @param {*} [options] Override http request option.
9510
+ * @throws {RequiredError}
9511
+ * @memberof GroupsApi
9512
+ */
9513
+ getGroupInstances(groupId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupInstance[], any>>;
9211
9514
  /**
9212
9515
  * Returns a list of members that have been invited to the Group.
9213
9516
  * @summary Get Group Invites Sent
@@ -9250,6 +9553,18 @@ export declare class GroupsApi extends BaseAPI {
9250
9553
  * @memberof GroupsApi
9251
9554
  */
9252
9555
  getGroupPermissions(groupId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupPermission[], any>>;
9556
+ /**
9557
+ * Get posts from a Group
9558
+ * @summary Get posts from a Group
9559
+ * @param {string} groupId Must be a valid group ID.
9560
+ * @param {number} [n] The number of objects to return.
9561
+ * @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
9562
+ * @param {boolean} [publicOnly] See public posts only.
9563
+ * @param {*} [options] Override http request option.
9564
+ * @throws {RequiredError}
9565
+ * @memberof GroupsApi
9566
+ */
9567
+ getGroupPost(groupId: string, n?: number, offset?: number, publicOnly?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupPost, any>>;
9253
9568
  /**
9254
9569
  * Returns a list of members that have requested to join the Group.
9255
9570
  * @summary Get Group Join Requests