add subdir

This commit is contained in:
ExilProductions
2026-02-15 17:39:26 +01:00
parent a4b3cb0164
commit aa707d1deb
262 changed files with 12189 additions and 0 deletions

635
Apis/AuthenticationApi.md Normal file
View File

@@ -0,0 +1,635 @@
# AuthenticationApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**cancelPending2FA**](AuthenticationApi.md#cancelPending2FA) | **DELETE** /auth/twofactorauth/totp/pending | Cancel pending enabling of time-based 2FA codes |
| [**checkUserExists**](AuthenticationApi.md#checkUserExists) | **GET** /auth/exists | Check User Exists |
| [**confirmEmail**](AuthenticationApi.md#confirmEmail) | **GET** /auth/confirmEmail | Confirm Email |
| [**createGlobalAvatarModeration**](AuthenticationApi.md#createGlobalAvatarModeration) | **POST** /auth/user/avatarmoderations | Create Global Avatar Moderation |
| [**deleteGlobalAvatarModeration**](AuthenticationApi.md#deleteGlobalAvatarModeration) | **DELETE** /auth/user/avatarmoderations | Delete Global Avatar Moderation |
| [**deleteModerationReport**](AuthenticationApi.md#deleteModerationReport) | **DELETE** /moderationReports/{moderationReportId} | Delete Moderation Report |
| [**deleteUser**](AuthenticationApi.md#deleteUser) | **PUT** /users/{userId}/delete | Delete User |
| [**disable2FA**](AuthenticationApi.md#disable2FA) | **DELETE** /auth/twofactorauth | Disable 2FA |
| [**enable2FA**](AuthenticationApi.md#enable2FA) | **POST** /auth/twofactorauth/totp/pending | Enable time-based 2FA codes |
| [**getCurrentUser**](AuthenticationApi.md#getCurrentUser) | **GET** /auth/user | Login and/or Get Current User Info |
| [**getGlobalAvatarModerations**](AuthenticationApi.md#getGlobalAvatarModerations) | **GET** /auth/user/avatarmoderations | Get Global Avatar Moderations |
| [**getModerationReports**](AuthenticationApi.md#getModerationReports) | **GET** /moderationReports | Get Moderation Reports |
| [**getRecoveryCodes**](AuthenticationApi.md#getRecoveryCodes) | **GET** /auth/user/twofactorauth/otp | Get 2FA Recovery codes |
| [**logout**](AuthenticationApi.md#logout) | **PUT** /logout | Logout |
| [**registerUserAccount**](AuthenticationApi.md#registerUserAccount) | **POST** /auth/register | Register User Account |
| [**resendEmailConfirmation**](AuthenticationApi.md#resendEmailConfirmation) | **POST** /auth/user/resendEmail | Resend Email Confirmation |
| [**submitModerationReport**](AuthenticationApi.md#submitModerationReport) | **POST** /moderationReports | Submit Moderation Report |
| [**verify2FA**](AuthenticationApi.md#verify2FA) | **POST** /auth/twofactorauth/totp/verify | Verify 2FA code |
| [**verify2FAEmailCode**](AuthenticationApi.md#verify2FAEmailCode) | **POST** /auth/twofactorauth/emailotp/verify | Verify 2FA email code |
| [**verifyAuthToken**](AuthenticationApi.md#verifyAuthToken) | **GET** /auth | Verify Auth Token |
| [**verifyLoginPlace**](AuthenticationApi.md#verifyLoginPlace) | **GET** /auth/verifyLoginPlace | Verify Login Place |
| [**verifyPending2FA**](AuthenticationApi.md#verifyPending2FA) | **POST** /auth/twofactorauth/totp/pending/verify | Verify Pending 2FA code |
| [**verifyRecoveryCode**](AuthenticationApi.md#verifyRecoveryCode) | **POST** /auth/twofactorauth/otp/verify | Verify 2FA code with Recovery code |
<a name="cancelPending2FA"></a>
# **cancelPending2FA**
> Disable2FAResult cancelPending2FA()
Cancel pending enabling of time-based 2FA codes
Cancels the sequence for enabling time-based 2FA.
### Parameters
This endpoint does not need any parameter.
### Return type
[**Disable2FAResult**](../Models/Disable2FAResult.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="checkUserExists"></a>
# **checkUserExists**
> UserExists checkUserExists(email, displayName, username, excludeUserId)
Check User Exists
Checks if a user by a given &#x60;username&#x60;, &#x60;displayName&#x60; or &#x60;email&#x60; exist. This is used during registration to check if a username has already been taken, during change of displayName to check if a displayName is available, and during change of email to check if the email is already used. In the later two cases the &#x60;excludeUserId&#x60; is used to exclude oneself, otherwise the result would always be true. It is **REQUIRED** to include **AT LEAST** &#x60;username&#x60;, &#x60;displayName&#x60; **or** &#x60;email&#x60; query parameter. Although they can be combined - in addition with &#x60;excludeUserId&#x60; (generally to exclude yourself) - to further fine-tune the search.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **email** | **String**| Filter by email. | [optional] [default to null] |
| **displayName** | **String**| Filter by displayName. | [optional] [default to null] |
| **username** | **String**| Filter by Username. | [optional] [default to null] |
| **excludeUserId** | **String**| Exclude by UserID. | [optional] [default to null] |
### Return type
[**UserExists**](../Models/UserExists.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="confirmEmail"></a>
# **confirmEmail**
> confirmEmail(id, verify\_email)
Confirm Email
Confirms the email address for a user
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **id** | **String**| Target user for which to verify email. | [default to null] |
| **verify\_email** | **String**| Token to verify email. | [default to null] |
### Return type
null (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="createGlobalAvatarModeration"></a>
# **createGlobalAvatarModeration**
> AvatarModerationCreated createGlobalAvatarModeration(CreateAvatarModerationRequest)
Create Global Avatar Moderation
Globally moderates an avatar.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **CreateAvatarModerationRequest** | [**CreateAvatarModerationRequest**](../Models/CreateAvatarModerationRequest.md)| | |
### Return type
[**AvatarModerationCreated**](../Models/AvatarModerationCreated.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="deleteGlobalAvatarModeration"></a>
# **deleteGlobalAvatarModeration**
> OkStatus2 deleteGlobalAvatarModeration(targetAvatarId, avatarModerationType)
Delete Global Avatar Moderation
Globally unmoderates an avatar.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **targetAvatarId** | **String**| Must be a valid avatar ID. | [default to null] |
| **avatarModerationType** | **String**| The avatar moderation type associated with the avatar. | [default to null] [enum: block] |
### Return type
[**OkStatus2**](../Models/OkStatus2.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteModerationReport"></a>
# **deleteModerationReport**
> SuccessFlag deleteModerationReport(moderationReportId)
Delete Moderation Report
Delete a moderation report
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **moderationReportId** | **String**| The moderation report id. | [default to null] |
### Return type
[**SuccessFlag**](../Models/SuccessFlag.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteUser"></a>
# **deleteUser**
> CurrentUser deleteUser(userId)
Delete User
Deletes the account with given ID. Normal users only have permission to delete their own account. Account deletion is 14 days from this request, and will be cancelled if you do an authenticated request with the account afterwards. **VRC+ NOTE:** Despite the 14-days cooldown, any VRC+ subscription will be cancelled **immediately**. **METHOD NOTE:** Despite this being a Delete action, the method type required is PUT.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**CurrentUser**](../Models/CurrentUser.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="disable2FA"></a>
# **disable2FA**
> Disable2FAResult disable2FA()
Disable 2FA
Disables 2FA for the currently logged in account
### Parameters
This endpoint does not need any parameter.
### Return type
[**Disable2FAResult**](../Models/Disable2FAResult.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="enable2FA"></a>
# **enable2FA**
> Pending2FAResult enable2FA()
Enable time-based 2FA codes
Begins the sequence for enabling time-based 2FA.
### Parameters
This endpoint does not need any parameter.
### Return type
[**Pending2FAResult**](../Models/Pending2FAResult.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getCurrentUser"></a>
# **getCurrentUser**
> oas_any_type_not_mapped getCurrentUser()
Login and/or Get Current User Info
This endpoint does the following two operations: 1) Checks if you are already logged in by looking for a valid &#x60;auth&#x60; cookie. If you are have a valid auth cookie then no additional auth-related actions are taken. If you are **not** logged in then it will log you in with the &#x60;Authorization&#x60; header and set the &#x60;auth&#x60; cookie. The &#x60;auth&#x60; cookie will only be sent once. 2) If logged in, this function will also return the CurrentUser object containing detailed information about the currently logged in user. The auth string after &#x60;Authorization: Basic {string}&#x60; is a base64-encoded string of the username and password, both individually url-encoded, and then joined with a colon. &gt; base64(urlencode(username):urlencode(password)) **WARNING: Session Limit:** Each authentication with login credentials counts as a separate session, out of which you have a limited amount. Make sure to save and reuse the &#x60;auth&#x60; cookie if you are often restarting the program. The provided API libraries automatically save cookies during runtime, but does not persist during restart. While it can be fine to use username/password during development, expect in production to very fast run into the rate-limit and be temporarily blocked from making new sessions until older ones expire. The exact number of simultaneous sessions is unknown/undisclosed.
### Parameters
This endpoint does not need any parameter.
### Return type
[**oas_any_type_not_mapped**](../Models/AnyType.md)
### Authorization
[authHeader](../README.md#authHeader), [twoFactorAuthCookie](../README.md#twoFactorAuthCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGlobalAvatarModerations"></a>
# **getGlobalAvatarModerations**
> List getGlobalAvatarModerations()
Get Global Avatar Moderations
Returns list of globally moderated avatars.
### Parameters
This endpoint does not need any parameter.
### Return type
[**List**](../Models/AvatarModeration.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getModerationReports"></a>
# **getModerationReports**
> PaginatedModerationReportList getModerationReports(offset, n, reportingUserId, status, type)
Get Moderation Reports
Get submitted moderation reports
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **reportingUserId** | **String**| Filter for moderation reports. | [optional] [default to null] |
| **status** | **String**| Filter for moderation reports. One of: &#x60;closed&#x60;... | [optional] [default to null] |
| **type** | **String**| Filter for moderation reports. One of: &#x60;avatar&#x60;, &#x60;group&#x60;, &#x60;user&#x60;, &#x60;world&#x60;... | [optional] [default to null] |
### Return type
[**PaginatedModerationReportList**](../Models/PaginatedModerationReportList.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getRecoveryCodes"></a>
# **getRecoveryCodes**
> TwoFactorRecoveryCodes getRecoveryCodes()
Get 2FA Recovery codes
Gets the OTP (One Time Password) recovery codes for accounts with 2FA-protection enabled.
### Parameters
This endpoint does not need any parameter.
### Return type
[**TwoFactorRecoveryCodes**](../Models/TwoFactorRecoveryCodes.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="logout"></a>
# **logout**
> Success logout()
Logout
Invalidates the login session.
### Parameters
This endpoint does not need any parameter.
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="registerUserAccount"></a>
# **registerUserAccount**
> oas_any_type_not_mapped registerUserAccount(RegisterUserAccountRequest)
Register User Account
~~Register a new user account.~~ **DEPRECATED:** Automated creation of accounts has no legitimate public third-party use case, and would be in violation of ToS ยง13.2: *By using the Platform, you agree not to: i. [...] use the Platform in a manner inconsistent with individual human usage* This endpoint is documented in the interest of completeness
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **RegisterUserAccountRequest** | [**RegisterUserAccountRequest**](../Models/RegisterUserAccountRequest.md)| | |
### Return type
[**oas_any_type_not_mapped**](../Models/AnyType.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="resendEmailConfirmation"></a>
# **resendEmailConfirmation**
> Success resendEmailConfirmation()
Resend Email Confirmation
Requests a resend of pending email address confirmation email
### Parameters
This endpoint does not need any parameter.
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="submitModerationReport"></a>
# **submitModerationReport**
> ModerationReport submitModerationReport(SubmitModerationReportRequest)
Submit Moderation Report
Submit a moderation report
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **SubmitModerationReportRequest** | [**SubmitModerationReportRequest**](../Models/SubmitModerationReportRequest.md)| | |
### Return type
[**ModerationReport**](../Models/ModerationReport.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="verify2FA"></a>
# **verify2FA**
> Verify2FAResult verify2FA(TwoFactorAuthCode)
Verify 2FA code
Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **TwoFactorAuthCode** | [**TwoFactorAuthCode**](../Models/TwoFactorAuthCode.md)| | |
### Return type
[**Verify2FAResult**](../Models/Verify2FAResult.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="verify2FAEmailCode"></a>
# **verify2FAEmailCode**
> Verify2FAEmailCodeResult verify2FAEmailCode(TwoFactorEmailCode)
Verify 2FA email code
Finishes the login sequence with an 2FA email code.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **TwoFactorEmailCode** | [**TwoFactorEmailCode**](../Models/TwoFactorEmailCode.md)| | |
### Return type
[**Verify2FAEmailCodeResult**](../Models/Verify2FAEmailCodeResult.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="verifyAuthToken"></a>
# **verifyAuthToken**
> VerifyAuthTokenResult verifyAuthToken()
Verify Auth Token
Verify whether the currently provided Auth Token is valid.
### Parameters
This endpoint does not need any parameter.
### Return type
[**VerifyAuthTokenResult**](../Models/VerifyAuthTokenResult.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="verifyLoginPlace"></a>
# **verifyLoginPlace**
> verifyLoginPlace(token, userId)
Verify Login Place
Verifies a login attempt for a user
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **token** | **String**| Token to verify login attempt. | [default to null] |
| **userId** | **String**| Filter by UserID. | [optional] [default to null] |
### Return type
null (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="verifyPending2FA"></a>
# **verifyPending2FA**
> Verify2FAResult verifyPending2FA(TwoFactorAuthCode)
Verify Pending 2FA code
Finishes sequence for enabling time-based 2FA.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **TwoFactorAuthCode** | [**TwoFactorAuthCode**](../Models/TwoFactorAuthCode.md)| | |
### Return type
[**Verify2FAResult**](../Models/Verify2FAResult.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="verifyRecoveryCode"></a>
# **verifyRecoveryCode**
> Verify2FAResult verifyRecoveryCode(TwoFactorAuthCode)
Verify 2FA code with Recovery code
Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **TwoFactorAuthCode** | [**TwoFactorAuthCode**](../Models/TwoFactorAuthCode.md)| | |
### Return type
[**Verify2FAResult**](../Models/Verify2FAResult.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json

421
Apis/AvatarsApi.md Normal file
View File

@@ -0,0 +1,421 @@
# AvatarsApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**createAvatar**](AvatarsApi.md#createAvatar) | **POST** /avatars | Create Avatar |
| [**deleteAvatar**](AvatarsApi.md#deleteAvatar) | **DELETE** /avatars/{avatarId} | Delete Avatar |
| [**deleteImpostor**](AvatarsApi.md#deleteImpostor) | **DELETE** /avatars/{avatarId}/impostor | Delete generated Impostor |
| [**enqueueImpostor**](AvatarsApi.md#enqueueImpostor) | **POST** /avatars/{avatarId}/impostor/enqueue | Enqueue Impostor generation |
| [**getAvatar**](AvatarsApi.md#getAvatar) | **GET** /avatars/{avatarId} | Get Avatar |
| [**getAvatarStyles**](AvatarsApi.md#getAvatarStyles) | **GET** /avatarStyles | Get Avatar Styles |
| [**getFavoritedAvatars**](AvatarsApi.md#getFavoritedAvatars) | **GET** /avatars/favorites | List Favorited Avatars |
| [**getImpostorQueueStats**](AvatarsApi.md#getImpostorQueueStats) | **GET** /avatars/impostor/queue/stats | Get Impostor Queue Stats |
| [**getLicensedAvatars**](AvatarsApi.md#getLicensedAvatars) | **GET** /avatars/licensed | List Licensed Avatars |
| [**getOwnAvatar**](AvatarsApi.md#getOwnAvatar) | **GET** /users/{userId}/avatar | Get Own Avatar |
| [**searchAvatars**](AvatarsApi.md#searchAvatars) | **GET** /avatars | Search Avatars |
| [**selectAvatar**](AvatarsApi.md#selectAvatar) | **PUT** /avatars/{avatarId}/select | Select Avatar |
| [**selectFallbackAvatar**](AvatarsApi.md#selectFallbackAvatar) | **PUT** /avatars/{avatarId}/selectFallback | Select Fallback Avatar |
| [**updateAvatar**](AvatarsApi.md#updateAvatar) | **PUT** /avatars/{avatarId} | Update Avatar |
<a name="createAvatar"></a>
# **createAvatar**
> Avatar createAvatar(CreateAvatarRequest)
Create Avatar
Create an avatar. It&#39;s possible to optionally specify a ID if you want a custom one. Attempting to create an Avatar with an already claimed ID will result in a DB error.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **CreateAvatarRequest** | [**CreateAvatarRequest**](../Models/CreateAvatarRequest.md)| | [optional] |
### Return type
[**Avatar**](../Models/Avatar.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="deleteAvatar"></a>
# **deleteAvatar**
> Avatar deleteAvatar(avatarId)
Delete Avatar
Delete an avatar. Notice an avatar is never fully \&quot;deleted\&quot;, only its ReleaseStatus is set to \&quot;hidden\&quot; and the linked Files are deleted. The AvatarID is permanently reserved.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **avatarId** | **String**| Must be a valid avatar ID. | [default to null] |
### Return type
[**Avatar**](../Models/Avatar.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteImpostor"></a>
# **deleteImpostor**
> deleteImpostor(avatarId)
Delete generated Impostor
Delete generated Impostor for that avatar.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **avatarId** | **String**| Must be a valid avatar ID. | [default to null] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="enqueueImpostor"></a>
# **enqueueImpostor**
> ServiceStatus enqueueImpostor(avatarId)
Enqueue Impostor generation
Enqueue Impostor generation for that avatar.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **avatarId** | **String**| Must be a valid avatar ID. | [default to null] |
### Return type
[**ServiceStatus**](../Models/ServiceStatus.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getAvatar"></a>
# **getAvatar**
> Avatar getAvatar(avatarId)
Get Avatar
Get information about a specific Avatar.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **avatarId** | **String**| Must be a valid avatar ID. | [default to null] |
### Return type
[**Avatar**](../Models/Avatar.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getAvatarStyles"></a>
# **getAvatarStyles**
> List getAvatarStyles()
Get Avatar Styles
List avatar styles.
### Parameters
This endpoint does not need any parameter.
### Return type
[**List**](../Models/AvatarStyle.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFavoritedAvatars"></a>
# **getFavoritedAvatars**
> List getFavoritedAvatars(featured, sort, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, userId)
List Favorited Avatars
Search and list favorited avatars by query filters.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **featured** | **Boolean**| Filters on featured results. | [optional] [default to null] |
| **sort** | **String**| The sort order of the results. | [optional] [default to popularity] [enum: _created_at, _updated_at, created, favorites, heat, labsPublicationDate, magic, name, order, popularity, publicationDate, random, relevance, reportCount, reportScore, shuffle, trust, updated] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **order** | **String**| Result ordering | [optional] [default to descending] [enum: ascending, descending] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **search** | **String**| Filters by world name. | [optional] [default to null] |
| **tag** | **String**| Tags to include (comma-separated). Any of the tags needs to be present. | [optional] [default to null] |
| **notag** | **String**| Tags to exclude (comma-separated). | [optional] [default to null] |
| **releaseStatus** | **String**| Filter by ReleaseStatus. | [optional] [default to public] [enum: all, hidden, private, public] |
| **maxUnityVersion** | **String**| The maximum Unity version supported by the asset. | [optional] [default to null] |
| **minUnityVersion** | **String**| The minimum Unity version supported by the asset. | [optional] [default to null] |
| **platform** | **String**| The platform the asset supports. | [optional] [default to null] |
| **userId** | **String**| Target user to see information on, admin-only. | [optional] [default to null] |
### Return type
[**List**](../Models/Avatar.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getImpostorQueueStats"></a>
# **getImpostorQueueStats**
> ServiceQueueStats getImpostorQueueStats()
Get Impostor Queue Stats
Gets service stats for queued impostor.
### Parameters
This endpoint does not need any parameter.
### Return type
[**ServiceQueueStats**](../Models/ServiceQueueStats.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getLicensedAvatars"></a>
# **getLicensedAvatars**
> List getLicensedAvatars(n, offset)
List Licensed Avatars
List licensed avatars.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**List**](../Models/Avatar.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getOwnAvatar"></a>
# **getOwnAvatar**
> Avatar getOwnAvatar(userId)
Get Own Avatar
Get the current avatar for the user. This will return an error for any other user than the one logged in.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**Avatar**](../Models/Avatar.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="searchAvatars"></a>
# **searchAvatars**
> List searchAvatars(featured, sort, user, userId, n, order, offset, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, isInternalVariant)
Search Avatars
Search and list avatars by query filters. You can only search your own or featured avatars. It is not possible as a normal user to search other peoples avatars.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **featured** | **Boolean**| Filters on featured results. | [optional] [default to null] |
| **sort** | **String**| The sort order of the results. | [optional] [default to popularity] [enum: _created_at, _updated_at, created, favorites, heat, labsPublicationDate, magic, name, order, popularity, publicationDate, random, relevance, reportCount, reportScore, shuffle, trust, updated] |
| **user** | **String**| Set to &#x60;me&#x60; for searching own avatars. | [optional] [default to null] [enum: me] |
| **userId** | **String**| Filter by UserID. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **order** | **String**| Result ordering | [optional] [default to descending] [enum: ascending, descending] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **tag** | **String**| Tags to include (comma-separated). Any of the tags needs to be present. | [optional] [default to null] |
| **notag** | **String**| Tags to exclude (comma-separated). | [optional] [default to null] |
| **releaseStatus** | **String**| Filter by ReleaseStatus. | [optional] [default to public] [enum: all, hidden, private, public] |
| **maxUnityVersion** | **String**| The maximum Unity version supported by the asset. | [optional] [default to null] |
| **minUnityVersion** | **String**| The minimum Unity version supported by the asset. | [optional] [default to null] |
| **platform** | **String**| The platform the asset supports. | [optional] [default to null] |
| **isInternalVariant** | **Boolean**| Not quite sure what this actually does (exists on the website but doesn&#39;t seem to be used) | [optional] [default to null] |
### Return type
[**List**](../Models/Avatar.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="selectAvatar"></a>
# **selectAvatar**
> CurrentUser selectAvatar(avatarId)
Select Avatar
Switches into that avatar.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **avatarId** | **String**| Must be a valid avatar ID. | [default to null] |
### Return type
[**CurrentUser**](../Models/CurrentUser.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="selectFallbackAvatar"></a>
# **selectFallbackAvatar**
> CurrentUser selectFallbackAvatar(avatarId)
Select Fallback Avatar
Switches into that avatar as your fallback avatar.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **avatarId** | **String**| Must be a valid avatar ID. | [default to null] |
### Return type
[**CurrentUser**](../Models/CurrentUser.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="updateAvatar"></a>
# **updateAvatar**
> Avatar updateAvatar(avatarId, UpdateAvatarRequest)
Update Avatar
Update information about a specific avatar.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **avatarId** | **String**| Must be a valid avatar ID. | [default to null] |
| **UpdateAvatarRequest** | [**UpdateAvatarRequest**](../Models/UpdateAvatarRequest.md)| | [optional] |
### Return type
[**Avatar**](../Models/Avatar.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json

403
Apis/CalendarApi.md Normal file
View File

@@ -0,0 +1,403 @@
# CalendarApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**createGroupCalendarEvent**](CalendarApi.md#createGroupCalendarEvent) | **POST** /calendar/{groupId}/event | Create a calendar event |
| [**deleteGroupCalendarEvent**](CalendarApi.md#deleteGroupCalendarEvent) | **DELETE** /calendar/{groupId}/{calendarId} | Delete a calendar event |
| [**discoverCalendarEvents**](CalendarApi.md#discoverCalendarEvents) | **GET** /calendar/discover | Discover calendar events |
| [**followGroupCalendarEvent**](CalendarApi.md#followGroupCalendarEvent) | **POST** /calendar/{groupId}/{calendarId}/follow | Follow a calendar event |
| [**getCalendarEvents**](CalendarApi.md#getCalendarEvents) | **GET** /calendar | List calendar events |
| [**getFeaturedCalendarEvents**](CalendarApi.md#getFeaturedCalendarEvents) | **GET** /calendar/featured | List featured calendar events |
| [**getFollowedCalendarEvents**](CalendarApi.md#getFollowedCalendarEvents) | **GET** /calendar/following | List followed calendar events |
| [**getGroupCalendarEvent**](CalendarApi.md#getGroupCalendarEvent) | **GET** /calendar/{groupId}/{calendarId} | Get a calendar event |
| [**getGroupCalendarEventICS**](CalendarApi.md#getGroupCalendarEventICS) | **GET** /calendar/{groupId}/{calendarId}.ics | Download calendar event as ICS |
| [**getGroupCalendarEvents**](CalendarApi.md#getGroupCalendarEvents) | **GET** /calendar/{groupId} | List a group&#39;s calendar events |
| [**getGroupNextCalendarEvent**](CalendarApi.md#getGroupNextCalendarEvent) | **GET** /calendar/{groupId}/next | Get next calendar event |
| [**searchCalendarEvents**](CalendarApi.md#searchCalendarEvents) | **GET** /calendar/search | Search for calendar events |
| [**updateGroupCalendarEvent**](CalendarApi.md#updateGroupCalendarEvent) | **PUT** /calendar/{groupId}/{calendarId}/event | Update a calendar event |
<a name="createGroupCalendarEvent"></a>
# **createGroupCalendarEvent**
> CalendarEvent createGroupCalendarEvent(groupId, CreateCalendarEventRequest)
Create a calendar event
Creates an event for a group on the calendar
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **CreateCalendarEventRequest** | [**CreateCalendarEventRequest**](../Models/CreateCalendarEventRequest.md)| | |
### Return type
[**CalendarEvent**](../Models/CalendarEvent.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="deleteGroupCalendarEvent"></a>
# **deleteGroupCalendarEvent**
> Success deleteGroupCalendarEvent(groupId, calendarId)
Delete a calendar event
Delete a group calendar event
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **calendarId** | **String**| Must be a valid calendar ID. | [default to null] |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="discoverCalendarEvents"></a>
# **discoverCalendarEvents**
> CalendarEventDiscovery discoverCalendarEvents(scope, categories, tags, featuredResults, nonFeaturedResults, personalizedResults, minimumInterestCount, minimumRemainingMinutes, upcomingOffsetMinutes, n, nextCursor)
Discover calendar events
Get a list of calendar events Initially, call without a &#x60;nextCursor&#x60; parameter For every successive call, use the &#x60;nextCursor&#x60; property returned in the previous call &amp; the &#x60;number&#x60; of entries desired for this call The &#x60;nextCursor&#x60; internally keeps track of the &#x60;offset&#x60; of the results, the initial request parameters, and accounts for discrepancies that might arise from time elapsed between calls
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **scope** | **String**| Scope for calendar event discovery. | [optional] [default to upcoming] [enum: all, live, upcoming] |
| **categories** | **String**| Filter for calendar event discovery. | [optional] [default to null] |
| **tags** | **String**| Filter for calendar event discovery. | [optional] [default to null] |
| **featuredResults** | **String**| Filter for calendar event discovery. | [optional] [default to include] [enum: exclude, include, skip] |
| **nonFeaturedResults** | **String**| Filter for calendar event discovery. | [optional] [default to include] [enum: exclude, include, skip] |
| **personalizedResults** | **String**| Filter for calendar event discovery. | [optional] [default to include] [enum: exclude, include, skip] |
| **minimumInterestCount** | **Integer**| Filter for calendar event discovery. | [optional] [default to null] |
| **minimumRemainingMinutes** | **Integer**| Filter for calendar event discovery. | [optional] [default to null] |
| **upcomingOffsetMinutes** | **Integer**| Filter for calendar event discovery. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **nextCursor** | **String**| Cursor returned from previous calendar discovery queries (see nextCursor property of the schema CalendarEventDiscovery). | [optional] [default to null] |
### Return type
[**CalendarEventDiscovery**](../Models/CalendarEventDiscovery.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="followGroupCalendarEvent"></a>
# **followGroupCalendarEvent**
> CalendarEvent followGroupCalendarEvent(groupId, calendarId, FollowCalendarEventRequest)
Follow a calendar event
Follow or unfollow an event on a group&#39;s calendar
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **calendarId** | **String**| Must be a valid calendar ID. | [default to null] |
| **FollowCalendarEventRequest** | [**FollowCalendarEventRequest**](../Models/FollowCalendarEventRequest.md)| | |
### Return type
[**CalendarEvent**](../Models/CalendarEvent.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="getCalendarEvents"></a>
# **getCalendarEvents**
> PaginatedCalendarEventList getCalendarEvents(date, n, offset)
List calendar events
Get a list of a user&#39;s calendar events for the month in ?date
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **date** | **Date**| The month to search in. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**PaginatedCalendarEventList**](../Models/PaginatedCalendarEventList.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFeaturedCalendarEvents"></a>
# **getFeaturedCalendarEvents**
> PaginatedCalendarEventList getFeaturedCalendarEvents(date, n, offset)
List featured calendar events
Get a list of a featured calendar events for the month in ?date
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **date** | **Date**| The month to search in. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**PaginatedCalendarEventList**](../Models/PaginatedCalendarEventList.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFollowedCalendarEvents"></a>
# **getFollowedCalendarEvents**
> PaginatedCalendarEventList getFollowedCalendarEvents(date, n, offset)
List followed calendar events
Get a list of a followed calendar events for the month in ?date
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **date** | **Date**| The month to search in. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**PaginatedCalendarEventList**](../Models/PaginatedCalendarEventList.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupCalendarEvent"></a>
# **getGroupCalendarEvent**
> CalendarEvent getGroupCalendarEvent(groupId, calendarId)
Get a calendar event
Get a group calendar event
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **calendarId** | **String**| Must be a valid calendar ID. | [default to null] |
### Return type
[**CalendarEvent**](../Models/CalendarEvent.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupCalendarEventICS"></a>
# **getGroupCalendarEventICS**
> File getGroupCalendarEventICS(groupId, calendarId)
Download calendar event as ICS
Returns the specified calendar in iCalendar (ICS) format.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **calendarId** | **String**| Must be a valid calendar ID. | [default to null] |
### Return type
**File**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/calendar, application/json
<a name="getGroupCalendarEvents"></a>
# **getGroupCalendarEvents**
> PaginatedCalendarEventList getGroupCalendarEvents(groupId, date, n, offset)
List a group&#39;s calendar events
Get a list of a group&#39;s calendar events
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **date** | **Date**| The month to search in. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**PaginatedCalendarEventList**](../Models/PaginatedCalendarEventList.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupNextCalendarEvent"></a>
# **getGroupNextCalendarEvent**
> CalendarEvent getGroupNextCalendarEvent(groupId)
Get next calendar event
Get the closest future calendar event scheduled for a group
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
### Return type
[**CalendarEvent**](../Models/CalendarEvent.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="searchCalendarEvents"></a>
# **searchCalendarEvents**
> PaginatedCalendarEventList searchCalendarEvents(searchTerm, utcOffset, n, offset, isInternalVariant)
Search for calendar events
Get a list of calendar events by search terms
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **searchTerm** | **String**| Search term for calendar events. | [default to null] |
| **utcOffset** | **Integer**| The offset from UTC in hours of the client or authenticated user. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **isInternalVariant** | **Boolean**| Not quite sure what this actually does (exists on the website but doesn&#39;t seem to be used) | [optional] [default to null] |
### Return type
[**PaginatedCalendarEventList**](../Models/PaginatedCalendarEventList.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="updateGroupCalendarEvent"></a>
# **updateGroupCalendarEvent**
> CalendarEvent updateGroupCalendarEvent(groupId, calendarId, UpdateCalendarEventRequest)
Update a calendar event
Updates an event for a group on the calendar
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **calendarId** | **String**| Must be a valid calendar ID. | [default to null] |
| **UpdateCalendarEventRequest** | [**UpdateCalendarEventRequest**](../Models/UpdateCalendarEventRequest.md)| | |
### Return type
[**CalendarEvent**](../Models/CalendarEvent.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json

677
Apis/EconomyApi.md Normal file
View File

@@ -0,0 +1,677 @@
# EconomyApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**getActiveLicenses**](EconomyApi.md#getActiveLicenses) | **GET** /economy/licenses/active | Get Active Licenses |
| [**getBalance**](EconomyApi.md#getBalance) | **GET** /user/{userId}/balance | Get Balance |
| [**getBalanceEarnings**](EconomyApi.md#getBalanceEarnings) | **GET** /user/{userId}/balance/earnings | Get Balance Earnings |
| [**getBulkGiftPurchases**](EconomyApi.md#getBulkGiftPurchases) | **GET** /user/bulk/gift/purchases | Get Bulk Gift Purchases |
| [**getCurrentSubscriptions**](EconomyApi.md#getCurrentSubscriptions) | **GET** /auth/user/subscription | Get Current Subscriptions |
| [**getEconomyAccount**](EconomyApi.md#getEconomyAccount) | **GET** /user/{userId}/economy/account | Get Economy Account |
| [**getLicenseGroup**](EconomyApi.md#getLicenseGroup) | **GET** /licenseGroups/{licenseGroupId} | Get License Group |
| [**getProductListing**](EconomyApi.md#getProductListing) | **GET** /listing/{productId} | Get Product Listing |
| [**getProductListingAlternate**](EconomyApi.md#getProductListingAlternate) | **GET** /products/{productId} | Get Product Listing (alternate) |
| [**getProductListings**](EconomyApi.md#getProductListings) | **GET** /user/{userId}/listings | Get User Product Listings |
| [**getProductPurchases**](EconomyApi.md#getProductPurchases) | **GET** /economy/purchases | Get Product Purchases |
| [**getRecentSubscription**](EconomyApi.md#getRecentSubscription) | **GET** /user/subscription/recent | Get Recent Subscription |
| [**getSteamTransaction**](EconomyApi.md#getSteamTransaction) | **GET** /Steam/transactions/{transactionId} | Get Steam Transaction |
| [**getSteamTransactions**](EconomyApi.md#getSteamTransactions) | **GET** /Steam/transactions | List Steam Transactions |
| [**getStore**](EconomyApi.md#getStore) | **GET** /economy/store | Get Store |
| [**getStoreShelves**](EconomyApi.md#getStoreShelves) | **GET** /economy/store/shelves | Get Store Shelves |
| [**getSubscriptions**](EconomyApi.md#getSubscriptions) | **GET** /subscriptions | List Subscriptions |
| [**getTiliaStatus**](EconomyApi.md#getTiliaStatus) | **GET** /tilia/status | Get Tilia Status |
| [**getTiliaTos**](EconomyApi.md#getTiliaTos) | **GET** /user/{userId}/tilia/tos | Get Tilia TOS Agreement Status |
| [**getTokenBundles**](EconomyApi.md#getTokenBundles) | **GET** /tokenBundles | List Token Bundles |
| [**getUserCreditsEligible**](EconomyApi.md#getUserCreditsEligible) | **GET** /users/{userId}/credits/eligible | Get User Credits Eligiblity |
| [**getUserSubscriptionEligible**](EconomyApi.md#getUserSubscriptionEligible) | **GET** /users/{userId}/subscription/eligible | Get User Subscription Eligiblity |
| [**purchaseProductListing**](EconomyApi.md#purchaseProductListing) | **POST** /economy/purchase/listing | Purchase Product Listing |
| [**updateTiliaTos**](EconomyApi.md#updateTiliaTos) | **PUT** /user/{userId}/tilia/tos | Update Tilia TOS Agreement Status |
<a name="getActiveLicenses"></a>
# **getActiveLicenses**
> List getActiveLicenses()
Get Active Licenses
Gets active licenses
### Parameters
This endpoint does not need any parameter.
### Return type
[**List**](../Models/License.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getBalance"></a>
# **getBalance**
> Balance getBalance(userId)
Get Balance
Gets the balance of a user
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**Balance**](../Models/Balance.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getBalanceEarnings"></a>
# **getBalanceEarnings**
> Balance getBalanceEarnings(userId)
Get Balance Earnings
Gets the balance of a user from earnings
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**Balance**](../Models/Balance.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getBulkGiftPurchases"></a>
# **getBulkGiftPurchases**
> List getBulkGiftPurchases(mostRecent)
Get Bulk Gift Purchases
Get bulk gift purchases made by the user.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **mostRecent** | **Boolean**| | [optional] [default to null] |
### Return type
**List**
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getCurrentSubscriptions"></a>
# **getCurrentSubscriptions**
> List getCurrentSubscriptions()
Get Current Subscriptions
Get a list of all current user subscriptions.
### Parameters
This endpoint does not need any parameter.
### Return type
[**List**](../Models/UserSubscription.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getEconomyAccount"></a>
# **getEconomyAccount**
> EconomyAccount getEconomyAccount(userId)
Get Economy Account
Gets the economy account of a user
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**EconomyAccount**](../Models/EconomyAccount.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getLicenseGroup"></a>
# **getLicenseGroup**
> LicenseGroup getLicenseGroup(licenseGroupId)
Get License Group
Get a single License Group by given ID.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **licenseGroupId** | **String**| Must be a valid license group ID. | [default to null] |
### Return type
[**LicenseGroup**](../Models/LicenseGroup.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getProductListing"></a>
# **getProductListing**
> Listing getProductListing(productId, hydrate)
Get Product Listing
Gets a product listing
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **productId** | **String**| Must be a valid product ID. | [default to null] |
| **hydrate** | **Boolean**| Populates some fields and changes types of others for certain objects. | [optional] [default to null] |
### Return type
[**Listing**](../Models/Listing.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getProductListingAlternate"></a>
# **getProductListingAlternate**
> Listing getProductListingAlternate(productId)
Get Product Listing (alternate)
Gets a product listing
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **productId** | **String**| Must be a valid product ID. | [default to null] |
### Return type
[**Listing**](../Models/Listing.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getProductListings"></a>
# **getProductListings**
> List getProductListings(userId, n, offset, hydrate, groupId, active)
Get User Product Listings
Gets the product listings of a given user
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **hydrate** | **Boolean**| Populates some fields and changes types of others for certain objects. | [optional] [default to null] |
| **groupId** | **String**| Must be a valid group ID. | [optional] [default to null] |
| **active** | **Boolean**| Filter for users&#39; listings and inventory bundles. | [optional] [default to null] |
### Return type
[**List**](../Models/Listing.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getProductPurchases"></a>
# **getProductPurchases**
> List getProductPurchases(buyerId, n, offset, mostRecent, sort, order)
Get Product Purchases
Gets product purchases
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **buyerId** | **String**| Must be a valid user ID. | [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **mostRecent** | **Boolean**| | [optional] [default to null] |
| **sort** | **String**| The sort order of the results. | [optional] [default to purchaseDate] [enum: purchaseDate] |
| **order** | **String**| Result ordering | [optional] [default to desc] [enum: asc, desc] |
### Return type
[**List**](../Models/ProductPurchase.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getRecentSubscription"></a>
# **getRecentSubscription**
> UserSubscription getRecentSubscription()
Get Recent Subscription
Get the most recent user subscription.
### Parameters
This endpoint does not need any parameter.
### Return type
[**UserSubscription**](../Models/UserSubscription.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getSteamTransaction"></a>
# **getSteamTransaction**
> Transaction getSteamTransaction(transactionId)
Get Steam Transaction
Get a single Steam transactions by ID. This returns the exact same information as &#x60;getSteamTransactions&#x60;, so no point in using this endpoint.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **transactionId** | **String**| Must be a valid transaction ID. | [default to null] |
### Return type
[**Transaction**](../Models/Transaction.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getSteamTransactions"></a>
# **getSteamTransactions**
> List getSteamTransactions()
List Steam Transactions
Get all own Steam transactions.
### Parameters
This endpoint does not need any parameter.
### Return type
[**List**](../Models/Transaction.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getStore"></a>
# **getStore**
> Store getStore(storeId, hydrateListings, hydrateProducts)
Get Store
Gets a store
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **storeId** | **String**| | [default to null] |
| **hydrateListings** | **Boolean**| Listings fields will be populated. | [optional] [default to null] |
| **hydrateProducts** | **Boolean**| Products fields will be populated. | [optional] [default to null] |
### Return type
[**Store**](../Models/Store.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getStoreShelves"></a>
# **getStoreShelves**
> List getStoreShelves(storeId, hydrateListings, fetch)
Get Store Shelves
Gets the shelves for a store
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **storeId** | **String**| | [default to null] |
| **hydrateListings** | **Boolean**| Listings fields will be populated. | [optional] [default to null] |
| **fetch** | **String**| | [optional] [default to public] [enum: all, draft, preview, public, publicPreview] |
### Return type
[**List**](../Models/StoreShelf.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getSubscriptions"></a>
# **getSubscriptions**
> List getSubscriptions()
List Subscriptions
List all existing Subscriptions. For example, \&quot;vrchatplus-monthly\&quot; and \&quot;vrchatplus-yearly\&quot;.
### Parameters
This endpoint does not need any parameter.
### Return type
[**List**](../Models/Subscription.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getTiliaStatus"></a>
# **getTiliaStatus**
> TiliaStatus getTiliaStatus()
Get Tilia Status
Gets the status of Tilia integration
### Parameters
This endpoint does not need any parameter.
### Return type
[**TiliaStatus**](../Models/TiliaStatus.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getTiliaTos"></a>
# **getTiliaTos**
> TiliaTOS getTiliaTos(userId)
Get Tilia TOS Agreement Status
Gets the status of the agreement of a user to the Tilia TOS
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**TiliaTOS**](../Models/TiliaTOS.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getTokenBundles"></a>
# **getTokenBundles**
> List getTokenBundles()
List Token Bundles
Gets the list of token bundles
### Parameters
This endpoint does not need any parameter.
### Return type
[**List**](../Models/TokenBundle.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserCreditsEligible"></a>
# **getUserCreditsEligible**
> UserCreditsEligible getUserCreditsEligible(userId, subscriptionId)
Get User Credits Eligiblity
Get the user&#39;s eligibility status for subscriptions based on available credits.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **subscriptionId** | **String**| | [default to null] |
### Return type
[**UserCreditsEligible**](../Models/UserCreditsEligible.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserSubscriptionEligible"></a>
# **getUserSubscriptionEligible**
> UserSubscriptionEligible getUserSubscriptionEligible(userId, steamId)
Get User Subscription Eligiblity
Get the user&#39;s eligibility status for subscriptions.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **steamId** | **String**| The Steam ID of the user. | [optional] [default to null] |
### Return type
[**UserSubscriptionEligible**](../Models/UserSubscriptionEligible.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="purchaseProductListing"></a>
# **purchaseProductListing**
> ProductPurchase purchaseProductListing(PurchaseProductListingRequest)
Purchase Product Listing
Purchases a product listing
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **PurchaseProductListingRequest** | [**PurchaseProductListingRequest**](../Models/PurchaseProductListingRequest.md)| | [optional] |
### Return type
[**ProductPurchase**](../Models/ProductPurchase.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="updateTiliaTos"></a>
# **updateTiliaTos**
> Object updateTiliaTos(userId, UpdateTiliaTOSRequest)
Update Tilia TOS Agreement Status
Updates the status of the agreement of a user to the Tilia TOS
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **UpdateTiliaTOSRequest** | [**UpdateTiliaTOSRequest**](../Models/UpdateTiliaTOSRequest.md)| | [optional] |
### Return type
**Object**
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json

242
Apis/FavoritesApi.md Normal file
View File

@@ -0,0 +1,242 @@
# FavoritesApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**addFavorite**](FavoritesApi.md#addFavorite) | **POST** /favorites | Add Favorite |
| [**clearFavoriteGroup**](FavoritesApi.md#clearFavoriteGroup) | **DELETE** /favorite/group/{favoriteGroupType}/{favoriteGroupName}/{userId} | Clear Favorite Group |
| [**getFavoriteGroup**](FavoritesApi.md#getFavoriteGroup) | **GET** /favorite/group/{favoriteGroupType}/{favoriteGroupName}/{userId} | Show Favorite Group |
| [**getFavoriteGroups**](FavoritesApi.md#getFavoriteGroups) | **GET** /favorite/groups | List Favorite Groups |
| [**getFavoriteLimits**](FavoritesApi.md#getFavoriteLimits) | **GET** /auth/user/favoritelimits | Get Favorite Limits |
| [**getFavorites**](FavoritesApi.md#getFavorites) | **GET** /favorites | List Favorites |
| [**removeFavorite**](FavoritesApi.md#removeFavorite) | **DELETE** /favorites/{favoriteId} | Remove Favorite |
| [**updateFavoriteGroup**](FavoritesApi.md#updateFavoriteGroup) | **PUT** /favorite/group/{favoriteGroupType}/{favoriteGroupName}/{userId} | Update Favorite Group |
<a name="addFavorite"></a>
# **addFavorite**
> Favorite addFavorite(addFavorite\_request)
Add Favorite
Add a new favorite. Friend groups are named &#x60;group_0&#x60; through &#x60;group_3&#x60;. Avatar and World groups are named &#x60;avatars1&#x60; to &#x60;avatars4&#x60; and &#x60;worlds1&#x60; to &#x60;worlds4&#x60;. You cannot add people whom you are not friends with to your friends list. Destroying a friendship removes the person as favorite on both sides.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **addFavorite\_request** | [**addFavorite_request**](../Models/addFavorite_request.md)| | [optional] |
### Return type
[**Favorite**](../Models/Favorite.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="clearFavoriteGroup"></a>
# **clearFavoriteGroup**
> Success clearFavoriteGroup(favoriteGroupType, favoriteGroupName, userId)
Clear Favorite Group
Clear ALL contents of a specific favorite group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **favoriteGroupType** | **String**| The type of group to fetch, must be a valid FavoriteType. | [default to null] [enum: avatar, friend, world] |
| **favoriteGroupName** | **String**| The name of the group to fetch, must be a name of a FavoriteGroup. | [default to null] |
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFavoriteGroup"></a>
# **getFavoriteGroup**
> FavoriteGroup getFavoriteGroup(favoriteGroupType, favoriteGroupName, userId)
Show Favorite Group
Fetch information about a specific favorite group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **favoriteGroupType** | **String**| The type of group to fetch, must be a valid FavoriteType. | [default to null] [enum: avatar, friend, world] |
| **favoriteGroupName** | **String**| The name of the group to fetch, must be a name of a FavoriteGroup. | [default to null] |
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**FavoriteGroup**](../Models/FavoriteGroup.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFavoriteGroups"></a>
# **getFavoriteGroups**
> List getFavoriteGroups(n, offset, userId, ownerId)
List Favorite Groups
Return a list of favorite groups owned by a user. Returns the same information as &#x60;getFavoriteGroups&#x60;.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **userId** | **String**| Target user to see information on, admin-only. | [optional] [default to null] |
| **ownerId** | **String**| The owner of whoms favorite groups to return. Must be a UserID. | [optional] [default to null] |
### Return type
[**List**](../Models/FavoriteGroup.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFavoriteLimits"></a>
# **getFavoriteLimits**
> FavoriteLimits getFavoriteLimits()
Get Favorite Limits
Return information about a specific Favorite.
### Parameters
This endpoint does not need any parameter.
### Return type
[**FavoriteLimits**](../Models/FavoriteLimits.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFavorites"></a>
# **getFavorites**
> List getFavorites(n, offset, type, tag)
List Favorites
Returns a list of favorites.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **type** | **String**| The type of favorites to return, FavoriteType. | [optional] [default to null] |
| **tag** | **String**| Tags to include (comma-separated). Any of the tags needs to be present. | [optional] [default to null] |
### Return type
[**List**](../Models/Favorite.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="removeFavorite"></a>
# **removeFavorite**
> Success removeFavorite(favoriteId)
Remove Favorite
Remove a favorite from your favorites list.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **favoriteId** | **String**| Must be a valid favorite ID. | [default to null] |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="updateFavoriteGroup"></a>
# **updateFavoriteGroup**
> updateFavoriteGroup(favoriteGroupType, favoriteGroupName, userId, UpdateFavoriteGroupRequest)
Update Favorite Group
Update information about a specific favorite group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **favoriteGroupType** | **String**| The type of group to fetch, must be a valid FavoriteType. | [default to null] [enum: avatar, friend, world] |
| **favoriteGroupName** | **String**| The name of the group to fetch, must be a name of a FavoriteGroup. | [default to null] |
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **UpdateFavoriteGroupRequest** | [**UpdateFavoriteGroupRequest**](../Models/UpdateFavoriteGroupRequest.md)| | [optional] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined

622
Apis/FilesApi.md Normal file
View File

@@ -0,0 +1,622 @@
# FilesApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**createFile**](FilesApi.md#createFile) | **POST** /file | Create File |
| [**createFileVersion**](FilesApi.md#createFileVersion) | **POST** /file/{fileId} | Create File Version |
| [**deleteFile**](FilesApi.md#deleteFile) | **DELETE** /file/{fileId} | Delete File |
| [**deleteFileVersion**](FilesApi.md#deleteFileVersion) | **DELETE** /file/{fileId}/{versionId} | Delete File Version |
| [**downloadFileVersion**](FilesApi.md#downloadFileVersion) | **GET** /file/{fileId}/{versionId} | Download File Version |
| [**finishFileDataUpload**](FilesApi.md#finishFileDataUpload) | **PUT** /file/{fileId}/{versionId}/{fileType}/finish | Finish FileData Upload |
| [**getAdminAssetBundle**](FilesApi.md#getAdminAssetBundle) | **GET** /adminassetbundles/{adminAssetBundleId} | Get AdminAssetBundle |
| [**getContentAgreementStatus**](FilesApi.md#getContentAgreementStatus) | **GET** /agreement | Get Content Agreement Status |
| [**getFile**](FilesApi.md#getFile) | **GET** /file/{fileId} | Show File |
| [**getFileAnalysis**](FilesApi.md#getFileAnalysis) | **GET** /analysis/{fileId}/{versionId} | Get File Version Analysis |
| [**getFileAnalysisSecurity**](FilesApi.md#getFileAnalysisSecurity) | **GET** /analysis/{fileId}/{versionId}/security | Get File Version Analysis Security |
| [**getFileAnalysisStandard**](FilesApi.md#getFileAnalysisStandard) | **GET** /analysis/{fileId}/{versionId}/standard | Get File Version Analysis Standard |
| [**getFileDataUploadStatus**](FilesApi.md#getFileDataUploadStatus) | **GET** /file/{fileId}/{versionId}/{fileType}/status | Check FileData Upload Status |
| [**getFiles**](FilesApi.md#getFiles) | **GET** /files | List Files |
| [**setGroupGalleryFileOrder**](FilesApi.md#setGroupGalleryFileOrder) | **PUT** /files/order | Set Group Gallery File Order |
| [**startFileDataUpload**](FilesApi.md#startFileDataUpload) | **PUT** /file/{fileId}/{versionId}/{fileType}/start | Start FileData Upload |
| [**submitContentAgreement**](FilesApi.md#submitContentAgreement) | **POST** /agreement | Submit Content Agreement |
| [**updateAssetReviewNotes**](FilesApi.md#updateAssetReviewNotes) | **PUT** /assetReview/{assetReviewId}/notes | Update Asset Review Notes |
| [**uploadGalleryImage**](FilesApi.md#uploadGalleryImage) | **POST** /gallery | Upload gallery image |
| [**uploadIcon**](FilesApi.md#uploadIcon) | **POST** /icon | Upload icon |
| [**uploadImage**](FilesApi.md#uploadImage) | **POST** /file/image | Upload gallery image, icon, emoji or sticker |
<a name="createFile"></a>
# **createFile**
> File createFile(CreateFileRequest)
Create File
Creates a new File object
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **CreateFileRequest** | [**CreateFileRequest**](../Models/CreateFileRequest.md)| | [optional] |
### Return type
[**File**](../Models/File.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="createFileVersion"></a>
# **createFileVersion**
> File createFileVersion(fileId, CreateFileVersionRequest)
Create File Version
Creates a new FileVersion. Once a Version has been created, proceed to the &#x60;/file/{fileId}/{versionId}/file/start&#x60; endpoint to start a file upload.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **fileId** | **String**| Must be a valid file ID. | [default to null] |
| **CreateFileVersionRequest** | [**CreateFileVersionRequest**](../Models/CreateFileVersionRequest.md)| | [optional] |
### Return type
[**File**](../Models/File.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="deleteFile"></a>
# **deleteFile**
> File deleteFile(fileId)
Delete File
Deletes a File object.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **fileId** | **String**| Must be a valid file ID. | [default to null] |
### Return type
[**File**](../Models/File.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteFileVersion"></a>
# **deleteFileVersion**
> File deleteFileVersion(fileId, versionId)
Delete File Version
Delete a specific version of a file. You can only delete the latest version.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **fileId** | **String**| Must be a valid file ID. | [default to null] |
| **versionId** | **Integer**| Version ID of the asset. | [default to null] |
### Return type
[**File**](../Models/File.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="downloadFileVersion"></a>
# **downloadFileVersion**
> File downloadFileVersion(fileId, versionId)
Download File Version
Downloads the file with the provided version number. **Version Note:** Version 0 is always when the file was created. The real data is usually always located in version 1 and up. **Extension Note:** Files are not guaranteed to have a file extensions. UnityPackage files tends to have it, images through this endpoint do not. You are responsible for appending file extension from the &#x60;extension&#x60; field when neccesary.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **fileId** | **String**| Must be a valid file ID. | [default to null] |
| **versionId** | **Integer**| Version ID of the asset. | [default to null] |
### Return type
**File**
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: image/*, application/json
<a name="finishFileDataUpload"></a>
# **finishFileDataUpload**
> File finishFileDataUpload(fileId, versionId, fileType, FinishFileDataUploadRequest)
Finish FileData Upload
Finish an upload of a FileData. This will mark it as \&quot;complete\&quot;. After uploading the &#x60;file&#x60; for Avatars and Worlds you then have to upload a &#x60;signature&#x60; file.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **fileId** | **String**| Must be a valid file ID. | [default to null] |
| **versionId** | **Integer**| Version ID of the asset. | [default to null] |
| **fileType** | **String**| Type of file. | [default to null] [enum: delta, file, signature] |
| **FinishFileDataUploadRequest** | [**FinishFileDataUploadRequest**](../Models/FinishFileDataUploadRequest.md)| Please see documentation on ETag&#39;s: [https://teppen.io/2018/06/23/aws_s3_etags/](https://teppen.io/2018/06/23/aws_s3_etags/) ETag&#39;s should NOT be present when uploading a &#x60;signature&#x60;. | [optional] |
### Return type
[**File**](../Models/File.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="getAdminAssetBundle"></a>
# **getAdminAssetBundle**
> AdminAssetBundle getAdminAssetBundle(adminAssetBundleId)
Get AdminAssetBundle
Returns an AdminAssetBundle
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **adminAssetBundleId** | **String**| Must be a valid admin asset bundle ID. | [default to null] |
### Return type
[**AdminAssetBundle**](../Models/AdminAssetBundle.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getContentAgreementStatus"></a>
# **getContentAgreementStatus**
> AgreementStatus getContentAgreementStatus(agreementCode, contentId, version)
Get Content Agreement Status
Returns the agreement status of the currently authenticated user for the given agreementCode, contentId, and version.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **agreementCode** | **String**| The type of agreement (currently content.copyright.owned) | [default to content.copyright.owned] [enum: content.copyright.owned] |
| **contentId** | **String**| The id of the content being uploaded, such as a WorldID, AvatarID, or PropID | [default to null] |
| **version** | **Integer**| The version of the agreement (currently 1) | [default to null] |
### Return type
[**AgreementStatus**](../Models/AgreementStatus.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFile"></a>
# **getFile**
> File getFile(fileId)
Show File
Shows general information about the \&quot;File\&quot; object. Each File can have several \&quot;Version\&quot;&#39;s, and each Version can have multiple real files or \&quot;Data\&quot; blobs.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **fileId** | **String**| Must be a valid file ID. | [default to null] |
### Return type
[**File**](../Models/File.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFileAnalysis"></a>
# **getFileAnalysis**
> FileAnalysis getFileAnalysis(fileId, versionId)
Get File Version Analysis
Get the performance analysis for the uploaded assets of an avatar
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **fileId** | **String**| Must be a valid file ID. | [default to null] |
| **versionId** | **Integer**| Version ID of the asset. | [default to null] |
### Return type
[**FileAnalysis**](../Models/FileAnalysis.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFileAnalysisSecurity"></a>
# **getFileAnalysisSecurity**
> FileAnalysis getFileAnalysisSecurity(fileId, versionId)
Get File Version Analysis Security
Get the security performance analysis for the uploaded assets of an avatar
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **fileId** | **String**| Must be a valid file ID. | [default to null] |
| **versionId** | **Integer**| Version ID of the asset. | [default to null] |
### Return type
[**FileAnalysis**](../Models/FileAnalysis.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFileAnalysisStandard"></a>
# **getFileAnalysisStandard**
> FileAnalysis getFileAnalysisStandard(fileId, versionId)
Get File Version Analysis Standard
Get the standard performance analysis for the uploaded assets of an avatar
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **fileId** | **String**| Must be a valid file ID. | [default to null] |
| **versionId** | **Integer**| Version ID of the asset. | [default to null] |
### Return type
[**FileAnalysis**](../Models/FileAnalysis.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFileDataUploadStatus"></a>
# **getFileDataUploadStatus**
> FileVersionUploadStatus getFileDataUploadStatus(fileId, versionId, fileType)
Check FileData Upload Status
Retrieves the upload status for file upload. Can currently only be accessed when &#x60;status&#x60; is &#x60;waiting&#x60;. Trying to access it on a file version already uploaded currently times out.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **fileId** | **String**| Must be a valid file ID. | [default to null] |
| **versionId** | **Integer**| Version ID of the asset. | [default to null] |
| **fileType** | **String**| Type of file. | [default to null] [enum: delta, file, signature] |
### Return type
[**FileVersionUploadStatus**](../Models/FileVersionUploadStatus.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFiles"></a>
# **getFiles**
> List getFiles(tag, userId, n, offset)
List Files
Returns a list of files
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **tag** | **String**| Tag, for example \&quot;icon\&quot; or \&quot;gallery\&quot;, not included by default. | [optional] [default to null] |
| **userId** | **String**| UserID, will always generate a 500 permission error. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**List**](../Models/File.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="setGroupGalleryFileOrder"></a>
# **setGroupGalleryFileOrder**
> GroupGalleryFileOrder setGroupGalleryFileOrder(GroupGalleryFileOrderRequest)
Set Group Gallery File Order
Set the order of the files in a group gallery
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **GroupGalleryFileOrderRequest** | [**GroupGalleryFileOrderRequest**](../Models/GroupGalleryFileOrderRequest.md)| | [optional] |
### Return type
[**GroupGalleryFileOrder**](../Models/GroupGalleryFileOrder.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="startFileDataUpload"></a>
# **startFileDataUpload**
> FileUploadURL startFileDataUpload(fileId, versionId, fileType, partNumber)
Start FileData Upload
Starts an upload of a specific FilePart. This endpoint will return an AWS URL which you can PUT data to. You need to call this and receive a new AWS API URL for each &#x60;partNumber&#x60;. Please see AWS&#39;s REST documentation on \&quot;PUT Object to S3\&quot; on how to upload. Once all parts has been uploaded, proceed to &#x60;/finish&#x60; endpoint. **Note:** &#x60;nextPartNumber&#x60; seems like it is always ignored. Despite it returning 0, first partNumber is always 1.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **fileId** | **String**| Must be a valid file ID. | [default to null] |
| **versionId** | **Integer**| Version ID of the asset. | [default to null] |
| **fileType** | **String**| Type of file. | [default to null] [enum: delta, file, signature] |
| **partNumber** | **Integer**| The part number to start uploading. If not provided, the first part will be started. | [optional] [default to null] |
### Return type
[**FileUploadURL**](../Models/FileUploadURL.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="submitContentAgreement"></a>
# **submitContentAgreement**
> Agreement submitContentAgreement(AgreementRequest)
Submit Content Agreement
Returns the agreement of the currently authenticated user for the given agreementCode, contentId, and version.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **AgreementRequest** | [**AgreementRequest**](../Models/AgreementRequest.md)| | [optional] |
### Return type
[**Agreement**](../Models/Agreement.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="updateAssetReviewNotes"></a>
# **updateAssetReviewNotes**
> updateAssetReviewNotes(assetReviewId, UpdateAssetReviewNotesRequest)
Update Asset Review Notes
Update notes regarding an asset review.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **assetReviewId** | **String**| Must be an valid asset review ID. | [default to null] |
| **UpdateAssetReviewNotesRequest** | [**UpdateAssetReviewNotesRequest**](../Models/UpdateAssetReviewNotesRequest.md)| | [optional] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="uploadGalleryImage"></a>
# **uploadGalleryImage**
> File uploadGalleryImage(file)
Upload gallery image
Upload a gallery image
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **file** | **File**| The binary blob of the png file. | [default to null] |
### Return type
[**File**](../Models/File.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
<a name="uploadIcon"></a>
# **uploadIcon**
> File uploadIcon(file)
Upload icon
Upload an icon
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **file** | **File**| The binary blob of the png file. | [default to null] |
### Return type
[**File**](../Models/File.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
<a name="uploadImage"></a>
# **uploadImage**
> File uploadImage(file, tag, animationStyle, frames, framesOverTime, loopStyle, maskTag)
Upload gallery image, icon, emoji or sticker
Upload an image, which can be an icon, gallery image, sticker or emoji
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **file** | **File**| The binary blob of the png file. | [default to null] |
| **tag** | **String**| Indication of the purpose for uploading images. | [default to gallery] [enum: admin, avatargallery, avatarimage, bundle, emoji, emojianimated, gallery, icon, listinggallery, product, sticker] |
| **animationStyle** | **String**| Animation style for images. | [optional] [default to null] [enum: aura, bats, bees, bounce, cloud, confetti, crying, dislike, fire, idea, lasers, like, magnet, mistletoe, money, noise, orbit, pizza, rain, rotate, shake, snow, snowball, spin, splash, stop, zzz] |
| **frames** | **Integer**| Required for animated images. Total number of frames of the spritesheet to be animated. | [optional] [default to null] |
| **framesOverTime** | **Integer**| Required for animated images. Animation frames per second. | [optional] [default to null] |
| **loopStyle** | **String**| Animation looping style for images. | [optional] [default to linear] [enum: linear, pingpong] |
| **maskTag** | **String**| Mask shape for images. | [optional] [default to square] [enum: circle, flower, heart, pow, square, star] |
### Return type
[**File**](../Models/File.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json

179
Apis/FriendsApi.md Normal file
View File

@@ -0,0 +1,179 @@
# FriendsApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**boop**](FriendsApi.md#boop) | **POST** /users/{userId}/boop | Send Boop |
| [**deleteFriendRequest**](FriendsApi.md#deleteFriendRequest) | **DELETE** /user/{userId}/friendRequest | Delete Friend Request |
| [**friend**](FriendsApi.md#friend) | **POST** /user/{userId}/friendRequest | Send Friend Request |
| [**getFriendStatus**](FriendsApi.md#getFriendStatus) | **GET** /user/{userId}/friendStatus | Check Friend Status |
| [**getFriends**](FriendsApi.md#getFriends) | **GET** /auth/user/friends | List Friends |
| [**unfriend**](FriendsApi.md#unfriend) | **DELETE** /auth/user/friends/{userId} | Unfriend |
<a name="boop"></a>
# **boop**
> Success boop(userId, BoopRequest)
Send Boop
Send a boop to another user.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **BoopRequest** | [**BoopRequest**](../Models/BoopRequest.md)| | |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="deleteFriendRequest"></a>
# **deleteFriendRequest**
> Success deleteFriendRequest(userId)
Delete Friend Request
Deletes an outgoing pending friend request to another user. To delete an incoming friend request, use the &#x60;deleteNotification&#x60; endpoint instead.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="friend"></a>
# **friend**
> Notification friend(userId)
Send Friend Request
Send a friend request to another user.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**Notification**](../Models/Notification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFriendStatus"></a>
# **getFriendStatus**
> FriendStatus getFriendStatus(userId)
Check Friend Status
Retrieve if the user is currently a friend with a given user, if they have an outgoing friend request, and if they have an incoming friend request. The proper way to receive and accept friend request is by checking if the user has an incoming &#x60;Notification&#x60; of type &#x60;friendRequest&#x60;, and then accepting that notification.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**FriendStatus**](../Models/FriendStatus.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFriends"></a>
# **getFriends**
> List getFriends(offset, n, offline)
List Friends
List information about friends.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offline** | **Boolean**| Returns *only* offline users if true, returns only online and active users if false | [optional] [default to null] |
### Return type
[**List**](../Models/LimitedUserFriend.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="unfriend"></a>
# **unfriend**
> Success unfriend(userId)
Unfriend
Unfriend a user by ID.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json

1503
Apis/GroupsApi.md Normal file

File diff suppressed because it is too large Load Diff

182
Apis/InstancesApi.md Normal file
View File

@@ -0,0 +1,182 @@
# InstancesApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**closeInstance**](InstancesApi.md#closeInstance) | **DELETE** /instances/{worldId}:{instanceId} | Close Instance |
| [**createInstance**](InstancesApi.md#createInstance) | **POST** /instances | Create Instance |
| [**getInstance**](InstancesApi.md#getInstance) | **GET** /instances/{worldId}:{instanceId} | Get Instance |
| [**getInstanceByShortName**](InstancesApi.md#getInstanceByShortName) | **GET** /instances/s/{shortName} | Get Instance By Short Name |
| [**getRecentLocations**](InstancesApi.md#getRecentLocations) | **GET** /instances/recent | List Recent Locations |
| [**getShortName**](InstancesApi.md#getShortName) | **GET** /instances/{worldId}:{instanceId}/shortName | Get Instance Short Name |
<a name="closeInstance"></a>
# **closeInstance**
> Instance closeInstance(worldId, instanceId, hardClose, closedAt)
Close Instance
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 &#x60;group-instance-manage&#x60; permission.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
| **instanceId** | **String**| Must be a valid instance ID. | [default to null] |
| **hardClose** | **Boolean**| Whether to hard close the instance. Defaults to false. | [optional] [default to null] |
| **closedAt** | **Date**| The time after which users won&#39;t be allowed to join the instances. If omitted, the instance will be closed immediately. | [optional] [default to null] |
### Return type
[**Instance**](../Models/Instance.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="createInstance"></a>
# **createInstance**
> Instance createInstance(CreateInstanceRequest)
Create Instance
Create an instance
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **CreateInstanceRequest** | [**CreateInstanceRequest**](../Models/CreateInstanceRequest.md)| | |
### Return type
[**Instance**](../Models/Instance.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="getInstance"></a>
# **getInstance**
> Instance getInstance(worldId, instanceId)
Get Instance
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 \&quot;null\&quot;!
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
| **instanceId** | **String**| Must be a valid instance ID. | [default to null] |
### Return type
[**Instance**](../Models/Instance.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getInstanceByShortName"></a>
# **getInstanceByShortName**
> Instance getInstanceByShortName(shortName)
Get Instance By Short Name
Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **shortName** | **String**| Must be a valid instance short name. | [default to null] |
### Return type
[**Instance**](../Models/Instance.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getRecentLocations"></a>
# **getRecentLocations**
> List getRecentLocations(n, offset)
List Recent Locations
Returns a list of recently visited locations.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
**List**
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getShortName"></a>
# **getShortName**
> InstanceShortNameResponse getShortName(worldId, instanceId)
Get Instance Short Name
Returns an instance short name.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
| **instanceId** | **String**| Must be a valid instance ID. | [default to null] |
### Return type
[**InstanceShortNameResponse**](../Models/InstanceShortNameResponse.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json

413
Apis/InventoryApi.md Normal file
View File

@@ -0,0 +1,413 @@
# InventoryApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**consumeOwnInventoryItem**](InventoryApi.md#consumeOwnInventoryItem) | **PUT** /inventory/{inventoryItemId}/consume | Consume Own Inventory Item |
| [**deleteOwnInventoryItem**](InventoryApi.md#deleteOwnInventoryItem) | **DELETE** /inventory/{inventoryItemId} | Delete Own Inventory Item |
| [**equipOwnInventoryItem**](InventoryApi.md#equipOwnInventoryItem) | **PUT** /inventory/{inventoryItemId}/equip | Equip Own Inventory Item |
| [**getInventory**](InventoryApi.md#getInventory) | **GET** /inventory | Get Inventory |
| [**getInventoryCollections**](InventoryApi.md#getInventoryCollections) | **GET** /inventory/collections | List Inventory Collections |
| [**getInventoryDrops**](InventoryApi.md#getInventoryDrops) | **GET** /inventory/drops | List Inventory Drops |
| [**getInventoryTemplate**](InventoryApi.md#getInventoryTemplate) | **GET** /inventory/template/{inventoryTemplateId} | Get Inventory Template |
| [**getOwnInventoryItem**](InventoryApi.md#getOwnInventoryItem) | **GET** /inventory/{inventoryItemId} | Get Own Inventory Item |
| [**getUserInventoryItem**](InventoryApi.md#getUserInventoryItem) | **GET** /user/{userId}/inventory/{inventoryItemId} | Get User Inventory Item |
| [**shareInventoryItemDirect**](InventoryApi.md#shareInventoryItemDirect) | **POST** /inventory/cloning/direct | Share Inventory Item Direct |
| [**shareInventoryItemPedestal**](InventoryApi.md#shareInventoryItemPedestal) | **GET** /inventory/cloning/pedestal | Share Inventory Item by Pedestal |
| [**spawnInventoryItem**](InventoryApi.md#spawnInventoryItem) | **GET** /inventory/spawn | Spawn Inventory Item |
| [**unequipOwnInventorySlot**](InventoryApi.md#unequipOwnInventorySlot) | **DELETE** /inventory/{inventoryItemId}/equip | Unequip Own Inventory Slot |
| [**updateOwnInventoryItem**](InventoryApi.md#updateOwnInventoryItem) | **PUT** /inventory/{inventoryItemId} | Update Own Inventory Item |
<a name="consumeOwnInventoryItem"></a>
# **consumeOwnInventoryItem**
> InventoryConsumptionResults consumeOwnInventoryItem(inventoryItemId)
Consume Own Inventory Item
Returns the modified InventoryItem object as held by the currently logged in user.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **inventoryItemId** | **String**| Must be a valid inventory item ID. | [default to null] |
### Return type
[**InventoryConsumptionResults**](../Models/InventoryConsumptionResults.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteOwnInventoryItem"></a>
# **deleteOwnInventoryItem**
> SuccessFlag deleteOwnInventoryItem(inventoryItemId)
Delete Own Inventory Item
Deletes an InventoryItem from the inventory of the currently logged in user.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **inventoryItemId** | **String**| Must be a valid inventory item ID. | [default to null] |
### Return type
[**SuccessFlag**](../Models/SuccessFlag.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="equipOwnInventoryItem"></a>
# **equipOwnInventoryItem**
> InventoryItem equipOwnInventoryItem(inventoryItemId, EquipInventoryItemRequest)
Equip Own Inventory Item
Returns the modified InventoryItem object as held by the currently logged in user.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **inventoryItemId** | **String**| Must be a valid inventory item ID. | [default to null] |
| **EquipInventoryItemRequest** | [**EquipInventoryItemRequest**](../Models/EquipInventoryItemRequest.md)| | [optional] |
### Return type
[**InventoryItem**](../Models/InventoryItem.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="getInventory"></a>
# **getInventory**
> Inventory getInventory(n, offset, holderId, equipSlot, order, tags, types, flags, notTypes, notFlags, archived)
Get Inventory
Returns an Inventory object.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **holderId** | **String**| The UserID of the owner of the inventory; defaults to the currently authenticated user. | [optional] [default to null] |
| **equipSlot** | **String**| Filter for inventory retrieval. | [optional] [default to ] [enum: , drone, portal, warp] |
| **order** | **String**| Sort order for inventory retrieval. | [optional] [default to null] [enum: newest, newest_created, oldest, oldest_created] |
| **tags** | **String**| Filter tags for inventory retrieval (comma-separated). | [optional] [default to null] |
| **types** | **String**| Filter for inventory retrieval. | [optional] [default to bundle] [enum: bundle, droneskin, emoji, portalskin, prop, sticker, warpeffect] |
| **flags** | **String**| Filter flags for inventory retrieval (comma-separated). | [optional] [default to instantiatable] [enum: archivable, cloneable, consumable, equippable, instantiatable, trashable, ugc, unique] |
| **notTypes** | **String**| Filter out types for inventory retrieval (comma-separated). | [optional] [default to bundle] [enum: bundle, droneskin, emoji, portalskin, prop, sticker, warpeffect] |
| **notFlags** | **String**| Filter out flags for inventory retrieval (comma-separated). | [optional] [default to instantiatable] [enum: archivable, cloneable, consumable, equippable, instantiatable, trashable, ugc, unique] |
| **archived** | **Boolean**| Filter archived status for inventory retrieval. | [optional] [default to null] |
### Return type
[**Inventory**](../Models/Inventory.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getInventoryCollections"></a>
# **getInventoryCollections**
> List getInventoryCollections()
List Inventory Collections
Returns a list of collection names.
### Parameters
This endpoint does not need any parameter.
### Return type
**List**
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getInventoryDrops"></a>
# **getInventoryDrops**
> List getInventoryDrops(active)
List Inventory Drops
Returns a list of InventoryDrop objects.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **active** | **Boolean**| Filter for users&#39; listings and inventory bundles. | [optional] [default to null] |
### Return type
[**List**](../Models/InventoryDrop.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getInventoryTemplate"></a>
# **getInventoryTemplate**
> InventoryTemplate getInventoryTemplate(inventoryTemplateId)
Get Inventory Template
Returns an InventoryTemplate object.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **inventoryTemplateId** | **String**| Must be a valid inventory template ID. | [default to null] |
### Return type
[**InventoryTemplate**](../Models/InventoryTemplate.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getOwnInventoryItem"></a>
# **getOwnInventoryItem**
> InventoryItem getOwnInventoryItem(inventoryItemId)
Get Own Inventory Item
Returns an InventoryItem object held by the currently logged in user.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **inventoryItemId** | **String**| Must be a valid inventory item ID. | [default to null] |
### Return type
[**InventoryItem**](../Models/InventoryItem.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserInventoryItem"></a>
# **getUserInventoryItem**
> InventoryItem getUserInventoryItem(userId, inventoryItemId)
Get User Inventory Item
Returns an InventoryItem object held by the given user.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **inventoryItemId** | **String**| Must be a valid inventory item ID. | [default to null] |
### Return type
[**InventoryItem**](../Models/InventoryItem.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="shareInventoryItemDirect"></a>
# **shareInventoryItemDirect**
> OkStatus shareInventoryItemDirect(itemId, duration, ShareInventoryItemDirectRequest)
Share Inventory Item Direct
Share content directly with other users.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **itemId** | **String**| Id for inventory item sharing. | [default to null] |
| **duration** | **Integer**| The duration before the sharing pedestal despawns. | [default to 90] |
| **ShareInventoryItemDirectRequest** | [**ShareInventoryItemDirectRequest**](../Models/ShareInventoryItemDirectRequest.md)| | |
### Return type
[**OkStatus**](../Models/OkStatus.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="shareInventoryItemPedestal"></a>
# **shareInventoryItemPedestal**
> InventorySpawn shareInventoryItemPedestal(itemId, duration)
Share Inventory Item by Pedestal
Returns an InventorySpawn object.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **itemId** | **String**| Id for inventory item sharing. | [default to null] |
| **duration** | **Integer**| The duration before the sharing pedestal despawns. | [default to 90] |
### Return type
[**InventorySpawn**](../Models/InventorySpawn.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="spawnInventoryItem"></a>
# **spawnInventoryItem**
> InventorySpawn spawnInventoryItem(id)
Spawn Inventory Item
Returns an InventorySpawn object.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **id** | **String**| Id for inventory item spawning. | [default to null] |
### Return type
[**InventorySpawn**](../Models/InventorySpawn.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="unequipOwnInventorySlot"></a>
# **unequipOwnInventorySlot**
> String unequipOwnInventorySlot(inventoryItemId)
Unequip Own Inventory Slot
Unequips the InventoryItem in the given slot of the inventory of the currently logged in user.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **inventoryItemId** | **String**| Selector for inventory slot management. | [default to ] [enum: , drone, portal, warp] |
### Return type
**String**
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="updateOwnInventoryItem"></a>
# **updateOwnInventoryItem**
> InventoryItem updateOwnInventoryItem(inventoryItemId, UpdateInventoryItemRequest)
Update Own Inventory Item
Returns the modified InventoryItem object as held by the currently logged in user.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **inventoryItemId** | **String**| Must be a valid inventory item ID. | [default to null] |
| **UpdateInventoryItemRequest** | [**UpdateInventoryItemRequest**](../Models/UpdateInventoryItemRequest.md)| | [optional] |
### Return type
[**InventoryItem**](../Models/InventoryItem.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json

334
Apis/InviteApi.md Normal file
View File

@@ -0,0 +1,334 @@
# InviteApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**getInviteMessage**](InviteApi.md#getInviteMessage) | **GET** /message/{userId}/{messageType}/{slot} | Get Invite Message |
| [**getInviteMessages**](InviteApi.md#getInviteMessages) | **GET** /message/{userId}/{messageType} | List Invite Messages |
| [**inviteMyselfTo**](InviteApi.md#inviteMyselfTo) | **POST** /invite/myself/to/{worldId}:{instanceId} | Invite Myself To Instance |
| [**inviteUser**](InviteApi.md#inviteUser) | **POST** /invite/{userId} | Invite User |
| [**inviteUserWithPhoto**](InviteApi.md#inviteUserWithPhoto) | **POST** /invite/{userId}/photo | Invite User with photo |
| [**requestInvite**](InviteApi.md#requestInvite) | **POST** /requestInvite/{userId} | Request Invite |
| [**requestInviteWithPhoto**](InviteApi.md#requestInviteWithPhoto) | **POST** /requestInvite/{userId}/photo | Request Invite with photo |
| [**resetInviteMessage**](InviteApi.md#resetInviteMessage) | **DELETE** /message/{userId}/{messageType}/{slot} | Reset Invite Message |
| [**respondInvite**](InviteApi.md#respondInvite) | **POST** /invite/{notificationId}/response | Respond Invite |
| [**respondInviteWithPhoto**](InviteApi.md#respondInviteWithPhoto) | **POST** /invite/{notificationId}/response/photo | Respond Invite with photo |
| [**updateInviteMessage**](InviteApi.md#updateInviteMessage) | **PUT** /message/{userId}/{messageType}/{slot} | Update Invite Message |
<a name="getInviteMessage"></a>
# **getInviteMessage**
> InviteMessage getInviteMessage(userId, messageType, slot)
Get Invite Message
Returns a single Invite Message. This returns the exact same information but less than &#x60;getInviteMessages&#x60;. Admin Credentials are required to view messages of other users! Message type refers to a different collection of messages, used during different types of responses. * &#x60;message&#x60; &#x3D; Message during a normal invite * &#x60;response&#x60; &#x3D; Message when replying to a message * &#x60;request&#x60; &#x3D; Message when requesting an invite * &#x60;requestResponse&#x60; &#x3D; Message when replying to a request for invite
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **messageType** | **String**| The type of message to fetch, must be a valid InviteMessageType. | [default to message] [enum: message, request, requestResponse, response] |
| **slot** | **Integer**| The message slot to fetch of a given message type. | [default to null] |
### Return type
[**InviteMessage**](../Models/InviteMessage.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getInviteMessages"></a>
# **getInviteMessages**
> List getInviteMessages(userId, messageType)
List Invite Messages
Returns a list of all the users Invite Messages. Admin Credentials are required to view messages of other users! Message type refers to a different collection of messages, used during different types of responses. * &#x60;message&#x60; &#x3D; Message during a normal invite * &#x60;response&#x60; &#x3D; Message when replying to a message * &#x60;request&#x60; &#x3D; Message when requesting an invite * &#x60;requestResponse&#x60; &#x3D; Message when replying to a request for invite
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **messageType** | **String**| The type of message to fetch, must be a valid InviteMessageType. | [default to message] [enum: message, request, requestResponse, response] |
### Return type
[**List**](../Models/InviteMessage.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="inviteMyselfTo"></a>
# **inviteMyselfTo**
> SentNotification inviteMyselfTo(worldId, instanceId)
Invite Myself To Instance
Sends self an invite to an instance
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
| **instanceId** | **String**| Must be a valid instance ID. | [default to null] |
### Return type
[**SentNotification**](../Models/SentNotification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="inviteUser"></a>
# **inviteUser**
> SentNotification inviteUser(userId, InviteRequest)
Invite User
Sends an invite to a user. Returns the Notification of type &#x60;invite&#x60; that was sent.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **InviteRequest** | [**InviteRequest**](../Models/InviteRequest.md)| Slot number of the Invite Message to use when inviting a user. | |
### Return type
[**SentNotification**](../Models/SentNotification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="inviteUserWithPhoto"></a>
# **inviteUserWithPhoto**
> SentNotification inviteUserWithPhoto(userId, data, image)
Invite User with photo
Sends an photo invite to a user. Returns the Notification of type &#x60;invite&#x60; that was sent.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **data** | [**InviteRequest**](../Models/InviteRequest.md)| | [default to null] |
| **image** | **File**| The binary blob of the png file. | [default to null] |
### Return type
[**SentNotification**](../Models/SentNotification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
<a name="requestInvite"></a>
# **requestInvite**
> Notification requestInvite(userId, RequestInviteRequest)
Request Invite
Requests an invite from a user. Returns the Notification of type &#x60;requestInvite&#x60; that was sent.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **RequestInviteRequest** | [**RequestInviteRequest**](../Models/RequestInviteRequest.md)| Slot number of the Request Message to use when request an invite. | [optional] |
### Return type
[**Notification**](../Models/Notification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="requestInviteWithPhoto"></a>
# **requestInviteWithPhoto**
> Notification requestInviteWithPhoto(userId, data, image)
Request Invite with photo
Requests with photo an invite from a user. Returns the Notification of type &#x60;requestInvite&#x60; that was sent.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **data** | [**RequestInviteRequest**](../Models/RequestInviteRequest.md)| | [default to null] |
| **image** | **File**| The binary blob of the png file. | [default to null] |
### Return type
[**Notification**](../Models/Notification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
<a name="resetInviteMessage"></a>
# **resetInviteMessage**
> List resetInviteMessage(userId, messageType, slot)
Reset Invite Message
Resets a single Invite Message back to its original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users! Resetting a message respects the rate-limit, so it is not possible to reset within the 60 minutes countdown. Resetting it does however not set the rate-limit to 60 like when editing it. It is possible to edit it right after resetting it. Trying to edit a message before the cooldown timer expires results in a 429 \&quot;Too Fast Error\&quot;. Message type refers to a different collection of messages, used during different types of responses. * &#x60;message&#x60; &#x3D; Message during a normal invite * &#x60;response&#x60; &#x3D; Message when replying to a message * &#x60;request&#x60; &#x3D; Message when requesting an invite * &#x60;requestResponse&#x60; &#x3D; Message when replying to a request for invite The DELETE endpoint does not have/require any request body.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **messageType** | **String**| The type of message to fetch, must be a valid InviteMessageType. | [default to message] [enum: message, request, requestResponse, response] |
| **slot** | **Integer**| The message slot to fetch of a given message type. | [default to null] |
### Return type
[**List**](../Models/InviteMessage.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="respondInvite"></a>
# **respondInvite**
> Notification respondInvite(notificationId, InviteResponse)
Respond Invite
Respond to an invite or invite request without accepting it. &#x60;:notificationId&#x60; is the ID of the requesting notification. In case the notification being replied to is an invite, the &#x60;responseSlot&#x60; refers to a response message from the the &#x60;message&#x60; collection. In case the notification is an invite request, it will refer to one from the &#x60;requestResponse&#x60; collection instead.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
| **InviteResponse** | [**InviteResponse**](../Models/InviteResponse.md)| Slot number of the Response Message to use when responding to a user. | |
### Return type
[**Notification**](../Models/Notification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="respondInviteWithPhoto"></a>
# **respondInviteWithPhoto**
> Notification respondInviteWithPhoto(notificationId, data, image)
Respond Invite with photo
Respond with photo to an invite or invite request without accepting it. &#x60;:notificationId&#x60; is the ID of the requesting notification. In case the notification being replied to is an invite, the &#x60;responseSlot&#x60; refers to a response message from the the &#x60;message&#x60; collection. In case the notification is an invite request, it will refer to one from the &#x60;requestResponse&#x60; collection instead.&#39;
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
| **data** | [**InviteResponse**](../Models/InviteResponse.md)| | [default to null] |
| **image** | **File**| The binary blob of the png file. | [default to null] |
### Return type
[**Notification**](../Models/Notification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
<a name="updateInviteMessage"></a>
# **updateInviteMessage**
> List updateInviteMessage(userId, messageType, slot, UpdateInviteMessageRequest)
Update Invite Message
Updates a single Invite Message and then returns a list of all of them. Admin Credentials are required to update messages of other users! Updating a message automatically sets the cooldown timer to 60 minutes. Trying to edit a message before the cooldown timer expires results in a 429 \&quot;Too Fast Error\&quot;. Message type refers to a different collection of messages, used during different types of responses. * &#x60;message&#x60; &#x3D; Message during a normal invite * &#x60;response&#x60; &#x3D; Message when replying to a message * &#x60;request&#x60; &#x3D; Message when requesting an invite * &#x60;requestResponse&#x60; &#x3D; Message when replying to a request for invite
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **messageType** | **String**| The type of message to fetch, must be a valid InviteMessageType. | [default to message] [enum: message, request, requestResponse, response] |
| **slot** | **Integer**| The message slot to fetch of a given message type. | [default to null] |
| **UpdateInviteMessageRequest** | [**UpdateInviteMessageRequest**](../Models/UpdateInviteMessageRequest.md)| Message of what to set the invite message to. | [optional] |
### Return type
[**List**](../Models/InviteMessage.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json

92
Apis/JamsApi.md Normal file
View File

@@ -0,0 +1,92 @@
# JamsApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**getJam**](JamsApi.md#getJam) | **GET** /jams/{jamId} | Show jam information |
| [**getJamSubmissions**](JamsApi.md#getJamSubmissions) | **GET** /jams/{jamId}/submissions | Show jam submissions |
| [**getJams**](JamsApi.md#getJams) | **GET** /jams | Show jams list |
<a name="getJam"></a>
# **getJam**
> Jam getJam(jamId)
Show jam information
Returns a jam.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **jamId** | **String**| Must be a valid query ID. | [default to null] |
### Return type
[**Jam**](../Models/Jam.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getJamSubmissions"></a>
# **getJamSubmissions**
> List getJamSubmissions(jamId)
Show jam submissions
Returns all submissions of a jam.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **jamId** | **String**| Must be a valid query ID. | [default to null] |
### Return type
[**List**](../Models/Submission.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getJams"></a>
# **getJams**
> List getJams(type)
Show jams list
Lists World Jams or Avatar Jams, both currently running and ones that have ended. &#x60;isActive&#x60; is used to select only active or already ended jams. &#x60;type&#x60; is used to select only world or avatar jams, and can only take &#x60;world&#x60; or &#x60;avatar&#x60;. &#x60;&#x60;
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **type** | **String**| Only show jams of this type (&#x60;avatar&#x60; or &#x60;world&#x60;). | [optional] [default to null] |
### Return type
[**List**](../Models/Jam.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json

248
Apis/MiscellaneousApi.md Normal file
View File

@@ -0,0 +1,248 @@
# MiscellaneousApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**getAssignedPermissions**](MiscellaneousApi.md#getAssignedPermissions) | **GET** /auth/permissions | Get Assigned Permissions |
| [**getCSS**](MiscellaneousApi.md#getCSS) | **GET** /css/app.css | Download CSS |
| [**getConfig**](MiscellaneousApi.md#getConfig) | **GET** /config | Fetch API Config |
| [**getCurrentOnlineUsers**](MiscellaneousApi.md#getCurrentOnlineUsers) | **GET** /visits | Current Online Users |
| [**getHealth**](MiscellaneousApi.md#getHealth) | **GET** /health | Check API Health |
| [**getInfoPush**](MiscellaneousApi.md#getInfoPush) | **GET** /infoPush | Show Information Notices |
| [**getJavaScript**](MiscellaneousApi.md#getJavaScript) | **GET** /js/app.js | Download JavaScript |
| [**getPermission**](MiscellaneousApi.md#getPermission) | **GET** /permissions/{permissionId} | Get Permission |
| [**getSystemTime**](MiscellaneousApi.md#getSystemTime) | **GET** /time | Current System Time |
<a name="getAssignedPermissions"></a>
# **getAssignedPermissions**
> List getAssignedPermissions()
Get Assigned Permissions
Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
### Parameters
This endpoint does not need any parameter.
### Return type
[**List**](../Models/Permission.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getCSS"></a>
# **getCSS**
> String getCSS(variant, branch)
Download CSS
Fetches the CSS code to the frontend React website.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **variant** | **String**| Specifies which &#x60;variant&#x60; of the site. Public is the end-user site, while &#x60;internal&#x60; is the staff-only site with special pages for moderation and management. | [optional] [default to public] [enum: internal, public] |
| **branch** | **String**| Specifies which git branch the site should load frontend source code from. | [optional] [default to main] |
### Return type
**String**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/css, application/json
<a name="getConfig"></a>
# **getConfig**
> APIConfig getConfig()
Fetch API Config
API config contains configuration that the clients needs to work properly. Currently the most important value here is &#x60;clientApiKey&#x60; which is used for all other API endpoints.
### Parameters
This endpoint does not need any parameter.
### Return type
[**APIConfig**](../Models/APIConfig.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getCurrentOnlineUsers"></a>
# **getCurrentOnlineUsers**
> Integer getCurrentOnlineUsers()
Current Online Users
Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
### Parameters
This endpoint does not need any parameter.
### Return type
**Integer**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getHealth"></a>
# **getHealth**
> APIHealth getHealth()
Check API Health
~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
### Parameters
This endpoint does not need any parameter.
### Return type
[**APIHealth**](../Models/APIHealth.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getInfoPush"></a>
# **getInfoPush**
> List getInfoPush(require, include)
Show Information Notices
IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. &#x60;include&#x60; is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an \&quot;any of\&quot; search. &#x60;require&#x60; is used to limit what Information Pushes should be included in the response. This is usually used in combination with &#x60;include&#x60;, and is an \&quot;all of\&quot; search.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **require** | **String**| Tags to include (comma-separated). All of the tags needs to be present. | [optional] [default to null] |
| **include** | **String**| Tags to include (comma-separated). Any of the tags needs to be present. | [optional] [default to null] |
### Return type
[**List**](../Models/InfoPush.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getJavaScript"></a>
# **getJavaScript**
> String getJavaScript(variant, branch)
Download JavaScript
Fetches the JavaScript code to the frontend React website.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **variant** | **String**| Specifies which &#x60;variant&#x60; of the site. Public is the end-user site, while &#x60;internal&#x60; is the staff-only site with special pages for moderation and management. | [optional] [default to public] [enum: internal, public] |
| **branch** | **String**| Specifies which git branch the site should load frontend source code from. | [optional] [default to main] |
### Return type
**String**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/javascript, application/json
<a name="getPermission"></a>
# **getPermission**
> Permission getPermission(permissionId)
Get Permission
Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as &#x60;/auth/permissions&#x60;.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **permissionId** | **String**| Must be a valid permission ID. | [default to null] |
### Return type
[**Permission**](../Models/Permission.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getSystemTime"></a>
# **getSystemTime**
> Date getSystemTime()
Current System Time
Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
### Parameters
This endpoint does not need any parameter.
### Return type
**Date**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json

373
Apis/NotificationsApi.md Normal file
View File

@@ -0,0 +1,373 @@
# NotificationsApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**acceptFriendRequest**](NotificationsApi.md#acceptFriendRequest) | **PUT** /auth/user/notifications/{notificationId}/accept | Accept Friend Request |
| [**acknowledgeNotificationV2**](NotificationsApi.md#acknowledgeNotificationV2) | **POST** /notifications/{notificationId}/see | Acknowledge NotificationV2 |
| [**clearNotifications**](NotificationsApi.md#clearNotifications) | **PUT** /auth/user/notifications/clear | Clear All Notifications |
| [**deleteAllNotificationV2s**](NotificationsApi.md#deleteAllNotificationV2s) | **DELETE** /notifications | Delete All NotificationV2s |
| [**deleteNotification**](NotificationsApi.md#deleteNotification) | **PUT** /auth/user/notifications/{notificationId}/hide | Delete Notification |
| [**deleteNotificationV2**](NotificationsApi.md#deleteNotificationV2) | **DELETE** /notifications/{notificationId} | Delete NotificationV2 |
| [**getNotification**](NotificationsApi.md#getNotification) | **GET** /auth/user/notifications/{notificationId} | Show notification |
| [**getNotificationV2**](NotificationsApi.md#getNotificationV2) | **GET** /notifications/{notificationId} | Get NotificationV2 |
| [**getNotificationV2s**](NotificationsApi.md#getNotificationV2s) | **GET** /notifications | List NotificationV2s |
| [**getNotifications**](NotificationsApi.md#getNotifications) | **GET** /auth/user/notifications | List Notifications |
| [**markNotificationAsRead**](NotificationsApi.md#markNotificationAsRead) | **PUT** /auth/user/notifications/{notificationId}/see | Mark Notification As Read |
| [**replyNotificationV2**](NotificationsApi.md#replyNotificationV2) | **POST** /notifications/{notificationId}/reply | Reply NotificationV2 |
| [**respondNotificationV2**](NotificationsApi.md#respondNotificationV2) | **POST** /notifications/{notificationId}/respond | Respond NotificationV2 |
<a name="acceptFriendRequest"></a>
# **acceptFriendRequest**
> Success acceptFriendRequest(notificationId)
Accept Friend Request
Accept a friend request by notification &#x60;frq_&#x60; ID. Friend requests can be found using the NotificationsAPI &#x60;getNotifications&#x60; by filtering of type &#x60;friendRequest&#x60;.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="acknowledgeNotificationV2"></a>
# **acknowledgeNotificationV2**
> NotificationV2 acknowledgeNotificationV2(notificationId)
Acknowledge NotificationV2
Acknowledge a specific notification
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
### Return type
[**NotificationV2**](../Models/NotificationV2.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="clearNotifications"></a>
# **clearNotifications**
> Success clearNotifications()
Clear All Notifications
Clear **all** notifications.
### Parameters
This endpoint does not need any parameter.
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteAllNotificationV2s"></a>
# **deleteAllNotificationV2s**
> Success deleteAllNotificationV2s()
Delete All NotificationV2s
Delete all of the current user&#39;s notifications.
### Parameters
This endpoint does not need any parameter.
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteNotification"></a>
# **deleteNotification**
> Notification deleteNotification(notificationId)
Delete Notification
Delete a notification.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
### Return type
[**Notification**](../Models/Notification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteNotificationV2"></a>
# **deleteNotificationV2**
> Success deleteNotificationV2(notificationId)
Delete NotificationV2
Delete a specific notification
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getNotification"></a>
# **getNotification**
> Notification getNotification(notificationId)
Show notification
Get a notification by notification &#x60;not_&#x60; ID.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
### Return type
[**Notification**](../Models/Notification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getNotificationV2"></a>
# **getNotificationV2**
> NotificationV2 getNotificationV2(notificationId)
Get NotificationV2
Get a specific notification. Appears to require admin credentials by default. Expect a 403 Forbidden error response for normal users.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
### Return type
[**NotificationV2**](../Models/NotificationV2.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getNotificationV2s"></a>
# **getNotificationV2s**
> List getNotificationV2s(limit)
List NotificationV2s
Retrieve all of the current user&#39;s notifications.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **limit** | **Integer**| The maximum number of entries to get. | [optional] [default to null] |
### Return type
[**List**](../Models/NotificationV2.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getNotifications"></a>
# **getNotifications**
> List getNotifications(type, sent, hidden, after, n, offset)
List Notifications
Retrieve all of the current user&#39;s notifications.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **type** | **String**| Only send notifications of this type (can use &#x60;all&#x60; for all). This parameter no longer does anything, and is deprecated. | [optional] [default to null] |
| **sent** | **Boolean**| Return notifications sent by the user. Must be false or omitted. | [optional] [default to null] |
| **hidden** | **Boolean**| Whether to return hidden or non-hidden notifications. True only allowed on type &#x60;friendRequest&#x60;. | [optional] [default to null] |
| **after** | **String**| Only return notifications sent after this Date. Ignored if type is &#x60;friendRequest&#x60;. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**List**](../Models/Notification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="markNotificationAsRead"></a>
# **markNotificationAsRead**
> Notification markNotificationAsRead(notificationId)
Mark Notification As Read
Mark a notification as seen.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
### Return type
[**Notification**](../Models/Notification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="replyNotificationV2"></a>
# **replyNotificationV2**
> NotificationV2 replyNotificationV2(notificationId, body)
Reply NotificationV2
Reply to a specific notification
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
| **body** | **Object**| | |
### Return type
[**NotificationV2**](../Models/NotificationV2.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="respondNotificationV2"></a>
# **respondNotificationV2**
> NotificationV2 respondNotificationV2(notificationId, RespondNotificationV2Request)
Respond NotificationV2
Respond to a specific notification
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
| **RespondNotificationV2Request** | [**RespondNotificationV2Request**](../Models/RespondNotificationV2Request.md)| | |
### Return type
[**NotificationV2**](../Models/NotificationV2.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json

119
Apis/PlayermoderationApi.md Normal file
View File

@@ -0,0 +1,119 @@
# PlayermoderationApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**clearAllPlayerModerations**](PlayermoderationApi.md#clearAllPlayerModerations) | **DELETE** /auth/user/playermoderations | Clear All Player Moderations |
| [**getPlayerModerations**](PlayermoderationApi.md#getPlayerModerations) | **GET** /auth/user/playermoderations | Search Player Moderations |
| [**moderateUser**](PlayermoderationApi.md#moderateUser) | **POST** /auth/user/playermoderations | Moderate User |
| [**unmoderateUser**](PlayermoderationApi.md#unmoderateUser) | **PUT** /auth/user/unplayermoderate | Unmoderate User |
<a name="clearAllPlayerModerations"></a>
# **clearAllPlayerModerations**
> Success clearAllPlayerModerations()
Clear All Player Moderations
⚠️ **This will delete every single player moderation you&#39;ve ever made.**
### Parameters
This endpoint does not need any parameter.
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getPlayerModerations"></a>
# **getPlayerModerations**
> List getPlayerModerations(type, sourceUserId, targetUserId)
Search Player Moderations
Returns a list of all player moderations made by **you**. This endpoint does not have pagination, and will return *all* results. Use query parameters to limit your query if needed.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **type** | **String**| Must be one of PlayerModerationType. | [optional] [default to unmute] [enum: block, hideAvatar, interactOff, interactOn, mute, muteChat, showAvatar, unmute, unmuteChat] |
| **sourceUserId** | **String**| Must be valid UserID. Trying to view someone else&#39;s moderations results with \&quot;Can&#39;t view someone else&#39;s player moderations\&quot; error. | [optional] [default to null] |
| **targetUserId** | **String**| Must be valid UserID. | [optional] [default to null] |
### Return type
[**List**](../Models/PlayerModeration.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="moderateUser"></a>
# **moderateUser**
> PlayerModeration moderateUser(ModerateUserRequest)
Moderate User
Moderate a user, e.g. unmute them or show their avatar. Please see the [Player Moderation docs](https://vrchatapi.github.io/docs/api/#tag--playermoderation) on what playerModerations are, and how they differ from staff moderations.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **ModerateUserRequest** | [**ModerateUserRequest**](../Models/ModerateUserRequest.md)| | |
### Return type
[**PlayerModeration**](../Models/PlayerModeration.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="unmoderateUser"></a>
# **unmoderateUser**
> Success unmoderateUser(ModerateUserRequest)
Unmoderate User
Removes a player moderation previously added through &#x60;moderateUser&#x60;. E.g if you previously have shown their avatar, but now want to reset it to default.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **ModerateUserRequest** | [**ModerateUserRequest**](../Models/ModerateUserRequest.md)| | |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json

154
Apis/PrintsApi.md Normal file
View File

@@ -0,0 +1,154 @@
# PrintsApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**deletePrint**](PrintsApi.md#deletePrint) | **DELETE** /prints/{printId} | Delete Print |
| [**editPrint**](PrintsApi.md#editPrint) | **POST** /prints/{printId} | Edit Print |
| [**getPrint**](PrintsApi.md#getPrint) | **GET** /prints/{printId} | Get Print |
| [**getUserPrints**](PrintsApi.md#getUserPrints) | **GET** /prints/user/{userId} | Get Own Prints |
| [**uploadPrint**](PrintsApi.md#uploadPrint) | **POST** /prints | Upload Print |
<a name="deletePrint"></a>
# **deletePrint**
> deletePrint(printId)
Delete Print
Returns a print.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **printId** | **String**| Print ID. | [default to null] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="editPrint"></a>
# **editPrint**
> Print editPrint(printId, image, note)
Edit Print
Edits a print.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **printId** | **String**| Print ID. | [default to null] |
| **image** | **File**| The binary blob of the png file. | [default to null] |
| **note** | **String**| The caption for the image. | [optional] [default to null] |
### Return type
[**Print**](../Models/Print.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
<a name="getPrint"></a>
# **getPrint**
> Print getPrint(printId)
Get Print
Returns a print.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **printId** | **String**| Print ID. | [default to null] |
### Return type
[**Print**](../Models/Print.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserPrints"></a>
# **getUserPrints**
> List getUserPrints(userId)
Get Own Prints
Returns a list of all prints of the user. User id has to be your own userId, as you can&#39;t request other user&#39;s prints.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**List**](../Models/Print.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="uploadPrint"></a>
# **uploadPrint**
> Print uploadPrint(image, timestamp, note, worldId, worldName)
Upload Print
Uploads and creates a print.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **image** | **File**| The binary blob of the png file. | [default to null] |
| **timestamp** | **Date**| The time the image was captured. | [default to null] |
| **note** | **String**| The caption for the image. | [optional] [default to null] |
| **worldId** | **String**| The id of the world in which the image was captured. | [optional] [default to null] |
| **worldName** | **String**| The name of the world in which the image was captured. | [optional] [default to null] |
### Return type
[**Print**](../Models/Print.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json

235
Apis/PropsApi.md Normal file
View File

@@ -0,0 +1,235 @@
# PropsApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**createProp**](PropsApi.md#createProp) | **POST** /props | Create Prop |
| [**deleteProp**](PropsApi.md#deleteProp) | **DELETE** /props/{propId} | Delete Prop |
| [**getProp**](PropsApi.md#getProp) | **GET** /props/{propId} | Get Prop |
| [**getPropPublishStatus**](PropsApi.md#getPropPublishStatus) | **GET** /props/{propId}/publish | Get Prop Publish Status |
| [**listProps**](PropsApi.md#listProps) | **GET** /props | List Props |
| [**publishProp**](PropsApi.md#publishProp) | **PUT** /props/{propId}/publish | Publish Prop |
| [**unpublishProp**](PropsApi.md#unpublishProp) | **DELETE** /props/{propId}/publish | Unpublish Prop |
| [**updateProp**](PropsApi.md#updateProp) | **PUT** /props/{propId} | Update Prop |
<a name="createProp"></a>
# **createProp**
> Prop createProp(CreatePropRequest)
Create Prop
Create a Prop and return the new Prop object.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **CreatePropRequest** | [**CreatePropRequest**](../Models/CreatePropRequest.md)| | |
### Return type
[**Prop**](../Models/Prop.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="deleteProp"></a>
# **deleteProp**
> deleteProp(propId)
Delete Prop
Delete a Prop.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **propId** | **String**| Prop ID. | [default to null] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getProp"></a>
# **getProp**
> Prop getProp(propId)
Get Prop
Returns a Prop object.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **propId** | **String**| Prop ID. | [default to null] |
### Return type
[**Prop**](../Models/Prop.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getPropPublishStatus"></a>
# **getPropPublishStatus**
> PropPublishStatus getPropPublishStatus(propId)
Get Prop Publish Status
Returns a PropPublishStatus object.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **propId** | **String**| Prop ID. | [default to null] |
### Return type
[**PropPublishStatus**](../Models/PropPublishStatus.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="listProps"></a>
# **listProps**
> List listProps(authorId, n, offset)
List Props
Returns a list Prop objects.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **authorId** | **String**| Must be a valid user ID. | [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**List**](../Models/Prop.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="publishProp"></a>
# **publishProp**
> PropPublishStatus publishProp(propId)
Publish Prop
Publish a Prop and return the updated PropPublishStatus object.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **propId** | **String**| Prop ID. | [default to null] |
### Return type
[**PropPublishStatus**](../Models/PropPublishStatus.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="unpublishProp"></a>
# **unpublishProp**
> PropPublishStatus unpublishProp(propId)
Unpublish Prop
Unpublish a Prop and return the updated PropPublishStatus object.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **propId** | **String**| Prop ID. | [default to null] |
### Return type
[**PropPublishStatus**](../Models/PropPublishStatus.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="updateProp"></a>
# **updateProp**
> Prop updateProp(propId, UpdatePropRequest)
Update Prop
Updates a Prop and returns the updated Prop object. When updating the asset bundle, all of &#x60;name&#x60;, &#x60;assetUrl&#x60;, &#x60;platform&#x60;, &#x60;unityVersion&#x60;, &#x60;assetVersion&#x60;, &#x60;spawnType&#x60;, and &#x60;worldPlacementMask&#x60; must be present, as well as &#x60;propSignature&#x60; if this value is not blank.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **propId** | **String**| Prop ID. | [default to null] |
| **UpdatePropRequest** | [**UpdatePropRequest**](../Models/UpdatePropRequest.md)| | |
### Return type
[**Prop**](../Models/Prop.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json

729
Apis/UsersApi.md Normal file
View File

@@ -0,0 +1,729 @@
# UsersApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**addTags**](UsersApi.md#addTags) | **POST** /users/{userId}/addTags | Add User Tags |
| [**checkUserPersistenceExists**](UsersApi.md#checkUserPersistenceExists) | **GET** /users/{userId}/{worldId}/persist/exists | Check User Persistence Exists |
| [**deleteAllUserPersistenceData**](UsersApi.md#deleteAllUserPersistenceData) | **DELETE** /users/{userId}/persist | Delete All User Persistence Data |
| [**deleteUserPersistence**](UsersApi.md#deleteUserPersistence) | **DELETE** /users/{userId}/{worldId}/persist | Delete User Persistence |
| [**getBlockedGroups**](UsersApi.md#getBlockedGroups) | **GET** /users/{userId}/groups/userblocked | Get User Group Blocks |
| [**getInvitedGroups**](UsersApi.md#getInvitedGroups) | **GET** /users/{userId}/groups/invited | Get User Group Invited |
| [**getMutualFriends**](UsersApi.md#getMutualFriends) | **GET** /users/{userId}/mutuals/friends | Get User Mutual Friends |
| [**getMutualGroups**](UsersApi.md#getMutualGroups) | **GET** /users/{userId}/mutuals/groups | Get User Mutual Groups |
| [**getMutuals**](UsersApi.md#getMutuals) | **GET** /users/{userId}/mutuals | Get User Mutuals |
| [**getUser**](UsersApi.md#getUser) | **GET** /users/{userId} | Get User by ID |
| [**getUserAllGroupPermissions**](UsersApi.md#getUserAllGroupPermissions) | **GET** /users/{userId}/groups/permissions | Get user&#39;s permissions for all joined groups. |
| [**getUserByName**](UsersApi.md#getUserByName) | **GET** /users/{username}/name | Get User by Username |
| [**getUserFeedback**](UsersApi.md#getUserFeedback) | **GET** /users/{userId}/feedback | Get User Feedback |
| [**getUserGroupInstances**](UsersApi.md#getUserGroupInstances) | **GET** /users/{userId}/instances/groups | Get User Group Instances |
| [**getUserGroupInstancesForGroup**](UsersApi.md#getUserGroupInstancesForGroup) | **GET** /users/{userId}/instances/groups/{groupId} | Get User Group Instances for a specific Group |
| [**getUserGroupRequests**](UsersApi.md#getUserGroupRequests) | **GET** /users/{userId}/groups/requested | Get User Group Requests |
| [**getUserGroups**](UsersApi.md#getUserGroups) | **GET** /users/{userId}/groups | Get User Groups |
| [**getUserNote**](UsersApi.md#getUserNote) | **GET** /userNotes/{userNoteId} | Get User Note |
| [**getUserNotes**](UsersApi.md#getUserNotes) | **GET** /userNotes | Get User Notes |
| [**getUserRepresentedGroup**](UsersApi.md#getUserRepresentedGroup) | **GET** /users/{userId}/groups/represented | Get user&#39;s current represented group |
| [**removeTags**](UsersApi.md#removeTags) | **POST** /users/{userId}/removeTags | Remove User Tags |
| [**searchUsers**](UsersApi.md#searchUsers) | **GET** /users | Search All Users |
| [**updateBadge**](UsersApi.md#updateBadge) | **PUT** /users/{userId}/badges/{badgeId} | Update User Badge |
| [**updateUser**](UsersApi.md#updateUser) | **PUT** /users/{userId} | Update User Info |
| [**updateUserNote**](UsersApi.md#updateUserNote) | **POST** /userNotes | Update User Note |
<a name="addTags"></a>
# **addTags**
> CurrentUser addTags(userId, ChangeUserTagsRequest)
Add User Tags
Adds tags to the user&#39;s profile
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **ChangeUserTagsRequest** | [**ChangeUserTagsRequest**](../Models/ChangeUserTagsRequest.md)| | |
### Return type
[**CurrentUser**](../Models/CurrentUser.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="checkUserPersistenceExists"></a>
# **checkUserPersistenceExists**
> checkUserPersistenceExists(userId, worldId)
Check User Persistence Exists
Checks whether the user has persistence data for a given world
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteAllUserPersistenceData"></a>
# **deleteAllUserPersistenceData**
> deleteAllUserPersistenceData(userId)
Delete All User Persistence Data
Deletes all of the user&#39;s persistence data for every world.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteUserPersistence"></a>
# **deleteUserPersistence**
> deleteUserPersistence(userId, worldId)
Delete User Persistence
Deletes the user&#39;s persistence data for a given world
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getBlockedGroups"></a>
# **getBlockedGroups**
> List getBlockedGroups(userId)
Get User Group Blocks
Returns a list of Groups the user has blocked.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**List**](../Models/Group.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getInvitedGroups"></a>
# **getInvitedGroups**
> List getInvitedGroups(userId)
Get User Group Invited
Returns a list of Groups the user has been invited to.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**List**](../Models/Group.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getMutualFriends"></a>
# **getMutualFriends**
> List getMutualFriends(userId, n, offset)
Get User Mutual Friends
Gets a list of mutual friends between the logged in user and the specified user
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**List**](../Models/MutualFriend.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getMutualGroups"></a>
# **getMutualGroups**
> List getMutualGroups(userId, n, offset)
Get User Mutual Groups
Gets a list of mutual groups between the logged in user and the specified user
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**List**](../Models/LimitedUserGroups.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getMutuals"></a>
# **getMutuals**
> Mutuals getMutuals(userId)
Get User Mutuals
Gets the counts of mutuals between the logged in user and the specified user
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**Mutuals**](../Models/Mutuals.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUser"></a>
# **getUser**
> User getUser(userId)
Get User by ID
Get public user information about a specific user using their ID.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**User**](../Models/User.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserAllGroupPermissions"></a>
# **getUserAllGroupPermissions**
> Map getUserAllGroupPermissions(userId, groupIds)
Get user&#39;s permissions for all joined groups.
Returns a mapping of GroupIDs to arrays of GroupPermissions.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **groupIds** | **String**| Comma-separated (no spaces!) list of GroupIDs to retrieve permissions for. | [optional] [default to null] |
### Return type
[**Map**](../Models/array.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserByName"></a>
# **getUserByName**
> User getUserByName(username)
Get User by Username
~~Get public user information about a specific user using their name.~~ **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). This endpoint now require Admin Credentials.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **username** | **String**| Username of the user | [default to null] |
### Return type
[**User**](../Models/User.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserFeedback"></a>
# **getUserFeedback**
> List getUserFeedback(userId, contentId, n, offset)
Get User Feedback
Get user&#39;s submitted feedback
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **contentId** | **Boolean**| Filter for users&#39; previously submitted feedback, e.g., a groupId, userId, avatarId, etc. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**List**](../Models/Feedback.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserGroupInstances"></a>
# **getUserGroupInstances**
> getUserGroupInstances_200_response getUserGroupInstances(userId)
Get User Group Instances
Returns a list of group instances for a user
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**getUserGroupInstances_200_response**](../Models/getUserGroupInstances_200_response.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserGroupInstancesForGroup"></a>
# **getUserGroupInstancesForGroup**
> getUserGroupInstances_200_response getUserGroupInstancesForGroup(userId, groupId)
Get User Group Instances for a specific Group
Returns a list of a group&#39;s instances for a user
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
### Return type
[**getUserGroupInstances_200_response**](../Models/getUserGroupInstances_200_response.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserGroupRequests"></a>
# **getUserGroupRequests**
> List getUserGroupRequests(userId)
Get User Group Requests
Returns a list of Groups the user has requested to be invited into.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**List**](../Models/Group.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserGroups"></a>
# **getUserGroups**
> List getUserGroups(userId)
Get User Groups
Get user&#39;s public groups
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**List**](../Models/LimitedUserGroups.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserNote"></a>
# **getUserNote**
> UserNote getUserNote(userNoteId)
Get User Note
Get a particular user note
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userNoteId** | **String**| Must be a valid user note ID. | [default to null] |
### Return type
[**UserNote**](../Models/UserNote.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserNotes"></a>
# **getUserNotes**
> List getUserNotes(n, offset)
Get User Notes
Get recently updated user notes
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**List**](../Models/UserNote.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserRepresentedGroup"></a>
# **getUserRepresentedGroup**
> RepresentedGroup getUserRepresentedGroup(userId)
Get user&#39;s current represented group
Returns the current group that the user is currently representing
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**RepresentedGroup**](../Models/RepresentedGroup.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="removeTags"></a>
# **removeTags**
> CurrentUser removeTags(userId, ChangeUserTagsRequest)
Remove User Tags
Removes tags from the user&#39;s profile
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **ChangeUserTagsRequest** | [**ChangeUserTagsRequest**](../Models/ChangeUserTagsRequest.md)| | |
### Return type
[**CurrentUser**](../Models/CurrentUser.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="searchUsers"></a>
# **searchUsers**
> List searchUsers(search, developerType, n, offset, isInternalVariant)
Search All Users
Search and list any users by text query
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **search** | **String**| Searches by &#x60;displayName&#x60;. Will return empty array if search query is empty or missing. | [optional] [default to null] |
| **developerType** | **String**| Active user by developer type, none for normal users and internal for moderators | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **isInternalVariant** | **Boolean**| Not quite sure what this actually does (exists on the website but doesn&#39;t seem to be used) | [optional] [default to null] |
### Return type
[**List**](../Models/LimitedUserSearch.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="updateBadge"></a>
# **updateBadge**
> updateBadge(userId, badgeId, UpdateUserBadgeRequest)
Update User Badge
Updates a user&#39;s badge
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **badgeId** | **String**| Must be a valid badge ID. | [default to null] |
| **UpdateUserBadgeRequest** | [**UpdateUserBadgeRequest**](../Models/UpdateUserBadgeRequest.md)| | |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="updateUser"></a>
# **updateUser**
> CurrentUser updateUser(userId, UpdateUserRequest)
Update User Info
Update a users information such as the email and birthday.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **UpdateUserRequest** | [**UpdateUserRequest**](../Models/UpdateUserRequest.md)| | [optional] |
### Return type
[**CurrentUser**](../Models/CurrentUser.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="updateUserNote"></a>
# **updateUserNote**
> UserNote updateUserNote(UpdateUserNoteRequest)
Update User Note
Updates the currently authenticated user&#39;s note on a user
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **UpdateUserNoteRequest** | [**UpdateUserNoteRequest**](../Models/UpdateUserNoteRequest.md)| | |
### Return type
[**UserNote**](../Models/UserNote.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json

512
Apis/WorldsApi.md Normal file
View File

@@ -0,0 +1,512 @@
# WorldsApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**checkUserPersistenceExists**](WorldsApi.md#checkUserPersistenceExists) | **GET** /users/{userId}/{worldId}/persist/exists | Check User Persistence Exists |
| [**createWorld**](WorldsApi.md#createWorld) | **POST** /worlds | Create World |
| [**deleteAllUserPersistenceData**](WorldsApi.md#deleteAllUserPersistenceData) | **DELETE** /users/{userId}/persist | Delete All User Persistence Data |
| [**deleteUserPersistence**](WorldsApi.md#deleteUserPersistence) | **DELETE** /users/{userId}/{worldId}/persist | Delete User Persistence |
| [**deleteWorld**](WorldsApi.md#deleteWorld) | **DELETE** /worlds/{worldId} | Delete World |
| [**getActiveWorlds**](WorldsApi.md#getActiveWorlds) | **GET** /worlds/active | List Active Worlds |
| [**getFavoritedWorlds**](WorldsApi.md#getFavoritedWorlds) | **GET** /worlds/favorites | List Favorited Worlds |
| [**getRecentWorlds**](WorldsApi.md#getRecentWorlds) | **GET** /worlds/recent | List Recent Worlds |
| [**getWorld**](WorldsApi.md#getWorld) | **GET** /worlds/{worldId} | Get World by ID |
| [**getWorldInstance**](WorldsApi.md#getWorldInstance) | **GET** /worlds/{worldId}/{instanceId} | Get World Instance |
| [**getWorldMetadata**](WorldsApi.md#getWorldMetadata) | **GET** /worlds/{worldId}/metadata | Get World Metadata |
| [**getWorldPublishStatus**](WorldsApi.md#getWorldPublishStatus) | **GET** /worlds/{worldId}/publish | Get World Publish Status |
| [**publishWorld**](WorldsApi.md#publishWorld) | **PUT** /worlds/{worldId}/publish | Publish World |
| [**searchWorlds**](WorldsApi.md#searchWorlds) | **GET** /worlds | Search All Worlds |
| [**unpublishWorld**](WorldsApi.md#unpublishWorld) | **DELETE** /worlds/{worldId}/publish | Unpublish World |
| [**updateWorld**](WorldsApi.md#updateWorld) | **PUT** /worlds/{worldId} | Update World |
<a name="checkUserPersistenceExists"></a>
# **checkUserPersistenceExists**
> checkUserPersistenceExists(userId, worldId)
Check User Persistence Exists
Checks whether the user has persistence data for a given world
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="createWorld"></a>
# **createWorld**
> World createWorld(CreateWorldRequest)
Create World
Create a new world. This endpoint requires &#x60;assetUrl&#x60; to be a valid File object with &#x60;.vrcw&#x60; file extension, and &#x60;imageUrl&#x60; to be a valid File object with an image file extension.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **CreateWorldRequest** | [**CreateWorldRequest**](../Models/CreateWorldRequest.md)| | [optional] |
### Return type
[**World**](../Models/World.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="deleteAllUserPersistenceData"></a>
# **deleteAllUserPersistenceData**
> deleteAllUserPersistenceData(userId)
Delete All User Persistence Data
Deletes all of the user&#39;s persistence data for every world.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteUserPersistence"></a>
# **deleteUserPersistence**
> deleteUserPersistence(userId, worldId)
Delete User Persistence
Deletes the user&#39;s persistence data for a given world
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteWorld"></a>
# **deleteWorld**
> deleteWorld(worldId)
Delete World
Delete a world. Notice a world is never fully \&quot;deleted\&quot;, only its ReleaseStatus is set to \&quot;hidden\&quot; and the linked Files are deleted. The WorldID is permanently reserved.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getActiveWorlds"></a>
# **getActiveWorlds**
> List getActiveWorlds(featured, sort, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, noplatform)
List Active Worlds
Search and list currently Active worlds by query filters.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **featured** | **Boolean**| Filters on featured results. | [optional] [default to null] |
| **sort** | **String**| The sort order of the results. | [optional] [default to popularity] [enum: _created_at, _updated_at, created, favorites, heat, labsPublicationDate, magic, name, order, popularity, publicationDate, random, relevance, reportCount, reportScore, shuffle, trust, updated] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **order** | **String**| Result ordering | [optional] [default to descending] [enum: ascending, descending] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **search** | **String**| Filters by world name. | [optional] [default to null] |
| **tag** | **String**| Tags to include (comma-separated). Any of the tags needs to be present. | [optional] [default to null] |
| **notag** | **String**| Tags to exclude (comma-separated). | [optional] [default to null] |
| **releaseStatus** | **String**| Filter by ReleaseStatus. | [optional] [default to public] [enum: all, hidden, private, public] |
| **maxUnityVersion** | **String**| The maximum Unity version supported by the asset. | [optional] [default to null] |
| **minUnityVersion** | **String**| The minimum Unity version supported by the asset. | [optional] [default to null] |
| **platform** | **String**| The platform the asset supports. | [optional] [default to null] |
| **noplatform** | **String**| The platform the asset does not support. | [optional] [default to null] |
### Return type
[**List**](../Models/LimitedWorld.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFavoritedWorlds"></a>
# **getFavoritedWorlds**
> List getFavoritedWorlds(featured, sort, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, userId)
List Favorited Worlds
Search and list favorited worlds by query filters.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **featured** | **Boolean**| Filters on featured results. | [optional] [default to null] |
| **sort** | **String**| The sort order of the results. | [optional] [default to popularity] [enum: _created_at, _updated_at, created, favorites, heat, labsPublicationDate, magic, name, order, popularity, publicationDate, random, relevance, reportCount, reportScore, shuffle, trust, updated] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **order** | **String**| Result ordering | [optional] [default to descending] [enum: ascending, descending] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **search** | **String**| Filters by world name. | [optional] [default to null] |
| **tag** | **String**| Tags to include (comma-separated). Any of the tags needs to be present. | [optional] [default to null] |
| **notag** | **String**| Tags to exclude (comma-separated). | [optional] [default to null] |
| **releaseStatus** | **String**| Filter by ReleaseStatus. | [optional] [default to public] [enum: all, hidden, private, public] |
| **maxUnityVersion** | **String**| The maximum Unity version supported by the asset. | [optional] [default to null] |
| **minUnityVersion** | **String**| The minimum Unity version supported by the asset. | [optional] [default to null] |
| **platform** | **String**| The platform the asset supports. | [optional] [default to null] |
| **userId** | **String**| Target user to see information on, admin-only. | [optional] [default to null] |
### Return type
[**List**](../Models/FavoritedWorld.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getRecentWorlds"></a>
# **getRecentWorlds**
> List getRecentWorlds(featured, sort, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, userId)
List Recent Worlds
Search and list recently visited worlds by query filters.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **featured** | **Boolean**| Filters on featured results. | [optional] [default to null] |
| **sort** | **String**| The sort order of the results. | [optional] [default to popularity] [enum: _created_at, _updated_at, created, favorites, heat, labsPublicationDate, magic, name, order, popularity, publicationDate, random, relevance, reportCount, reportScore, shuffle, trust, updated] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **order** | **String**| Result ordering | [optional] [default to descending] [enum: ascending, descending] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **search** | **String**| Filters by world name. | [optional] [default to null] |
| **tag** | **String**| Tags to include (comma-separated). Any of the tags needs to be present. | [optional] [default to null] |
| **notag** | **String**| Tags to exclude (comma-separated). | [optional] [default to null] |
| **releaseStatus** | **String**| Filter by ReleaseStatus. | [optional] [default to public] [enum: all, hidden, private, public] |
| **maxUnityVersion** | **String**| The maximum Unity version supported by the asset. | [optional] [default to null] |
| **minUnityVersion** | **String**| The minimum Unity version supported by the asset. | [optional] [default to null] |
| **platform** | **String**| The platform the asset supports. | [optional] [default to null] |
| **userId** | **String**| Target user to see information on, admin-only. | [optional] [default to null] |
### Return type
[**List**](../Models/LimitedWorld.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getWorld"></a>
# **getWorld**
> World getWorld(worldId)
Get World by ID
Get information about a specific World. Works unauthenticated but when so will always return &#x60;0&#x60; for certain fields.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
### Return type
[**World**](../Models/World.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getWorldInstance"></a>
# **getWorldInstance**
> Instance getWorldInstance(worldId, instanceId)
Get World Instance
Returns a worlds instance.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
| **instanceId** | **String**| Must be a valid instance ID. | [default to null] |
### Return type
[**Instance**](../Models/Instance.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getWorldMetadata"></a>
# **getWorldMetadata**
> WorldMetadata getWorldMetadata(worldId)
Get World Metadata
Return a worlds custom metadata. This is currently believed to be unused. Metadata can be set with &#x60;updateWorld&#x60; and can be any arbitrary object.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
### Return type
[**WorldMetadata**](../Models/WorldMetadata.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getWorldPublishStatus"></a>
# **getWorldPublishStatus**
> WorldPublishStatus getWorldPublishStatus(worldId)
Get World Publish Status
Returns a worlds publish status.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
### Return type
[**WorldPublishStatus**](../Models/WorldPublishStatus.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="publishWorld"></a>
# **publishWorld**
> publishWorld(worldId)
Publish World
Publish a world. You can only publish one world per week.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="searchWorlds"></a>
# **searchWorlds**
> List searchWorlds(featured, sort, user, userId, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, noplatform, fuzzy, avatarSpecific)
Search All Worlds
Search and list any worlds by query filters.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **featured** | **Boolean**| Filters on featured results. | [optional] [default to null] |
| **sort** | **String**| The sort order of the results. | [optional] [default to popularity] [enum: _created_at, _updated_at, created, favorites, heat, labsPublicationDate, magic, name, order, popularity, publicationDate, random, relevance, reportCount, reportScore, shuffle, trust, updated] |
| **user** | **String**| Set to &#x60;me&#x60; for searching own worlds. | [optional] [default to null] [enum: me] |
| **userId** | **String**| Filter by UserID. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **order** | **String**| Result ordering | [optional] [default to descending] [enum: ascending, descending] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **search** | **String**| Filters by world name. | [optional] [default to null] |
| **tag** | **String**| Tags to include (comma-separated). Any of the tags needs to be present. | [optional] [default to null] |
| **notag** | **String**| Tags to exclude (comma-separated). | [optional] [default to null] |
| **releaseStatus** | **String**| Filter by ReleaseStatus. | [optional] [default to public] [enum: all, hidden, private, public] |
| **maxUnityVersion** | **String**| The maximum Unity version supported by the asset. | [optional] [default to null] |
| **minUnityVersion** | **String**| The minimum Unity version supported by the asset. | [optional] [default to null] |
| **platform** | **String**| The platform the asset supports. | [optional] [default to null] |
| **noplatform** | **String**| The platform the asset does not support. | [optional] [default to null] |
| **fuzzy** | **Boolean**| | [optional] [default to null] |
| **avatarSpecific** | **Boolean**| Only search for avatar worlds. | [optional] [default to null] |
### Return type
[**List**](../Models/LimitedWorld.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="unpublishWorld"></a>
# **unpublishWorld**
> unpublishWorld(worldId)
Unpublish World
Unpublish a world.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="updateWorld"></a>
# **updateWorld**
> World updateWorld(worldId, UpdateWorldRequest)
Update World
Update information about a specific World.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
| **UpdateWorldRequest** | [**UpdateWorldRequest**](../Models/UpdateWorldRequest.md)| | [optional] |
### Return type
[**World**](../Models/World.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json