vrchat 1.17.1 → 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.1
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
@@ -2990,6 +3033,95 @@ export interface GroupPermission {
2990
3033
  */
2991
3034
  'allowedToAdd'?: boolean;
2992
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];
2993
3125
  /**
2994
3126
  *
2995
3127
  * @export
@@ -8002,6 +8134,15 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
8002
8134
  * @throws {RequiredError}
8003
8135
  */
8004
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>;
8005
8146
  /**
8006
8147
  * Bans a user from a Group.
8007
8148
  * @summary Ban Group Member
@@ -8107,6 +8248,15 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
8107
8248
  * @throws {RequiredError}
8108
8249
  */
8109
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>;
8110
8260
  /**
8111
8261
  * Deletes a Group Role by ID and returns the remaining roles.
8112
8262
  * @summary Delete Group Role
@@ -8213,6 +8363,17 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
8213
8363
  * @throws {RequiredError}
8214
8364
  */
8215
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>;
8216
8377
  /**
8217
8378
  * Returns a list of members that have requested to join the Group.
8218
8379
  * @summary Get Group Join Requests
@@ -8360,6 +8521,15 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
8360
8521
  * @throws {RequiredError}
8361
8522
  */
8362
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>>;
8363
8533
  /**
8364
8534
  * Bans a user from a Group.
8365
8535
  * @summary Ban Group Member
@@ -8465,6 +8635,15 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
8465
8635
  * @throws {RequiredError}
8466
8636
  */
8467
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>>;
8468
8647
  /**
8469
8648
  * Deletes a Group Role by ID and returns the remaining roles.
8470
8649
  * @summary Delete Group Role
@@ -8571,6 +8750,17 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
8571
8750
  * @throws {RequiredError}
8572
8751
  */
8573
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>>;
8574
8764
  /**
8575
8765
  * Returns a list of members that have requested to join the Group.
8576
8766
  * @summary Get Group Join Requests
@@ -8718,6 +8908,15 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
8718
8908
  * @throws {RequiredError}
8719
8909
  */
8720
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>;
8721
8920
  /**
8722
8921
  * Bans a user from a Group.
8723
8922
  * @summary Ban Group Member
@@ -8823,6 +9022,15 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
8823
9022
  * @throws {RequiredError}
8824
9023
  */
8825
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>;
8826
9034
  /**
8827
9035
  * Deletes a Group Role by ID and returns the remaining roles.
8828
9036
  * @summary Delete Group Role
@@ -8929,6 +9137,17 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
8929
9137
  * @throws {RequiredError}
8930
9138
  */
8931
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>;
8932
9151
  /**
8933
9152
  * Returns a list of members that have requested to join the Group.
8934
9153
  * @summary Get Group Join Requests
@@ -9080,6 +9299,16 @@ export declare class GroupsApi extends BaseAPI {
9080
9299
  * @memberof GroupsApi
9081
9300
  */
9082
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>>;
9083
9312
  /**
9084
9313
  * Bans a user from a Group.
9085
9314
  * @summary Ban Group Member
@@ -9197,6 +9426,16 @@ export declare class GroupsApi extends BaseAPI {
9197
9426
  * @memberof GroupsApi
9198
9427
  */
9199
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>>;
9200
9439
  /**
9201
9440
  * Deletes a Group Role by ID and returns the remaining roles.
9202
9441
  * @summary Delete Group Role
@@ -9314,6 +9553,18 @@ export declare class GroupsApi extends BaseAPI {
9314
9553
  * @memberof GroupsApi
9315
9554
  */
9316
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>>;
9317
9568
  /**
9318
9569
  * Returns a list of members that have requested to join the Group.
9319
9570
  * @summary Get Group Join Requests