vrchat 1.17.3 → 1.17.6

package/dist/api.d.ts

@@ -1,7 +1,7 @@
 /**
  * VRChat API Documentation
  *
- * The version of the OpenAPI document: 1.17.3
+ * The version of the OpenAPI document: 1.17.6
  * Contact: vrchatapi.lpv0t@aries.fyi
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -846,6 +846,61 @@ export interface AvatarUnityPackageUrlObject {
      */
     'unityPackageUrl'?: string;
 }
+/**
+ *
+ * @export
+ * @interface Badge
+ */
+export interface Badge {
+    /**
+     * only present in CurrentUser badges
+     * @type {string}
+     * @memberof Badge
+     */
+    'assignedAt'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Badge
+     */
+    'badgeDescription': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Badge
+     */
+    'badgeId': string;
+    /**
+     * direct url to image
+     * @type {string}
+     * @memberof Badge
+     */
+    'badgeImageUrl': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Badge
+     */
+    'badgeName': string;
+    /**
+     * only present in CurrentUser badges
+     * @type {boolean}
+     * @memberof Badge
+     */
+    'hidden'?: boolean | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Badge
+     */
+    'showcased': boolean;
+    /**
+     * only present in CurrentUser badges
+     * @type {string}
+     * @memberof Badge
+     */
+    'updatedAt'?: string | null;
+}
 /**
  *
  * @export
@@ -1242,10 +1297,10 @@ export interface CreateInstanceRequest {
     'type': InstanceType;
     /**
      *
-     * @type {Region}
+     * @type {InstanceRegion}
      * @memberof CreateInstanceRequest
      */
-    'region': Region;
+    'region': InstanceRegion;
     /**
      * A groupId if the instance type is \"group\", null if instance type is public, or a userId otherwise
      * @type {string}
@@ -1271,11 +1326,29 @@ export interface CreateInstanceRequest {
      */
     'queueEnabled'?: boolean;
     /**
-     * The time after which users won\'t be allowed to join the instance
+     * The time after which users won\'t be allowed to join the instance. This doesn\'t work for public instances.
      * @type {string}
      * @memberof CreateInstanceRequest
      */
     'closedAt'?: string;
+    /**
+     * Only applies to invite type instances to make them invite+
+     * @type {boolean}
+     * @memberof CreateInstanceRequest
+     */
+    'canRequestInvite'?: boolean;
+    /**
+     * Currently unused, but will eventually be a flag to set if the closing of the instance should kick people.
+     * @type {boolean}
+     * @memberof CreateInstanceRequest
+     */
+    'hardClose'?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CreateInstanceRequest
+     */
+    'inviteOnly'?: boolean;
 }
 /**
  *
@@ -1410,6 +1483,12 @@ export interface CurrentUser {
      * @memberof CurrentUser
      */
     'allowAvatarCopying': boolean;
+    /**
+     *
+     * @type {Array<Badge>}
+     * @memberof CurrentUser
+     */
+    'badges'?: Array<Badge>;
     /**
      *
      * @type {string}
@@ -1451,7 +1530,7 @@ export interface CurrentUser {
      * @type {Array<string>}
      * @memberof CurrentUser
      */
-    'currentAvatarTags'?: Array<string>;
+    'currentAvatarTags': Array<string>;
     /**
      *
      * @type {string}
@@ -1555,6 +1634,12 @@ export interface CurrentUser {
      * @memberof CurrentUser
      */
     'id': string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CurrentUser
+     */
+    'isBoopingEnabled'?: boolean;
     /**
      *
      * @type {boolean}
@@ -1573,6 +1658,12 @@ export interface CurrentUser {
      * @memberof CurrentUser
      */
     'last_login': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CurrentUser
+     */
+    'last_mobile': string | null;
     /**
      * This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`.
      * @type {string}
@@ -1603,6 +1694,12 @@ export interface CurrentUser {
      * @memberof CurrentUser
      */
     'googleId'?: string;
+    /**
+     *
+     * @type {object}
+     * @memberof CurrentUser
+     */
+    'googleDetails'?: object;
     /**
      *
      * @type {string}
@@ -1645,6 +1742,18 @@ export interface CurrentUser {
      * @memberof CurrentUser
      */
     'profilePicOverride': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CurrentUser
+     */
+    'profilePicOverrideThumbnail': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CurrentUser
+     */
+    'pronouns': string;
     /**
      *
      * @type {UserState}
@@ -2392,7 +2501,7 @@ export interface Group {
 export declare const GroupAccessType: {
     readonly Public: "public";
     readonly Plus: "plus";
-    readonly Member: "member";
+    readonly Members: "members";
 };
 export type GroupAccessType = typeof GroupAccessType[keyof typeof GroupAccessType];
 /**
@@ -2751,7 +2860,7 @@ export interface GroupLimitedMember {
      * @type {string}
      * @memberof GroupLimitedMember
      */
-    'joinedAt'?: string;
+    'joinedAt'?: string | null;
     /**
      *
      * @type {GroupMemberStatus}
@@ -2964,6 +3073,7 @@ export declare const GroupMemberStatus: {
     readonly Requested: "requested";
     readonly Invited: "invited";
     readonly Banned: "banned";
+    readonly Userblocked: "userblocked";
 };
 export type GroupMemberStatus = typeof GroupMemberStatus[keyof typeof GroupMemberStatus];
 /**
@@ -3584,10 +3694,10 @@ export interface Instance {
     'platforms': InstancePlatforms;
     /**
      *
-     * @type {Region}
+     * @type {InstanceRegion}
      * @memberof Instance
      */
-    'region': Region;
+    'region': InstanceRegion;
     /**
      *
      * @type {string}
@@ -3734,6 +3844,18 @@ export interface InstancePlatforms {
      */
     'standalonewindows': number;
 }
+/**
+ * Instance region
+ * @export
+ * @enum {string}
+ */
+export declare const InstanceRegion: {
+    readonly Us: "us";
+    readonly Use: "use";
+    readonly Eu: "eu";
+    readonly Jp: "jp";
+};
+export type InstanceRegion = typeof InstanceRegion[keyof typeof InstanceRegion];
 /**
  *
  * @export
@@ -4083,6 +4205,12 @@ export interface LimitedUser {
      * @memberof LimitedUser
      */
     'bio'?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof LimitedUser
+     */
+    'bioLinks'?: Array<string>;
     /**
      * When profilePicOverride is not empty, use it instead.
      * @type {string}
@@ -4095,6 +4223,12 @@ export interface LimitedUser {
      * @memberof LimitedUser
      */
     'currentAvatarThumbnailImageUrl'?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof LimitedUser
+     */
+    'currentAvatarTags'?: Array<string>;
     /**
      *
      * @type {DeveloperType}
@@ -4137,6 +4271,12 @@ export interface LimitedUser {
      * @memberof LimitedUser
      */
     'profilePicOverride'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LimitedUser
+     */
+    'pronouns'?: string;
     /**
      *
      * @type {UserStatus}
@@ -4181,6 +4321,121 @@ export interface LimitedUser {
      */
     'friendKey'?: string;
 }
+/**
+ *
+ * @export
+ * @interface LimitedUserGroups
+ */
+export interface LimitedUserGroups {
+    /**
+     *
+     * @type {string}
+     * @memberof LimitedUserGroups
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LimitedUserGroups
+     */
+    'name'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LimitedUserGroups
+     */
+    'shortCode'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LimitedUserGroups
+     */
+    'discriminator'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LimitedUserGroups
+     */
+    'description'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LimitedUserGroups
+     */
+    'iconId'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof LimitedUserGroups
+     */
+    'iconUrl'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof LimitedUserGroups
+     */
+    'bannerId'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof LimitedUserGroups
+     */
+    'bannerUrl'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof LimitedUserGroups
+     */
+    'privacy'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LimitedUserGroups
+     */
+    'lastPostCreatedAt'?: string | null;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof LimitedUserGroups
+     */
+    'ownerId'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof LimitedUserGroups
+     */
+    'memberCount'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof LimitedUserGroups
+     */
+    'groupId'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LimitedUserGroups
+     */
+    'memberVisibility'?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof LimitedUserGroups
+     */
+    'isRepresenting'?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof LimitedUserGroups
+     */
+    'mutualGroup'?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof LimitedUserGroups
+     */
+    'lastPostReadAt'?: string | null;
+}
 /**
  *
  * @export
@@ -4223,6 +4478,12 @@ export interface LimitedWorld {
      * @memberof LimitedWorld
      */
     'favorites': number;
+    /**
+     *
+     * @type {number}
+     * @memberof LimitedWorld
+     */
+    'visits'?: number;
     /**
      *
      * @type {number}
@@ -4271,6 +4532,12 @@ export interface LimitedWorld {
      * @memberof LimitedWorld
      */
     'popularity': number;
+    /**
+     *
+     * @type {string}
+     * @memberof LimitedWorld
+     */
+    'previewYoutubeId'?: string | null;
     /**
      *
      * @type {string}
@@ -4885,6 +5152,12 @@ export interface RespondGroupJoinRequest {
      * @memberof RespondGroupJoinRequest
      */
     'action': GroupJoinRequestAction;
+    /**
+     * Whether to block the user from requesting again
+     * @type {boolean}
+     * @memberof RespondGroupJoinRequest
+     */
+    'block'?: boolean;
 }
 /**
  *
@@ -4918,11 +5191,11 @@ export interface SentNotification {
      */
     'created_at': string;
     /**
-     * **NOTICE:** This is not a JSON object, this is a json **encoded** object, meaning you have to json-de-encode to get the NotificationDetail object depending on the NotificationType.
-     * @type {string}
+     *
+     * @type {object}
      * @memberof SentNotification
      */
-    'details': string;
+    'details': object;
     /**
      *
      * @type {string}
@@ -4940,7 +5213,7 @@ export interface SentNotification {
      * @type {string}
      * @memberof SentNotification
      */
-    'recieverUserId': string;
+    'receiverUserId': string;
     /**
      * 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.
      * @type {string}
@@ -5005,6 +5278,30 @@ export interface Subscription {
      * @memberof Subscription
      */
     'steamItemId': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Subscription
+     */
+    'oculusSku'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Subscription
+     */
+    'googleProductId'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Subscription
+     */
+    'googlePlanId'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Subscription
+     */
+    'picoSku'?: string;
     /**
      *
      * @type {number}
@@ -5068,6 +5365,18 @@ export interface Transaction {
      * @memberof Transaction
      */
     'id': string;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof Transaction
+     */
+    'userId'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Transaction
+     */
+    'userDisplayName'?: string;
     /**
      *
      * @type {TransactionStatus}
@@ -5116,6 +5425,18 @@ export interface Transaction {
      * @memberof Transaction
      */
     'error': string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Transaction
+     */
+    'isGift'?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Transaction
+     */
+    'isTokens'?: boolean;
 }
 /**
  *
@@ -5410,6 +5731,12 @@ export interface UnityPackage {
      * @memberof UnityPackage
      */
     'scanStatus'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UnityPackage
+     */
+    'variant'?: string;
 }
 /**
  *
@@ -5748,6 +6075,18 @@ export interface UpdateUserRequest {
      * @memberof UpdateUserRequest
      */
     'bioLinks'?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateUserRequest
+     */
+    'pronouns'?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UpdateUserRequest
+     */
+    'isBoopingEnabled'?: boolean;
     /**
      * MUST be a valid VRChat /file/ url.
      * @type {string}
@@ -5852,6 +6191,12 @@ export interface User {
      * @memberof User
      */
     'allowAvatarCopying': boolean;
+    /**
+     *
+     * @type {Array<Badge>}
+     * @memberof User
+     */
+    'badges'?: Array<Badge>;
     /**
      *
      * @type {string}
@@ -5876,6 +6221,12 @@ export interface User {
      * @memberof User
      */
     'currentAvatarThumbnailImageUrl': string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof User
+     */
+    'currentAvatarTags': Array<string>;
     /**
      *
      * @type {string}
@@ -5960,6 +6311,18 @@ export interface User {
      * @memberof User
      */
     'profilePicOverride': string;
+    /**
+     *
+     * @type {string}
+     * @memberof User
+     */
+    'profilePicOverrideThumbnail': string;
+    /**
+     *
+     * @type {string}
+     * @memberof User
+     */
+    'pronouns': string;
     /**
      *
      * @type {UserState}
@@ -6418,7 +6781,7 @@ export interface WorldPublishStatus {
      * @type {boolean}
      * @memberof WorldPublishStatus
      */
-    'canPubilsh': boolean;
+    'canPublish': boolean;
 }
 /**
  * AuthenticationApi - axios parameter creator
@@ -8536,10 +8899,11 @@ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration)
      * @param {string} groupId Must be a valid group ID.
      * @param {number} [n] The number of objects to return.
      * @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
+     * @param {boolean} [blocked] See blocked join requests
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getGroupRequests: (groupId: string, n?: number, offset?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getGroupRequests: (groupId: string, n?: number, offset?: number, blocked?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns a Group Role by ID.
      * @summary Get Group Roles
@@ -8933,10 +9297,11 @@ export declare const GroupsApiFp: (configuration?: Configuration) => {
      * @param {string} groupId Must be a valid group ID.
      * @param {number} [n] The number of objects to return.
      * @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
+     * @param {boolean} [blocked] See blocked join requests
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getGroupRequests(groupId: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GroupMember>>>;
+    getGroupRequests(groupId: string, n?: number, offset?: number, blocked?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GroupMember>>>;
     /**
      * Returns a Group Role by ID.
      * @summary Get Group Roles
@@ -9330,10 +9695,11 @@ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?
      * @param {string} groupId Must be a valid group ID.
      * @param {number} [n] The number of objects to return.
      * @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
+     * @param {boolean} [blocked] See blocked join requests
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getGroupRequests(groupId: string, n?: number, offset?: number, options?: any): AxiosPromise<Array<GroupMember>>;
+    getGroupRequests(groupId: string, n?: number, offset?: number, blocked?: boolean, options?: any): AxiosPromise<Array<GroupMember>>;
     /**
      * Returns a Group Role by ID.
      * @summary Get Group Roles
@@ -9757,11 +10123,12 @@ export declare class GroupsApi extends BaseAPI {
      * @param {string} groupId Must be a valid group ID.
      * @param {number} [n] The number of objects to return.
      * @param {number} [offset] A zero-based offset from the default object sorting from where search results start.
+     * @param {boolean} [blocked] See blocked join requests
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof GroupsApi
      */
-    getGroupRequests(groupId: string, n?: number, offset?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupMember[], any>>;
+    getGroupRequests(groupId: string, n?: number, offset?: number, blocked?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupMember[], any>>;
     /**
      * Returns a Group Role by ID.
      * @summary Get Group Roles
@@ -11363,7 +11730,7 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getUserGroups(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<LimitedGroup>>>;
+    getUserGroups(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<LimitedUserGroups>>>;
     /**
      * Returns the current group that the user is currently representing
      * @summary Get user\'s current represented group
@@ -11430,7 +11797,7 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getUserGroups(userId: string, options?: any): AxiosPromise<Array<LimitedGroup>>;
+    getUserGroups(userId: string, options?: any): AxiosPromise<Array<LimitedUserGroups>>;
     /**
      * Returns the current group that the user is currently representing
      * @summary Get user\'s current represented group
@@ -11503,7 +11870,7 @@ export declare class UsersApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof UsersApi
      */
-    getUserGroups(userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LimitedGroup[], any>>;
+    getUserGroups(userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LimitedUserGroups[], any>>;
     /**
      * Returns the current group that the user is currently representing
      * @summary Get user\'s current represented group