diff --git a/.openapi-generator-ignore b/.openapi-generator-ignore new file mode 100644 index 0000000..7484ee5 --- /dev/null +++ b/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES new file mode 100644 index 0000000..96927e0 --- /dev/null +++ b/.openapi-generator/FILES @@ -0,0 +1,261 @@ +.openapi-generator-ignore +Apis/AuthenticationApi.md +Apis/AvatarsApi.md +Apis/CalendarApi.md +Apis/EconomyApi.md +Apis/FavoritesApi.md +Apis/FilesApi.md +Apis/FriendsApi.md +Apis/GroupsApi.md +Apis/InstancesApi.md +Apis/InventoryApi.md +Apis/InviteApi.md +Apis/JamsApi.md +Apis/MiscellaneousApi.md +Apis/NotificationsApi.md +Apis/PlayermoderationApi.md +Apis/PrintsApi.md +Apis/PropsApi.md +Apis/UsersApi.md +Apis/WorldsApi.md +Models/APIConfig.md +Models/APIConfigAnnouncement.md +Models/APIConfigAudioConfig.md +Models/APIConfigConstants.md +Models/APIConfigConstants_GROUPS.md +Models/APIConfigConstants_INSTANCE.md +Models/APIConfigConstants_INSTANCE_POPULATION_BRACKETS.md +Models/APIConfigConstants_INSTANCE_POPULATION_BRACKETS_CROWDED.md +Models/APIConfigConstants_INSTANCE_POPULATION_BRACKETS_FEW.md +Models/APIConfigConstants_INSTANCE_POPULATION_BRACKETS_MANY.md +Models/APIConfigConstants_LANGUAGE.md +Models/APIConfigDownloadURLList.md +Models/APIConfigEvents.md +Models/APIConfig_accessLogsUrls.md +Models/APIConfig_avatarPerfLimiter.md +Models/APIConfig_iosVersion.md +Models/APIConfig_minSupportedClientBuildNumber.md +Models/APIConfig_offlineAnalysis.md +Models/APIHealth.md +Models/AccountDeletionLog.md +Models/AddGroupGalleryImageRequest.md +Models/AdminAssetBundle.md +Models/AdminUnityPackage.md +Models/Agreement.md +Models/AgreementRequest.md +Models/AgreementStatus.md +Models/Avatar.md +Models/AvatarModeration.md +Models/AvatarModerationCreated.md +Models/AvatarStyle.md +Models/Avatar_performance.md +Models/Avatar_publishedListings_inner.md +Models/Avatar_styles.md +Models/Avatar_unityPackageUrlObject.md +Models/Badge.md +Models/Balance.md +Models/BanGroupMemberRequest.md +Models/BoopRequest.md +Models/CalendarEvent.md +Models/CalendarEventDiscovery.md +Models/CalendarEvent_userInterest.md +Models/ChangeUserTagsRequest.md +Models/CreateAvatarModerationRequest.md +Models/CreateAvatarRequest.md +Models/CreateCalendarEventRequest.md +Models/CreateFileRequest.md +Models/CreateFileVersionRequest.md +Models/CreateGroupAnnouncementRequest.md +Models/CreateGroupGalleryRequest.md +Models/CreateGroupInviteRequest.md +Models/CreateGroupPostRequest.md +Models/CreateGroupRequest.md +Models/CreateGroupRequest_1.md +Models/CreateInstanceRequest.md +Models/CreatePropRequest.md +Models/CreateWorldRequest.md +Models/CurrentUser.md +Models/CurrentUserPresence.md +Models/CurrentUser_platform_history_inner.md +Models/DeclineGroupInviteRequest.md +Models/Disable2FAResult.md +Models/DiscordDetails.md +Models/DynamicContentRow.md +Models/EconomyAccount.md +Models/EquipInventoryItemRequest.md +Models/Error.md +Models/Favorite.md +Models/FavoriteGroup.md +Models/FavoriteGroupLimits.md +Models/FavoriteLimits.md +Models/FavoritedWorld.md +Models/Feedback.md +Models/File.md +Models/FileAnalysis.md +Models/FileAnalysisAvatarStats.md +Models/FileData.md +Models/FileUploadURL.md +Models/FileVersion.md +Models/FileVersionUploadStatus.md +Models/FinishFileDataUploadRequest.md +Models/FollowCalendarEventRequest.md +Models/FriendStatus.md +Models/Group.md +Models/GroupAnnouncement.md +Models/GroupAuditLogEntry.md +Models/GroupGallery.md +Models/GroupGalleryFileOrder.md +Models/GroupGalleryFileOrderRequest.md +Models/GroupGalleryImage.md +Models/GroupInstance.md +Models/GroupMember.md +Models/GroupMemberLimitedUser.md +Models/GroupMyMember.md +Models/GroupPermission.md +Models/GroupPost.md +Models/GroupRole.md +Models/GroupRoleTemplateValues.md +Models/GroupRoleTemplateValues_roles.md +Models/GroupTransferable.md +Models/GroupTransferable_requirements.md +Models/InfoPush.md +Models/InfoPushData.md +Models/InfoPushDataArticle.md +Models/InfoPushDataArticleContent.md +Models/InfoPushDataClickable.md +Models/Instance.md +Models/InstanceContentSettings.md +Models/InstancePlatforms.md +Models/InstanceShortNameResponse.md +Models/Inventory.md +Models/InventoryConsumptionResults.md +Models/InventoryDefaultAttributes_value.md +Models/InventoryDefaultAttributes_value_validator.md +Models/InventoryDrop.md +Models/InventoryItem.md +Models/InventoryMetadata.md +Models/InventoryNotificationDetails.md +Models/InventorySpawn.md +Models/InventoryTemplate.md +Models/InventoryUserAttributes.md +Models/InviteMessage.md +Models/InviteRequest.md +Models/InviteResponse.md +Models/Jam.md +Models/Jam_stateChangeDates.md +Models/JoinGroupRequest.md +Models/License.md +Models/LicenseGroup.md +Models/LimitedGroup.md +Models/LimitedUnityPackage.md +Models/LimitedUserFriend.md +Models/LimitedUserGroups.md +Models/LimitedUserInstance.md +Models/LimitedUserSearch.md +Models/LimitedWorld.md +Models/Listing.md +Models/ModerateUserRequest.md +Models/ModerationReport.md +Models/MutualFriend.md +Models/Mutuals.md +Models/Notification.md +Models/NotificationDetailInvite.md +Models/NotificationDetailInviteResponse.md +Models/NotificationDetailRequestInvite.md +Models/NotificationDetailRequestInviteResponse.md +Models/NotificationDetailVoteToKick.md +Models/NotificationV2.md +Models/NotificationV2DetailsBoop.md +Models/NotificationV2Response.md +Models/OkStatus.md +Models/OkStatus2.md +Models/PaginatedCalendarEventList.md +Models/PaginatedGroupAuditLogEntryList.md +Models/PaginatedModerationReportList.md +Models/PastDisplayName.md +Models/Pending2FAResult.md +Models/PerformanceLimiterInfo.md +Models/Permission.md +Models/Permission_data.md +Models/PlatformBuildInfo.md +Models/PlayerModeration.md +Models/Print.md +Models/Print_files.md +Models/Product.md +Models/ProductListingVariant.md +Models/ProductPurchase.md +Models/ProductPurchase_purchaseContext.md +Models/Prop.md +Models/PropPublishStatus.md +Models/PropUnityPackage.md +Models/PurchaseProductListingRequest.md +Models/RegisterUserAccountRequest.md +Models/ReportCategory.md +Models/ReportReason.md +Models/RepresentedGroup.md +Models/RequestInviteRequest.md +Models/RespondGroupJoinRequest.md +Models/RespondNotificationV2Request.md +Models/Response.md +Models/SentNotification.md +Models/ServiceQueueStats.md +Models/ServiceStatus.md +Models/ShareInventoryItemDirectRequest.md +Models/Store.md +Models/StoreShelf.md +Models/Submission.md +Models/SubmitModerationReportRequest.md +Models/SubmitModerationReportRequest_details.md +Models/Subscription.md +Models/Success.md +Models/SuccessFlag.md +Models/TiliaStatus.md +Models/TiliaTOS.md +Models/TokenBundle.md +Models/Transaction.md +Models/TransactionAgreement.md +Models/TransactionSteamInfo.md +Models/TransactionSteamWalletInfo.md +Models/TransferGroupRequest.md +Models/TwoFactorAuthCode.md +Models/TwoFactorEmailCode.md +Models/TwoFactorRecoveryCodes.md +Models/TwoFactorRecoveryCodes_otp_inner.md +Models/UnityPackage.md +Models/UpdateAssetReviewNotesRequest.md +Models/UpdateAvatarRequest.md +Models/UpdateCalendarEventRequest.md +Models/UpdateFavoriteGroupRequest.md +Models/UpdateGroupGalleryRequest.md +Models/UpdateGroupMemberRequest.md +Models/UpdateGroupRequest.md +Models/UpdateGroupRoleRequest.md +Models/UpdateInventoryItemRequest.md +Models/UpdateInviteMessageRequest.md +Models/UpdatePropRequest.md +Models/UpdateTiliaTOSRequest.md +Models/UpdateUserBadgeRequest.md +Models/UpdateUserNoteRequest.md +Models/UpdateUserRequest.md +Models/UpdateWorldRequest.md +Models/User.md +Models/UserCreditsEligible.md +Models/UserExists.md +Models/UserNote.md +Models/UserNote_targetUser.md +Models/UserSubscription.md +Models/UserSubscriptionEligible.md +Models/Verify2FAEmailCodeResult.md +Models/Verify2FAResult.md +Models/VerifyAuthTokenResult.md +Models/World.md +Models/WorldMetadata.md +Models/WorldPublishStatus.md +Models/addFavorite_request.md +Models/createPermission_request.md +Models/getGroupPosts_200_response.md +Models/getUserGroupInstances_200_response.md +Models/searchGroupMembers_200_response.md +Models/updateGroupRepresentation_request.md +Models/updatePermission_request.md +README.md diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION new file mode 100644 index 0000000..3821090 --- /dev/null +++ b/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.19.0 diff --git a/Apis/AuthenticationApi.md b/Apis/AuthenticationApi.md new file mode 100644 index 0000000..6dc8409 --- /dev/null +++ b/Apis/AuthenticationApi.md @@ -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 | + + + +# **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 + + +# **checkUserExists** +> UserExists checkUserExists(email, displayName, username, excludeUserId) + +Check User Exists + + Checks if a user by a given `username`, `displayName` or `email` 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 `excludeUserId` is used to exclude oneself, otherwise the result would always be true. It is **REQUIRED** to include **AT LEAST** `username`, `displayName` **or** `email` query parameter. Although they can be combined - in addition with `excludeUserId` (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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 `auth` 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 `Authorization` header and set the `auth` cookie. The `auth` 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 `Authorization: Basic {string}` is a base64-encoded string of the username and password, both individually url-encoded, and then joined with a colon. > 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 `auth` 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 + + +# **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 + + +# **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: `closed`... | [optional] [default to null] | +| **type** | **String**| Filter for moderation reports. One of: `avatar`, `group`, `user`, `world`... | [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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + diff --git a/Apis/AvatarsApi.md b/Apis/AvatarsApi.md new file mode 100644 index 0000000..09dfe3a --- /dev/null +++ b/Apis/AvatarsApi.md @@ -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 | + + + +# **createAvatar** +> Avatar createAvatar(CreateAvatarRequest) + +Create Avatar + + Create an avatar. It'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 + + +# **deleteAvatar** +> Avatar deleteAvatar(avatarId) + +Delete Avatar + + Delete an avatar. Notice an avatar is never fully \"deleted\", only its ReleaseStatus is set to \"hidden\" 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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 `me` 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'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 + + +# **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 + + +# **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 + + +# **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 + diff --git a/Apis/CalendarApi.md b/Apis/CalendarApi.md new file mode 100644 index 0000000..a79d1dd --- /dev/null +++ b/Apis/CalendarApi.md @@ -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'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 | + + + +# **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 + + +# **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 + + +# **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 `nextCursor` parameter For every successive call, use the `nextCursor` property returned in the previous call & the `number` of entries desired for this call The `nextCursor` internally keeps track of the `offset` 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 + + +# **followGroupCalendarEvent** +> CalendarEvent followGroupCalendarEvent(groupId, calendarId, FollowCalendarEventRequest) + +Follow a calendar event + + Follow or unfollow an event on a group'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 + + +# **getCalendarEvents** +> PaginatedCalendarEventList getCalendarEvents(date, n, offset) + +List calendar events + + Get a list of a user'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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **getGroupCalendarEvents** +> PaginatedCalendarEventList getGroupCalendarEvents(groupId, date, n, offset) + +List a group's calendar events + + Get a list of a group'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 + + +# **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 + + +# **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'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 + + +# **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 + diff --git a/Apis/EconomyApi.md b/Apis/EconomyApi.md new file mode 100644 index 0000000..0264821 --- /dev/null +++ b/Apis/EconomyApi.md @@ -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 | + + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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' 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 + + +# **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 + + +# **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 + + +# **getSteamTransaction** +> Transaction getSteamTransaction(transactionId) + +Get Steam Transaction + + Get a single Steam transactions by ID. This returns the exact same information as `getSteamTransactions`, 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 + + +# **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 + + +# **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 + + +# **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 + + +# **getSubscriptions** +> List getSubscriptions() + +List Subscriptions + + List all existing Subscriptions. For example, \"vrchatplus-monthly\" and \"vrchatplus-yearly\". + +### 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 + + +# **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 + + +# **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 + + +# **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 + + +# **getUserCreditsEligible** +> UserCreditsEligible getUserCreditsEligible(userId, subscriptionId) + +Get User Credits Eligiblity + + Get the user'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 + + +# **getUserSubscriptionEligible** +> UserSubscriptionEligible getUserSubscriptionEligible(userId, steamId) + +Get User Subscription Eligiblity + + Get the user'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 + + +# **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 + + +# **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 + diff --git a/Apis/FavoritesApi.md b/Apis/FavoritesApi.md new file mode 100644 index 0000000..4489824 --- /dev/null +++ b/Apis/FavoritesApi.md @@ -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 | + + + +# **addFavorite** +> Favorite addFavorite(addFavorite\_request) + +Add Favorite + + Add a new favorite. Friend groups are named `group_0` through `group_3`. Avatar and World groups are named `avatars1` to `avatars4` and `worlds1` to `worlds4`. 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 + + +# **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 + + +# **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 + + +# **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 `getFavoriteGroups`. + +### 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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + diff --git a/Apis/FilesApi.md b/Apis/FilesApi.md new file mode 100644 index 0000000..b79dcc0 --- /dev/null +++ b/Apis/FilesApi.md @@ -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 | + + + +# **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 + + +# **createFileVersion** +> File createFileVersion(fileId, CreateFileVersionRequest) + +Create File Version + + Creates a new FileVersion. Once a Version has been created, proceed to the `/file/{fileId}/{versionId}/file/start` 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 + + +# **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 + + +# **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 + + +# **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 `extension` 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 + + +# **finishFileDataUpload** +> File finishFileDataUpload(fileId, versionId, fileType, FinishFileDataUploadRequest) + +Finish FileData Upload + + Finish an upload of a FileData. This will mark it as \"complete\". After uploading the `file` for Avatars and Worlds you then have to upload a `signature` 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's: [https://teppen.io/2018/06/23/aws_s3_etags/](https://teppen.io/2018/06/23/aws_s3_etags/) ETag's should NOT be present when uploading a `signature`. | [optional] | + +### Return type + +[**File**](../Models/File.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +# **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 + + +# **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 + + +# **getFile** +> File getFile(fileId) + +Show File + + Shows general information about the \"File\" object. Each File can have several \"Version\"'s, and each Version can have multiple real files or \"Data\" 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 + + +# **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 + + +# **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 + + +# **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 + + +# **getFileDataUploadStatus** +> FileVersionUploadStatus getFileDataUploadStatus(fileId, versionId, fileType) + +Check FileData Upload Status + + Retrieves the upload status for file upload. Can currently only be accessed when `status` is `waiting`. 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 + + +# **getFiles** +> List getFiles(tag, userId, n, offset) + +List Files + + Returns a list of files + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **tag** | **String**| Tag, for example \"icon\" or \"gallery\", 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 + + +# **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 + + +# **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 `partNumber`. Please see AWS's REST documentation on \"PUT Object to S3\" on how to upload. Once all parts has been uploaded, proceed to `/finish` endpoint. **Note:** `nextPartNumber` 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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + diff --git a/Apis/FriendsApi.md b/Apis/FriendsApi.md new file mode 100644 index 0000000..e17ce61 --- /dev/null +++ b/Apis/FriendsApi.md @@ -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 | + + + +# **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 + + +# **deleteFriendRequest** +> Success deleteFriendRequest(userId) + +Delete Friend Request + + Deletes an outgoing pending friend request to another user. To delete an incoming friend request, use the `deleteNotification` 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 + + +# **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 + + +# **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 `Notification` of type `friendRequest`, 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 + + +# **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 + + +# **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 + diff --git a/Apis/GroupsApi.md b/Apis/GroupsApi.md new file mode 100644 index 0000000..be22f86 --- /dev/null +++ b/Apis/GroupsApi.md @@ -0,0 +1,1503 @@ +# GroupsApi + +All URIs are relative to *https://api.vrchat.cloud/api/1* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**addGroupGalleryImage**](GroupsApi.md#addGroupGalleryImage) | **POST** /groups/{groupId}/galleries/{groupGalleryId}/images | Add Group Gallery Image | +| [**addGroupMemberRole**](GroupsApi.md#addGroupMemberRole) | **PUT** /groups/{groupId}/members/{userId}/roles/{groupRoleId} | Add Role to GroupMember | +| [**addGroupPost**](GroupsApi.md#addGroupPost) | **POST** /groups/{groupId}/posts | Create a post in a Group | +| [**banGroupMember**](GroupsApi.md#banGroupMember) | **POST** /groups/{groupId}/bans | Ban Group Member | +| [**blockGroup**](GroupsApi.md#blockGroup) | **POST** /groups/{groupId}/block | Block Group | +| [**cancelGroupRequest**](GroupsApi.md#cancelGroupRequest) | **DELETE** /groups/{groupId}/requests | Cancel Group Join Request | +| [**cancelGroupTransfer**](GroupsApi.md#cancelGroupTransfer) | **DELETE** /groups/{groupId}/transfer | Cancel Group Transfer | +| [**createGroup**](GroupsApi.md#createGroup) | **POST** /groups | Create Group | +| [**createGroupAnnouncement**](GroupsApi.md#createGroupAnnouncement) | **POST** /groups/{groupId}/announcement | Create Group Announcement | +| [**createGroupGallery**](GroupsApi.md#createGroupGallery) | **POST** /groups/{groupId}/galleries | Create Group Gallery | +| [**createGroupInvite**](GroupsApi.md#createGroupInvite) | **POST** /groups/{groupId}/invites | Invite User to Group | +| [**createGroupRole**](GroupsApi.md#createGroupRole) | **POST** /groups/{groupId}/roles | Create GroupRole | +| [**declineGroupInvite**](GroupsApi.md#declineGroupInvite) | **PUT** /groups/{groupId}/invites | Decline Invite from Group | +| [**deleteGroup**](GroupsApi.md#deleteGroup) | **DELETE** /groups/{groupId} | Delete Group | +| [**deleteGroupAnnouncement**](GroupsApi.md#deleteGroupAnnouncement) | **DELETE** /groups/{groupId}/announcement | Delete Group Announcement | +| [**deleteGroupGallery**](GroupsApi.md#deleteGroupGallery) | **DELETE** /groups/{groupId}/galleries/{groupGalleryId} | Delete Group Gallery | +| [**deleteGroupGalleryImage**](GroupsApi.md#deleteGroupGalleryImage) | **DELETE** /groups/{groupId}/galleries/{groupGalleryId}/images/{groupGalleryImageId} | Delete Group Gallery Image | +| [**deleteGroupInvite**](GroupsApi.md#deleteGroupInvite) | **DELETE** /groups/{groupId}/invites/{userId} | Delete User Invite | +| [**deleteGroupPost**](GroupsApi.md#deleteGroupPost) | **DELETE** /groups/{groupId}/posts/{notificationId} | Delete a Group post | +| [**deleteGroupRole**](GroupsApi.md#deleteGroupRole) | **DELETE** /groups/{groupId}/roles/{groupRoleId} | Delete Group Role | +| [**getGroup**](GroupsApi.md#getGroup) | **GET** /groups/{groupId} | Get Group by ID | +| [**getGroupAnnouncements**](GroupsApi.md#getGroupAnnouncements) | **GET** /groups/{groupId}/announcement | Get Group Announcement | +| [**getGroupAuditLogEntryTypes**](GroupsApi.md#getGroupAuditLogEntryTypes) | **GET** /groups/{groupId}/auditLogTypes | Get Group Audit Log Entry Types | +| [**getGroupAuditLogs**](GroupsApi.md#getGroupAuditLogs) | **GET** /groups/{groupId}/auditLogs | Get Group Audit Logs | +| [**getGroupBans**](GroupsApi.md#getGroupBans) | **GET** /groups/{groupId}/bans | Get Group Bans | +| [**getGroupGalleryImages**](GroupsApi.md#getGroupGalleryImages) | **GET** /groups/{groupId}/galleries/{groupGalleryId} | Get Group Gallery Images | +| [**getGroupInstances**](GroupsApi.md#getGroupInstances) | **GET** /groups/{groupId}/instances | Get Group Instances | +| [**getGroupInvites**](GroupsApi.md#getGroupInvites) | **GET** /groups/{groupId}/invites | Get Group Invites Sent | +| [**getGroupMember**](GroupsApi.md#getGroupMember) | **GET** /groups/{groupId}/members/{userId} | Get Group Member | +| [**getGroupMembers**](GroupsApi.md#getGroupMembers) | **GET** /groups/{groupId}/members | List Group Members | +| [**getGroupPermissions**](GroupsApi.md#getGroupPermissions) | **GET** /groups/{groupId}/permissions | List Group Permissions | +| [**getGroupPosts**](GroupsApi.md#getGroupPosts) | **GET** /groups/{groupId}/posts | Get posts from a Group | +| [**getGroupRequests**](GroupsApi.md#getGroupRequests) | **GET** /groups/{groupId}/requests | Get Group Join Requests | +| [**getGroupRoleTemplates**](GroupsApi.md#getGroupRoleTemplates) | **GET** /groups/roleTemplates | Get Group Role Templates | +| [**getGroupRoles**](GroupsApi.md#getGroupRoles) | **GET** /groups/{groupId}/roles | Get Group Roles | +| [**getGroupTransferability**](GroupsApi.md#getGroupTransferability) | **GET** /groups/{groupId}/transfer | Get Group Transferability | +| [**initiateOrAcceptGroupTransfer**](GroupsApi.md#initiateOrAcceptGroupTransfer) | **POST** /groups/{groupId}/transfer | Initiate or Accept Group Transfer | +| [**joinGroup**](GroupsApi.md#joinGroup) | **POST** /groups/{groupId}/join | Join Group | +| [**kickGroupMember**](GroupsApi.md#kickGroupMember) | **DELETE** /groups/{groupId}/members/{userId} | Kick Group Member | +| [**leaveGroup**](GroupsApi.md#leaveGroup) | **POST** /groups/{groupId}/leave | Leave Group | +| [**removeGroupMemberRole**](GroupsApi.md#removeGroupMemberRole) | **DELETE** /groups/{groupId}/members/{userId}/roles/{groupRoleId} | Remove Role from GroupMember | +| [**respondGroupJoinRequest**](GroupsApi.md#respondGroupJoinRequest) | **PUT** /groups/{groupId}/requests/{userId} | Respond Group Join request | +| [**searchGroupMembers**](GroupsApi.md#searchGroupMembers) | **GET** /groups/{groupId}/members/search | Search Group Members | +| [**searchGroups**](GroupsApi.md#searchGroups) | **GET** /groups | Search Group | +| [**unbanGroupMember**](GroupsApi.md#unbanGroupMember) | **DELETE** /groups/{groupId}/bans/{userId} | Unban Group Member | +| [**updateGroup**](GroupsApi.md#updateGroup) | **PUT** /groups/{groupId} | Update Group | +| [**updateGroupGallery**](GroupsApi.md#updateGroupGallery) | **PUT** /groups/{groupId}/galleries/{groupGalleryId} | Update Group Gallery | +| [**updateGroupMember**](GroupsApi.md#updateGroupMember) | **PUT** /groups/{groupId}/members/{userId} | Update Group Member | +| [**updateGroupPost**](GroupsApi.md#updateGroupPost) | **PUT** /groups/{groupId}/posts/{notificationId} | Edits a Group post | +| [**updateGroupRepresentation**](GroupsApi.md#updateGroupRepresentation) | **PUT** /groups/{groupId}/representation | Update Group Representation | +| [**updateGroupRole**](GroupsApi.md#updateGroupRole) | **PUT** /groups/{groupId}/roles/{groupRoleId} | Update Group Role | + + + +# **addGroupGalleryImage** +> GroupGalleryImage addGroupGalleryImage(groupId, groupGalleryId, AddGroupGalleryImageRequest) + +Add Group Gallery Image + + Adds an image to a Group gallery. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **groupGalleryId** | **String**| Must be a valid group gallery ID. | [default to null] | +| **AddGroupGalleryImageRequest** | [**AddGroupGalleryImageRequest**](../Models/AddGroupGalleryImageRequest.md)| | | + +### Return type + +[**GroupGalleryImage**](../Models/GroupGalleryImage.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +# **addGroupMemberRole** +> List addGroupMemberRole(groupId, userId, groupRoleId) + +Add Role to GroupMember + + Adds a Role to a Group Member + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **userId** | **String**| Must be a valid user ID. | [default to null] | +| **groupRoleId** | **String**| Must be a valid group role ID. | [default to null] | + +### Return type + +**List** + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **addGroupPost** +> GroupPost addGroupPost(groupId, CreateGroupPostRequest) + +Create a post in a Group + + Create a post in a Group. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **CreateGroupPostRequest** | [**CreateGroupPostRequest**](../Models/CreateGroupPostRequest.md)| | | + +### Return type + +[**GroupPost**](../Models/GroupPost.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +# **banGroupMember** +> GroupMember banGroupMember(groupId, BanGroupMemberRequest) + +Ban Group Member + + Bans a user from a Group. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **BanGroupMemberRequest** | [**BanGroupMemberRequest**](../Models/BanGroupMemberRequest.md)| | | + +### Return type + +[**GroupMember**](../Models/GroupMember.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +# **blockGroup** +> Success blockGroup(groupId) + +Block Group + + Blocks a Group for the current user. To unblock a group, call kickGroupMember (DELETE /groups/{groupId}/members/{userId}). + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group 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 + + +# **cancelGroupRequest** +> cancelGroupRequest(groupId) + +Cancel Group Join Request + + Cancels a request sent to join the group. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group 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 + + +# **cancelGroupTransfer** +> Success cancelGroupTransfer(groupId) + +Cancel Group Transfer + + Cancel a Group Transfer. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group 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 + + +# **createGroup** +> Group createGroup(CreateGroupRequest) + +Create Group + + Creates a Group and returns a Group object. **Requires VRC+ Subscription.** + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **CreateGroupRequest** | [**CreateGroupRequest**](../Models/CreateGroupRequest.md)| | | + +### Return type + +[**Group**](../Models/Group.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +# **createGroupAnnouncement** +> GroupAnnouncement createGroupAnnouncement(groupId, CreateGroupAnnouncementRequest) + +Create Group Announcement + + Creates an Announcement for a Group. Warning: This will also remove all announcements. To make proper announcements, use the posts endpoint instead + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **CreateGroupAnnouncementRequest** | [**CreateGroupAnnouncementRequest**](../Models/CreateGroupAnnouncementRequest.md)| | | + +### Return type + +[**GroupAnnouncement**](../Models/GroupAnnouncement.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +# **createGroupGallery** +> GroupGallery createGroupGallery(groupId, CreateGroupGalleryRequest) + +Create Group Gallery + + Creates a gallery for a Group. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **CreateGroupGalleryRequest** | [**CreateGroupGalleryRequest**](../Models/CreateGroupGalleryRequest.md)| | | + +### Return type + +[**GroupGallery**](../Models/GroupGallery.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +# **createGroupInvite** +> createGroupInvite(groupId, CreateGroupInviteRequest) + +Invite User to Group + + Sends an invite to a user to join the group. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **CreateGroupInviteRequest** | [**CreateGroupInviteRequest**](../Models/CreateGroupInviteRequest.md)| | | + +### Return type + +null (empty response body) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +# **createGroupRole** +> GroupRole createGroupRole(groupId, CreateGroupRequest\_1) + +Create GroupRole + + Create a Group role. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **CreateGroupRequest\_1** | [**CreateGroupRequest_1**](../Models/CreateGroupRequest_1.md)| | | + +### Return type + +[**GroupRole**](../Models/GroupRole.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +# **declineGroupInvite** +> Success declineGroupInvite(groupId, DeclineGroupInviteRequest) + +Decline Invite from Group + + Declines an invite to the user from a group. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **DeclineGroupInviteRequest** | [**DeclineGroupInviteRequest**](../Models/DeclineGroupInviteRequest.md)| | [optional] | + +### Return type + +[**Success**](../Models/Success.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +# **deleteGroup** +> Success deleteGroup(groupId, hardDelete) + +Delete Group + + Deletes a Group. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **hardDelete** | **Boolean**| | [optional] [default to null] | + +### Return type + +[**Success**](../Models/Success.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **deleteGroupAnnouncement** +> Success deleteGroupAnnouncement(groupId) + +Delete Group Announcement + + Deletes the announcement for a Group. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group 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 + + +# **deleteGroupGallery** +> Success deleteGroupGallery(groupId, groupGalleryId) + +Delete Group Gallery + + Deletes a gallery for a Group. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **groupGalleryId** | **String**| Must be a valid group gallery 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 + + +# **deleteGroupGalleryImage** +> Success deleteGroupGalleryImage(groupId, groupGalleryId, groupGalleryImageId) + +Delete Group Gallery Image + + Deletes an image from a Group gallery. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **groupGalleryId** | **String**| Must be a valid group gallery ID. | [default to null] | +| **groupGalleryImageId** | **String**| Must be a valid group gallery image 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 + + +# **deleteGroupInvite** +> deleteGroupInvite(groupId, userId) + +Delete User Invite + + Deletes an Group invite sent to a User + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **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 + + +# **deleteGroupPost** +> Success deleteGroupPost(groupId, notificationId) + +Delete a Group post + + Delete a Group post + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **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 + + +# **deleteGroupRole** +> List deleteGroupRole(groupId, groupRoleId) + +Delete Group Role + + Deletes a Group Role by ID and returns the remaining roles. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **groupRoleId** | **String**| Must be a valid group role ID. | [default to null] | + +### Return type + +[**List**](../Models/GroupRole.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **getGroup** +> Group getGroup(groupId, includeRoles) + +Get Group by ID + + Returns a single Group by ID. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **includeRoles** | **Boolean**| Include roles for the Group object. Defaults to false. | [optional] [default to null] | + +### Return type + +[**Group**](../Models/Group.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **getGroupAnnouncements** +> GroupAnnouncement getGroupAnnouncements(groupId) + +Get Group Announcement + + Returns the announcement for a Group. If no announcement has been made, then it returns **empty object**. If an announcement exists, then it will always return all fields except `imageId` and `imageUrl` which may be null. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | + +### Return type + +[**GroupAnnouncement**](../Models/GroupAnnouncement.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **getGroupAuditLogEntryTypes** +> List getGroupAuditLogEntryTypes(groupId) + +Get Group Audit Log Entry Types + + Returns a list of audit log entry types for which the group has entries. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | + +### Return type + +**List** + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **getGroupAuditLogs** +> PaginatedGroupAuditLogEntryList getGroupAuditLogs(groupId, n, offset, startDate, endDate, actorIds, eventTypes, targetIds) + +Get Group Audit Logs + + Returns a list of audit logs for a Group. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group 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] | +| **startDate** | **Date**| The start date of the search range. | [optional] [default to null] | +| **endDate** | **Date**| The end date of the search range. | [optional] [default to null] | +| **actorIds** | **String**| The comma-separated actor ids to search for. | [optional] [default to null] | +| **eventTypes** | **String**| The comma-separated event types to search for. | [optional] [default to null] | +| **targetIds** | **String**| The comma-separated target ids to search for. | [optional] [default to null] | + +### Return type + +[**PaginatedGroupAuditLogEntryList**](../Models/PaginatedGroupAuditLogEntryList.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **getGroupBans** +> List getGroupBans(groupId, n, offset) + +Get Group Bans + + Returns a list of banned users for a Group. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group 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/GroupMember.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **getGroupGalleryImages** +> List getGroupGalleryImages(groupId, groupGalleryId, n, offset, approved) + +Get Group Gallery Images + + Returns a list of images for a Group gallery. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **groupGalleryId** | **String**| Must be a valid group gallery 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] | +| **approved** | **Boolean**| If specified, only returns images that have been approved or not approved. | [optional] [default to null] | + +### Return type + +[**List**](../Models/GroupGalleryImage.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **getGroupInstances** +> List getGroupInstances(groupId) + +Get Group Instances + + Returns a list of group instances + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | + +### Return type + +[**List**](../Models/GroupInstance.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **getGroupInvites** +> List getGroupInvites(groupId, n, offset) + +Get Group Invites Sent + + Returns a list of members that have been invited to the Group. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group 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/GroupMember.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **getGroupMember** +> GroupMember getGroupMember(groupId, userId) + +Get Group Member + + Returns a GroupMember. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **userId** | **String**| Must be a valid user ID. | [default to null] | + +### Return type + +[**GroupMember**](../Models/GroupMember.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **getGroupMembers** +> List getGroupMembers(groupId, n, offset, sort, roleId) + +List Group Members + + Returns a List of all **other** Group Members. This endpoint will never return the user calling the endpoint. Information about the user calling the endpoint must be found in the `myMember` field of the Group object. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group 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] | +| **sort** | **String**| The sort order of Group Member results | [optional] [default to null] [enum: joinedAt:asc, joinedAt:desc] | +| **roleId** | **String**| Only returns members with a specific groupRoleId | [optional] [default to null] | + +### Return type + +[**List**](../Models/GroupMember.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **getGroupPermissions** +> List getGroupPermissions(groupId) + +List Group Permissions + + Returns a List of all possible/available permissions for a Group. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | + +### Return type + +[**List**](../Models/GroupPermission.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **getGroupPosts** +> getGroupPosts_200_response getGroupPosts(groupId, n, offset, publicOnly) + +Get posts from a Group + + Get posts from a Group + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group 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] | +| **publicOnly** | **Boolean**| See public posts only. | [optional] [default to null] | + +### Return type + +[**getGroupPosts_200_response**](../Models/getGroupPosts_200_response.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **getGroupRequests** +> List getGroupRequests(groupId, n, offset, blocked) + +Get Group Join Requests + + Returns a list of members that have requested to join the Group. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group 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] | +| **blocked** | **Boolean**| See blocked join requests | [optional] [default to null] | + +### Return type + +[**List**](../Models/GroupMember.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **getGroupRoleTemplates** +> Map getGroupRoleTemplates() + +Get Group Role Templates + + Obtain predefined templates for group roles + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**Map**](../Models/GroupRoleTemplateValues.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **getGroupRoles** +> List getGroupRoles(groupId) + +Get Group Roles + + Returns a Group Role by ID. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | + +### Return type + +[**List**](../Models/GroupRole.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **getGroupTransferability** +> GroupTransferable getGroupTransferability(groupId, transferTargetId) + +Get Group Transferability + + Returns the transferability of the group to a given user. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **transferTargetId** | **String**| The UserID of the prospective transferee. | [optional] [default to null] | + +### Return type + +[**GroupTransferable**](../Models/GroupTransferable.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **initiateOrAcceptGroupTransfer** +> Success initiateOrAcceptGroupTransfer(groupId, TransferGroupRequest) + +Initiate or Accept Group Transfer + + To initiate, must be logged in as the current owner and specify the transferTargetId in the body. To accept, must be logged in as the user targetted by a pending transfer, no body is required. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **TransferGroupRequest** | [**TransferGroupRequest**](../Models/TransferGroupRequest.md)| | [optional] | + +### Return type + +[**Success**](../Models/Success.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +# **joinGroup** +> GroupMember joinGroup(groupId, confirmOverrideBlock, JoinGroupRequest) + +Join Group + + Join a Group by ID and returns the member object. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **confirmOverrideBlock** | **Boolean**| Manually override the failure that would occur if the user has blocked the group. | [optional] [default to null] | +| **JoinGroupRequest** | [**JoinGroupRequest**](../Models/JoinGroupRequest.md)| | [optional] | + +### Return type + +[**GroupMember**](../Models/GroupMember.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +# **kickGroupMember** +> Success kickGroupMember(groupId, userId) + +Kick Group Member + + Kicks a Group Member from the Group. The current user must have the \"Remove Group Members\" permission. Also used for unblocking groups. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [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 + + +# **leaveGroup** +> leaveGroup(groupId) + +Leave Group + + Leave a group by ID. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group 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 + + +# **removeGroupMemberRole** +> List removeGroupMemberRole(groupId, userId, groupRoleId) + +Remove Role from GroupMember + + Removes a Role from a Group Member + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **userId** | **String**| Must be a valid user ID. | [default to null] | +| **groupRoleId** | **String**| Must be a valid group role ID. | [default to null] | + +### Return type + +**List** + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **respondGroupJoinRequest** +> respondGroupJoinRequest(groupId, userId, RespondGroupJoinRequest) + +Respond Group Join request + + Responds to a Group Join Request with Accept/Deny + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **userId** | **String**| Must be a valid user ID. | [default to null] | +| **RespondGroupJoinRequest** | [**RespondGroupJoinRequest**](../Models/RespondGroupJoinRequest.md)| | | + +### Return type + +null (empty response body) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +# **searchGroupMembers** +> searchGroupMembers_200_response searchGroupMembers(groupId, query, n, offset) + +Search Group Members + + Search for members in the group by displayName. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **query** | **String**| Filter for member displayName. | [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 + +[**searchGroupMembers_200_response**](../Models/searchGroupMembers_200_response.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **searchGroups** +> List searchGroups(query, offset, n) + +Search Group + + Searches Groups by name or shortCode + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **query** | **String**| Query to search for, can be either Group Name or Group shortCode | [optional] [default to null] | +| **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] | + +### Return type + +[**List**](../Models/LimitedGroup.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **unbanGroupMember** +> GroupMember unbanGroupMember(groupId, userId) + +Unban Group Member + + Unbans a user from a Group. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **userId** | **String**| Must be a valid user ID. | [default to null] | + +### Return type + +[**GroupMember**](../Models/GroupMember.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **updateGroup** +> Group updateGroup(groupId, UpdateGroupRequest) + +Update Group + + Updates a Group and returns it. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **UpdateGroupRequest** | [**UpdateGroupRequest**](../Models/UpdateGroupRequest.md)| | [optional] | + +### Return type + +[**Group**](../Models/Group.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +# **updateGroupGallery** +> GroupGallery updateGroupGallery(groupId, groupGalleryId, UpdateGroupGalleryRequest) + +Update Group Gallery + + Updates a gallery for a Group. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **groupGalleryId** | **String**| Must be a valid group gallery ID. | [default to null] | +| **UpdateGroupGalleryRequest** | [**UpdateGroupGalleryRequest**](../Models/UpdateGroupGalleryRequest.md)| | [optional] | + +### Return type + +[**GroupGallery**](../Models/GroupGallery.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +# **updateGroupMember** +> GroupMember updateGroupMember(groupId, userId, UpdateGroupMemberRequest) + +Update Group Member + + Updates a Group Member + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **userId** | **String**| Must be a valid user ID. | [default to null] | +| **UpdateGroupMemberRequest** | [**UpdateGroupMemberRequest**](../Models/UpdateGroupMemberRequest.md)| | [optional] | + +### Return type + +[**GroupMember**](../Models/GroupMember.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +# **updateGroupPost** +> GroupPost updateGroupPost(groupId, notificationId, CreateGroupPostRequest) + +Edits a Group post + + Edits a Group post + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **notificationId** | **String**| Must be a valid notification ID. | [default to null] | +| **CreateGroupPostRequest** | [**CreateGroupPostRequest**](../Models/CreateGroupPostRequest.md)| | | + +### Return type + +[**GroupPost**](../Models/GroupPost.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +# **updateGroupRepresentation** +> Success updateGroupRepresentation(groupId, updateGroupRepresentation\_request) + +Update Group Representation + + Updates whether the user is representing the group. When `isRepresenting` is set to `true`, this flag will be set to `false` for all other groups + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **updateGroupRepresentation\_request** | [**updateGroupRepresentation_request**](../Models/updateGroupRepresentation_request.md)| | | + +### Return type + +[**Success**](../Models/Success.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +# **updateGroupRole** +> List updateGroupRole(groupId, groupRoleId, UpdateGroupRoleRequest) + +Update Group Role + + Updates a group role by ID. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **String**| Must be a valid group ID. | [default to null] | +| **groupRoleId** | **String**| Must be a valid group role ID. | [default to null] | +| **UpdateGroupRoleRequest** | [**UpdateGroupRoleRequest**](../Models/UpdateGroupRoleRequest.md)| | [optional] | + +### Return type + +[**List**](../Models/GroupRole.md) + +### Authorization + +[authCookie](../README.md#authCookie) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + diff --git a/Apis/InstancesApi.md b/Apis/InstancesApi.md new file mode 100644 index 0000000..2288c51 --- /dev/null +++ b/Apis/InstancesApi.md @@ -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 | + + + +# **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 `group-instance-manage` 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'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 + + +# **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 + + +# **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 \"null\"! + +### 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 + + +# **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 + + +# **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 + + +# **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 + diff --git a/Apis/InventoryApi.md b/Apis/InventoryApi.md new file mode 100644 index 0000000..1cf00f6 --- /dev/null +++ b/Apis/InventoryApi.md @@ -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 | + + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **getInventoryDrops** +> List getInventoryDrops(active) + +List Inventory Drops + + Returns a list of InventoryDrop objects. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **active** | **Boolean**| Filter for users' 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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + diff --git a/Apis/InviteApi.md b/Apis/InviteApi.md new file mode 100644 index 0000000..4917d2f --- /dev/null +++ b/Apis/InviteApi.md @@ -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 | + + + +# **getInviteMessage** +> InviteMessage getInviteMessage(userId, messageType, slot) + +Get Invite Message + + Returns a single Invite Message. This returns the exact same information but less than `getInviteMessages`. 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. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = 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 + + +# **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. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = 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 + + +# **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 + + +# **inviteUser** +> SentNotification inviteUser(userId, InviteRequest) + +Invite User + + Sends an invite to a user. Returns the Notification of type `invite` 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 + + +# **inviteUserWithPhoto** +> SentNotification inviteUserWithPhoto(userId, data, image) + +Invite User with photo + + Sends an photo invite to a user. Returns the Notification of type `invite` 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 + + +# **requestInvite** +> Notification requestInvite(userId, RequestInviteRequest) + +Request Invite + + Requests an invite from a user. Returns the Notification of type `requestInvite` 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 + + +# **requestInviteWithPhoto** +> Notification requestInviteWithPhoto(userId, data, image) + +Request Invite with photo + + Requests with photo an invite from a user. Returns the Notification of type `requestInvite` 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 + + +# **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 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = 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 + + +# **respondInvite** +> Notification respondInvite(notificationId, InviteResponse) + +Respond Invite + + Respond to an invite or invite request without accepting it. `:notificationId` is the ID of the requesting notification. In case the notification being replied to is an invite, the `responseSlot` refers to a response message from the the `message` collection. In case the notification is an invite request, it will refer to one from the `requestResponse` 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 + + +# **respondInviteWithPhoto** +> Notification respondInviteWithPhoto(notificationId, data, image) + +Respond Invite with photo + + Respond with photo to an invite or invite request without accepting it. `:notificationId` is the ID of the requesting notification. In case the notification being replied to is an invite, the `responseSlot` refers to a response message from the the `message` collection. In case the notification is an invite request, it will refer to one from the `requestResponse` collection instead.' + +### 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 + + +# **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 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = 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 + diff --git a/Apis/JamsApi.md b/Apis/JamsApi.md new file mode 100644 index 0000000..87de44c --- /dev/null +++ b/Apis/JamsApi.md @@ -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 | + + + +# **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 + + +# **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 + + +# **getJams** +> List getJams(type) + +Show jams list + + Lists World Jams or Avatar Jams, both currently running and ones that have ended. `isActive` is used to select only active or already ended jams. `type` is used to select only world or avatar jams, and can only take `world` or `avatar`. `` + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **type** | **String**| Only show jams of this type (`avatar` or `world`). | [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 + diff --git a/Apis/MiscellaneousApi.md b/Apis/MiscellaneousApi.md new file mode 100644 index 0000000..68fc972 --- /dev/null +++ b/Apis/MiscellaneousApi.md @@ -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 | + + + +# **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 + + +# **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 `variant` of the site. Public is the end-user site, while `internal` 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 + + +# **getConfig** +> APIConfig getConfig() + +Fetch API Config + + API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` 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 + + +# **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 + + +# **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 + + +# **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. `include` 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 \"any of\" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an \"all of\" 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 + + +# **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 `variant` of the site. Public is the end-user site, while `internal` 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 + + +# **getPermission** +> Permission getPermission(permissionId) + +Get Permission + + Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`. + +### 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 + + +# **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 + diff --git a/Apis/NotificationsApi.md b/Apis/NotificationsApi.md new file mode 100644 index 0000000..e5badb1 --- /dev/null +++ b/Apis/NotificationsApi.md @@ -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 | + + + +# **acceptFriendRequest** +> Success acceptFriendRequest(notificationId) + +Accept Friend Request + + Accept a friend request by notification `frq_` ID. Friend requests can be found using the NotificationsAPI `getNotifications` by filtering of type `friendRequest`. + +### 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 + + +# **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 + + +# **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 + + +# **deleteAllNotificationV2s** +> Success deleteAllNotificationV2s() + +Delete All NotificationV2s + + Delete all of the current user'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 + + +# **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 + + +# **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 + + +# **getNotification** +> Notification getNotification(notificationId) + +Show notification + + Get a notification by notification `not_` 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 + + +# **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 + + +# **getNotificationV2s** +> List getNotificationV2s(limit) + +List NotificationV2s + + Retrieve all of the current user'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 + + +# **getNotifications** +> List getNotifications(type, sent, hidden, after, n, offset) + +List Notifications + + Retrieve all of the current user's notifications. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **type** | **String**| Only send notifications of this type (can use `all` 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 `friendRequest`. | [optional] [default to null] | +| **after** | **String**| Only return notifications sent after this Date. Ignored if type is `friendRequest`. | [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 + + +# **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 + + +# **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 + + +# **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 + diff --git a/Apis/PlayermoderationApi.md b/Apis/PlayermoderationApi.md new file mode 100644 index 0000000..c70c067 --- /dev/null +++ b/Apis/PlayermoderationApi.md @@ -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 | + + + +# **clearAllPlayerModerations** +> Success clearAllPlayerModerations() + +Clear All Player Moderations + + ⚠️ **This will delete every single player moderation you'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 + + +# **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's moderations results with \"Can't view someone else's player moderations\" 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 + + +# **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 + + +# **unmoderateUser** +> Success unmoderateUser(ModerateUserRequest) + +Unmoderate User + + Removes a player moderation previously added through `moderateUser`. 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 + diff --git a/Apis/PrintsApi.md b/Apis/PrintsApi.md new file mode 100644 index 0000000..e196588 --- /dev/null +++ b/Apis/PrintsApi.md @@ -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 | + + + +# **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 + + +# **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 + + +# **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 + + +# **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't request other user'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 + + +# **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 + diff --git a/Apis/PropsApi.md b/Apis/PropsApi.md new file mode 100644 index 0000000..6719fcd --- /dev/null +++ b/Apis/PropsApi.md @@ -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 | + + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **updateProp** +> Prop updateProp(propId, UpdatePropRequest) + +Update Prop + + Updates a Prop and returns the updated Prop object. When updating the asset bundle, all of `name`, `assetUrl`, `platform`, `unityVersion`, `assetVersion`, `spawnType`, and `worldPlacementMask` must be present, as well as `propSignature` 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 + diff --git a/Apis/UsersApi.md b/Apis/UsersApi.md new file mode 100644 index 0000000..2301b02 --- /dev/null +++ b/Apis/UsersApi.md @@ -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'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'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 | + + + +# **addTags** +> CurrentUser addTags(userId, ChangeUserTagsRequest) + +Add User Tags + + Adds tags to the user'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 + + +# **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 + + +# **deleteAllUserPersistenceData** +> deleteAllUserPersistenceData(userId) + +Delete All User Persistence Data + + Deletes all of the user'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 + + +# **deleteUserPersistence** +> deleteUserPersistence(userId, worldId) + +Delete User Persistence + + Deletes the user'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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **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 + + +# **getUserAllGroupPermissions** +> Map getUserAllGroupPermissions(userId, groupIds) + +Get user'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 + + +# **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 + + +# **getUserFeedback** +> List getUserFeedback(userId, contentId, n, offset) + +Get User Feedback + + Get user's submitted feedback + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **String**| Must be a valid user ID. | [default to null] | +| **contentId** | **Boolean**| Filter for users' 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 + + +# **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 + + +# **getUserGroupInstancesForGroup** +> getUserGroupInstances_200_response getUserGroupInstancesForGroup(userId, groupId) + +Get User Group Instances for a specific Group + + Returns a list of a group'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 + + +# **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 + + +# **getUserGroups** +> List getUserGroups(userId) + +Get User Groups + + Get user'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 + + +# **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 + + +# **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 + + +# **getUserRepresentedGroup** +> RepresentedGroup getUserRepresentedGroup(userId) + +Get user'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 + + +# **removeTags** +> CurrentUser removeTags(userId, ChangeUserTagsRequest) + +Remove User Tags + + Removes tags from the user'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 + + +# **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 `displayName`. 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'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 + + +# **updateBadge** +> updateBadge(userId, badgeId, UpdateUserBadgeRequest) + +Update User Badge + + Updates a user'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 + + +# **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 + + +# **updateUserNote** +> UserNote updateUserNote(UpdateUserNoteRequest) + +Update User Note + + Updates the currently authenticated user'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 + diff --git a/Apis/WorldsApi.md b/Apis/WorldsApi.md new file mode 100644 index 0000000..16f7822 --- /dev/null +++ b/Apis/WorldsApi.md @@ -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 | + + + +# **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 + + +# **createWorld** +> World createWorld(CreateWorldRequest) + +Create World + + Create a new world. This endpoint requires `assetUrl` to be a valid File object with `.vrcw` file extension, and `imageUrl` 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 + + +# **deleteAllUserPersistenceData** +> deleteAllUserPersistenceData(userId) + +Delete All User Persistence Data + + Deletes all of the user'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 + + +# **deleteUserPersistence** +> deleteUserPersistence(userId, worldId) + +Delete User Persistence + + Deletes the user'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 + + +# **deleteWorld** +> deleteWorld(worldId) + +Delete World + + Delete a world. Notice a world is never fully \"deleted\", only its ReleaseStatus is set to \"hidden\" 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 + + +# **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 + + +# **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 + + +# **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 + + +# **getWorld** +> World getWorld(worldId) + +Get World by ID + + Get information about a specific World. Works unauthenticated but when so will always return `0` 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 + + +# **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 + + +# **getWorldMetadata** +> WorldMetadata getWorldMetadata(worldId) + +Get World Metadata + + Return a worlds custom metadata. This is currently believed to be unused. Metadata can be set with `updateWorld` 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 + + +# **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 + + +# **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 + + +# **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 `me` 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 + + +# **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 + + +# **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 + diff --git a/Models/APIConfig.md b/Models/APIConfig.md new file mode 100644 index 0000000..2aa1f74 --- /dev/null +++ b/Models/APIConfig.md @@ -0,0 +1,134 @@ +# APIConfig +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **CampaignStatus** | **String** | The current platform-wide event taking place | [default to null] | +| **DisableBackgroundPreloads** | **Boolean** | Toggles if certain assets are preloaded in the background | [default to true] | +| **LocationGiftingNonSubPrioEnabled** | **Boolean** | Toggles whether users without a current VRC+ subscription are priority recipients for gift drops | [default to true] | +| **VoiceEnableDegradation** | **Boolean** | Unknown, probably voice optimization testing | [default to false] | +| **VoiceEnableReceiverLimiting** | **Boolean** | Unknown, probably voice optimization testing | [default to true] | +| **accessLogsUrls** | [**APIConfig_accessLogsUrls**](APIConfig_accessLogsUrls.md) | | [default to null] | +| **address** | **String** | VRChat's office address | [default to null] | +| **ageVerificationInviteVisible** | **Boolean** | | [default to null] | +| **ageVerificationP** | **Boolean** | | [default to null] | +| **ageVerificationStatusVisible** | **Boolean** | | [default to null] | +| **analysisMaxRetries** | **Integer** | Max retries for avatar analysis requests | [default to null] | +| **analysisRetryInterval** | **Integer** | Interval between retries for avatar analysis requests | [default to null] | +| **analyticsSegment\_NewUI\_PctOfUsers** | **Integer** | Unknown | [default to null] | +| **analyticsSegment\_NewUI\_Salt** | **String** | Unknown | [default to null] | +| **announcements** | [**Set**](APIConfigAnnouncement.md) | Public Announcements | [default to null] | +| **audioConfig** | [**APIConfigAudioConfig**](APIConfigAudioConfig.md) | | [optional] [default to null] | +| **availableLanguageCodes** | **List** | List of supported Languages | [default to null] | +| **availableLanguages** | **List** | List of supported Languages | [default to null] | +| **avatarPerfLimiter** | [**APIConfig_avatarPerfLimiter**](APIConfig_avatarPerfLimiter.md) | | [default to null] | +| **chatboxLogBufferSeconds** | **Integer** | Unknown | [default to 40] | +| **clientApiKey** | **String** | apiKey to be used for all other requests | [default to null] | +| **clientBPSCeiling** | **Integer** | Unknown | [default to 18432] | +| **clientDisconnectTimeout** | **Integer** | Unknown | [default to 30000] | +| **clientNetDispatchThread** | **Boolean** | Unknown | [optional] [default to false] | +| **clientNetDispatchThreadMobile** | **Boolean** | Unknown | [default to true] | +| **clientNetInThread** | **Boolean** | Unknown | [optional] [default to false] | +| **clientNetInThread2** | **Boolean** | Unknown | [optional] [default to false] | +| **clientNetInThreadMobile** | **Boolean** | Unknown | [optional] [default to false] | +| **clientNetInThreadMobile2** | **Boolean** | Unknown | [optional] [default to false] | +| **clientNetOutThread** | **Boolean** | Unknown | [optional] [default to false] | +| **clientNetOutThread2** | **Boolean** | Unknown | [optional] [default to false] | +| **clientNetOutThreadMobile** | **Boolean** | Unknown | [optional] [default to false] | +| **clientNetOutThreadMobile2** | **Boolean** | Unknown | [optional] [default to false] | +| **clientQR** | **Integer** | Unknown | [optional] [default to 1] | +| **clientReservedPlayerBPS** | **Integer** | Unknown | [default to 7168] | +| **clientSentCountAllowance** | **Integer** | Unknown | [default to 15] | +| **constants** | [**APIConfigConstants**](APIConfigConstants.md) | | [default to null] | +| **contactEmail** | **String** | VRChat's contact email | [default to null] | +| **copyrightEmail** | **String** | VRChat's copyright-issues-related email | [default to null] | +| **copyrightFormUrl** | **String** | VRChat's DMCA claim webform url | [default to null] | +| **currentPrivacyVersion** | **Integer** | Current version number of the Privacy Agreement | [default to 1] | +| **currentTOSVersion** | **Integer** | Current version number of the Terms of Service | [default to null] | +| **defaultAvatar** | **String** | | [default to null] | +| **defaultStickerSet** | **String** | | [default to null] | +| **devLanguageCodes** | **List** | Unknown | [optional] [default to null] | +| **devSdkUrl** | **String** | Link to download the development SDK, use downloadUrls instead | [default to null] | +| **devSdkVersion** | **String** | Version of the development SDK | [default to null] | +| **dis-countdown** | **Date** | Unknown, \"dis\" maybe for disconnect? | [default to null] | +| **disableAVProInProton** | **Boolean** | Unknown | [optional] [default to false] | +| **disableAvatarCopying** | **Boolean** | Toggles if copying avatars should be disabled | [default to false] | +| **disableAvatarGating** | **Boolean** | Toggles if avatar gating should be disabled. Avatar gating restricts uploading of avatars to people with the `system_avatar_access` Tag or `admin_avatar_access` Tag | [default to false] | +| **disableCaptcha** | **Boolean** | Unknown | [optional] [default to true] | +| **disableCommunityLabs** | **Boolean** | Toggles if the Community Labs should be disabled | [default to false] | +| **disableCommunityLabsPromotion** | **Boolean** | Toggles if promotion out of Community Labs should be disabled | [default to false] | +| **disableEmail** | **Boolean** | Unknown | [default to false] | +| **disableEventStream** | **Boolean** | Toggles if Analytics should be disabled. | [default to false] | +| **disableFeedbackGating** | **Boolean** | Toggles if feedback gating should be disabled. Feedback gating restricts submission of feedback (reporting a World or User) to people with the `system_feedback_access` Tag. | [default to false] | +| **disableFrontendBuilds** | **Boolean** | Unknown, probably toggles compilation of frontend web builds? So internal flag? | [default to false] | +| **disableGiftDrops** | **Boolean** | Toggles if gift drops should be disabled | [default to false] | +| **disableHello** | **Boolean** | Unknown | [default to false] | +| **disableOculusSubs** | **Boolean** | Toggles if signing up for Subscriptions in Oculus is disabled or not. | [default to false] | +| **disableRegistration** | **Boolean** | Toggles if new user account registration should be disabled. | [default to false] | +| **disableSteamNetworking** | **Boolean** | Toggles if Steam Networking should be disabled. VRChat these days uses Photon Unity Networking (PUN) instead. | [default to true] | +| **disableTwoFactorAuth** | **Boolean** | Toggles if 2FA should be disabled. | [default to false] | +| **disableUdon** | **Boolean** | Toggles if Udon should be universally disabled in-game. | [default to false] | +| **disableUpgradeAccount** | **Boolean** | Toggles if account upgrading \"linking with Steam/Oculus\" should be disabled. | [default to false] | +| **downloadLinkWindows** | **String** | Download link for game on the Oculus Rift website. | [default to null] | +| **downloadUrls** | [**APIConfigDownloadURLList**](APIConfigDownloadURLList.md) | | [default to null] | +| **dynamicWorldRows** | [**Set**](DynamicContentRow.md) | Array of DynamicWorldRow objects, used by the game to display the list of world rows | [default to null] | +| **economyLedgerBackfill** | **Boolean** | Unknown | [default to null] | +| **economyLedgerMigrationStop** | **String** | Unknown | [default to null] | +| **economyLedgerMode** | **String** | Unknown | [default to null] | +| **economyPauseEnd** | **Date** | Unknown | [default to null] | +| **economyPauseStart** | **Date** | Unknown | [default to null] | +| **economyPurchaseRepairEnabled** | **Boolean** | Unknown | [default to null] | +| **economyState** | **Integer** | Unknown | [default to 1] | +| **events** | [**APIConfigEvents**](APIConfigEvents.md) | | [default to null] | +| **forceUseLatestWorld** | **Boolean** | Unknown | [default to true] | +| **giftDisplayType** | **String** | Display type of gifts | [default to null] | +| **googleApiClientId** | **String** | Unknown | [default to 827942544393-r2ouvckvouldn9dg9uruseje575e878f.apps.googleusercontent.com] | +| **homeWorldId** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [default to null] | +| **homepageRedirectTarget** | **String** | Redirect target if you try to open the base API domain in your browser | [default to https://hello.vrchat.com] | +| **hubWorldId** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [default to null] | +| **imageHostUrlList** | **List** | A list of explicitly allowed origins that worlds can request images from via the Udon's [VRCImageDownloader#DownloadImage](https://creators.vrchat.com/worlds/udon/image-loading/#downloadimage). | [default to null] | +| **iosAppVersion** | **List** | Current app version for iOS | [default to null] | +| **iosVersion** | [**APIConfig_iosVersion**](APIConfig_iosVersion.md) | | [default to null] | +| **jobsEmail** | **String** | VRChat's job application email | [default to null] | +| **maxUserEmoji** | **Integer** | The maximum number of custom emoji each user may have at a given time. | [default to 18] | +| **maxUserStickers** | **Integer** | The maximum number of custom stickers each user may have at a given time. | [default to 18] | +| **minSupportedClientBuildNumber** | [**APIConfig_minSupportedClientBuildNumber**](APIConfig_minSupportedClientBuildNumber.md) | | [default to null] | +| **minimumUnityVersionForUploads** | **String** | Minimum Unity version required for uploading assets | [default to 2019.0.0f1] | +| **moderationEmail** | **String** | VRChat's moderation related email | [default to null] | +| **notAllowedToSelectAvatarInPrivateWorldMessage** | **String** | Used in-game to notify a user they aren't allowed to select avatars in private worlds | [default to null] | +| **offlineAnalysis** | [**APIConfig_offlineAnalysis**](APIConfig_offlineAnalysis.md) | | [default to null] | +| **photonNameserverOverrides** | **List** | Unknown | [default to null] | +| **photonPublicKeys** | **List** | Unknown | [default to null] | +| **player-url-resolver-sha1** | **String** | Currently used youtube-dl.exe hash in SHA1-delimited format | [default to null] | +| **player-url-resolver-version** | **String** | Currently used youtube-dl.exe version | [default to null] | +| **publicKey** | **String** | Public key, hex encoded | [default to null] | +| **reportCategories** | [**Map**](ReportCategory.md) | Categories available for reporting objectionable content | [default to null] | +| **reportFormUrl** | **String** | URL to the report form | [default to https://help.vrchat.com/hc/en-us/requests/new?ticket_form_id=1500000182242&tf_360056455174=user_report&tf_360057451993={userId}&tf_1500001445142={reportedId}&tf_subject={reason} {category} By {contentType} {reportedName}&tf_description={description}] | +| **reportOptions** | [**Map**](map.md) | Options for reporting content. Select a key+value from this mapping as the `type` of the report. Select one key+value from the object at reportOptions[type] as the `category` of the report. reportCategories[category] contains user-facing text to display for all possible categories. Select one value from the array at reportOptions[type][category] as the `reason` of the report. reportReasons[reason] contains user-facing text to display for all possible categories. | [default to null] | +| **reportReasons** | [**Map**](ReportReason.md) | Reasons available for submitting a report | [default to null] | +| **requireAgeVerificationBetaTag** | **Boolean** | | [default to null] | +| **sdkDeveloperFaqUrl** | **String** | Link to the developer FAQ | [default to null] | +| **sdkDiscordUrl** | **String** | Link to the official VRChat Discord | [default to null] | +| **sdkNotAllowedToPublishMessage** | **String** | Used in the SDK to notify a user they aren't allowed to upload avatars/worlds yet | [default to null] | +| **sdkUnityVersion** | **String** | Unity version supported by the SDK | [default to null] | +| **stringHostUrlList** | **List** | A list of explicitly allowed origins that worlds can request strings from via the Udon's [VRCStringDownloader.LoadUrl](https://creators.vrchat.com/worlds/udon/string-loading/#ivrcstringdownload). | [default to null] | +| **supportEmail** | **String** | VRChat's support email | [default to null] | +| **supportFormUrl** | **String** | VRChat's support form | [default to null] | +| **timeOutWorldId** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [default to null] | +| **timekeeping** | **Boolean** | Unknown | [default to true] | +| **tutorialWorldId** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [default to null] | +| **updateRateMsMaximum** | **Integer** | Unknown | [default to null] | +| **updateRateMsMinimum** | **Integer** | Unknown | [default to null] | +| **updateRateMsNormal** | **Integer** | Unknown | [default to null] | +| **updateRateMsUdonManual** | **Integer** | Unknown | [default to null] | +| **uploadAnalysisPercent** | **Integer** | Unknown | [default to null] | +| **urlList** | **List** | List of allowed URLs that bypass the \"Allow untrusted URL's\" setting in-game | [default to null] | +| **useReliableUdpForVoice** | **Boolean** | Unknown | [default to false] | +| **viveWindowsUrl** | **String** | Download link for game on the Steam website. | [default to null] | +| **websocketMaxFriendsRefreshDelay** | **Integer** | Unknown | [default to 900] | +| **websocketQuickReconnectTime** | **Integer** | Unknown | [default to 2] | +| **websocketReconnectMaxDelay** | **Integer** | Unknown | [default to 2] | +| **whiteListedAssetUrls** | **List** | List of allowed URLs that are allowed to host avatar assets | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/APIConfigAnnouncement.md b/Models/APIConfigAnnouncement.md new file mode 100644 index 0000000..f03c293 --- /dev/null +++ b/Models/APIConfigAnnouncement.md @@ -0,0 +1,10 @@ +# APIConfigAnnouncement +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **name** | **String** | Announcement name | [default to null] | +| **text** | **String** | Announcement text | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/APIConfigAudioConfig.md b/Models/APIConfigAudioConfig.md new file mode 100644 index 0000000..0691017 --- /dev/null +++ b/Models/APIConfigAudioConfig.md @@ -0,0 +1,19 @@ +# APIConfigAudioConfig +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **eq** | **BigDecimal** | Unknown | [default to null] | +| **nearFieldILDNudge** | **BigDecimal** | Unknown | [default to null] | +| **nearFieldILDNudgeDistance** | **BigDecimal** | Unknown | [default to null] | +| **nearFieldILDNudgeEarRadius** | **BigDecimal** | Unknown | [default to null] | +| **perEarDirectionalityEarRadius** | **BigDecimal** | Unknown | [default to null] | +| **perEarDirectionalityFadeDistance** | **BigDecimal** | Unknown | [default to null] | +| **perEarDirectionalityMaxScale** | **BigDecimal** | Unknown | [default to null] | +| **perEarDirectionalityPCFactor** | **BigDecimal** | Unknown | [default to null] | +| **trackingScaleMax** | **BigDecimal** | Unknown | [default to null] | +| **trackingScaleMin** | **BigDecimal** | Unknown | [default to null] | +| **trackingScaleMultiplier** | **BigDecimal** | Unknown | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/APIConfigConstants.md b/Models/APIConfigConstants.md new file mode 100644 index 0000000..a2334ff --- /dev/null +++ b/Models/APIConfigConstants.md @@ -0,0 +1,11 @@ +# APIConfigConstants +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **GROUPS** | [**APIConfigConstants_GROUPS**](APIConfigConstants_GROUPS.md) | | [default to null] | +| **INSTANCE** | [**APIConfigConstants_INSTANCE**](APIConfigConstants_INSTANCE.md) | | [default to null] | +| **LANGUAGE** | [**APIConfigConstants_LANGUAGE**](APIConfigConstants_LANGUAGE.md) | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/APIConfigConstants_GROUPS.md b/Models/APIConfigConstants_GROUPS.md new file mode 100644 index 0000000..722f497 --- /dev/null +++ b/Models/APIConfigConstants_GROUPS.md @@ -0,0 +1,18 @@ +# APIConfigConstants_GROUPS +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **CAPACITY** | **Integer** | Maximum group capacity | [optional] [default to 100000] | +| **GROUP\_TRANSFER\_REQUIREMENTS** | **List** | Requirements for transferring group ownership | [optional] [default to null] | +| **MAX\_INVITES\_REQUESTS** | **Integer** | Maximum number of invite requests | [optional] [default to 50] | +| **MAX\_JOINED** | **Integer** | Maximum number of joined groups | [optional] [default to 100] | +| **MAX\_JOINED\_PLUS** | **Integer** | Maximum number of joined groups for VRChat Plus members | [optional] [default to 200] | +| **MAX\_LANGUAGES** | **Integer** | Maximum number of supported languages | [optional] [default to 10] | +| **MAX\_LINKS** | **Integer** | Maximum number of group links | [optional] [default to 3] | +| **MAX\_MANAGEMENT\_ROLES** | **Integer** | Maximum number of management roles in a group | [optional] [default to 5] | +| **MAX\_OWNED** | **Integer** | Maximum number of groups a user can own | [optional] [default to 5] | +| **MAX\_ROLES** | **Integer** | Maximum number of roles in a group | [optional] [default to 50] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/APIConfigConstants_INSTANCE.md b/Models/APIConfigConstants_INSTANCE.md new file mode 100644 index 0000000..4c3af30 --- /dev/null +++ b/Models/APIConfigConstants_INSTANCE.md @@ -0,0 +1,9 @@ +# APIConfigConstants_INSTANCE +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **POPULATION\_BRACKETS** | [**APIConfigConstants_INSTANCE_POPULATION_BRACKETS**](APIConfigConstants_INSTANCE_POPULATION_BRACKETS.md) | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/APIConfigConstants_INSTANCE_POPULATION_BRACKETS.md b/Models/APIConfigConstants_INSTANCE_POPULATION_BRACKETS.md new file mode 100644 index 0000000..fc6cac7 --- /dev/null +++ b/Models/APIConfigConstants_INSTANCE_POPULATION_BRACKETS.md @@ -0,0 +1,11 @@ +# APIConfigConstants_INSTANCE_POPULATION_BRACKETS +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **CROWDED** | [**APIConfigConstants_INSTANCE_POPULATION_BRACKETS_CROWDED**](APIConfigConstants_INSTANCE_POPULATION_BRACKETS_CROWDED.md) | | [optional] [default to null] | +| **FEW** | [**APIConfigConstants_INSTANCE_POPULATION_BRACKETS_FEW**](APIConfigConstants_INSTANCE_POPULATION_BRACKETS_FEW.md) | | [optional] [default to null] | +| **MANY** | [**APIConfigConstants_INSTANCE_POPULATION_BRACKETS_MANY**](APIConfigConstants_INSTANCE_POPULATION_BRACKETS_MANY.md) | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/APIConfigConstants_INSTANCE_POPULATION_BRACKETS_CROWDED.md b/Models/APIConfigConstants_INSTANCE_POPULATION_BRACKETS_CROWDED.md new file mode 100644 index 0000000..22fa020 --- /dev/null +++ b/Models/APIConfigConstants_INSTANCE_POPULATION_BRACKETS_CROWDED.md @@ -0,0 +1,10 @@ +# APIConfigConstants_INSTANCE_POPULATION_BRACKETS_CROWDED +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **max** | **Integer** | Maximum population for a crowded instance | [optional] [default to null] | +| **min** | **Integer** | Minimum population for a crowded instance | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/APIConfigConstants_INSTANCE_POPULATION_BRACKETS_FEW.md b/Models/APIConfigConstants_INSTANCE_POPULATION_BRACKETS_FEW.md new file mode 100644 index 0000000..8b4cf9d --- /dev/null +++ b/Models/APIConfigConstants_INSTANCE_POPULATION_BRACKETS_FEW.md @@ -0,0 +1,10 @@ +# APIConfigConstants_INSTANCE_POPULATION_BRACKETS_FEW +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **max** | **Integer** | Maximum population for a few instance | [optional] [default to null] | +| **min** | **Integer** | Minimum population for a few instance | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/APIConfigConstants_INSTANCE_POPULATION_BRACKETS_MANY.md b/Models/APIConfigConstants_INSTANCE_POPULATION_BRACKETS_MANY.md new file mode 100644 index 0000000..1c8f09c --- /dev/null +++ b/Models/APIConfigConstants_INSTANCE_POPULATION_BRACKETS_MANY.md @@ -0,0 +1,10 @@ +# APIConfigConstants_INSTANCE_POPULATION_BRACKETS_MANY +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **max** | **Integer** | Maximum population for a many instance | [optional] [default to null] | +| **min** | **Integer** | Minimum population for a many instance | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/APIConfigConstants_LANGUAGE.md b/Models/APIConfigConstants_LANGUAGE.md new file mode 100644 index 0000000..4c1ce87 --- /dev/null +++ b/Models/APIConfigConstants_LANGUAGE.md @@ -0,0 +1,9 @@ +# APIConfigConstants_LANGUAGE +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **SPOKEN\_LANGUAGE\_OPTIONS** | **Map** | Supported spoken language options | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/APIConfigDownloadURLList.md b/Models/APIConfigDownloadURLList.md new file mode 100644 index 0000000..1c04773 --- /dev/null +++ b/Models/APIConfigDownloadURLList.md @@ -0,0 +1,13 @@ +# APIConfigDownloadURLList +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **bootstrap** | **String** | Download link for ??? | [default to null] | +| **sdk2** | **String** | Download link for legacy SDK2 | [default to null] | +| **sdk3-avatars** | **String** | Download link for SDK3 for Avatars | [default to null] | +| **sdk3-worlds** | **String** | Download link for SDK3 for Worlds | [default to null] | +| **vcc** | **String** | Download link for the Creator Companion | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/APIConfigEvents.md b/Models/APIConfigEvents.md new file mode 100644 index 0000000..341291d --- /dev/null +++ b/Models/APIConfigEvents.md @@ -0,0 +1,19 @@ +# APIConfigEvents +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **distanceClose** | **Integer** | Unknown | [default to null] | +| **distanceFactor** | **Integer** | Unknown | [default to null] | +| **distanceFar** | **Integer** | Unknown | [default to null] | +| **groupDistance** | **Integer** | Unknown | [default to null] | +| **maximumBunchSize** | **Integer** | Unknown | [default to null] | +| **notVisibleFactor** | **Integer** | Unknown | [default to null] | +| **playerOrderBucketSize** | **Integer** | Unknown | [default to null] | +| **playerOrderFactor** | **Integer** | Unknown | [default to null] | +| **slowUpdateFactorThreshold** | **Integer** | Unknown | [default to null] | +| **useDirectPlayerSerialization** | **Boolean** | Unknown | [default to null] | +| **viewSegmentLength** | **Integer** | Unknown | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/APIConfig_accessLogsUrls.md b/Models/APIConfig_accessLogsUrls.md new file mode 100644 index 0000000..c4476c0 --- /dev/null +++ b/Models/APIConfig_accessLogsUrls.md @@ -0,0 +1,12 @@ +# APIConfig_accessLogsUrls +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **Default** | **URI** | | [optional] [default to null] | +| **Pico** | **URI** | | [optional] [default to null] | +| **Quest** | **URI** | | [optional] [default to null] | +| **XRElite** | **URI** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/APIConfig_avatarPerfLimiter.md b/Models/APIConfig_avatarPerfLimiter.md new file mode 100644 index 0000000..bbcf766 --- /dev/null +++ b/Models/APIConfig_avatarPerfLimiter.md @@ -0,0 +1,14 @@ +# APIConfig_avatarPerfLimiter +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **AndroidMobile** | [**PerformanceLimiterInfo**](PerformanceLimiterInfo.md) | | [default to null] | +| **PC** | [**PerformanceLimiterInfo**](PerformanceLimiterInfo.md) | | [default to null] | +| **Pico** | [**PerformanceLimiterInfo**](PerformanceLimiterInfo.md) | | [default to null] | +| **Quest** | [**PerformanceLimiterInfo**](PerformanceLimiterInfo.md) | | [default to null] | +| **XRElite** | [**PerformanceLimiterInfo**](PerformanceLimiterInfo.md) | | [default to null] | +| **iOSMobile** | [**PerformanceLimiterInfo**](PerformanceLimiterInfo.md) | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/APIConfig_iosVersion.md b/Models/APIConfig_iosVersion.md new file mode 100644 index 0000000..b01d43f --- /dev/null +++ b/Models/APIConfig_iosVersion.md @@ -0,0 +1,10 @@ +# APIConfig_iosVersion +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **major** | **Integer** | | [default to null] | +| **minor** | **Integer** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/APIConfig_minSupportedClientBuildNumber.md b/Models/APIConfig_minSupportedClientBuildNumber.md new file mode 100644 index 0000000..9d09679 --- /dev/null +++ b/Models/APIConfig_minSupportedClientBuildNumber.md @@ -0,0 +1,19 @@ +# APIConfig_minSupportedClientBuildNumber +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **AppStore** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | [default to null] | +| **Default** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | [default to null] | +| **Firebase** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | [default to null] | +| **FirebaseiOS** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | [default to null] | +| **GooglePlay** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | [default to null] | +| **PC** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | [default to null] | +| **PicoStore** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | [default to null] | +| **QuestAppLab** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | [default to null] | +| **QuestStore** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | [default to null] | +| **TestFlight** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | [default to null] | +| **XRElite** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/APIConfig_offlineAnalysis.md b/Models/APIConfig_offlineAnalysis.md new file mode 100644 index 0000000..9037a78 --- /dev/null +++ b/Models/APIConfig_offlineAnalysis.md @@ -0,0 +1,10 @@ +# APIConfig_offlineAnalysis +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **android** | **Boolean** | Whether to allow offline analysis | [optional] [default to true] | +| **standalonewindows** | **Boolean** | Whether to allow offline analysis | [optional] [default to true] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/APIHealth.md b/Models/APIHealth.md new file mode 100644 index 0000000..23907c6 --- /dev/null +++ b/Models/APIHealth.md @@ -0,0 +1,11 @@ +# APIHealth +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **buildVersionTag** | **String** | | [default to null] | +| **ok** | **Boolean** | | [default to null] | +| **serverName** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/AccountDeletionLog.md b/Models/AccountDeletionLog.md new file mode 100644 index 0000000..b4c7617 --- /dev/null +++ b/Models/AccountDeletionLog.md @@ -0,0 +1,11 @@ +# AccountDeletionLog +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **dateTime** | **Date** | Date and time of the deletion request. | [optional] [default to null] | +| **deletionScheduled** | **Date** | When the deletion is scheduled to happen, standard is 14 days after the request. | [optional] [default to null] | +| **message** | **String** | Typically \"Deletion requested\" or \"Deletion canceled\". Other messages like \"Deletion completed\" may exist, but are these are not possible to see as a regular user. | [optional] [default to Deletion requested] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/AddGroupGalleryImageRequest.md b/Models/AddGroupGalleryImageRequest.md new file mode 100644 index 0000000..b1910ea --- /dev/null +++ b/Models/AddGroupGalleryImageRequest.md @@ -0,0 +1,9 @@ +# AddGroupGalleryImageRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **fileId** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/AdminAssetBundle.md b/Models/AdminAssetBundle.md new file mode 100644 index 0000000..fd615a8 --- /dev/null +++ b/Models/AdminAssetBundle.md @@ -0,0 +1,21 @@ +# AdminAssetBundle +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **\_created\_at** | **Date** | | [default to null] | +| **\_updated\_at** | **Date** | | [default to null] | +| **assetType** | **String** | | [default to null] | +| **authorId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **authorName** | **String** | | [default to null] | +| **description** | **String** | | [default to null] | +| **imageUrl** | **String** | | [default to null] | +| **name** | **String** | | [default to null] | +| **releaseStatus** | **String** | | [default to public] | +| **tags** | **List** | | [default to null] | +| **thumbnailImageUrl** | **String** | | [default to null] | +| **unityPackageUrl** | **String** | | [default to null] | +| **unityPackages** | [**Set**](AdminUnityPackage.md) | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/AdminUnityPackage.md b/Models/AdminUnityPackage.md new file mode 100644 index 0000000..c3e0f98 --- /dev/null +++ b/Models/AdminUnityPackage.md @@ -0,0 +1,13 @@ +# AdminUnityPackage +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **assetUrl** | **String** | | [default to null] | +| **assetVersion** | **Integer** | | [default to null] | +| **platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [default to null] | +| **unityVersion** | **String** | | [default to 2022.3.22f1-DWR] | +| **variant** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Agreement.md b/Models/Agreement.md new file mode 100644 index 0000000..064f165 --- /dev/null +++ b/Models/Agreement.md @@ -0,0 +1,16 @@ +# Agreement +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **agreementCode** | **String** | The type of agreement. | [default to content.copyright.owned] | +| **agreementFulltext** | **String** | The full text of the agreement. | [optional] [default to null] | +| **contentId** | **String** | The id of the content being uploaded, such as a WorldID, AvatarID, or PropID. | [default to null] | +| **created** | **String** | When the agreement was created | [default to null] | +| **id** | **String** | The id of the agreement. | [default to null] | +| **tags** | **List** | | [default to null] | +| **userId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **version** | **Integer** | The version of the agreement. | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/AgreementRequest.md b/Models/AgreementRequest.md new file mode 100644 index 0000000..235b6a7 --- /dev/null +++ b/Models/AgreementRequest.md @@ -0,0 +1,12 @@ +# AgreementRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **agreementCode** | **String** | The type of agreement. | [default to content.copyright.owned] | +| **agreementFulltext** | **String** | The full text of the agreement (currently `By clicking OK, I certify that I have the necessary rights to upload this content and that it will not infringe on any third-party legal or intellectual property rights.`). | [default to null] | +| **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] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/AgreementStatus.md b/Models/AgreementStatus.md new file mode 100644 index 0000000..8987bdd --- /dev/null +++ b/Models/AgreementStatus.md @@ -0,0 +1,13 @@ +# AgreementStatus +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **agreed** | **Boolean** | Whether the user has agreed for this content. | [default to null] | +| **agreementCode** | **String** | The type of agreement. | [default to content.copyright.owned] | +| **contentId** | **String** | The id of the content being uploaded, such as a WorldID, AvatarID, or PropID. | [default to null] | +| **userId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **version** | **Integer** | The version of the agreement. | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Avatar.md b/Models/Avatar.md new file mode 100644 index 0000000..5643328 --- /dev/null +++ b/Models/Avatar.md @@ -0,0 +1,38 @@ +# Avatar +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **acknowledgements** | **String** | | [optional] [default to null] | +| **activeAssetReviewId** | **String** | Only present for the avatar author on avatars under active review. | [optional] [default to null] | +| **assetUrl** | **String** | Not present from general search `/avatars`, only on specific requests `/avatars/{avatarId}`. | [optional] [default to null] | +| **assetUrlObject** | [**Object**](.md) | Not present from general search `/avatars`, only on specific requests `/avatars/{avatarId}`. **Deprecation:** `Object` has unknown usage/fields, and is always empty. Use normal `Url` field instead. | [optional] [default to null] | +| **authorId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **authorName** | **String** | | [default to null] | +| **created\_at** | **Date** | | [default to null] | +| **description** | **String** | | [default to null] | +| **featured** | **Boolean** | | [default to false] | +| **highestPrice** | **Integer** | | [optional] [default to null] | +| **id** | **String** | | [default to null] | +| **imageUrl** | **String** | | [default to null] | +| **listingDate** | **String** | | [default to null] | +| **lock** | **Boolean** | | [optional] [default to null] | +| **lowestPrice** | **Integer** | | [optional] [default to null] | +| **name** | **String** | | [default to null] | +| **pendingUpload** | **Boolean** | | [optional] [default to false] | +| **performance** | [**Avatar_performance**](Avatar_performance.md) | | [default to null] | +| **productId** | **String** | | [optional] [default to null] | +| **publishedListings** | [**List**](Avatar_publishedListings_inner.md) | | [optional] [default to null] | +| **releaseStatus** | **String** | | [default to public] | +| **searchable** | **Boolean** | | [optional] [default to false] | +| **styles** | [**Avatar_styles**](Avatar_styles.md) | | [default to null] | +| **tags** | **List** | | [default to null] | +| **thumbnailImageUrl** | **String** | | [default to null] | +| **unityPackageUrl** | **String** | | [default to null] | +| **unityPackageUrlObject** | [**Avatar_unityPackageUrlObject**](Avatar_unityPackageUrlObject.md) | | [default to null] | +| **unityPackages** | [**Set**](UnityPackage.md) | | [default to null] | +| **updated\_at** | **Date** | | [default to null] | +| **version** | **Integer** | | [default to 0] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/AvatarModeration.md b/Models/AvatarModeration.md new file mode 100644 index 0000000..e75100d --- /dev/null +++ b/Models/AvatarModeration.md @@ -0,0 +1,11 @@ +# AvatarModeration +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **avatarModerationType** | **String** | | [default to null] | +| **created** | **Date** | | [default to null] | +| **targetAvatarId** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/AvatarModerationCreated.md b/Models/AvatarModerationCreated.md new file mode 100644 index 0000000..f78fe44 --- /dev/null +++ b/Models/AvatarModerationCreated.md @@ -0,0 +1,11 @@ +# AvatarModerationCreated +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **avatarModerationType** | **String** | | [default to null] | +| **created** | **Long** | Timestamp in milliseconds since Unix epoch | [default to null] | +| **targetAvatarId** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/AvatarStyle.md b/Models/AvatarStyle.md new file mode 100644 index 0000000..e9a5e74 --- /dev/null +++ b/Models/AvatarStyle.md @@ -0,0 +1,10 @@ +# AvatarStyle +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **id** | **String** | | [default to null] | +| **styleName** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Avatar_performance.md b/Models/Avatar_performance.md new file mode 100644 index 0000000..51eab4a --- /dev/null +++ b/Models/Avatar_performance.md @@ -0,0 +1,14 @@ +# Avatar_performance +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **android** | **String** | | [optional] [default to null] | +| **android-sort** | **Integer** | | [optional] [default to null] | +| **ios** | **String** | | [optional] [default to null] | +| **ios-sort** | **Integer** | | [optional] [default to null] | +| **standalonewindows** | **String** | | [optional] [default to null] | +| **standalonewindows-sort** | **Integer** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Avatar_publishedListings_inner.md b/Models/Avatar_publishedListings_inner.md new file mode 100644 index 0000000..67ee31f --- /dev/null +++ b/Models/Avatar_publishedListings_inner.md @@ -0,0 +1,14 @@ +# Avatar_publishedListings_inner +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **description** | **String** | | [optional] [default to null] | +| **displayName** | **String** | | [optional] [default to null] | +| **imageId** | **String** | | [optional] [default to null] | +| **listingId** | **String** | | [optional] [default to null] | +| **listingType** | **String** | | [optional] [default to null] | +| **priceTokens** | **Integer** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Avatar_styles.md b/Models/Avatar_styles.md new file mode 100644 index 0000000..60ebf01 --- /dev/null +++ b/Models/Avatar_styles.md @@ -0,0 +1,11 @@ +# Avatar_styles +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **primary** | **String** | | [optional] [default to null] | +| **secondary** | **String** | | [optional] [default to null] | +| **supplementary** | **List** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Avatar_unityPackageUrlObject.md b/Models/Avatar_unityPackageUrlObject.md new file mode 100644 index 0000000..ccd901b --- /dev/null +++ b/Models/Avatar_unityPackageUrlObject.md @@ -0,0 +1,9 @@ +# Avatar_unityPackageUrlObject +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **unityPackageUrl** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Badge.md b/Models/Badge.md new file mode 100644 index 0000000..6c85511 --- /dev/null +++ b/Models/Badge.md @@ -0,0 +1,16 @@ +# Badge +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **assignedAt** | **Date** | only present in CurrentUser badges | [optional] [default to null] | +| **badgeDescription** | **String** | | [default to null] | +| **badgeId** | **String** | | [default to null] | +| **badgeImageUrl** | **String** | direct url to image | [default to null] | +| **badgeName** | **String** | | [default to null] | +| **hidden** | **Boolean** | only present in CurrentUser badges | [optional] [default to null] | +| **showcased** | **Boolean** | | [default to null] | +| **updatedAt** | **Date** | only present in CurrentUser badges | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Balance.md b/Models/Balance.md new file mode 100644 index 0000000..2f4864f --- /dev/null +++ b/Models/Balance.md @@ -0,0 +1,11 @@ +# Balance +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **balance** | **Integer** | | [default to 0] | +| **noTransactions** | **Boolean** | | [optional] [default to null] | +| **tiliaResponse** | **Boolean** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/BanGroupMemberRequest.md b/Models/BanGroupMemberRequest.md new file mode 100644 index 0000000..ecf1b35 --- /dev/null +++ b/Models/BanGroupMemberRequest.md @@ -0,0 +1,9 @@ +# BanGroupMemberRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **userId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/BoopRequest.md b/Models/BoopRequest.md new file mode 100644 index 0000000..24e12ba --- /dev/null +++ b/Models/BoopRequest.md @@ -0,0 +1,11 @@ +# BoopRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **emojiId** | **String** | Either a FileID or a string constant for default emojis | [optional] [default to null] | +| **emojiVersion** | **Integer** | | [optional] [default to null] | +| **inventoryItemId** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CalendarEvent.md b/Models/CalendarEvent.md new file mode 100644 index 0000000..e8423ba --- /dev/null +++ b/Models/CalendarEvent.md @@ -0,0 +1,38 @@ +# CalendarEvent +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **accessType** | **String** | Who the event is for | [default to public] | +| **category** | **String** | The activity intended to take place at an event | [default to other] | +| **closeInstanceAfterEndMinutes** | **Integer** | | [optional] [default to null] | +| **createdAt** | **Date** | | [optional] [default to null] | +| **deletedAt** | **Date** | | [optional] [default to null] | +| **description** | **String** | | [default to null] | +| **durationInMs** | **Long** | | [optional] [default to null] | +| **endsAt** | **Date** | | [default to null] | +| **featured** | **Boolean** | | [optional] [default to null] | +| **guestEarlyJoinMinutes** | **Integer** | | [optional] [default to null] | +| **hostEarlyJoinMinutes** | **Integer** | | [optional] [default to null] | +| **id** | **String** | | [default to null] | +| **imageId** | **String** | | [optional] [default to null] | +| **imageUrl** | **String** | | [optional] [default to null] | +| **interestedUserCount** | **Integer** | | [optional] [default to null] | +| **isDraft** | **Boolean** | | [optional] [default to null] | +| **languages** | **List** | Languages that might be spoken at this event | [optional] [default to null] | +| **occurrenceKind** | **String** | So far if it exists, always the string \"single\" | [optional] [default to null] | +| **ownerId** | **String** | | [optional] [default to null] | +| **platforms** | **List** | | [optional] [default to null] | +| **recurrence** | **String** | So far unused, always \"null\" | [optional] [default to null] | +| **roleIds** | **List** | Group roles that may join this event | [optional] [default to null] | +| **seriesId** | **String** | So far unused, always \"null\" | [optional] [default to null] | +| **startsAt** | **Date** | | [default to null] | +| **tags** | **List** | Custom tags for this event | [optional] [default to null] | +| **title** | **String** | | [default to null] | +| **type** | **String** | | [optional] [default to null] | +| **updatedAt** | **Date** | | [optional] [default to null] | +| **userInterest** | [**CalendarEvent_userInterest**](CalendarEvent_userInterest.md) | | [optional] [default to null] | +| **usesInstanceOverflow** | **Boolean** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CalendarEventDiscovery.md b/Models/CalendarEventDiscovery.md new file mode 100644 index 0000000..fc11194 --- /dev/null +++ b/Models/CalendarEventDiscovery.md @@ -0,0 +1,10 @@ +# CalendarEventDiscovery +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **nextCursor** | **String** | Base64-encoded JSON: type: object properties: dataSource: type: string enum: - featured - personalized dataIndex: type: integer format: int32 phase: type: string enum: - all - live - upcoming description: see CalendarEventDiscoveryScope asOf: type: integer format: int64 description: milliseconds since Unix epoch paramHash: type: string format: string description: Base64-encoded 256-bit hash of the original query parameters | [default to null] | +| **results** | [**List**](CalendarEvent.md) | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CalendarEvent_userInterest.md b/Models/CalendarEvent_userInterest.md new file mode 100644 index 0000000..31ee2dd --- /dev/null +++ b/Models/CalendarEvent_userInterest.md @@ -0,0 +1,11 @@ +# CalendarEvent_userInterest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **createdAt** | **Date** | | [optional] [default to null] | +| **isFollowing** | **Boolean** | | [optional] [default to null] | +| **updatedAt** | **Date** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/ChangeUserTagsRequest.md b/Models/ChangeUserTagsRequest.md new file mode 100644 index 0000000..1c2333d --- /dev/null +++ b/Models/ChangeUserTagsRequest.md @@ -0,0 +1,9 @@ +# ChangeUserTagsRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **tags** | **List** | The tags being added or removed. | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CreateAvatarModerationRequest.md b/Models/CreateAvatarModerationRequest.md new file mode 100644 index 0000000..b7e6414 --- /dev/null +++ b/Models/CreateAvatarModerationRequest.md @@ -0,0 +1,10 @@ +# CreateAvatarModerationRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **avatarModerationType** | **String** | | [default to null] | +| **targetAvatarId** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CreateAvatarRequest.md b/Models/CreateAvatarRequest.md new file mode 100644 index 0000000..b290500 --- /dev/null +++ b/Models/CreateAvatarRequest.md @@ -0,0 +1,24 @@ +# CreateAvatarRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **assetUrl** | **String** | | [optional] [default to null] | +| **assetVersion** | **String** | | [optional] [default to null] | +| **created\_at** | **String** | A date and time of the pattern `M/d/yyyy h:mm:ss tt` (see C Sharp `System.DateTime`) | [optional] [default to null] | +| **description** | **String** | | [optional] [default to null] | +| **featured** | **Boolean** | Enabling featured tag requires Admin Credentials. | [optional] [default to null] | +| **id** | **String** | | [optional] [default to null] | +| **imageUrl** | **String** | | [default to null] | +| **name** | **String** | | [default to null] | +| **platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [optional] [default to null] | +| **releaseStatus** | **String** | | [optional] [default to public] | +| **tags** | **List** | | [optional] [default to null] | +| **thumbnailImageUrl** | **String** | | [optional] [default to null] | +| **unityPackageUrl** | **String** | | [optional] [default to null] | +| **unityVersion** | **String** | | [optional] [default to 5.3.4p1] | +| **updated\_at** | **String** | A date and time of the pattern `M/d/yyyy h:mm:ss tt` (see C Sharp `System.DateTime`) | [optional] [default to null] | +| **version** | **Integer** | | [optional] [default to 1] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CreateCalendarEventRequest.md b/Models/CreateCalendarEventRequest.md new file mode 100644 index 0000000..062b09c --- /dev/null +++ b/Models/CreateCalendarEventRequest.md @@ -0,0 +1,27 @@ +# CreateCalendarEventRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **accessType** | **String** | Who the event is for | [default to public] | +| **category** | **String** | The activity intended to take place at an event | [default to other] | +| **closeInstanceAfterEndMinutes** | **Integer** | | [optional] [default to null] | +| **description** | **String** | | [default to null] | +| **endsAt** | **Date** | Time the event ends at | [default to null] | +| **featured** | **Boolean** | | [optional] [default to null] | +| **guestEarlyJoinMinutes** | **Integer** | | [optional] [default to null] | +| **hostEarlyJoinMinutes** | **Integer** | | [optional] [default to null] | +| **imageId** | **String** | | [optional] [default to null] | +| **isDraft** | **Boolean** | | [optional] [default to null] | +| **languages** | **List** | | [optional] [default to null] | +| **parentId** | **String** | | [optional] [default to null] | +| **platforms** | **List** | | [optional] [default to null] | +| **roleIds** | **List** | | [optional] [default to null] | +| **sendCreationNotification** | **Boolean** | Send notification to group members. | [default to null] | +| **startsAt** | **Date** | Time the event starts at | [default to null] | +| **tags** | **List** | | [optional] [default to null] | +| **title** | **String** | Event title | [default to null] | +| **usesInstanceOverflow** | **Boolean** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CreateFileRequest.md b/Models/CreateFileRequest.md new file mode 100644 index 0000000..880cada --- /dev/null +++ b/Models/CreateFileRequest.md @@ -0,0 +1,12 @@ +# CreateFileRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **extension** | **String** | | [default to null] | +| **mimeType** | **String** | | [default to image/jpeg] | +| **name** | **String** | | [default to null] | +| **tags** | **List** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CreateFileVersionRequest.md b/Models/CreateFileVersionRequest.md new file mode 100644 index 0000000..c48cbff --- /dev/null +++ b/Models/CreateFileVersionRequest.md @@ -0,0 +1,12 @@ +# CreateFileVersionRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **fileMd5** | **String** | | [optional] [default to null] | +| **fileSizeInBytes** | **Integer** | | [optional] [default to null] | +| **signatureMd5** | **String** | | [default to null] | +| **signatureSizeInBytes** | **Integer** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CreateGroupAnnouncementRequest.md b/Models/CreateGroupAnnouncementRequest.md new file mode 100644 index 0000000..9ae5baf --- /dev/null +++ b/Models/CreateGroupAnnouncementRequest.md @@ -0,0 +1,12 @@ +# CreateGroupAnnouncementRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **imageId** | **String** | | [optional] [default to null] | +| **sendNotification** | **Boolean** | Send notification to group members. | [optional] [default to false] | +| **text** | **String** | Announcement text | [optional] [default to null] | +| **title** | **String** | Announcement title | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CreateGroupGalleryRequest.md b/Models/CreateGroupGalleryRequest.md new file mode 100644 index 0000000..a12a268 --- /dev/null +++ b/Models/CreateGroupGalleryRequest.md @@ -0,0 +1,15 @@ +# CreateGroupGalleryRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **description** | **String** | Description of the gallery. | [optional] [default to null] | +| **membersOnly** | **Boolean** | Whether the gallery is members only. | [optional] [default to false] | +| **name** | **String** | Name of the gallery. | [default to null] | +| **roleIdsToAutoApprove** | **List** | | [optional] [default to null] | +| **roleIdsToManage** | **List** | | [optional] [default to null] | +| **roleIdsToSubmit** | **List** | | [optional] [default to null] | +| **roleIdsToView** | **List** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CreateGroupInviteRequest.md b/Models/CreateGroupInviteRequest.md new file mode 100644 index 0000000..9a25a1b --- /dev/null +++ b/Models/CreateGroupInviteRequest.md @@ -0,0 +1,10 @@ +# CreateGroupInviteRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **confirmOverrideBlock** | **Boolean** | | [optional] [default to true] | +| **userId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CreateGroupPostRequest.md b/Models/CreateGroupPostRequest.md new file mode 100644 index 0000000..78408a8 --- /dev/null +++ b/Models/CreateGroupPostRequest.md @@ -0,0 +1,14 @@ +# CreateGroupPostRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **imageId** | **String** | | [optional] [default to null] | +| **roleIds** | **List** | | [optional] [default to null] | +| **sendNotification** | **Boolean** | Send notification to group members. | [default to false] | +| **text** | **String** | Post text | [default to null] | +| **title** | **String** | Post title | [default to null] | +| **visibility** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CreateGroupRequest.md b/Models/CreateGroupRequest.md new file mode 100644 index 0000000..bfa01bd --- /dev/null +++ b/Models/CreateGroupRequest.md @@ -0,0 +1,16 @@ +# CreateGroupRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **bannerId** | **String** | | [optional] [default to null] | +| **description** | **String** | | [optional] [default to null] | +| **iconId** | **String** | | [optional] [default to null] | +| **joinState** | **String** | | [optional] [default to open] | +| **name** | **String** | | [default to null] | +| **privacy** | **String** | | [optional] [default to default] | +| **roleTemplate** | **String** | | [default to default] | +| **shortCode** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CreateGroupRequest_1.md b/Models/CreateGroupRequest_1.md new file mode 100644 index 0000000..e07ddc2 --- /dev/null +++ b/Models/CreateGroupRequest_1.md @@ -0,0 +1,13 @@ +# CreateGroupRequest_1 +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **description** | **String** | | [optional] [default to null] | +| **id** | **String** | | [optional] [default to null] | +| **isSelfAssignable** | **Boolean** | | [optional] [default to false] | +| **name** | **String** | | [optional] [default to null] | +| **permissions** | **List** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CreateInstanceRequest.md b/Models/CreateInstanceRequest.md new file mode 100644 index 0000000..66b823d --- /dev/null +++ b/Models/CreateInstanceRequest.md @@ -0,0 +1,25 @@ +# CreateInstanceRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **ageGate** | **Boolean** | | [optional] [default to false] | +| **calendarEntryId** | **String** | | [optional] [default to null] | +| **canRequestInvite** | **Boolean** | Only applies to invite type instances to make them invite+ | [optional] [default to false] | +| **closedAt** | **Date** | The time after which users won't be allowed to join the instance. This doesn't work for public instances. | [optional] [default to null] | +| **contentSettings** | [**InstanceContentSettings**](InstanceContentSettings.md) | | [optional] [default to null] | +| **displayName** | **String** | | [optional] [default to null] | +| **groupAccessType** | **String** | Group access type when the instance type is \"group\" | [optional] [default to members] | +| **hardClose** | **Boolean** | Currently unused, but will eventually be a flag to set if the closing of the instance should kick people. | [optional] [default to false] | +| **instancePersistenceEnabled** | **Boolean** | | [optional] [default to null] | +| **inviteOnly** | **Boolean** | | [optional] [default to false] | +| **ownerId** | **String** | A groupId if the instance type is \"group\", null if instance type is public, or a userId otherwise | [optional] [default to null] | +| **playerPersistenceEnabled** | **Boolean** | | [optional] [default to null] | +| **queueEnabled** | **Boolean** | | [optional] [default to false] | +| **region** | **String** | Instance region | [default to us] | +| **roleIds** | **List** | Group roleIds that are allowed to join if the type is \"group\" and groupAccessType is \"member\" | [optional] [default to null] | +| **type** | **String** | | [default to null] | +| **worldId** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CreatePropRequest.md b/Models/CreatePropRequest.md new file mode 100644 index 0000000..95b8d3b --- /dev/null +++ b/Models/CreatePropRequest.md @@ -0,0 +1,20 @@ +# CreatePropRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **assetUrl** | **String** | | [default to null] | +| **assetVersion** | **Integer** | | [default to null] | +| **description** | **String** | | [default to null] | +| **id** | **String** | | [default to null] | +| **imageUrl** | **String** | | [default to null] | +| **name** | **String** | | [default to null] | +| **platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [default to null] | +| **propSignature** | **String** | | [optional] [default to null] | +| **spawnType** | **Integer** | How a prop is summoned and interacted with. 0: the prop fixed to some surface in the world 1: the prop is a pickup and may be held by users 2: ??? | [default to 1] | +| **tags** | **List** | | [default to null] | +| **unityVersion** | **String** | | [default to null] | +| **worldPlacementMask** | **Integer** | Bitmask for restrictions on what world surfaces a prop may be summoned. 0: no restrictions 1: floors 2: walls 4: ceilings | [default to 1] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CreateWorldRequest.md b/Models/CreateWorldRequest.md new file mode 100644 index 0000000..ad4ed75 --- /dev/null +++ b/Models/CreateWorldRequest.md @@ -0,0 +1,22 @@ +# CreateWorldRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **assetUrl** | **String** | | [default to null] | +| **assetVersion** | **Integer** | | [optional] [default to null] | +| **authorId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **authorName** | **String** | | [optional] [default to null] | +| **capacity** | **Integer** | | [optional] [default to null] | +| **description** | **String** | | [optional] [default to null] | +| **id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [optional] [default to null] | +| **imageUrl** | **String** | | [default to null] | +| **name** | **String** | | [default to null] | +| **platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [optional] [default to null] | +| **releaseStatus** | **String** | | [optional] [default to public] | +| **tags** | **List** | | [optional] [default to null] | +| **unityPackageUrl** | **String** | | [optional] [default to null] | +| **unityVersion** | **String** | | [optional] [default to 5.3.4p1] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CurrentUser.md b/Models/CurrentUser.md new file mode 100644 index 0000000..3979ec4 --- /dev/null +++ b/Models/CurrentUser.md @@ -0,0 +1,84 @@ +# CurrentUser +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **acceptedPrivacyVersion** | **Integer** | | [optional] [default to null] | +| **acceptedTOSVersion** | **Integer** | | [default to null] | +| **accountDeletionDate** | **date** | | [optional] [default to null] | +| **accountDeletionLog** | [**List**](AccountDeletionLog.md) | | [optional] [default to null] | +| **activeFriends** | **List** | | [optional] [default to null] | +| **ageVerificationStatus** | **String** | `verified` is obsolete. User who have verified and are 18+ can switch to `plus18` status. | [default to null] | +| **ageVerified** | **Boolean** | `true` if, user is age verified (not 18+). | [default to null] | +| **allowAvatarCopying** | **Boolean** | | [default to null] | +| **authToken** | **String** | The auth token for NEWLY REGISTERED ACCOUNTS ONLY (/auth/register) | [optional] [default to null] | +| **badges** | [**List**](Badge.md) | | [optional] [default to null] | +| **bio** | **String** | | [default to null] | +| **bioLinks** | **List** | | [default to null] | +| **contentFilters** | **List** | These tags begin with `content_` and control content gating | [optional] [default to null] | +| **currentAvatar** | **String** | | [default to null] | +| **currentAvatarImageUrl** | **String** | When profilePicOverride is not empty, use it instead. | [default to null] | +| **currentAvatarTags** | **List** | | [default to null] | +| **currentAvatarThumbnailImageUrl** | **String** | When profilePicOverride is not empty, use it instead. | [default to null] | +| **date\_joined** | **date** | | [default to null] | +| **developerType** | **String** | \"none\" User is a normal user \"trusted\" Unknown \"internal\" Is a VRChat Developer \"moderator\" Is a VRChat Moderator Staff can hide their developerType at will. | [default to none] | +| **discordDetails** | [**DiscordDetails**](DiscordDetails.md) | | [optional] [default to null] | +| **discordId** | **String** | https://discord.com/developers/docs/reference#snowflakes | [optional] [default to null] | +| **displayName** | **String** | | [default to null] | +| **emailVerified** | **Boolean** | | [default to null] | +| **fallbackAvatar** | **String** | | [optional] [default to null] | +| **friendGroupNames** | **List** | Always empty array. | [default to null] | +| **friendKey** | **String** | | [default to null] | +| **friends** | **List** | | [default to null] | +| **googleDetails** | [**Object**](.md) | | [optional] [default to null] | +| **googleId** | **String** | | [optional] [default to null] | +| **hasBirthday** | **Boolean** | | [default to null] | +| **hasEmail** | **Boolean** | | [default to null] | +| **hasLoggedInFromClient** | **Boolean** | | [default to null] | +| **hasPendingEmail** | **Boolean** | | [default to null] | +| **hideContentFilterSettings** | **Boolean** | | [optional] [default to null] | +| **homeLocation** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [default to null] | +| **id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **isAdult** | **Boolean** | | [default to null] | +| **isBoopingEnabled** | **Boolean** | | [optional] [default to true] | +| **isFriend** | **Boolean** | | [default to false] | +| **last\_activity** | **Date** | | [optional] [default to null] | +| **last\_login** | **Date** | | [default to null] | +| **last\_mobile** | **Date** | | [default to null] | +| **last\_platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [default to null] | +| **obfuscatedEmail** | **String** | | [default to null] | +| **obfuscatedPendingEmail** | **String** | | [default to null] | +| **oculusId** | **String** | | [default to null] | +| **offlineFriends** | **List** | | [optional] [default to null] | +| **onlineFriends** | **List** | | [optional] [default to null] | +| **pastDisplayNames** | [**List**](PastDisplayName.md) | | [default to null] | +| **picoId** | **String** | | [optional] [default to null] | +| **platform\_history** | [**List**](CurrentUser_platform_history_inner.md) | | [optional] [default to null] | +| **presence** | [**CurrentUserPresence**](CurrentUserPresence.md) | | [optional] [default to null] | +| **profilePicOverride** | **String** | | [default to null] | +| **profilePicOverrideThumbnail** | **String** | | [default to null] | +| **pronouns** | **String** | | [default to null] | +| **pronounsHistory** | **List** | | [default to null] | +| **queuedInstance** | **String** | | [optional] [default to null] | +| **receiveMobileInvitations** | **Boolean** | | [optional] [default to null] | +| **state** | **String** | * \"online\" User is online in VRChat * \"active\" User is online, but not in VRChat * \"offline\" User is offline Always offline when returned through `getCurrentUser` (/auth/user). | [default to offline] | +| **status** | **String** | Defines the User's current status, for example \"ask me\", \"join me\" or \"offline. This status is a combined indicator of their online activity and privacy preference. | [default to offline] | +| **statusDescription** | **String** | | [default to null] | +| **statusFirstTime** | **Boolean** | | [default to null] | +| **statusHistory** | **List** | | [default to null] | +| **steamDetails** | [**Object**](.md) | | [default to null] | +| **steamId** | **String** | | [default to null] | +| **tags** | **List** | | [default to null] | +| **twoFactorAuthEnabled** | **Boolean** | | [default to null] | +| **twoFactorAuthEnabledDate** | **Date** | | [optional] [default to null] | +| **unsubscribe** | **Boolean** | | [default to null] | +| **updated\_at** | **Date** | | [optional] [default to null] | +| **userIcon** | **String** | | [default to null] | +| **userLanguage** | **String** | | [optional] [default to null] | +| **userLanguageCode** | **String** | | [optional] [default to null] | +| **username** | **String** | -| **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). | [optional] [default to null] | +| **usesGeneratedPassword** | **Boolean** | | [default to null] | +| **viveId** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CurrentUserPresence.md b/Models/CurrentUserPresence.md new file mode 100644 index 0000000..ba0c5e9 --- /dev/null +++ b/Models/CurrentUserPresence.md @@ -0,0 +1,24 @@ +# CurrentUserPresence +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **avatarThumbnail** | **String** | | [optional] [default to null] | +| **currentAvatarTags** | **List** | | [optional] [default to null] | +| **debugflag** | **String** | | [optional] [default to null] | +| **displayName** | **String** | | [optional] [default to null] | +| **groups** | **List** | | [optional] [default to null] | +| **id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **instance** | **String** | | [optional] [default to null] | +| **instanceType** | **String** | either an InstanceType or an empty string | [optional] [default to null] | +| **isRejoining** | **String** | | [optional] [default to null] | +| **platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [optional] [default to null] | +| **profilePicOverride** | **String** | | [optional] [default to null] | +| **status** | **String** | either a UserStatus or empty string | [optional] [default to null] | +| **travelingToInstance** | **String** | | [optional] [default to null] | +| **travelingToWorld** | **String** | Represents a unique location, consisting of a world identifier and an instance identifier, or \"offline\" if the user is not on your friends list. | [optional] [default to null] | +| **userIcon** | **String** | | [optional] [default to null] | +| **world** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/CurrentUser_platform_history_inner.md b/Models/CurrentUser_platform_history_inner.md new file mode 100644 index 0000000..1384c3c --- /dev/null +++ b/Models/CurrentUser_platform_history_inner.md @@ -0,0 +1,11 @@ +# CurrentUser_platform_history_inner +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **isMobile** | **Boolean** | | [optional] [default to null] | +| **platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [optional] [default to null] | +| **recorded** | **Date** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/DeclineGroupInviteRequest.md b/Models/DeclineGroupInviteRequest.md new file mode 100644 index 0000000..6956d86 --- /dev/null +++ b/Models/DeclineGroupInviteRequest.md @@ -0,0 +1,9 @@ +# DeclineGroupInviteRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **block** | **Boolean** | | [optional] [default to false] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Disable2FAResult.md b/Models/Disable2FAResult.md new file mode 100644 index 0000000..4b16af5 --- /dev/null +++ b/Models/Disable2FAResult.md @@ -0,0 +1,9 @@ +# Disable2FAResult +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **removed** | **Boolean** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/DiscordDetails.md b/Models/DiscordDetails.md new file mode 100644 index 0000000..90c9a14 --- /dev/null +++ b/Models/DiscordDetails.md @@ -0,0 +1,10 @@ +# DiscordDetails +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **global\_name** | **String** | | [optional] [default to null] | +| **id** | **String** | https://discord.com/developers/docs/reference#snowflakes | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/DynamicContentRow.md b/Models/DynamicContentRow.md new file mode 100644 index 0000000..58cbc7b --- /dev/null +++ b/Models/DynamicContentRow.md @@ -0,0 +1,16 @@ +# DynamicContentRow +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **index** | **Integer** | | [optional] [default to null] | +| **name** | **String** | | [default to null] | +| **platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [default to null] | +| **sortHeading** | **String** | | [default to null] | +| **sortOrder** | **String** | | [default to null] | +| **sortOwnership** | **String** | | [default to null] | +| **tag** | **String** | Tags are a way to grant various access, assign restrictions or other kinds of metadata to various to objects such as worlds, users and avatars. System tags starting with `system_` are granted automatically by the system, while admin tags with `admin_` are granted manually. More prefixes such as `language_ ` (to indicate that a player can speak the tagged language), and `author_tag_` (provided by a world author for search and sorting) exist as well. | [optional] [default to null] | +| **type** | **String** | Type is not present if it is a world. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/EconomyAccount.md b/Models/EconomyAccount.md new file mode 100644 index 0000000..1d085c1 --- /dev/null +++ b/Models/EconomyAccount.md @@ -0,0 +1,14 @@ +# EconomyAccount +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **accountActivatedOn** | **Date** | | [default to null] | +| **accountId** | **String** | | [default to null] | +| **blocked** | **Boolean** | | [default to null] | +| **canSpend** | **Boolean** | | [default to null] | +| **source** | **String** | | [default to null] | +| **userId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/EquipInventoryItemRequest.md b/Models/EquipInventoryItemRequest.md new file mode 100644 index 0000000..aa410f7 --- /dev/null +++ b/Models/EquipInventoryItemRequest.md @@ -0,0 +1,9 @@ +# EquipInventoryItemRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **equipSlot** | **String** | | [default to ] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Error.md b/Models/Error.md new file mode 100644 index 0000000..3817a64 --- /dev/null +++ b/Models/Error.md @@ -0,0 +1,9 @@ +# Error +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **error** | [**Response**](Response.md) | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Favorite.md b/Models/Favorite.md new file mode 100644 index 0000000..a886d55 --- /dev/null +++ b/Models/Favorite.md @@ -0,0 +1,12 @@ +# Favorite +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **favoriteId** | **String** | MUST be either AvatarID, UserID or WorldID. | [default to null] | +| **id** | **String** | | [default to null] | +| **tags** | **List** | | [default to null] | +| **type** | **String** | | [default to friend] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/FavoriteGroup.md b/Models/FavoriteGroup.md new file mode 100644 index 0000000..4abf7f7 --- /dev/null +++ b/Models/FavoriteGroup.md @@ -0,0 +1,16 @@ +# FavoriteGroup +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **displayName** | **String** | | [default to null] | +| **id** | **String** | | [default to null] | +| **name** | **String** | | [default to null] | +| **ownerDisplayName** | **String** | | [default to null] | +| **ownerId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **tags** | **List** | | [default to null] | +| **type** | **String** | | [default to friend] | +| **visibility** | **String** | | [default to private] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/FavoriteGroupLimits.md b/Models/FavoriteGroupLimits.md new file mode 100644 index 0000000..04ec46c --- /dev/null +++ b/Models/FavoriteGroupLimits.md @@ -0,0 +1,12 @@ +# FavoriteGroupLimits +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **avatar** | **Integer** | | [default to null] | +| **friend** | **Integer** | | [default to null] | +| **vrcPlusWorld** | **Integer** | | [default to null] | +| **world** | **Integer** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/FavoriteLimits.md b/Models/FavoriteLimits.md new file mode 100644 index 0000000..0ec1565 --- /dev/null +++ b/Models/FavoriteLimits.md @@ -0,0 +1,12 @@ +# FavoriteLimits +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **defaultMaxFavoriteGroups** | **Integer** | | [default to null] | +| **defaultMaxFavoritesPerGroup** | **Integer** | | [default to null] | +| **maxFavoriteGroups** | [**FavoriteGroupLimits**](FavoriteGroupLimits.md) | | [default to null] | +| **maxFavoritesPerGroup** | [**FavoriteGroupLimits**](FavoriteGroupLimits.md) | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/FavoritedWorld.md b/Models/FavoritedWorld.md new file mode 100644 index 0000000..d88b28a --- /dev/null +++ b/Models/FavoritedWorld.md @@ -0,0 +1,38 @@ +# FavoritedWorld +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **authorId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **authorName** | **String** | | [default to null] | +| **capacity** | **Integer** | | [default to null] | +| **created\_at** | **Date** | | [optional] [default to null] | +| **defaultContentSettings** | [**InstanceContentSettings**](InstanceContentSettings.md) | | [optional] [default to null] | +| **description** | **String** | | [optional] [default to null] | +| **favoriteGroup** | **String** | | [default to null] | +| **favoriteId** | **String** | | [default to null] | +| **favorites** | **Integer** | | [optional] [default to 0] | +| **featured** | **Boolean** | | [optional] [default to false] | +| **heat** | **Integer** | | [optional] [default to 0] | +| **id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [default to null] | +| **imageUrl** | **String** | | [default to null] | +| **labsPublicationDate** | **String** | | [optional] [default to null] | +| **name** | **String** | | [default to null] | +| **occupants** | **Integer** | | [default to 0] | +| **organization** | **String** | | [optional] [default to vrchat] | +| **popularity** | **Integer** | | [optional] [default to 0] | +| **previewYoutubeId** | **String** | | [optional] [default to null] | +| **publicationDate** | **String** | | [optional] [default to null] | +| **recommendedCapacity** | **Integer** | | [optional] [default to null] | +| **releaseStatus** | **String** | | [default to public] | +| **tags** | **List** | | [optional] [default to null] | +| **thumbnailImageUrl** | **String** | | [default to null] | +| **udonProducts** | **List** | | [optional] [default to null] | +| **unityPackages** | [**List**](UnityPackage.md) | | [optional] [default to null] | +| **updated\_at** | **Date** | | [optional] [default to null] | +| **urlList** | **List** | | [optional] [default to null] | +| **version** | **Integer** | | [optional] [default to null] | +| **visits** | **Integer** | | [optional] [default to 0] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Feedback.md b/Models/Feedback.md new file mode 100644 index 0000000..4981960 --- /dev/null +++ b/Models/Feedback.md @@ -0,0 +1,21 @@ +# Feedback +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **commenterId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **commenterName** | **String** | | [default to null] | +| **contentAuthorId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **contentAuthorName** | **String** | | [default to null] | +| **contentId** | **String** | | [default to null] | +| **contentName** | **String** | | [optional] [default to null] | +| **contentType** | **String** | | [default to null] | +| **contentVersion** | **Integer** | | [default to null] | +| **description** | **String** | | [optional] [default to null] | +| **id** | **String** | | [default to null] | +| **reason** | **String** | | [default to null] | +| **tags** | **List** | | [default to null] | +| **type** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/File.md b/Models/File.md new file mode 100644 index 0000000..480504e --- /dev/null +++ b/Models/File.md @@ -0,0 +1,21 @@ +# File +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **animationStyle** | **String** | Animation style for images. | [optional] [default to null] | +| **extension** | **String** | | [default to null] | +| **frames** | **Integer** | The number of frames for animated spritesheet images. | [optional] [default to null] | +| **framesOverTime** | **Integer** | The frames per second for animated spritesheet images. | [optional] [default to null] | +| **id** | **String** | | [default to null] | +| **loopStyle** | **String** | Animation looping style for images. | [optional] [default to linear] | +| **maskTag** | **String** | Mask shape for images. | [optional] [default to square] | +| **mimeType** | **String** | | [default to image/jpeg] | +| **modifiedThumbnailFileName** | **String** | | [optional] [default to null] | +| **name** | **String** | | [default to null] | +| **ownerId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **tags** | **List** | | [default to null] | +| **versions** | [**Set**](FileVersion.md) | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/FileAnalysis.md b/Models/FileAnalysis.md new file mode 100644 index 0000000..4003273 --- /dev/null +++ b/Models/FileAnalysis.md @@ -0,0 +1,15 @@ +# FileAnalysis +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **avatarStats** | [**FileAnalysisAvatarStats**](FileAnalysisAvatarStats.md) | | [default to null] | +| **created\_at** | **Date** | | [optional] [default to null] | +| **encryptionKey** | **String** | | [optional] [default to null] | +| **fileSize** | **Integer** | | [default to null] | +| **performanceRating** | **String** | | [optional] [default to null] | +| **success** | **Boolean** | | [default to null] | +| **uncompressedSize** | **Integer** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/FileAnalysisAvatarStats.md b/Models/FileAnalysisAvatarStats.md new file mode 100644 index 0000000..9df84c0 --- /dev/null +++ b/Models/FileAnalysisAvatarStats.md @@ -0,0 +1,52 @@ +# FileAnalysisAvatarStats +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **animatorCount** | **Integer** | | [default to null] | +| **audioSourceCount** | **Integer** | | [default to null] | +| **blendShapeCount** | **Integer** | | [default to null] | +| **boneCount** | **Integer** | | [default to null] | +| **bounds** | **List** | | [default to null] | +| **cameraCount** | **Integer** | | [optional] [default to null] | +| **clothCount** | **Integer** | | [default to null] | +| **constraintCount** | **Integer** | | [default to null] | +| **constraintDepth** | **Integer** | | [default to null] | +| **contactCount** | **Integer** | | [default to null] | +| **customExpressions** | **Boolean** | | [default to null] | +| **customizeAnimationLayers** | **Boolean** | | [default to null] | +| **enableEyeLook** | **Boolean** | | [default to null] | +| **lightCount** | **Integer** | | [default to null] | +| **lineRendererCount** | **Integer** | | [default to null] | +| **lipSync** | **Integer** | | [default to null] | +| **materialCount** | **Integer** | | [default to null] | +| **materialSlotsUsed** | **Integer** | | [default to null] | +| **meshCount** | **Integer** | | [default to null] | +| **meshIndices** | **Integer** | | [default to null] | +| **meshParticleMaxPolygons** | **Integer** | | [default to null] | +| **meshPolygons** | **Integer** | | [default to null] | +| **meshVertices** | **Integer** | | [default to null] | +| **particleCollisionEnabled** | **Boolean** | | [default to null] | +| **particleSystemCount** | **Integer** | | [default to null] | +| **particleTrailsEnabled** | **Boolean** | | [default to null] | +| **physBoneColliderCount** | **Integer** | | [default to null] | +| **physBoneCollisionCheckCount** | **Integer** | | [default to null] | +| **physBoneComponentCount** | **Integer** | | [default to null] | +| **physBoneTransformCount** | **Integer** | | [default to null] | +| **physicsColliders** | **Integer** | | [default to null] | +| **physicsRigidbodies** | **Integer** | | [default to null] | +| **skinnedMeshCount** | **Integer** | | [default to null] | +| **skinnedMeshIndices** | **Integer** | | [default to null] | +| **skinnedMeshPolygons** | **Integer** | | [default to null] | +| **skinnedMeshVertices** | **Integer** | | [default to null] | +| **totalClothVertices** | **Integer** | | [default to null] | +| **totalIndices** | **Integer** | | [default to null] | +| **totalMaxParticles** | **Integer** | | [default to null] | +| **totalPolygons** | **Integer** | | [default to null] | +| **totalTextureUsage** | **Integer** | | [default to null] | +| **totalVertices** | **Integer** | | [default to null] | +| **trailRendererCount** | **Integer** | | [default to null] | +| **writeDefaultsUsed** | **Boolean** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/FileData.md b/Models/FileData.md new file mode 100644 index 0000000..0e9dfc8 --- /dev/null +++ b/Models/FileData.md @@ -0,0 +1,15 @@ +# FileData +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **category** | **String** | | [default to queued] | +| **fileName** | **String** | | [default to null] | +| **md5** | **String** | | [optional] [default to null] | +| **sizeInBytes** | **Integer** | | [default to null] | +| **status** | **String** | | [default to waiting] | +| **uploadId** | **String** | | [default to ] | +| **url** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/FileUploadURL.md b/Models/FileUploadURL.md new file mode 100644 index 0000000..323aced --- /dev/null +++ b/Models/FileUploadURL.md @@ -0,0 +1,9 @@ +# FileUploadURL +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **url** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/FileVersion.md b/Models/FileVersion.md new file mode 100644 index 0000000..fb32e6e --- /dev/null +++ b/Models/FileVersion.md @@ -0,0 +1,15 @@ +# FileVersion +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **created\_at** | **Date** | | [default to null] | +| **deleted** | **Boolean** | Usually only present if `true` | [optional] [default to true] | +| **delta** | [**FileData**](FileData.md) | | [optional] [default to null] | +| **file** | [**FileData**](FileData.md) | | [optional] [default to null] | +| **signature** | [**FileData**](FileData.md) | | [optional] [default to null] | +| **status** | **String** | | [default to waiting] | +| **version** | **Integer** | Incremental version counter, can only be increased. | [default to 0] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/FileVersionUploadStatus.md b/Models/FileVersionUploadStatus.md new file mode 100644 index 0000000..5675dbd --- /dev/null +++ b/Models/FileVersionUploadStatus.md @@ -0,0 +1,14 @@ +# FileVersionUploadStatus +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **etags** | **List** | Unknown | [default to null] | +| **fileName** | **String** | | [default to null] | +| **maxParts** | **Integer** | | [default to null] | +| **nextPartNumber** | **Integer** | | [default to null] | +| **parts** | **List** | | [default to null] | +| **uploadId** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/FinishFileDataUploadRequest.md b/Models/FinishFileDataUploadRequest.md new file mode 100644 index 0000000..2685e10 --- /dev/null +++ b/Models/FinishFileDataUploadRequest.md @@ -0,0 +1,11 @@ +# FinishFileDataUploadRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **etags** | **Set** | Array of ETags uploaded. | [optional] [default to null] | +| **maxParts** | **String** | Always a zero in string form, despite how many parts uploaded. | [default to 0] | +| **nextPartNumber** | **String** | Always a zero in string form, despite how many parts uploaded. | [default to 0] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/FollowCalendarEventRequest.md b/Models/FollowCalendarEventRequest.md new file mode 100644 index 0000000..8df027a --- /dev/null +++ b/Models/FollowCalendarEventRequest.md @@ -0,0 +1,9 @@ +# FollowCalendarEventRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **isFollowing** | **Boolean** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/FriendStatus.md b/Models/FriendStatus.md new file mode 100644 index 0000000..319a39d --- /dev/null +++ b/Models/FriendStatus.md @@ -0,0 +1,11 @@ +# FriendStatus +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **incomingRequest** | **Boolean** | | [default to false] | +| **isFriend** | **Boolean** | | [default to false] | +| **outgoingRequest** | **Boolean** | | [default to false] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Group.md b/Models/Group.md new file mode 100644 index 0000000..977ed56 --- /dev/null +++ b/Models/Group.md @@ -0,0 +1,41 @@ +# Group +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **ageVerificationBetaCode** | **String** | | [optional] [default to null] | +| **ageVerificationBetaSlots** | **BigDecimal** | | [optional] [default to null] | +| **ageVerificationSlotsAvailable** | **Boolean** | | [optional] [default to null] | +| **allowGroupJoinPrompt** | **Boolean** | | [optional] [default to null] | +| **badges** | **List** | | [optional] [default to null] | +| **bannerId** | **String** | | [optional] [default to null] | +| **bannerUrl** | **String** | | [optional] [default to null] | +| **createdAt** | **Date** | | [optional] [default to null] | +| **description** | **String** | | [optional] [default to null] | +| **discriminator** | **String** | | [optional] [default to null] | +| **galleries** | [**List**](GroupGallery.md) | | [optional] [default to null] | +| **iconId** | **String** | | [optional] [default to null] | +| **iconUrl** | **String** | | [optional] [default to null] | +| **id** | **String** | | [optional] [default to null] | +| **isVerified** | **Boolean** | | [optional] [default to false] | +| **joinState** | **String** | | [optional] [default to open] | +| **languages** | **List** | | [optional] [default to null] | +| **lastPostCreatedAt** | **Date** | | [optional] [default to null] | +| **links** | **List** | | [optional] [default to null] | +| **memberCount** | **Integer** | | [optional] [default to null] | +| **memberCountSyncedAt** | **Date** | | [optional] [default to null] | +| **membershipStatus** | **String** | | [optional] [default to inactive] | +| **myMember** | [**GroupMyMember**](GroupMyMember.md) | | [optional] [default to null] | +| **name** | **String** | | [optional] [default to null] | +| **onlineMemberCount** | **Integer** | | [optional] [default to null] | +| **ownerId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **privacy** | **String** | | [optional] [default to default] | +| **roles** | [**List**](GroupRole.md) | Only returned if ?includeRoles=true is specified. | [optional] [default to null] | +| **rules** | **String** | | [optional] [default to null] | +| **shortCode** | **String** | | [optional] [default to null] | +| **tags** | **List** | | [optional] [default to null] | +| **transferTargetId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **updatedAt** | **Date** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/GroupAnnouncement.md b/Models/GroupAnnouncement.md new file mode 100644 index 0000000..6e9cd10 --- /dev/null +++ b/Models/GroupAnnouncement.md @@ -0,0 +1,17 @@ +# GroupAnnouncement +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **authorId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **createdAt** | **Date** | | [optional] [default to null] | +| **groupId** | **String** | | [optional] [default to null] | +| **id** | **String** | | [optional] [default to null] | +| **imageId** | **String** | | [optional] [default to null] | +| **imageUrl** | **String** | | [optional] [default to null] | +| **text** | **String** | | [optional] [default to null] | +| **title** | **String** | | [optional] [default to null] | +| **updatedAt** | **Date** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/GroupAuditLogEntry.md b/Models/GroupAuditLogEntry.md new file mode 100644 index 0000000..2f591e5 --- /dev/null +++ b/Models/GroupAuditLogEntry.md @@ -0,0 +1,17 @@ +# GroupAuditLogEntry +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **actorDisplayName** | **String** | | [optional] [default to null] | +| **actorId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **created\_at** | **Date** | | [optional] [default to null] | +| **data** | [**Object**](.md) | The data associated with the event. The format of this data is dependent on the event type. | [optional] [default to null] | +| **description** | **String** | A human-readable description of the event. | [optional] [default to null] | +| **eventType** | **String** | The type of event that occurred. This is a string that is prefixed with the type of object that the event occurred on. For example, a group role update event would be prefixed with `group.role`. | [optional] [default to group.update] | +| **groupId** | **String** | | [optional] [default to null] | +| **id** | **String** | | [optional] [default to null] | +| **targetId** | **String** | Typically a UserID, GroupID, GroupRoleID, or Location, but could be other types of IDs. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/GroupGallery.md b/Models/GroupGallery.md new file mode 100644 index 0000000..e67c13d --- /dev/null +++ b/Models/GroupGallery.md @@ -0,0 +1,18 @@ +# GroupGallery +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **createdAt** | **Date** | | [optional] [default to null] | +| **description** | **String** | Description of the gallery. | [optional] [default to null] | +| **id** | **String** | | [optional] [default to null] | +| **membersOnly** | **Boolean** | Whether the gallery is members only. | [optional] [default to false] | +| **name** | **String** | Name of the gallery. | [optional] [default to null] | +| **roleIdsToAutoApprove** | **List** | | [optional] [default to null] | +| **roleIdsToManage** | **List** | | [optional] [default to null] | +| **roleIdsToSubmit** | **List** | | [optional] [default to null] | +| **roleIdsToView** | **List** | | [optional] [default to null] | +| **updatedAt** | **Date** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/GroupGalleryFileOrder.md b/Models/GroupGalleryFileOrder.md new file mode 100644 index 0000000..262b0f1 --- /dev/null +++ b/Models/GroupGalleryFileOrder.md @@ -0,0 +1,9 @@ +# GroupGalleryFileOrder +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **ids** | **List** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/GroupGalleryFileOrderRequest.md b/Models/GroupGalleryFileOrderRequest.md new file mode 100644 index 0000000..9b743d0 --- /dev/null +++ b/Models/GroupGalleryFileOrderRequest.md @@ -0,0 +1,10 @@ +# GroupGalleryFileOrderRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **galleryId** | **String** | | [default to null] | +| **ids** | **List** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/GroupGalleryImage.md b/Models/GroupGalleryImage.md new file mode 100644 index 0000000..ae7a5fb --- /dev/null +++ b/Models/GroupGalleryImage.md @@ -0,0 +1,18 @@ +# GroupGalleryImage +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **approved** | **Boolean** | | [optional] [default to false] | +| **approvedAt** | **Date** | | [optional] [default to null] | +| **approvedByUserId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **createdAt** | **Date** | | [optional] [default to null] | +| **fileId** | **String** | | [optional] [default to null] | +| **galleryId** | **String** | | [optional] [default to null] | +| **groupId** | **String** | | [optional] [default to null] | +| **id** | **String** | | [optional] [default to null] | +| **imageUrl** | **URI** | | [optional] [default to null] | +| **submittedByUserId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/GroupInstance.md b/Models/GroupInstance.md new file mode 100644 index 0000000..19ccbc4 --- /dev/null +++ b/Models/GroupInstance.md @@ -0,0 +1,12 @@ +# GroupInstance +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **instanceId** | **String** | InstanceID can be \"offline\" on User profiles if you are not friends with that user and \"private\" if you are friends and user is in private instance. | [default to null] | +| **location** | **String** | Represents a unique location, consisting of a world identifier and an instance identifier, or \"offline\" if the user is not on your friends list. | [default to null] | +| **memberCount** | **Integer** | | [default to null] | +| **world** | [**World**](World.md) | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/GroupMember.md b/Models/GroupMember.md new file mode 100644 index 0000000..2644450 --- /dev/null +++ b/Models/GroupMember.md @@ -0,0 +1,27 @@ +# GroupMember +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **acceptedByDisplayName** | **String** | Only missing when explicitly fetching own user. | [optional] [default to null] | +| **acceptedById** | **String** | Only missing when explicitly fetching own user. | [optional] [default to null] | +| **bannedAt** | **Date** | Only missing when explicitly fetching own user. | [optional] [default to null] | +| **createdAt** | **Date** | Only missing when explicitly fetching own user. | [optional] [default to null] | +| **groupId** | **String** | | [default to null] | +| **hasJoinedFromPurchase** | **Boolean** | Missing when explicitly fetching own user, or when group isn't linked to a purchase. | [optional] [default to null] | +| **id** | **String** | | [default to null] | +| **isRepresenting** | **Boolean** | Whether the user is representing the group. This makes the group show up above the name tag in-game. | [default to false] | +| **isSubscribedToAnnouncements** | **Boolean** | | [default to false] | +| **isSubscribedToEventAnnouncements** | **Boolean** | Only missing when explicitly fetching own user. | [optional] [default to null] | +| **joinedAt** | **Date** | | [default to null] | +| **lastPostReadAt** | **Date** | | [default to null] | +| **mRoleIds** | **List** | | [default to null] | +| **managerNotes** | **String** | Only missing when explicitly fetching own user. | [optional] [default to null] | +| **membershipStatus** | **String** | | [default to inactive] | +| **roleIds** | **List** | | [default to null] | +| **user** | [**GroupMemberLimitedUser**](GroupMemberLimitedUser.md) | | [optional] [default to null] | +| **userId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **visibility** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/GroupMemberLimitedUser.md b/Models/GroupMemberLimitedUser.md new file mode 100644 index 0000000..952a2a3 --- /dev/null +++ b/Models/GroupMemberLimitedUser.md @@ -0,0 +1,15 @@ +# GroupMemberLimitedUser +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **currentAvatarTags** | **List** | | [optional] [default to null] | +| **currentAvatarThumbnailImageUrl** | **String** | | [optional] [default to null] | +| **displayName** | **String** | | [optional] [default to null] | +| **iconUrl** | **String** | | [optional] [default to null] | +| **id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **profilePicOverride** | **String** | | [optional] [default to null] | +| **thumbnailUrl** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/GroupMyMember.md b/Models/GroupMyMember.md new file mode 100644 index 0000000..10db82d --- /dev/null +++ b/Models/GroupMyMember.md @@ -0,0 +1,28 @@ +# GroupMyMember +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **acceptedByDisplayName** | **String** | | [optional] [default to null] | +| **acceptedById** | **String** | | [optional] [default to null] | +| **bannedAt** | **String** | | [optional] [default to null] | +| **createdAt** | **Date** | | [optional] [default to null] | +| **groupId** | **String** | | [optional] [default to null] | +| **has2FA** | **Boolean** | | [optional] [default to false] | +| **hasJoinedFromPurchase** | **Boolean** | | [optional] [default to false] | +| **id** | **String** | | [optional] [default to null] | +| **isRepresenting** | **Boolean** | | [optional] [default to false] | +| **isSubscribedToAnnouncements** | **Boolean** | | [optional] [default to true] | +| **isSubscribedToEventAnnouncements** | **Boolean** | | [optional] [default to null] | +| **joinedAt** | **Date** | | [optional] [default to null] | +| **lastPostReadAt** | **Date** | | [optional] [default to null] | +| **mRoleIds** | **List** | | [optional] [default to null] | +| **managerNotes** | **String** | | [optional] [default to null] | +| **membershipStatus** | **String** | | [optional] [default to null] | +| **permissions** | **List** | | [optional] [default to null] | +| **roleIds** | **List** | | [optional] [default to null] | +| **userId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **visibility** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/GroupPermission.md b/Models/GroupPermission.md new file mode 100644 index 0000000..31e1bad --- /dev/null +++ b/Models/GroupPermission.md @@ -0,0 +1,13 @@ +# GroupPermission +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **allowedToAdd** | **Boolean** | Whether the user is allowed to add this permission to a role. | [optional] [default to false] | +| **displayName** | **String** | The display name of the permission. | [optional] [default to null] | +| **help** | **String** | Human-readable description of the permission. | [optional] [default to null] | +| **isManagementPermission** | **Boolean** | Whether this permission is a \"management\" permission. | [optional] [default to false] | +| **name** | **String** | The name of the permission. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/GroupPost.md b/Models/GroupPost.md new file mode 100644 index 0000000..3484e0f --- /dev/null +++ b/Models/GroupPost.md @@ -0,0 +1,20 @@ +# GroupPost +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **authorId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **createdAt** | **Date** | | [optional] [default to null] | +| **editorId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **groupId** | **String** | | [optional] [default to null] | +| **id** | **String** | | [optional] [default to null] | +| **imageId** | **String** | | [optional] [default to null] | +| **imageUrl** | **String** | | [optional] [default to null] | +| **roleId** | **List** | | [optional] [default to null] | +| **text** | **String** | | [optional] [default to null] | +| **title** | **String** | | [optional] [default to null] | +| **updatedAt** | **Date** | | [optional] [default to null] | +| **visibility** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/GroupRole.md b/Models/GroupRole.md new file mode 100644 index 0000000..b0f8d16 --- /dev/null +++ b/Models/GroupRole.md @@ -0,0 +1,20 @@ +# GroupRole +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **createdAt** | **Date** | | [optional] [default to null] | +| **description** | **String** | | [optional] [default to null] | +| **groupId** | **String** | | [optional] [default to null] | +| **id** | **String** | | [optional] [default to null] | +| **isManagementRole** | **Boolean** | | [optional] [default to false] | +| **isSelfAssignable** | **Boolean** | | [optional] [default to false] | +| **name** | **String** | | [optional] [default to null] | +| **order** | **Integer** | | [optional] [default to null] | +| **permissions** | **List** | | [optional] [default to null] | +| **requiresPurchase** | **Boolean** | | [optional] [default to false] | +| **requiresTwoFactor** | **Boolean** | | [optional] [default to false] | +| **updatedAt** | **Date** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/GroupRoleTemplateValues.md b/Models/GroupRoleTemplateValues.md new file mode 100644 index 0000000..2a0af8c --- /dev/null +++ b/Models/GroupRoleTemplateValues.md @@ -0,0 +1,12 @@ +# GroupRoleTemplateValues +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **basePermissions** | **List** | | [default to null] | +| **description** | **String** | | [default to null] | +| **name** | **String** | | [default to null] | +| **roles** | [**GroupRoleTemplateValues_roles**](GroupRoleTemplateValues_roles.md) | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/GroupRoleTemplateValues_roles.md b/Models/GroupRoleTemplateValues_roles.md new file mode 100644 index 0000000..8304b4b --- /dev/null +++ b/Models/GroupRoleTemplateValues_roles.md @@ -0,0 +1,12 @@ +# GroupRoleTemplateValues_roles +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **name** | **String** | | [optional] [default to null] | +| **description** | **String** | | [optional] [default to null] | +| **basePermissions** | **List** | | [optional] [default to null] | +| **isAddedOnJoin** | **Boolean** | | [optional] [default to false] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/GroupTransferable.md b/Models/GroupTransferable.md new file mode 100644 index 0000000..6091957 --- /dev/null +++ b/Models/GroupTransferable.md @@ -0,0 +1,9 @@ +# GroupTransferable +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **requirements** | [**GroupTransferable_requirements**](GroupTransferable_requirements.md) | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/GroupTransferable_requirements.md b/Models/GroupTransferable_requirements.md new file mode 100644 index 0000000..e55652c --- /dev/null +++ b/Models/GroupTransferable_requirements.md @@ -0,0 +1,13 @@ +# GroupTransferable_requirements +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **groupNotMonetized** | **Boolean** | | [default to false] | +| **hasVRCPlus** | **Boolean** | | [default to false] | +| **hasVerifiedEmail** | **Boolean** | | [default to false] | +| **targetCanOwnMoreGroups** | **Boolean** | | [default to false] | +| **targetIsGroupMember** | **Boolean** | | [default to false] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InfoPush.md b/Models/InfoPush.md new file mode 100644 index 0000000..345e497 --- /dev/null +++ b/Models/InfoPush.md @@ -0,0 +1,19 @@ +# InfoPush +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **createdAt** | **Date** | | [default to null] | +| **data** | [**InfoPushData**](InfoPushData.md) | | [default to null] | +| **endDate** | **Date** | | [optional] [default to null] | +| **hash** | **String** | Unknown usage, MD5 | [default to null] | +| **id** | **String** | | [default to null] | +| **isEnabled** | **Boolean** | | [default to true] | +| **priority** | **Integer** | | [default to null] | +| **releaseStatus** | **String** | | [default to public] | +| **startDate** | **Date** | | [optional] [default to null] | +| **tags** | **List** | | [default to null] | +| **updatedAt** | **Date** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InfoPushData.md b/Models/InfoPushData.md new file mode 100644 index 0000000..ce6f353 --- /dev/null +++ b/Models/InfoPushData.md @@ -0,0 +1,16 @@ +# InfoPushData +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **article** | [**InfoPushDataArticle**](InfoPushDataArticle.md) | | [optional] [default to null] | +| **contentList** | [**DynamicContentRow**](DynamicContentRow.md) | | [optional] [default to null] | +| **description** | **String** | | [optional] [default to null] | +| **imageUrl** | **String** | | [optional] [default to null] | +| **name** | **String** | | [optional] [default to null] | +| **onPressed** | [**InfoPushDataClickable**](InfoPushDataClickable.md) | | [optional] [default to null] | +| **template** | **String** | | [optional] [default to null] | +| **version** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InfoPushDataArticle.md b/Models/InfoPushDataArticle.md new file mode 100644 index 0000000..5b3f8b7 --- /dev/null +++ b/Models/InfoPushDataArticle.md @@ -0,0 +1,9 @@ +# InfoPushDataArticle +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **content** | [**InfoPushDataArticleContent**](InfoPushDataArticleContent.md) | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InfoPushDataArticleContent.md b/Models/InfoPushDataArticleContent.md new file mode 100644 index 0000000..a4367f8 --- /dev/null +++ b/Models/InfoPushDataArticleContent.md @@ -0,0 +1,11 @@ +# InfoPushDataArticleContent +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **imageUrl** | **String** | | [optional] [default to null] | +| **onPressed** | [**InfoPushDataClickable**](InfoPushDataClickable.md) | | [optional] [default to null] | +| **text** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InfoPushDataClickable.md b/Models/InfoPushDataClickable.md new file mode 100644 index 0000000..4ab5315 --- /dev/null +++ b/Models/InfoPushDataClickable.md @@ -0,0 +1,10 @@ +# InfoPushDataClickable +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **parameters** | **List** | In case of OpenURL, this would contain the link. | [optional] [default to null] | +| **command** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Instance.md b/Models/Instance.md new file mode 100644 index 0000000..a642619 --- /dev/null +++ b/Models/Instance.md @@ -0,0 +1,52 @@ +# Instance +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **active** | **Boolean** | | [optional] [default to true] | +| **ageGate** | **Boolean** | | [optional] [default to null] | +| **calendarEntryId** | **String** | | [optional] [default to null] | +| **canRequestInvite** | **Boolean** | | [optional] [default to true] | +| **capacity** | **Integer** | | [optional] [default to null] | +| **clientNumber** | **String** | Always returns \"unknown\". | [default to null] | +| **closedAt** | **Date** | | [optional] [default to null] | +| **contentSettings** | [**InstanceContentSettings**](InstanceContentSettings.md) | | [optional] [default to null] | +| **creatorId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **displayName** | **String** | | [optional] [default to null] | +| **friends** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **full** | **Boolean** | | [default to false] | +| **gameServerVersion** | **Integer** | | [optional] [default to null] | +| **groupAccessType** | **String** | Group access type when the instance type is \"group\" | [optional] [default to members] | +| **hardClose** | **Boolean** | | [optional] [default to null] | +| **hasCapacityForYou** | **Boolean** | | [optional] [default to null] | +| **hidden** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **id** | **String** | InstanceID can be \"offline\" on User profiles if you are not friends with that user and \"private\" if you are friends and user is in private instance. | [default to null] | +| **instanceId** | **String** | InstanceID can be \"offline\" on User profiles if you are not friends with that user and \"private\" if you are friends and user is in private instance. | [default to null] | +| **instancePersistenceEnabled** | **Boolean** | | [optional] [default to null] | +| **location** | **String** | Represents a unique location, consisting of a world identifier and an instance identifier, or \"offline\" if the user is not on your friends list. | [default to null] | +| **n\_users** | **Integer** | | [default to null] | +| **name** | **String** | | [default to null] | +| **nonce** | **String** | | [optional] [default to null] | +| **ownerId** | **String** | A groupId if the instance type is \"group\", null if instance type is public, or a userId otherwise | [optional] [default to null] | +| **permanent** | **Boolean** | | [default to false] | +| **photonRegion** | **String** | API/Photon region. | [default to us] | +| **platforms** | [**InstancePlatforms**](InstancePlatforms.md) | | [default to null] | +| **playerPersistenceEnabled** | **Boolean** | | [optional] [default to null] | +| **private** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **queueEnabled** | **Boolean** | | [default to null] | +| **queueSize** | **Integer** | | [default to null] | +| **recommendedCapacity** | **Integer** | | [default to null] | +| **region** | **String** | Instance region | [default to us] | +| **roleRestricted** | **Boolean** | | [optional] [default to null] | +| **secureName** | **String** | | [default to null] | +| **shortName** | **String** | | [optional] [default to null] | +| **strict** | **Boolean** | | [default to null] | +| **tags** | **List** | The tags array on Instances usually contain the language tags of the people in the instance. | [default to null] | +| **type** | **String** | | [default to null] | +| **userCount** | **Integer** | | [default to null] | +| **users** | [**List**](LimitedUserInstance.md) | The users field is present on instances created by the requesting user. | [optional] [default to null] | +| **world** | [**World**](World.md) | | [default to null] | +| **worldId** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InstanceContentSettings.md b/Models/InstanceContentSettings.md new file mode 100644 index 0000000..d05d131 --- /dev/null +++ b/Models/InstanceContentSettings.md @@ -0,0 +1,14 @@ +# InstanceContentSettings +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **drones** | **Boolean** | | [optional] [default to true] | +| **emoji** | **Boolean** | | [optional] [default to true] | +| **pedestals** | **Boolean** | | [optional] [default to true] | +| **prints** | **Boolean** | | [optional] [default to true] | +| **props** | **Boolean** | | [optional] [default to true] | +| **stickers** | **Boolean** | | [optional] [default to true] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InstancePlatforms.md b/Models/InstancePlatforms.md new file mode 100644 index 0000000..4fdd62c --- /dev/null +++ b/Models/InstancePlatforms.md @@ -0,0 +1,11 @@ +# InstancePlatforms +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **android** | **Integer** | | [default to null] | +| **ios** | **Integer** | | [optional] [default to null] | +| **standalonewindows** | **Integer** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InstanceShortNameResponse.md b/Models/InstanceShortNameResponse.md new file mode 100644 index 0000000..a14a1c5 --- /dev/null +++ b/Models/InstanceShortNameResponse.md @@ -0,0 +1,10 @@ +# InstanceShortNameResponse +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **secureName** | **String** | | [default to null] | +| **shortName** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Inventory.md b/Models/Inventory.md new file mode 100644 index 0000000..c155ab1 --- /dev/null +++ b/Models/Inventory.md @@ -0,0 +1,10 @@ +# Inventory +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **data** | [**List**](InventoryItem.md) | | [default to null] | +| **totalCount** | **Integer** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InventoryConsumptionResults.md b/Models/InventoryConsumptionResults.md new file mode 100644 index 0000000..4ff3d56 --- /dev/null +++ b/Models/InventoryConsumptionResults.md @@ -0,0 +1,11 @@ +# InventoryConsumptionResults +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **errors** | **List** | | [default to null] | +| **inventoryItems** | [**List**](InventoryItem.md) | | [default to null] | +| **inventoryItemsCreated** | **Integer** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InventoryDefaultAttributes_value.md b/Models/InventoryDefaultAttributes_value.md new file mode 100644 index 0000000..1b4c4d5 --- /dev/null +++ b/Models/InventoryDefaultAttributes_value.md @@ -0,0 +1,10 @@ +# InventoryDefaultAttributes_value +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **defaultValue** | **String** | | [optional] [default to null] | +| **validator** | [**InventoryDefaultAttributes_value_validator**](InventoryDefaultAttributes_value_validator.md) | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InventoryDefaultAttributes_value_validator.md b/Models/InventoryDefaultAttributes_value_validator.md new file mode 100644 index 0000000..a365eb6 --- /dev/null +++ b/Models/InventoryDefaultAttributes_value_validator.md @@ -0,0 +1,9 @@ +# InventoryDefaultAttributes_value_validator +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **type** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InventoryDrop.md b/Models/InventoryDrop.md new file mode 100644 index 0000000..a9eaf87 --- /dev/null +++ b/Models/InventoryDrop.md @@ -0,0 +1,22 @@ +# InventoryDrop +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **authorId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **created\_at** | **Date** | | [default to null] | +| **dropExpiryDate** | **Date** | | [default to null] | +| **endDropDate** | **Date** | | [default to null] | +| **id** | **String** | | [default to null] | +| **isDisabled** | **Boolean** | | [default to null] | +| **name** | **String** | | [default to null] | +| **notificationDetails** | [**InventoryNotificationDetails**](InventoryNotificationDetails.md) | | [default to null] | +| **startDropDate** | **Date** | | [default to null] | +| **status** | **String** | | [default to null] | +| **tags** | **List** | | [default to null] | +| **targetGroup** | **String** | | [default to null] | +| **templateIds** | **List** | | [default to null] | +| **updated\_at** | **Date** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InventoryItem.md b/Models/InventoryItem.md new file mode 100644 index 0000000..9dc1303 --- /dev/null +++ b/Models/InventoryItem.md @@ -0,0 +1,33 @@ +# InventoryItem +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **collections** | **List** | | [default to null] | +| **created\_at** | **Date** | | [default to null] | +| **defaultAttributes** | [**Map**](InventoryDefaultAttributes_value.md) | | [default to null] | +| **description** | **String** | | [default to null] | +| **equipSlot** | **String** | | [optional] [default to ] | +| **equipSlots** | **List** | | [optional] [default to null] | +| **expiryDate** | **Date** | | [optional] [default to null] | +| **flags** | **List** | | [default to null] | +| **holderId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **id** | **String** | | [default to null] | +| **imageUrl** | **String** | | [default to null] | +| **isArchived** | **Boolean** | | [default to null] | +| **isSeen** | **Boolean** | | [default to null] | +| **itemType** | **String** | | [default to bundle] | +| **itemTypeLabel** | **String** | | [default to null] | +| **metadata** | [**InventoryMetadata**](InventoryMetadata.md) | | [default to null] | +| **name** | **String** | | [default to null] | +| **quantifiable** | **Boolean** | | [default to null] | +| **tags** | **List** | | [default to null] | +| **templateId** | **String** | | [default to null] | +| **template\_created\_at** | **Date** | | [default to null] | +| **template\_updated\_at** | **Date** | | [default to null] | +| **updated\_at** | **Date** | | [default to null] | +| **userAttributes** | [**InventoryUserAttributes**](InventoryUserAttributes.md) | | [default to null] | +| **validateUserAttributes** | **Boolean** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InventoryMetadata.md b/Models/InventoryMetadata.md new file mode 100644 index 0000000..8f06e16 --- /dev/null +++ b/Models/InventoryMetadata.md @@ -0,0 +1,16 @@ +# InventoryMetadata +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **animated** | **Boolean** | | [optional] [default to null] | +| **animationStyle** | **String** | | [optional] [default to null] | +| **assetBundleId** | **String** | | [optional] [default to null] | +| **fileId** | **String** | | [optional] [default to null] | +| **imageUrl** | **String** | | [optional] [default to null] | +| **inventoryItemsToInstantiate** | **List** | Only in bundles | [optional] [default to null] | +| **maskTag** | **String** | | [optional] [default to null] | +| **propId** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InventoryNotificationDetails.md b/Models/InventoryNotificationDetails.md new file mode 100644 index 0000000..dc5e42b --- /dev/null +++ b/Models/InventoryNotificationDetails.md @@ -0,0 +1,11 @@ +# InventoryNotificationDetails +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **body** | **String** | | [default to null] | +| **imageUrl** | **String** | | [default to null] | +| **title** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InventorySpawn.md b/Models/InventorySpawn.md new file mode 100644 index 0000000..d0deed8 --- /dev/null +++ b/Models/InventorySpawn.md @@ -0,0 +1,10 @@ +# InventorySpawn +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **token** | **String** | | [default to null] | +| **version** | **Integer** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InventoryTemplate.md b/Models/InventoryTemplate.md new file mode 100644 index 0000000..28de900 --- /dev/null +++ b/Models/InventoryTemplate.md @@ -0,0 +1,26 @@ +# InventoryTemplate +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **authorId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **collections** | **List** | | [default to null] | +| **created\_at** | **Date** | | [default to null] | +| **defaultAttributes** | [**Object**](.md) | | [default to null] | +| **description** | **String** | | [default to null] | +| **equipSlots** | **List** | | [default to null] | +| **flags** | **List** | | [default to null] | +| **id** | **String** | | [default to null] | +| **imageUrl** | **String** | | [default to null] | +| **itemType** | **String** | | [default to bundle] | +| **itemTypeLabel** | **String** | | [default to null] | +| **metadata** | [**InventoryMetadata**](InventoryMetadata.md) | | [optional] [default to null] | +| **name** | **String** | | [default to null] | +| **notificationDetails** | [**InventoryNotificationDetails**](InventoryNotificationDetails.md) | | [optional] [default to null] | +| **status** | **String** | | [default to null] | +| **tags** | **List** | | [default to null] | +| **updated\_at** | **Date** | | [default to null] | +| **validateUserAttributes** | **Boolean** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InventoryUserAttributes.md b/Models/InventoryUserAttributes.md new file mode 100644 index 0000000..5292957 --- /dev/null +++ b/Models/InventoryUserAttributes.md @@ -0,0 +1,11 @@ +# InventoryUserAttributes +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **primaryColor** | **String** | | [optional] [default to null] | +| **secondaryColor** | **String** | | [optional] [default to null] | +| **trailColor** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InviteMessage.md b/Models/InviteMessage.md new file mode 100644 index 0000000..c5d3d8c --- /dev/null +++ b/Models/InviteMessage.md @@ -0,0 +1,15 @@ +# InviteMessage +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **canBeUpdated** | **Boolean** | | [default to true] | +| **id** | **String** | | [default to null] | +| **message** | **String** | | [default to null] | +| **messageType** | **String** | | [default to message] | +| **remainingCooldownMinutes** | **Integer** | Changes to 60 when updated, although probably server-side configurable. | [default to 0] | +| **slot** | **Integer** | | [default to null] | +| **updatedAt** | **Date** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InviteRequest.md b/Models/InviteRequest.md new file mode 100644 index 0000000..3a81abd --- /dev/null +++ b/Models/InviteRequest.md @@ -0,0 +1,10 @@ +# InviteRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **instanceId** | **String** | InstanceID can be \"offline\" on User profiles if you are not friends with that user and \"private\" if you are friends and user is in private instance. | [default to null] | +| **messageSlot** | **Integer** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/InviteResponse.md b/Models/InviteResponse.md new file mode 100644 index 0000000..a4cf7f4 --- /dev/null +++ b/Models/InviteResponse.md @@ -0,0 +1,9 @@ +# InviteResponse +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **responseSlot** | **Integer** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Jam.md b/Models/Jam.md new file mode 100644 index 0000000..513ea18 --- /dev/null +++ b/Models/Jam.md @@ -0,0 +1,18 @@ +# Jam +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **description** | **String** | | [default to null] | +| **id** | **String** | | [default to null] | +| **isVisible** | **Boolean** | | [default to null] | +| **moreInfo** | **String** | | [default to null] | +| **state** | **String** | One of: - submissions_open - closed | [default to null] | +| **stateChangeDates** | [**Jam_stateChangeDates**](Jam_stateChangeDates.md) | | [default to null] | +| **submissionContentGateDate** | **Date** | | [default to null] | +| **submissionContentGated** | **Boolean** | | [default to null] | +| **title** | **String** | | [default to null] | +| **updated\_at** | **Date** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Jam_stateChangeDates.md b/Models/Jam_stateChangeDates.md new file mode 100644 index 0000000..5ec48b0 --- /dev/null +++ b/Models/Jam_stateChangeDates.md @@ -0,0 +1,12 @@ +# Jam_stateChangeDates +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **closed** | **Date** | | [optional] [default to null] | +| **submissionsClosed** | **Date** | | [optional] [default to null] | +| **submissionsOpened** | **Date** | | [optional] [default to null] | +| **winnersSelected** | **Date** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/JoinGroupRequest.md b/Models/JoinGroupRequest.md new file mode 100644 index 0000000..a3c0826 --- /dev/null +++ b/Models/JoinGroupRequest.md @@ -0,0 +1,9 @@ +# JoinGroupRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **inviteId** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/License.md b/Models/License.md new file mode 100644 index 0000000..86d3a47 --- /dev/null +++ b/Models/License.md @@ -0,0 +1,12 @@ +# License +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **forAction** | **String** | | [default to have] | +| **forId** | **String** | Either a AvatarID, LicenseGroupID, PermissionID or ProductID. This depends on the `forType` field. | [default to null] | +| **forName** | **String** | | [default to null] | +| **forType** | **String** | | [default to permission] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/LicenseGroup.md b/Models/LicenseGroup.md new file mode 100644 index 0000000..90d36c3 --- /dev/null +++ b/Models/LicenseGroup.md @@ -0,0 +1,12 @@ +# LicenseGroup +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **description** | **String** | | [default to null] | +| **id** | **String** | | [default to null] | +| **licenses** | [**List**](License.md) | | [default to null] | +| **name** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/LimitedGroup.md b/Models/LimitedGroup.md new file mode 100644 index 0000000..ada13dd --- /dev/null +++ b/Models/LimitedGroup.md @@ -0,0 +1,25 @@ +# LimitedGroup +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **bannerId** | **String** | | [optional] [default to null] | +| **bannerUrl** | **String** | | [optional] [default to null] | +| **createdAt** | **Date** | | [optional] [default to null] | +| **description** | **String** | | [optional] [default to null] | +| **discriminator** | **String** | | [optional] [default to null] | +| **galleries** | [**List**](GroupGallery.md) | | [optional] [default to null] | +| **iconId** | **String** | | [optional] [default to null] | +| **iconUrl** | **String** | | [optional] [default to null] | +| **id** | **String** | | [optional] [default to null] | +| **isSearchable** | **Boolean** | | [optional] [default to null] | +| **memberCount** | **Integer** | | [optional] [default to null] | +| **membershipStatus** | **String** | | [optional] [default to inactive] | +| **name** | **String** | | [optional] [default to null] | +| **ownerId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **rules** | **String** | | [optional] [default to null] | +| **shortCode** | **String** | | [optional] [default to null] | +| **tags** | **List** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/LimitedUnityPackage.md b/Models/LimitedUnityPackage.md new file mode 100644 index 0000000..8d8077f --- /dev/null +++ b/Models/LimitedUnityPackage.md @@ -0,0 +1,11 @@ +# LimitedUnityPackage +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **created\_at** | **Date** | | [default to null] | +| **platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [default to null] | +| **unityVersion** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/LimitedUserFriend.md b/Models/LimitedUserFriend.md new file mode 100644 index 0000000..f32e0ef --- /dev/null +++ b/Models/LimitedUserFriend.md @@ -0,0 +1,31 @@ +# LimitedUserFriend +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **bio** | **String** | | [optional] [default to null] | +| **bioLinks** | **List** | | [optional] [default to null] | +| **currentAvatarImageUrl** | **String** | When profilePicOverride is not empty, use it instead. | [optional] [default to null] | +| **currentAvatarTags** | **List** | | [optional] [default to null] | +| **currentAvatarThumbnailImageUrl** | **String** | When profilePicOverride is not empty, use it instead. | [optional] [default to null] | +| **developerType** | **String** | \"none\" User is a normal user \"trusted\" Unknown \"internal\" Is a VRChat Developer \"moderator\" Is a VRChat Moderator Staff can hide their developerType at will. | [default to none] | +| **displayName** | **String** | | [default to null] | +| **friendKey** | **String** | | [default to null] | +| **id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **imageUrl** | **String** | | [default to null] | +| **isFriend** | **Boolean** | | [default to null] | +| **last\_activity** | **Date** | | [default to null] | +| **last\_login** | **Date** | | [default to null] | +| **last\_mobile** | **Date** | | [default to null] | +| **last\_platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [default to null] | +| **location** | **String** | | [default to null] | +| **platform** | **String** | | [default to null] | +| **profilePicOverride** | **String** | | [optional] [default to null] | +| **profilePicOverrideThumbnail** | **String** | | [optional] [default to null] | +| **status** | **String** | Defines the User's current status, for example \"ask me\", \"join me\" or \"offline. This status is a combined indicator of their online activity and privacy preference. | [default to offline] | +| **statusDescription** | **String** | | [default to null] | +| **tags** | **List** | <- Always empty. | [default to null] | +| **userIcon** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/LimitedUserGroups.md b/Models/LimitedUserGroups.md new file mode 100644 index 0000000..87332ad --- /dev/null +++ b/Models/LimitedUserGroups.md @@ -0,0 +1,26 @@ +# LimitedUserGroups +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **bannerId** | **String** | | [optional] [default to null] | +| **bannerUrl** | **String** | | [optional] [default to null] | +| **description** | **String** | | [optional] [default to null] | +| **discriminator** | **String** | | [optional] [default to null] | +| **groupId** | **String** | | [optional] [default to null] | +| **iconId** | **String** | | [optional] [default to null] | +| **iconUrl** | **String** | | [optional] [default to null] | +| **id** | **String** | | [optional] [default to null] | +| **isRepresenting** | **Boolean** | | [optional] [default to null] | +| **lastPostCreatedAt** | **Date** | | [optional] [default to null] | +| **lastPostReadAt** | **Date** | | [optional] [default to null] | +| **memberCount** | **Integer** | | [optional] [default to null] | +| **memberVisibility** | **String** | | [optional] [default to null] | +| **mutualGroup** | **Boolean** | | [optional] [default to null] | +| **name** | **String** | | [optional] [default to null] | +| **ownerId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **privacy** | **String** | | [optional] [default to null] | +| **shortCode** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/LimitedUserInstance.md b/Models/LimitedUserInstance.md new file mode 100644 index 0000000..8167cc6 --- /dev/null +++ b/Models/LimitedUserInstance.md @@ -0,0 +1,35 @@ +# LimitedUserInstance +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **ageVerificationStatus** | **String** | `verified` is obsolete. User who have verified and are 18+ can switch to `plus18` status. | [default to null] | +| **ageVerified** | **Boolean** | `true` if, user is age verified (not 18+). | [default to null] | +| **allowAvatarCopying** | **Boolean** | | [default to null] | +| **bio** | **String** | | [optional] [default to null] | +| **bioLinks** | **List** | | [optional] [default to null] | +| **currentAvatarImageUrl** | **String** | When profilePicOverride is not empty, use it instead. | [default to null] | +| **currentAvatarTags** | **List** | | [default to null] | +| **currentAvatarThumbnailImageUrl** | **String** | When profilePicOverride is not empty, use it instead. | [default to null] | +| **date\_joined** | **Date** | | [default to null] | +| **developerType** | **String** | \"none\" User is a normal user \"trusted\" Unknown \"internal\" Is a VRChat Developer \"moderator\" Is a VRChat Moderator Staff can hide their developerType at will. | [default to none] | +| **displayName** | **String** | | [default to null] | +| **friendKey** | **String** | | [default to null] | +| **id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **imageUrl** | **String** | | [optional] [default to null] | +| **isFriend** | **Boolean** | | [default to null] | +| **last\_activity** | **Date** | | [default to null] | +| **last\_mobile** | **Date** | | [optional] [default to null] | +| **last\_platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [default to null] | +| **platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [optional] [default to null] | +| **profilePicOverride** | **String** | | [optional] [default to null] | +| **profilePicOverrideThumbnail** | **String** | | [optional] [default to null] | +| **pronouns** | **String** | | [default to null] | +| **state** | **String** | * \"online\" User is online in VRChat * \"active\" User is online, but not in VRChat * \"offline\" User is offline Always offline when returned through `getCurrentUser` (/auth/user). | [optional] [default to offline] | +| **status** | **String** | Defines the User's current status, for example \"ask me\", \"join me\" or \"offline. This status is a combined indicator of their online activity and privacy preference. | [default to offline] | +| **statusDescription** | **String** | | [default to null] | +| **tags** | **List** | | [default to null] | +| **userIcon** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/LimitedUserSearch.md b/Models/LimitedUserSearch.md new file mode 100644 index 0000000..e74d53c --- /dev/null +++ b/Models/LimitedUserSearch.md @@ -0,0 +1,24 @@ +# LimitedUserSearch +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **bio** | **String** | | [optional] [default to null] | +| **bioLinks** | **List** | | [optional] [default to null] | +| **currentAvatarImageUrl** | **String** | When profilePicOverride is not empty, use it instead. | [default to null] | +| **currentAvatarTags** | **List** | | [default to null] | +| **currentAvatarThumbnailImageUrl** | **String** | When profilePicOverride is not empty, use it instead. | [default to null] | +| **developerType** | **String** | \"none\" User is a normal user \"trusted\" Unknown \"internal\" Is a VRChat Developer \"moderator\" Is a VRChat Moderator Staff can hide their developerType at will. | [default to none] | +| **displayName** | **String** | | [default to null] | +| **id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **isFriend** | **Boolean** | | [default to null] | +| **last\_platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [default to null] | +| **profilePicOverride** | **String** | | [optional] [default to null] | +| **pronouns** | **String** | | [optional] [default to null] | +| **status** | **String** | Defines the User's current status, for example \"ask me\", \"join me\" or \"offline. This status is a combined indicator of their online activity and privacy preference. | [default to offline] | +| **statusDescription** | **String** | | [default to null] | +| **tags** | **List** | <- Always empty. | [default to null] | +| **userIcon** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/LimitedWorld.md b/Models/LimitedWorld.md new file mode 100644 index 0000000..8ab4457 --- /dev/null +++ b/Models/LimitedWorld.md @@ -0,0 +1,33 @@ +# LimitedWorld +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **authorId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **authorName** | **String** | | [default to null] | +| **capacity** | **Integer** | | [default to null] | +| **created\_at** | **Date** | | [default to null] | +| **defaultContentSettings** | [**InstanceContentSettings**](InstanceContentSettings.md) | | [optional] [default to null] | +| **favorites** | **Integer** | | [default to 0] | +| **heat** | **Integer** | | [default to 0] | +| **id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [default to null] | +| **imageUrl** | **String** | | [default to null] | +| **labsPublicationDate** | **String** | | [default to null] | +| **name** | **String** | | [default to null] | +| **occupants** | **Integer** | | [default to 0] | +| **organization** | **String** | | [default to vrchat] | +| **popularity** | **Integer** | | [default to 0] | +| **previewYoutubeId** | **String** | | [optional] [default to null] | +| **publicationDate** | **String** | | [default to null] | +| **recommendedCapacity** | **Integer** | | [optional] [default to null] | +| **releaseStatus** | **String** | | [default to public] | +| **storeId** | **String** | | [optional] [default to null] | +| **tags** | **List** | | [default to null] | +| **thumbnailImageUrl** | **String** | | [default to null] | +| **udonProducts** | **List** | | [optional] [default to null] | +| **unityPackages** | [**List**](LimitedUnityPackage.md) | | [default to null] | +| **updated\_at** | **Date** | | [default to null] | +| **visits** | **Integer** | | [optional] [default to 0] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Listing.md b/Models/Listing.md new file mode 100644 index 0000000..79358e2 --- /dev/null +++ b/Models/Listing.md @@ -0,0 +1,42 @@ +# Listing +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **active** | **Boolean** | | [default to null] | +| **buyerRefundable** | **Boolean** | | [default to null] | +| **description** | **String** | | [default to null] | +| **displayName** | **String** | | [default to null] | +| **duration** | **Integer** | | [optional] [default to null] | +| **durationType** | **String** | | [optional] [default to null] | +| **groupIcon** | **String** | | [optional] [default to null] | +| **groupId** | **String** | | [optional] [default to null] | +| **groupName** | **String** | | [optional] [default to null] | +| **hasAvatar** | **Boolean** | | [default to null] | +| **hasUdon** | **Boolean** | | [default to null] | +| **hydratedProducts** | [**List**](Product.md) | | [optional] [default to null] | +| **id** | **String** | | [default to null] | +| **imageId** | **String** | | [optional] [default to null] | +| **imageUrl** | **String** | | [optional] [default to null] | +| **listingType** | **String** | | [default to subscription] | +| **listingVariants** | [**List**](ProductListingVariant.md) | | [optional] [default to null] | +| **permanent** | **Boolean** | | [optional] [default to null] | +| **priceTokens** | **Integer** | | [default to null] | +| **productIds** | **List** | | [default to null] | +| **productType** | **String** | | [default to udon] | +| **products** | **List** | | [default to null] | +| **quantifiable** | **Boolean** | | [optional] [default to null] | +| **recurrable** | **Boolean** | | [default to null] | +| **refundable** | **Boolean** | | [default to null] | +| **sellerDisplayName** | **String** | | [default to null] | +| **sellerId** | **String** | | [default to null] | +| **soldByVrc** | **Boolean** | | [optional] [default to null] | +| **stackable** | **Boolean** | | [default to null] | +| **storeIds** | **List** | | [default to null] | +| **subtitle** | **String** | | [optional] [default to null] | +| **tags** | **List** | | [optional] [default to null] | +| **vrcPlusDiscountPrice** | **Integer** | | [optional] [default to null] | +| **whenToExpire** | **Date** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/ModerateUserRequest.md b/Models/ModerateUserRequest.md new file mode 100644 index 0000000..8907efa --- /dev/null +++ b/Models/ModerateUserRequest.md @@ -0,0 +1,10 @@ +# ModerateUserRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **moderated** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **type** | **String** | | [default to unmute] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/ModerationReport.md b/Models/ModerationReport.md new file mode 100644 index 0000000..e8c8ec1 --- /dev/null +++ b/Models/ModerationReport.md @@ -0,0 +1,18 @@ +# ModerationReport +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **category** | **String** | Valid values are the keys of the object `$.reportOptions[type]` from `GET /config`. Descriptions of these are found at `$.reportCategories[type]`. | [default to null] | +| **contentId** | **String** | | [default to null] | +| **contentName** | **String** | | [default to null] | +| **contentThumbnailImageUrl** | **String** | | [default to null] | +| **description** | **String** | The subjective reason for the report | [default to null] | +| **evidenceRequired** | **Boolean** | | [default to null] | +| **id** | **String** | | [default to null] | +| **reason** | **String** | Valid values are the strings in the array `$.reportOptions[type][category]` from `GET /config`. Descriptions of these are found at `$.reportReasons[type]`. | [default to null] | +| **supportRequired** | **Boolean** | | [default to null] | +| **type** | **String** | Valid values are the keys of the object `$.reportOptions` from `GET /config`. | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/MutualFriend.md b/Models/MutualFriend.md new file mode 100644 index 0000000..f4c2589 --- /dev/null +++ b/Models/MutualFriend.md @@ -0,0 +1,18 @@ +# MutualFriend +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **avatarThumbnail** | **String** | When profilePicOverride is not empty, use it instead. | [optional] [default to null] | +| **currentAvatarImageUrl** | **String** | When profilePicOverride is not empty, use it instead. | [default to null] | +| **currentAvatarTags** | **List** | | [optional] [default to null] | +| **currentAvatarThumbnailImageUrl** | **String** | When profilePicOverride is not empty, use it instead. | [optional] [default to null] | +| **displayName** | **String** | | [default to null] | +| **id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **imageUrl** | **String** | | [default to null] | +| **profilePicOverride** | **String** | | [optional] [default to null] | +| **status** | **String** | Defines the User's current status, for example \"ask me\", \"join me\" or \"offline. This status is a combined indicator of their online activity and privacy preference. | [default to offline] | +| **statusDescription** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Mutuals.md b/Models/Mutuals.md new file mode 100644 index 0000000..ef61e94 --- /dev/null +++ b/Models/Mutuals.md @@ -0,0 +1,10 @@ +# Mutuals +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **friends** | **Integer** | | [default to 0] | +| **groups** | **Integer** | | [default to 0] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Notification.md b/Models/Notification.md new file mode 100644 index 0000000..a48a608 --- /dev/null +++ b/Models/Notification.md @@ -0,0 +1,17 @@ +# Notification +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **created\_at** | **Date** | | [default to null] | +| **details** | **String** | **NOTICE:** This is not a JSON object when received from the REST API, but it is when received from the Websocket API. When received from the REST API, this is a json **encoded** object, meaning you have to json-de-encode to get the NotificationDetail object depending on the NotificationType. | [default to {}] | +| **id** | **String** | | [default to null] | +| **message** | **String** | | [default to null] | +| **receiverUserId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **seen** | **Boolean** | Not included in notification objects received from the Websocket API | [optional] [default to false] | +| **senderUserId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **senderUsername** | **String** | -| **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). | [optional] [default to null] | +| **type** | **String** | | [default to friendRequest] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/NotificationDetailInvite.md b/Models/NotificationDetailInvite.md new file mode 100644 index 0000000..0df9ff3 --- /dev/null +++ b/Models/NotificationDetailInvite.md @@ -0,0 +1,11 @@ +# NotificationDetailInvite +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **inviteMessage** | **String** | | [optional] [default to null] | +| **worldId** | **String** | Represents a unique location, consisting of a world identifier and an instance identifier, or \"offline\" if the user is not on your friends list. | [default to null] | +| **worldName** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/NotificationDetailInviteResponse.md b/Models/NotificationDetailInviteResponse.md new file mode 100644 index 0000000..c3bd1fd --- /dev/null +++ b/Models/NotificationDetailInviteResponse.md @@ -0,0 +1,10 @@ +# NotificationDetailInviteResponse +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **inResponseTo** | **String** | | [default to null] | +| **responseMessage** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/NotificationDetailRequestInvite.md b/Models/NotificationDetailRequestInvite.md new file mode 100644 index 0000000..d74c8f6 --- /dev/null +++ b/Models/NotificationDetailRequestInvite.md @@ -0,0 +1,10 @@ +# NotificationDetailRequestInvite +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [optional] [default to null] | +| **requestMessage** | **String** | Used when using InviteMessage Slot. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/NotificationDetailRequestInviteResponse.md b/Models/NotificationDetailRequestInviteResponse.md new file mode 100644 index 0000000..e8deec5 --- /dev/null +++ b/Models/NotificationDetailRequestInviteResponse.md @@ -0,0 +1,10 @@ +# NotificationDetailRequestInviteResponse +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **inResponseTo** | **String** | | [default to null] | +| **requestMessage** | **String** | Used when using InviteMessage Slot. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/NotificationDetailVoteToKick.md b/Models/NotificationDetailVoteToKick.md new file mode 100644 index 0000000..7c60e37 --- /dev/null +++ b/Models/NotificationDetailVoteToKick.md @@ -0,0 +1,10 @@ +# NotificationDetailVoteToKick +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **initiatorUserId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **userToKickId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/NotificationV2.md b/Models/NotificationV2.md new file mode 100644 index 0000000..4a47b33 --- /dev/null +++ b/Models/NotificationV2.md @@ -0,0 +1,36 @@ +# NotificationV2 +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **canDelete** | **Boolean** | | [default to null] | +| **category** | **String** | | [default to null] | +| **createdAt** | **Date** | | [default to null] | +| **data** | [**oas_any_type_not_mapped**](.md) | | [default to null] | +| **details** | [**NotificationV2DetailsBoop**](NotificationV2DetailsBoop.md) | | [optional] [default to null] | +| **expiresAt** | **Date** | | [default to null] | +| **expiryAfterSeen** | **Integer** | | [default to null] | +| **id** | **String** | | [default to null] | +| **ignoreDND** | **Boolean** | | [default to null] | +| **imageUrl** | **String** | | [default to null] | +| **isSystem** | **Boolean** | | [default to null] | +| **link** | **String** | | [default to null] | +| **linkText** | **String** | | [default to null] | +| **linkTextKey** | **String** | | [default to null] | +| **message** | **String** | | [default to null] | +| **messageKey** | **String** | | [optional] [default to null] | +| **receiverUserId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **relatedNotificationsId** | **String** | | [default to null] | +| **requireSeen** | **Boolean** | | [default to null] | +| **responses** | [**List**](NotificationV2Response.md) | | [default to null] | +| **seen** | **Boolean** | | [default to null] | +| **senderUserId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **senderUsername** | **String** | | [default to null] | +| **title** | **String** | | [default to null] | +| **titleKey** | **String** | | [default to null] | +| **type** | **String** | | [default to group.announcement] | +| **updatedAt** | **Date** | | [default to null] | +| **version** | **Integer** | | [default to 2] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/NotificationV2DetailsBoop.md b/Models/NotificationV2DetailsBoop.md new file mode 100644 index 0000000..c924952 --- /dev/null +++ b/Models/NotificationV2DetailsBoop.md @@ -0,0 +1,11 @@ +# NotificationV2DetailsBoop +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **emojiId** | **String** | Either a FileID or a string constant for default emojis | [default to null] | +| **emojiVersion** | **Integer** | | [default to null] | +| **inventoryItemId** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/NotificationV2Response.md b/Models/NotificationV2Response.md new file mode 100644 index 0000000..823d21b --- /dev/null +++ b/Models/NotificationV2Response.md @@ -0,0 +1,13 @@ +# NotificationV2Response +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **data** | **String** | | [default to null] | +| **icon** | **String** | | [default to null] | +| **text** | **String** | | [default to null] | +| **textKey** | **String** | | [default to null] | +| **type** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/OkStatus.md b/Models/OkStatus.md new file mode 100644 index 0000000..57d2da4 --- /dev/null +++ b/Models/OkStatus.md @@ -0,0 +1,9 @@ +# OkStatus +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **ok** | **String** | The actual status itself | [default to maybe?] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/OkStatus2.md b/Models/OkStatus2.md new file mode 100644 index 0000000..deae9f6 --- /dev/null +++ b/Models/OkStatus2.md @@ -0,0 +1,9 @@ +# OkStatus2 +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **OK** | **String** | The actual status itself | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/PaginatedCalendarEventList.md b/Models/PaginatedCalendarEventList.md new file mode 100644 index 0000000..b1c3681 --- /dev/null +++ b/Models/PaginatedCalendarEventList.md @@ -0,0 +1,11 @@ +# PaginatedCalendarEventList +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **hasNext** | **Boolean** | Whether there are more results after this page. | [optional] [default to null] | +| **results** | [**List**](CalendarEvent.md) | | [optional] [default to null] | +| **totalCount** | **Integer** | The total number of results that the query would return if there were no pagination. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/PaginatedGroupAuditLogEntryList.md b/Models/PaginatedGroupAuditLogEntryList.md new file mode 100644 index 0000000..57f627d --- /dev/null +++ b/Models/PaginatedGroupAuditLogEntryList.md @@ -0,0 +1,11 @@ +# PaginatedGroupAuditLogEntryList +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **hasNext** | **Boolean** | Whether there are more results after this page. | [optional] [default to null] | +| **results** | [**List**](GroupAuditLogEntry.md) | | [optional] [default to null] | +| **totalCount** | **Integer** | The total number of results that the query would return if there were no pagination. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/PaginatedModerationReportList.md b/Models/PaginatedModerationReportList.md new file mode 100644 index 0000000..b7befdc --- /dev/null +++ b/Models/PaginatedModerationReportList.md @@ -0,0 +1,11 @@ +# PaginatedModerationReportList +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **hasNext** | **Boolean** | Whether there are more results after this page. | [optional] [default to null] | +| **results** | [**List**](ModerationReport.md) | The list of moderation reports. | [optional] [default to null] | +| **totalCount** | **Integer** | The total number of results that the query would return if there were no pagination. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/PastDisplayName.md b/Models/PastDisplayName.md new file mode 100644 index 0000000..ddc0490 --- /dev/null +++ b/Models/PastDisplayName.md @@ -0,0 +1,10 @@ +# PastDisplayName +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **displayName** | **String** | | [default to null] | +| **updated\_at** | **Date** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Pending2FAResult.md b/Models/Pending2FAResult.md new file mode 100644 index 0000000..5b20b4f --- /dev/null +++ b/Models/Pending2FAResult.md @@ -0,0 +1,10 @@ +# Pending2FAResult +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **qrCodeDataUrl** | **String** | | [default to null] | +| **secret** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/PerformanceLimiterInfo.md b/Models/PerformanceLimiterInfo.md new file mode 100644 index 0000000..791158b --- /dev/null +++ b/Models/PerformanceLimiterInfo.md @@ -0,0 +1,9 @@ +# PerformanceLimiterInfo +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **maxSeats** | **Integer** | Maximum amount of seats. -1 means no limit. | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Permission.md b/Models/Permission.md new file mode 100644 index 0000000..7a6bebb --- /dev/null +++ b/Models/Permission.md @@ -0,0 +1,16 @@ +# Permission +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **data** | [**Permission_data**](Permission_data.md) | | [optional] [default to null] | +| **description** | **String** | | [optional] [default to null] | +| **displayName** | **String** | | [optional] [default to null] | +| **id** | **String** | | [default to null] | +| **name** | **String** | | [default to null] | +| **ownerDisplayName** | **String** | | [default to null] | +| **ownerId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **type** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Permission_data.md b/Models/Permission_data.md new file mode 100644 index 0000000..77cde5c --- /dev/null +++ b/Models/Permission_data.md @@ -0,0 +1,13 @@ +# Permission_data +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **badges** | **List** | Badges afforded the user by this permission | [optional] [default to null] | +| **max** | **Integer** | Maximum value afforded the user by this permission | [optional] [default to null] | +| **maxFavoriteGroups** | **Map** | Maximum favorite groups afforded the user by this permission | [optional] [default to null] | +| **maxFavoritesPerGroup** | **Map** | Maximum favorites per group afforded the user by this permission | [optional] [default to null] | +| **tags** | **List** | Tags afforded the user by this permission | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/PlatformBuildInfo.md b/Models/PlatformBuildInfo.md new file mode 100644 index 0000000..d2920eb --- /dev/null +++ b/Models/PlatformBuildInfo.md @@ -0,0 +1,10 @@ +# PlatformBuildInfo +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **minBuildNumber** | **Integer** | Minimum build number required for the platform | [default to null] | +| **redirectionAddress** | **String** | Redirection URL for updating the app | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/PlayerModeration.md b/Models/PlayerModeration.md new file mode 100644 index 0000000..7966387 --- /dev/null +++ b/Models/PlayerModeration.md @@ -0,0 +1,15 @@ +# PlayerModeration +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **created** | **Date** | | [default to null] | +| **id** | **String** | | [default to null] | +| **sourceDisplayName** | **String** | | [default to null] | +| **sourceUserId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **targetDisplayName** | **String** | | [default to null] | +| **targetUserId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **type** | **String** | | [default to unmute] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Print.md b/Models/Print.md new file mode 100644 index 0000000..0cf4a22 --- /dev/null +++ b/Models/Print.md @@ -0,0 +1,18 @@ +# Print +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **authorId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **authorName** | **String** | | [default to null] | +| **createdAt** | **Date** | | [default to null] | +| **files** | [**Print_files**](Print_files.md) | | [default to null] | +| **id** | **String** | | [default to null] | +| **note** | **String** | | [default to null] | +| **ownerId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **timestamp** | **Date** | | [default to null] | +| **worldId** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [default to null] | +| **worldName** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Print_files.md b/Models/Print_files.md new file mode 100644 index 0000000..82d1ba7 --- /dev/null +++ b/Models/Print_files.md @@ -0,0 +1,10 @@ +# Print_files +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **fileId** | **String** | | [optional] [default to null] | +| **image** | **String** | Link to file, e.g. https://api.vrchat.cloud/api/1/file/file_66fe782d-f2bd-4462-9761-1d766d7b2b26/1/file | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Product.md b/Models/Product.md new file mode 100644 index 0000000..15b8a2d --- /dev/null +++ b/Models/Product.md @@ -0,0 +1,25 @@ +# Product +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **archived** | **Boolean** | | [optional] [default to null] | +| **created** | **Date** | | [optional] [default to null] | +| **description** | **String** | | [default to null] | +| **displayName** | **String** | | [default to null] | +| **groupAccess** | **Boolean** | | [optional] [default to false] | +| **groupAccessRemove** | **Boolean** | | [optional] [default to false] | +| **groupId** | **String** | | [optional] [default to null] | +| **groupRoleId** | **String** | | [optional] [default to null] | +| **id** | **String** | | [default to null] | +| **imageId** | **String** | | [default to null] | +| **parentListings** | **List** | | [default to null] | +| **productType** | **String** | | [default to udon] | +| **sellerDisplayName** | **String** | | [default to null] | +| **sellerId** | **String** | | [default to null] | +| **tags** | **List** | | [default to null] | +| **updated** | **Date** | | [optional] [default to null] | +| **useForSubscriberList** | **Boolean** | | [optional] [default to false] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/ProductListingVariant.md b/Models/ProductListingVariant.md new file mode 100644 index 0000000..79c1986 --- /dev/null +++ b/Models/ProductListingVariant.md @@ -0,0 +1,14 @@ +# ProductListingVariant +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **effectiveFrom** | **Date** | | [optional] [default to null] | +| **listingVariantId** | **String** | | [default to null] | +| **nonRefundable** | **Boolean** | | [default to null] | +| **quantity** | **Integer** | | [default to null] | +| **sellerVariant** | **Boolean** | | [default to null] | +| **unitPriceTokens** | **Integer** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/ProductPurchase.md b/Models/ProductPurchase.md new file mode 100644 index 0000000..977be20 --- /dev/null +++ b/Models/ProductPurchase.md @@ -0,0 +1,45 @@ +# ProductPurchase +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **buyerDisplayName** | **String** | | [default to null] | +| **buyerId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **firstParty** | **Boolean** | | [optional] [default to null] | +| **isBuyer** | **Boolean** | | [default to null] | +| **isGift** | **Boolean** | | [default to null] | +| **isReceiver** | **Boolean** | | [default to null] | +| **isSeller** | **Boolean** | | [default to null] | +| **listingCurrentlyAvailable** | **Boolean** | | [default to null] | +| **listingDisplayName** | **String** | | [default to null] | +| **listingId** | **String** | | [default to null] | +| **listingImageId** | **String** | | [default to null] | +| **listingSubtitle** | **String** | | [default to null] | +| **listingType** | **String** | | [default to subscription] | +| **products** | **List** | | [default to null] | +| **purchaseActive** | **Boolean** | | [default to null] | +| **purchaseContext** | [**ProductPurchase_purchaseContext**](ProductPurchase_purchaseContext.md) | | [default to null] | +| **purchaseCurrentStatus** | **String** | | [default to null] | +| **purchaseDate** | **Date** | | [default to null] | +| **purchaseDuration** | **Integer** | | [optional] [default to null] | +| **purchaseDurationType** | **String** | | [optional] [default to null] | +| **purchaseEndDate** | **Date** | | [default to null] | +| **purchaseId** | **String** | | [default to null] | +| **purchaseLatest** | **Boolean** | | [default to null] | +| **purchasePrice** | **Integer** | | [default to null] | +| **purchaseQuantity** | **Integer** | | [default to null] | +| **purchaseStartDate** | **Date** | | [default to null] | +| **purchaseToken** | [**Object**](.md) | | [default to null] | +| **purchaseType** | **String** | | [default to null] | +| **purchaseUnitPrice** | **Integer** | | [default to null] | +| **receiverDisplayName** | **String** | | [default to null] | +| **receiverId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **recurrable** | **Boolean** | | [default to null] | +| **refundable** | **Boolean** | | [default to null] | +| **sellerDisplayName** | **String** | | [default to null] | +| **sellerId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **stackable** | **Boolean** | | [default to null] | +| **willRecur** | **Boolean** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/ProductPurchase_purchaseContext.md b/Models/ProductPurchase_purchaseContext.md new file mode 100644 index 0000000..a1e90e7 --- /dev/null +++ b/Models/ProductPurchase_purchaseContext.md @@ -0,0 +1,9 @@ +# ProductPurchase_purchaseContext +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **locationType** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Prop.md b/Models/Prop.md new file mode 100644 index 0000000..521392f --- /dev/null +++ b/Models/Prop.md @@ -0,0 +1,24 @@ +# Prop +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **\_created\_at** | **Date** | | [default to null] | +| **\_updated\_at** | **Date** | | [default to null] | +| **authorId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **authorName** | **String** | | [default to null] | +| **description** | **String** | | [default to null] | +| **id** | **String** | | [default to null] | +| **imageUrl** | **String** | | [default to null] | +| **maxCountPerUser** | **Integer** | | [default to 1] | +| **name** | **String** | | [default to null] | +| **releaseStatus** | **String** | | [default to public] | +| **spawnType** | **Integer** | How a prop is summoned and interacted with. 0: the prop fixed to some surface in the world 1: the prop is a pickup and may be held by users 2: ??? | [default to 1] | +| **tags** | **List** | | [default to null] | +| **thumbnailImageUrl** | **String** | | [default to null] | +| **unityPackageUrl** | **String** | | [default to null] | +| **unityPackages** | [**Set**](PropUnityPackage.md) | | [default to null] | +| **worldPlacementMask** | **Integer** | Bitmask for restrictions on what world surfaces a prop may be summoned. 0: no restrictions 1: floors 2: walls 4: ceilings | [default to 1] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/PropPublishStatus.md b/Models/PropPublishStatus.md new file mode 100644 index 0000000..b7cd94c --- /dev/null +++ b/Models/PropPublishStatus.md @@ -0,0 +1,9 @@ +# PropPublishStatus +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **canPublish** | **Boolean** | | [optional] [default to false] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/PropUnityPackage.md b/Models/PropUnityPackage.md new file mode 100644 index 0000000..05f0964 --- /dev/null +++ b/Models/PropUnityPackage.md @@ -0,0 +1,14 @@ +# PropUnityPackage +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **assetUrl** | **String** | | [default to null] | +| **assetVersion** | **Integer** | | [default to null] | +| **platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [default to null] | +| **propSignature** | **String** | | [default to null] | +| **unityVersion** | **String** | | [default to 2022.3.22f1] | +| **variant** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/PurchaseProductListingRequest.md b/Models/PurchaseProductListingRequest.md new file mode 100644 index 0000000..26b8859 --- /dev/null +++ b/Models/PurchaseProductListingRequest.md @@ -0,0 +1,11 @@ +# PurchaseProductListingRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **listingId** | **String** | | [default to null] | +| **quantity** | **Integer** | | [default to 1] | +| **totalPrice** | **Integer** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/RegisterUserAccountRequest.md b/Models/RegisterUserAccountRequest.md new file mode 100644 index 0000000..53071c0 --- /dev/null +++ b/Models/RegisterUserAccountRequest.md @@ -0,0 +1,17 @@ +# RegisterUserAccountRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **acceptedTOSVersion** | **Integer** | The most recent version of the TOS | [default to null] | +| **captchaCode** | **String** | Captcha code | [default to null] | +| **day** | **String** | Birth day of month | [default to null] | +| **email** | **String** | Email address | [default to null] | +| **month** | **String** | Birth month of year | [default to null] | +| **password** | **String** | Password | [default to null] | +| **subscribe** | **Boolean** | Whether to recieve promotional emails | [default to null] | +| **username** | **String** | Display Name / Username (Username is a sanitized version) | [default to null] | +| **year** | **String** | Birth year | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/ReportCategory.md b/Models/ReportCategory.md new file mode 100644 index 0000000..a76110e --- /dev/null +++ b/Models/ReportCategory.md @@ -0,0 +1,12 @@ +# ReportCategory +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **description** | **String** | The description of the report category | [optional] [default to null] | +| **text** | **String** | The label of the report category | [default to null] | +| **title** | **String** | The title of the report category | [optional] [default to null] | +| **tooltip** | **String** | The tooltip that describes the category | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/ReportReason.md b/Models/ReportReason.md new file mode 100644 index 0000000..a909032 --- /dev/null +++ b/Models/ReportReason.md @@ -0,0 +1,10 @@ +# ReportReason +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **text** | **String** | The label or name of the report reason | [default to null] | +| **tooltip** | **String** | A brief explanation of what this reason entails | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/RepresentedGroup.md b/Models/RepresentedGroup.md new file mode 100644 index 0000000..91f4767 --- /dev/null +++ b/Models/RepresentedGroup.md @@ -0,0 +1,22 @@ +# RepresentedGroup +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **bannerId** | **String** | | [optional] [default to null] | +| **bannerUrl** | **String** | | [optional] [default to null] | +| **description** | **String** | | [optional] [default to null] | +| **discriminator** | **String** | | [optional] [default to null] | +| **groupId** | **String** | | [optional] [default to null] | +| **iconId** | **String** | | [optional] [default to null] | +| **iconUrl** | **String** | | [optional] [default to null] | +| **isRepresenting** | **Boolean** | | [optional] [default to null] | +| **memberCount** | **Integer** | | [optional] [default to null] | +| **memberVisibility** | **String** | | [optional] [default to null] | +| **name** | **String** | | [optional] [default to null] | +| **ownerId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **privacy** | **String** | | [optional] [default to default] | +| **shortCode** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/RequestInviteRequest.md b/Models/RequestInviteRequest.md new file mode 100644 index 0000000..9f2f6bb --- /dev/null +++ b/Models/RequestInviteRequest.md @@ -0,0 +1,9 @@ +# RequestInviteRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **requestSlot** | **Integer** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/RespondGroupJoinRequest.md b/Models/RespondGroupJoinRequest.md new file mode 100644 index 0000000..eb8966b --- /dev/null +++ b/Models/RespondGroupJoinRequest.md @@ -0,0 +1,10 @@ +# RespondGroupJoinRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **action** | **String** | | [default to null] | +| **block** | **Boolean** | Whether to block the user from requesting again | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/RespondNotificationV2Request.md b/Models/RespondNotificationV2Request.md new file mode 100644 index 0000000..31f6599 --- /dev/null +++ b/Models/RespondNotificationV2Request.md @@ -0,0 +1,10 @@ +# RespondNotificationV2Request +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **responseData** | **String** | | [optional] [default to ] | +| **responseType** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Response.md b/Models/Response.md new file mode 100644 index 0000000..ae0bdf8 --- /dev/null +++ b/Models/Response.md @@ -0,0 +1,10 @@ +# Response +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **message** | **String** | | [optional] [default to null] | +| **status\_code** | **Integer** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/SentNotification.md b/Models/SentNotification.md new file mode 100644 index 0000000..6c26960 --- /dev/null +++ b/Models/SentNotification.md @@ -0,0 +1,16 @@ +# SentNotification +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **created\_at** | **Date** | | [default to null] | +| **details** | [**oas_any_type_not_mapped**](.md) | | [default to null] | +| **id** | **String** | | [default to null] | +| **message** | **String** | | [default to null] | +| **receiverUserId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **senderUserId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **senderUsername** | **String** | -| **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). | [optional] [default to null] | +| **type** | **String** | | [default to friendRequest] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/ServiceQueueStats.md b/Models/ServiceQueueStats.md new file mode 100644 index 0000000..ae061d5 --- /dev/null +++ b/Models/ServiceQueueStats.md @@ -0,0 +1,9 @@ +# ServiceQueueStats +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **estimatedServiceDurationSeconds** | **Integer** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/ServiceStatus.md b/Models/ServiceStatus.md new file mode 100644 index 0000000..6a015be --- /dev/null +++ b/Models/ServiceStatus.md @@ -0,0 +1,17 @@ +# ServiceStatus +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **created\_at** | **Date** | | [default to null] | +| **id** | **String** | The id of this service, NOT the id of the thing this service was requested for. | [default to null] | +| **progress** | **List** | | [default to null] | +| **requesterUserId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **state** | **String** | | [default to null] | +| **subjectId** | **String** | The id of the thing this service was requested for. | [default to null] | +| **subjectType** | **String** | The kind of the thing this service was requested for. | [default to null] | +| **type** | **String** | The kind of service that was requested. | [default to null] | +| **updated\_at** | **Date** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/ShareInventoryItemDirectRequest.md b/Models/ShareInventoryItemDirectRequest.md new file mode 100644 index 0000000..cb5c543 --- /dev/null +++ b/Models/ShareInventoryItemDirectRequest.md @@ -0,0 +1,10 @@ +# ShareInventoryItemDirectRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **itemId** | **String** | | [default to null] | +| **users** | **List** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Store.md b/Models/Store.md new file mode 100644 index 0000000..240d68b --- /dev/null +++ b/Models/Store.md @@ -0,0 +1,22 @@ +# Store +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **description** | **String** | | [default to null] | +| **displayName** | **String** | | [default to null] | +| **groupId** | **String** | | [optional] [default to null] | +| **id** | **String** | | [default to null] | +| **listingIds** | **List** | Only for store type world and group | [optional] [default to null] | +| **listings** | [**List**](Listing.md) | Only for store type world and group | [optional] [default to null] | +| **sellerDisplayName** | **String** | | [default to null] | +| **sellerId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **shelfIds** | **List** | Only for store type house | [optional] [default to null] | +| **shelves** | [**List**](StoreShelf.md) | Only for store type house | [optional] [default to null] | +| **storeId** | **String** | | [default to null] | +| **storeType** | **String** | | [default to group] | +| **tags** | **List** | | [default to null] | +| **worldId** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/StoreShelf.md b/Models/StoreShelf.md new file mode 100644 index 0000000..04c3bb5 --- /dev/null +++ b/Models/StoreShelf.md @@ -0,0 +1,17 @@ +# StoreShelf +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **highlightListing** | [**Listing**](Listing.md) | | [optional] [default to null] | +| **highlightListingId** | **String** | | [optional] [default to null] | +| **id** | **String** | | [default to null] | +| **listingIds** | **List** | | [default to null] | +| **listings** | [**List**](Listing.md) | | [optional] [default to null] | +| **shelfDescription** | **String** | | [default to null] | +| **shelfLayout** | **String** | | [default to null] | +| **shelfTitle** | **String** | | [default to null] | +| **updatedAt** | **Date** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Submission.md b/Models/Submission.md new file mode 100644 index 0000000..e230ebc --- /dev/null +++ b/Models/Submission.md @@ -0,0 +1,15 @@ +# Submission +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **contentId** | **String** | Either world ID or avatar ID | [default to null] | +| **created\_at** | **Date** | | [default to null] | +| **description** | **String** | | [default to null] | +| **id** | **String** | | [default to null] | +| **jamId** | **String** | | [default to null] | +| **ratingScore** | **Integer** | | [optional] [default to null] | +| **submitterId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/SubmitModerationReportRequest.md b/Models/SubmitModerationReportRequest.md new file mode 100644 index 0000000..569eb90 --- /dev/null +++ b/Models/SubmitModerationReportRequest.md @@ -0,0 +1,14 @@ +# SubmitModerationReportRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **category** | **String** | Valid values are the keys of the object `$.reportOptions[type]` from `GET /config`. Descriptions of these are found at `$.reportCategories[type]`. | [default to null] | +| **contentId** | **String** | The id of the user, group, world, avatar, inventory item, print, etc. being reported. | [default to null] | +| **description** | **String** | The subjective reason for the report | [optional] [default to null] | +| **details** | [**SubmitModerationReportRequest_details**](SubmitModerationReportRequest_details.md) | | [optional] [default to null] | +| **reason** | **String** | Valid values are the strings in the array `$.reportOptions[type][category]` from `GET /config`. Descriptions of these are found at `$.reportReasons[type]`. | [default to null] | +| **type** | **String** | Valid values are the keys of the object `$.reportOptions` from `GET /config`. | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/SubmitModerationReportRequest_details.md b/Models/SubmitModerationReportRequest_details.md new file mode 100644 index 0000000..ade672d --- /dev/null +++ b/Models/SubmitModerationReportRequest_details.md @@ -0,0 +1,15 @@ +# SubmitModerationReportRequest_details +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **fileId** | **String** | | [optional] [default to null] | +| **holderId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **imageType** | **String** | Relevant detail for reports about image content, such as emoji. | [optional] [default to null] | +| **instanceAgeGated** | **Boolean** | Relevant detail for reports taking place from within an instance. | [optional] [default to null] | +| **instanceType** | **String** | Relevant detail for reports taking place from within an instance. | [optional] [default to null] | +| **suggestedWarnings** | **List** | Relevant detail for reports about content that might not be tagged properly. | [optional] [default to null] | +| **userInSameInstance** | **Boolean** | Relevant detail for reports involving another user in the same instance world. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Subscription.md b/Models/Subscription.md new file mode 100644 index 0000000..031da67 --- /dev/null +++ b/Models/Subscription.md @@ -0,0 +1,19 @@ +# Subscription +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **amount** | **BigDecimal** | | [default to null] | +| **appleProductId** | **String** | | [optional] [default to null] | +| **description** | **String** | | [default to null] | +| **googlePlanId** | **String** | | [optional] [default to null] | +| **googleProductId** | **String** | | [optional] [default to null] | +| **id** | **String** | | [default to null] | +| **oculusSku** | **String** | | [optional] [default to null] | +| **period** | **String** | | [default to month] | +| **picoSku** | **String** | | [optional] [default to null] | +| **steamItemId** | **String** | | [default to null] | +| **tier** | **Integer** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Success.md b/Models/Success.md new file mode 100644 index 0000000..9c6861f --- /dev/null +++ b/Models/Success.md @@ -0,0 +1,9 @@ +# Success +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **success** | [**Response**](Response.md) | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/SuccessFlag.md b/Models/SuccessFlag.md new file mode 100644 index 0000000..a8eae62 --- /dev/null +++ b/Models/SuccessFlag.md @@ -0,0 +1,9 @@ +# SuccessFlag +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **success** | **Boolean** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/TiliaStatus.md b/Models/TiliaStatus.md new file mode 100644 index 0000000..0761955 --- /dev/null +++ b/Models/TiliaStatus.md @@ -0,0 +1,12 @@ +# TiliaStatus +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **economyOnline** | **Boolean** | | [default to null] | +| **economyState** | **Integer** | | [optional] [default to null] | +| **plannedOfflineWindowEnd** | **Date** | | [optional] [default to null] | +| **plannedOfflineWindowStart** | **Date** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/TiliaTOS.md b/Models/TiliaTOS.md new file mode 100644 index 0000000..74b45aa --- /dev/null +++ b/Models/TiliaTOS.md @@ -0,0 +1,9 @@ +# TiliaTOS +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **signed\_tos** | **Boolean** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/TokenBundle.md b/Models/TokenBundle.md new file mode 100644 index 0000000..9e2d20e --- /dev/null +++ b/Models/TokenBundle.md @@ -0,0 +1,17 @@ +# TokenBundle +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **amount** | **Integer** | price of the bundle | [default to null] | +| **appleProductId** | **String** | | [default to null] | +| **description** | **String** | | [default to null] | +| **googleProductId** | **String** | | [optional] [default to null] | +| **id** | **String** | | [default to null] | +| **imageUrl** | **String** | direct url to image | [default to null] | +| **oculusSku** | **String** | | [default to null] | +| **steamItemId** | **String** | | [default to null] | +| **tokens** | **Integer** | number of tokens received | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Transaction.md b/Models/Transaction.md new file mode 100644 index 0000000..258bedd --- /dev/null +++ b/Models/Transaction.md @@ -0,0 +1,21 @@ +# Transaction +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **agreement** | [**TransactionAgreement**](TransactionAgreement.md) | | [optional] [default to null] | +| **created\_at** | **Date** | | [default to null] | +| **error** | **String** | | [default to null] | +| **id** | **String** | | [default to null] | +| **isGift** | **Boolean** | | [optional] [default to false] | +| **isTokens** | **Boolean** | | [optional] [default to false] | +| **sandbox** | **Boolean** | | [default to false] | +| **status** | **String** | | [default to active] | +| **steam** | [**TransactionSteamInfo**](TransactionSteamInfo.md) | | [optional] [default to null] | +| **subscription** | [**Subscription**](Subscription.md) | | [default to null] | +| **updated\_at** | **Date** | | [default to null] | +| **userDisplayName** | **String** | | [optional] [default to null] | +| **userId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/TransactionAgreement.md b/Models/TransactionAgreement.md new file mode 100644 index 0000000..2f76420 --- /dev/null +++ b/Models/TransactionAgreement.md @@ -0,0 +1,26 @@ +# TransactionAgreement +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **agreement** | **String** | | [default to null] | +| **agreementId** | **String** | | [default to null] | +| **billingType** | **String** | | [default to null] | +| **currency** | **String** | | [default to null] | +| **endDate** | **String** | | [default to null] | +| **failedAttempts** | **Integer** | | [default to null] | +| **frequency** | **Integer** | | [default to null] | +| **itemId** | **Integer** | | [default to null] | +| **lastAmount** | **BigDecimal** | | [default to null] | +| **lastAmountVat** | **BigDecimal** | | [default to null] | +| **lastPayment** | **String** | | [default to null] | +| **nextPayment** | **String** | | [default to null] | +| **outstanding** | **Integer** | | [default to null] | +| **period** | **String** | | [default to null] | +| **recurringAmt** | **BigDecimal** | | [default to null] | +| **startDate** | **String** | | [default to null] | +| **status** | **String** | This is NOT TransactionStatus, but whatever Steam return. | [default to null] | +| **timeCreated** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/TransactionSteamInfo.md b/Models/TransactionSteamInfo.md new file mode 100644 index 0000000..832bbea --- /dev/null +++ b/Models/TransactionSteamInfo.md @@ -0,0 +1,13 @@ +# TransactionSteamInfo +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **orderId** | **String** | Steam Order ID | [default to null] | +| **steamId** | **String** | Steam User ID | [default to null] | +| **steamUrl** | **String** | Empty | [default to null] | +| **transId** | **String** | Steam Transaction ID, NOT the same as VRChat TransactionID | [default to null] | +| **walletInfo** | [**TransactionSteamWalletInfo**](TransactionSteamWalletInfo.md) | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/TransactionSteamWalletInfo.md b/Models/TransactionSteamWalletInfo.md new file mode 100644 index 0000000..6b5e4e2 --- /dev/null +++ b/Models/TransactionSteamWalletInfo.md @@ -0,0 +1,12 @@ +# TransactionSteamWalletInfo +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **country** | **String** | | [default to US] | +| **currency** | **String** | | [default to USD] | +| **state** | **String** | | [default to null] | +| **status** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/TransferGroupRequest.md b/Models/TransferGroupRequest.md new file mode 100644 index 0000000..98376d1 --- /dev/null +++ b/Models/TransferGroupRequest.md @@ -0,0 +1,9 @@ +# TransferGroupRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **transferTargetId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/TwoFactorAuthCode.md b/Models/TwoFactorAuthCode.md new file mode 100644 index 0000000..468a6b5 --- /dev/null +++ b/Models/TwoFactorAuthCode.md @@ -0,0 +1,9 @@ +# TwoFactorAuthCode +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **code** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/TwoFactorEmailCode.md b/Models/TwoFactorEmailCode.md new file mode 100644 index 0000000..4c47b2c --- /dev/null +++ b/Models/TwoFactorEmailCode.md @@ -0,0 +1,9 @@ +# TwoFactorEmailCode +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **code** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/TwoFactorRecoveryCodes.md b/Models/TwoFactorRecoveryCodes.md new file mode 100644 index 0000000..a1f478d --- /dev/null +++ b/Models/TwoFactorRecoveryCodes.md @@ -0,0 +1,10 @@ +# TwoFactorRecoveryCodes +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **otp** | [**List**](TwoFactorRecoveryCodes_otp_inner.md) | | [optional] [default to null] | +| **requiresTwoFactorAuth** | **List** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/TwoFactorRecoveryCodes_otp_inner.md b/Models/TwoFactorRecoveryCodes_otp_inner.md new file mode 100644 index 0000000..59f4d68 --- /dev/null +++ b/Models/TwoFactorRecoveryCodes_otp_inner.md @@ -0,0 +1,10 @@ +# TwoFactorRecoveryCodes_otp_inner +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **code** | **String** | | [default to null] | +| **used** | **Boolean** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UnityPackage.md b/Models/UnityPackage.md new file mode 100644 index 0000000..99d0101 --- /dev/null +++ b/Models/UnityPackage.md @@ -0,0 +1,24 @@ +# UnityPackage +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **assetUrl** | **String** | | [optional] [default to null] | +| **assetUrlObject** | [**Object**](.md) | | [optional] [default to null] | +| **assetVersion** | **Integer** | | [default to null] | +| **created\_at** | **Date** | | [optional] [default to null] | +| **id** | **String** | | [default to null] | +| **impostorUrl** | **String** | | [optional] [default to null] | +| **impostorizerVersion** | **String** | | [optional] [default to null] | +| **performanceRating** | **String** | Avatar Performance ratings. | [optional] [default to null] | +| **platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [default to null] | +| **pluginUrl** | **String** | | [optional] [default to null] | +| **pluginUrlObject** | [**Object**](.md) | | [optional] [default to null] | +| **scanStatus** | **String** | | [optional] [default to null] | +| **unitySortNumber** | **Long** | | [optional] [default to null] | +| **unityVersion** | **String** | | [default to 5.3.4p1] | +| **variant** | **String** | | [optional] [default to null] | +| **worldSignature** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UpdateAssetReviewNotesRequest.md b/Models/UpdateAssetReviewNotesRequest.md new file mode 100644 index 0000000..f1abecb --- /dev/null +++ b/Models/UpdateAssetReviewNotesRequest.md @@ -0,0 +1,9 @@ +# UpdateAssetReviewNotesRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **reviewNotes** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UpdateAvatarRequest.md b/Models/UpdateAvatarRequest.md new file mode 100644 index 0000000..9c1d277 --- /dev/null +++ b/Models/UpdateAvatarRequest.md @@ -0,0 +1,19 @@ +# UpdateAvatarRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **assetUrl** | **String** | | [optional] [default to null] | +| **description** | **String** | | [optional] [default to null] | +| **featured** | **Boolean** | Enabling featured tag requires Admin Credentials. | [optional] [default to null] | +| **id** | **String** | | [optional] [default to null] | +| **imageUrl** | **String** | | [optional] [default to null] | +| **name** | **String** | | [optional] [default to null] | +| **releaseStatus** | **String** | | [optional] [default to public] | +| **tags** | **List** | | [optional] [default to null] | +| **unityPackageUrl** | **String** | | [optional] [default to null] | +| **unityVersion** | **String** | | [optional] [default to 5.3.4p1] | +| **version** | **Integer** | | [optional] [default to 1] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UpdateCalendarEventRequest.md b/Models/UpdateCalendarEventRequest.md new file mode 100644 index 0000000..ded2a81 --- /dev/null +++ b/Models/UpdateCalendarEventRequest.md @@ -0,0 +1,26 @@ +# UpdateCalendarEventRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **category** | **String** | | [optional] [default to null] | +| **closeInstanceAfterEndMinutes** | **Integer** | | [optional] [default to null] | +| **description** | **String** | | [optional] [default to null] | +| **endsAt** | **Date** | Time the vent starts at | [optional] [default to null] | +| **featured** | **Boolean** | | [optional] [default to null] | +| **guestEarlyJoinMinutes** | **Integer** | | [optional] [default to null] | +| **hostEarlyJoinMinutes** | **Integer** | | [optional] [default to null] | +| **imageId** | **String** | | [optional] [default to null] | +| **isDraft** | **Boolean** | | [optional] [default to null] | +| **languages** | **List** | | [optional] [default to null] | +| **parentId** | **String** | | [optional] [default to null] | +| **platforms** | **List** | | [optional] [default to null] | +| **roleIds** | **List** | | [optional] [default to null] | +| **sendCreationNotification** | **Boolean** | Send notification to group members. | [optional] [default to false] | +| **startsAt** | **Date** | Time the vent starts at | [optional] [default to null] | +| **tags** | **List** | | [optional] [default to null] | +| **title** | **String** | Event title | [optional] [default to null] | +| **usesInstanceOverflow** | **Boolean** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UpdateFavoriteGroupRequest.md b/Models/UpdateFavoriteGroupRequest.md new file mode 100644 index 0000000..11f7439 --- /dev/null +++ b/Models/UpdateFavoriteGroupRequest.md @@ -0,0 +1,11 @@ +# UpdateFavoriteGroupRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **displayName** | **String** | | [optional] [default to null] | +| **tags** | **List** | Tags on FavoriteGroups are believed to do nothing. | [optional] [default to null] | +| **visibility** | **String** | | [optional] [default to private] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UpdateGroupGalleryRequest.md b/Models/UpdateGroupGalleryRequest.md new file mode 100644 index 0000000..2f226b6 --- /dev/null +++ b/Models/UpdateGroupGalleryRequest.md @@ -0,0 +1,15 @@ +# UpdateGroupGalleryRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **description** | **String** | Description of the gallery. | [optional] [default to null] | +| **membersOnly** | **Boolean** | Whether the gallery is members only. | [optional] [default to false] | +| **name** | **String** | Name of the gallery. | [optional] [default to null] | +| **roleIdsToAutoApprove** | **List** | | [optional] [default to null] | +| **roleIdsToManage** | **List** | | [optional] [default to null] | +| **roleIdsToSubmit** | **List** | | [optional] [default to null] | +| **roleIdsToView** | **List** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UpdateGroupMemberRequest.md b/Models/UpdateGroupMemberRequest.md new file mode 100644 index 0000000..3046cc0 --- /dev/null +++ b/Models/UpdateGroupMemberRequest.md @@ -0,0 +1,12 @@ +# UpdateGroupMemberRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **isSubscribedToAnnouncements** | **Boolean** | | [optional] [default to null] | +| **isSubscribedToEventAnnouncements** | **Boolean** | | [optional] [default to null] | +| **managerNotes** | **String** | | [optional] [default to null] | +| **visibility** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UpdateGroupRequest.md b/Models/UpdateGroupRequest.md new file mode 100644 index 0000000..29f6284 --- /dev/null +++ b/Models/UpdateGroupRequest.md @@ -0,0 +1,18 @@ +# UpdateGroupRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **bannerId** | **String** | | [optional] [default to null] | +| **description** | **String** | | [optional] [default to null] | +| **iconId** | **String** | | [optional] [default to null] | +| **joinState** | **String** | | [optional] [default to open] | +| **languages** | **List** | 3 letter language code | [optional] [default to null] | +| **links** | **List** | | [optional] [default to null] | +| **name** | **String** | | [optional] [default to null] | +| **rules** | **String** | | [optional] [default to null] | +| **shortCode** | **String** | | [optional] [default to null] | +| **tags** | **List** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UpdateGroupRoleRequest.md b/Models/UpdateGroupRoleRequest.md new file mode 100644 index 0000000..7ecb3ef --- /dev/null +++ b/Models/UpdateGroupRoleRequest.md @@ -0,0 +1,13 @@ +# UpdateGroupRoleRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **description** | **String** | | [optional] [default to null] | +| **isSelfAssignable** | **Boolean** | | [optional] [default to false] | +| **name** | **String** | | [optional] [default to null] | +| **order** | **Integer** | | [optional] [default to null] | +| **permissions** | **List** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UpdateInventoryItemRequest.md b/Models/UpdateInventoryItemRequest.md new file mode 100644 index 0000000..07f9477 --- /dev/null +++ b/Models/UpdateInventoryItemRequest.md @@ -0,0 +1,11 @@ +# UpdateInventoryItemRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **isArchived** | **Boolean** | | [optional] [default to null] | +| **isSeen** | **Boolean** | | [optional] [default to null] | +| **userAttributes** | [**InventoryUserAttributes**](InventoryUserAttributes.md) | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UpdateInviteMessageRequest.md b/Models/UpdateInviteMessageRequest.md new file mode 100644 index 0000000..ce00585 --- /dev/null +++ b/Models/UpdateInviteMessageRequest.md @@ -0,0 +1,9 @@ +# UpdateInviteMessageRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **message** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UpdatePropRequest.md b/Models/UpdatePropRequest.md new file mode 100644 index 0000000..e3fd781 --- /dev/null +++ b/Models/UpdatePropRequest.md @@ -0,0 +1,19 @@ +# UpdatePropRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **assetUrl** | **String** | | [optional] [default to null] | +| **assetVersion** | **Integer** | | [optional] [default to null] | +| **description** | **String** | | [optional] [default to null] | +| **imageUrl** | **String** | | [optional] [default to null] | +| **name** | **String** | | [optional] [default to null] | +| **platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [optional] [default to null] | +| **propSignature** | **String** | | [optional] [default to null] | +| **spawnType** | **Integer** | How a prop is summoned and interacted with. 0: the prop fixed to some surface in the world 1: the prop is a pickup and may be held by users 2: ??? | [optional] [default to 1] | +| **tags** | **List** | | [optional] [default to null] | +| **unityVersion** | **String** | | [optional] [default to null] | +| **worldPlacementMask** | **Integer** | Bitmask for restrictions on what world surfaces a prop may be summoned. 0: no restrictions 1: floors 2: walls 4: ceilings | [optional] [default to 1] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UpdateTiliaTOSRequest.md b/Models/UpdateTiliaTOSRequest.md new file mode 100644 index 0000000..af0b3db --- /dev/null +++ b/Models/UpdateTiliaTOSRequest.md @@ -0,0 +1,9 @@ +# UpdateTiliaTOSRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **accepted** | **Boolean** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UpdateUserBadgeRequest.md b/Models/UpdateUserBadgeRequest.md new file mode 100644 index 0000000..b65a2ea --- /dev/null +++ b/Models/UpdateUserBadgeRequest.md @@ -0,0 +1,10 @@ +# UpdateUserBadgeRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **hidden** | **Boolean** | | [optional] [default to null] | +| **showcased** | **Boolean** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UpdateUserNoteRequest.md b/Models/UpdateUserNoteRequest.md new file mode 100644 index 0000000..e862799 --- /dev/null +++ b/Models/UpdateUserNoteRequest.md @@ -0,0 +1,10 @@ +# UpdateUserNoteRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **note** | **String** | | [default to null] | +| **targetUserId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UpdateUserRequest.md b/Models/UpdateUserRequest.md new file mode 100644 index 0000000..15e3a44 --- /dev/null +++ b/Models/UpdateUserRequest.md @@ -0,0 +1,26 @@ +# UpdateUserRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **acceptedTOSVersion** | **Integer** | | [optional] [default to null] | +| **bio** | **String** | | [optional] [default to null] | +| **bioLinks** | **List** | | [optional] [default to null] | +| **birthday** | **date** | | [optional] [default to null] | +| **contentFilters** | **List** | These tags begin with `content_` and control content gating | [optional] [default to null] | +| **currentPassword** | **String** | | [optional] [default to null] | +| **displayName** | **String** | MUST specify currentPassword as well to change display name | [optional] [default to null] | +| **email** | **String** | | [optional] [default to null] | +| **hasSharedConnectionsOptOut** | **Boolean** | Opt out of the Mutuals feature | [optional] [default to null] | +| **isBoopingEnabled** | **Boolean** | | [optional] [default to null] | +| **password** | **String** | MUST specify currentPassword as well to change password | [optional] [default to null] | +| **pronouns** | **String** | | [optional] [default to null] | +| **revertDisplayName** | **Boolean** | MUST specify currentPassword as well to revert display name | [optional] [default to null] | +| **status** | **String** | Defines the User's current status, for example \"ask me\", \"join me\" or \"offline. This status is a combined indicator of their online activity and privacy preference. | [optional] [default to offline] | +| **statusDescription** | **String** | | [optional] [default to null] | +| **tags** | **List** | | [optional] [default to null] | +| **unsubscribe** | **Boolean** | | [optional] [default to null] | +| **userIcon** | **String** | MUST be a valid VRChat /file/ url. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UpdateWorldRequest.md b/Models/UpdateWorldRequest.md new file mode 100644 index 0000000..d575599 --- /dev/null +++ b/Models/UpdateWorldRequest.md @@ -0,0 +1,21 @@ +# UpdateWorldRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **assetUrl** | **String** | | [optional] [default to null] | +| **assetVersion** | **String** | | [optional] [default to null] | +| **authorId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | +| **authorName** | **String** | | [optional] [default to null] | +| **capacity** | **Integer** | | [optional] [default to null] | +| **description** | **String** | | [optional] [default to null] | +| **imageUrl** | **String** | | [optional] [default to null] | +| **name** | **String** | | [optional] [default to null] | +| **platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [optional] [default to null] | +| **releaseStatus** | **String** | | [optional] [default to public] | +| **tags** | **List** | | [optional] [default to null] | +| **unityPackageUrl** | **String** | | [optional] [default to null] | +| **unityVersion** | **String** | | [optional] [default to 5.3.4p1] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/User.md b/Models/User.md new file mode 100644 index 0000000..b5861cd --- /dev/null +++ b/Models/User.md @@ -0,0 +1,45 @@ +# User +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **ageVerificationStatus** | **String** | `verified` is obsolete. User who have verified and are 18+ can switch to `plus18` status. | [default to null] | +| **ageVerified** | **Boolean** | `true` if, user is age verified (not 18+). | [default to null] | +| **allowAvatarCopying** | **Boolean** | | [default to true] | +| **badges** | [**List**](Badge.md) | | [optional] [default to null] | +| **bio** | **String** | | [default to null] | +| **bioLinks** | **List** | | [default to null] | +| **currentAvatarImageUrl** | **String** | When profilePicOverride is not empty, use it instead. | [default to null] | +| **currentAvatarTags** | **List** | | [default to null] | +| **currentAvatarThumbnailImageUrl** | **String** | When profilePicOverride is not empty, use it instead. | [default to null] | +| **date\_joined** | **date** | | [default to null] | +| **developerType** | **String** | \"none\" User is a normal user \"trusted\" Unknown \"internal\" Is a VRChat Developer \"moderator\" Is a VRChat Moderator Staff can hide their developerType at will. | [default to none] | +| **displayName** | **String** | A users visual display name. This is what shows up in-game, and can different from their `username`. Changing display name is restricted to a cooldown period. | [default to null] | +| **friendKey** | **String** | | [default to null] | +| **friendRequestStatus** | **String** | | [optional] [default to null] | +| **id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **instanceId** | **String** | InstanceID can be \"offline\" on User profiles if you are not friends with that user and \"private\" if you are friends and user is in private instance. | [optional] [default to null] | +| **isFriend** | **Boolean** | Either their `friendKey`, or empty string if you are not friends. Unknown usage. | [default to null] | +| **last\_activity** | **String** | Either a date-time or empty string. | [default to null] | +| **last\_login** | **String** | Either a date-time or empty string. | [default to null] | +| **last\_mobile** | **String** | | [optional] [default to null] | +| **last\_platform** | **String** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [default to null] | +| **location** | **String** | Represents a unique location, consisting of a world identifier and an instance identifier, or \"offline\" if the user is not on your friends list. | [optional] [default to null] | +| **note** | **String** | | [optional] [default to null] | +| **platform** | **String** | | [optional] [default to null] | +| **profilePicOverride** | **String** | | [default to null] | +| **profilePicOverrideThumbnail** | **String** | | [default to null] | +| **pronouns** | **String** | | [default to null] | +| **state** | **String** | * \"online\" User is online in VRChat * \"active\" User is online, but not in VRChat * \"offline\" User is offline Always offline when returned through `getCurrentUser` (/auth/user). | [default to offline] | +| **status** | **String** | Defines the User's current status, for example \"ask me\", \"join me\" or \"offline. This status is a combined indicator of their online activity and privacy preference. | [default to offline] | +| **statusDescription** | **String** | | [default to null] | +| **tags** | **List** | | [default to null] | +| **travelingToInstance** | **String** | | [optional] [default to null] | +| **travelingToLocation** | **String** | | [optional] [default to null] | +| **travelingToWorld** | **String** | | [optional] [default to null] | +| **userIcon** | **String** | | [default to null] | +| **username** | **String** | -| A users unique name, used during login. This is different from `displayName` which is what shows up in-game. A users `username` can never be changed.' **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). | [optional] [default to null] | +| **worldId** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UserCreditsEligible.md b/Models/UserCreditsEligible.md new file mode 100644 index 0000000..e19078e --- /dev/null +++ b/Models/UserCreditsEligible.md @@ -0,0 +1,10 @@ +# UserCreditsEligible +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **eligible** | **Boolean** | | [default to null] | +| **reason** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UserExists.md b/Models/UserExists.md new file mode 100644 index 0000000..855e5e0 --- /dev/null +++ b/Models/UserExists.md @@ -0,0 +1,10 @@ +# UserExists +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **nameOk** | **Boolean** | Is the username valid? | [optional] [default to false] | +| **userExists** | **Boolean** | Status if a user exist with that username or userId. | [default to false] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UserNote.md b/Models/UserNote.md new file mode 100644 index 0000000..d0b75bf --- /dev/null +++ b/Models/UserNote.md @@ -0,0 +1,14 @@ +# UserNote +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **createdAt** | **Date** | | [default to null] | +| **id** | **String** | | [default to null] | +| **note** | **String** | | [default to null] | +| **targetUser** | [**UserNote_targetUser**](UserNote_targetUser.md) | | [optional] [default to null] | +| **targetUserId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **userId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UserNote_targetUser.md b/Models/UserNote_targetUser.md new file mode 100644 index 0000000..f88743d --- /dev/null +++ b/Models/UserNote_targetUser.md @@ -0,0 +1,14 @@ +# UserNote_targetUser +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **id** | **String** | | [optional] [default to null] | +| **currentAvatarTags** | **List** | | [optional] [default to null] | +| **currentAvatarThumbnailImageUrl** | **String** | When profilePicOverride is not empty, use it instead. | [optional] [default to null] | +| **displayName** | **String** | | [optional] [default to null] | +| **profilePicOverride** | **String** | | [optional] [default to null] | +| **userIcon** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UserSubscription.md b/Models/UserSubscription.md new file mode 100644 index 0000000..4bd1c76 --- /dev/null +++ b/Models/UserSubscription.md @@ -0,0 +1,25 @@ +# UserSubscription +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **active** | **Boolean** | | [default to true] | +| **amount** | **BigDecimal** | | [default to null] | +| **created\_at** | **Date** | | [default to null] | +| **description** | **String** | | [default to null] | +| **expires** | **Date** | | [default to null] | +| **id** | **String** | | [default to null] | +| **isBulkGift** | **Boolean** | | [default to false] | +| **isGift** | **Boolean** | | [default to false] | +| **licenseGroups** | **List** | | [default to null] | +| **period** | **String** | | [default to month] | +| **starts** | **String** | | [optional] [default to null] | +| **status** | **String** | | [default to active] | +| **steamItemId** | **String** | | [optional] [default to null] | +| **store** | **String** | Which \"Store\" it came from. Right now only Stores are \"Steam\" and \"Admin\". | [default to null] | +| **tier** | **Integer** | | [default to null] | +| **transactionId** | **String** | | [default to null] | +| **updated\_at** | **Date** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/UserSubscriptionEligible.md b/Models/UserSubscriptionEligible.md new file mode 100644 index 0000000..7a9126e --- /dev/null +++ b/Models/UserSubscriptionEligible.md @@ -0,0 +1,14 @@ +# UserSubscriptionEligible +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **activeCancelledSubscription** | **Boolean** | | [default to null] | +| **giftEligible** | **Boolean** | | [default to null] | +| **nonExtendVendorWillLoseGiftTime** | **Boolean** | | [default to null] | +| **purchaseEligible** | **Boolean** | | [default to null] | +| **subscriptionEligible** | **Boolean** | | [default to null] | +| **subscriptionOnAltAccount** | **Boolean** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Verify2FAEmailCodeResult.md b/Models/Verify2FAEmailCodeResult.md new file mode 100644 index 0000000..8d15c9a --- /dev/null +++ b/Models/Verify2FAEmailCodeResult.md @@ -0,0 +1,9 @@ +# Verify2FAEmailCodeResult +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **verified** | **Boolean** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/Verify2FAResult.md b/Models/Verify2FAResult.md new file mode 100644 index 0000000..53a4466 --- /dev/null +++ b/Models/Verify2FAResult.md @@ -0,0 +1,10 @@ +# Verify2FAResult +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **enabled** | **Boolean** | | [optional] [default to true] | +| **verified** | **Boolean** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/VerifyAuthTokenResult.md b/Models/VerifyAuthTokenResult.md new file mode 100644 index 0000000..4bcf24c --- /dev/null +++ b/Models/VerifyAuthTokenResult.md @@ -0,0 +1,10 @@ +# VerifyAuthTokenResult +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **ok** | **Boolean** | | [default to null] | +| **token** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/World.md b/Models/World.md new file mode 100644 index 0000000..d1edd78 --- /dev/null +++ b/Models/World.md @@ -0,0 +1,41 @@ +# World +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **authorId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [default to null] | +| **authorName** | **String** | | [default to null] | +| **capacity** | **Integer** | | [default to null] | +| **created\_at** | **Date** | | [default to null] | +| **defaultContentSettings** | [**InstanceContentSettings**](InstanceContentSettings.md) | | [optional] [default to null] | +| **description** | **String** | | [default to null] | +| **favorites** | **Integer** | | [optional] [default to 0] | +| **featured** | **Boolean** | | [default to false] | +| **heat** | **Integer** | | [default to 0] | +| **id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [default to null] | +| **imageUrl** | **String** | | [default to null] | +| **instances** | [**List**](array.md) | Will always be an empty list when unauthenticated. | [optional] [default to null] | +| **labsPublicationDate** | **String** | | [default to null] | +| **name** | **String** | | [default to null] | +| **namespace** | **String** | | [optional] [default to null] | +| **occupants** | **Integer** | Will always be `0` when unauthenticated. | [optional] [default to 0] | +| **organization** | **String** | | [default to vrchat] | +| **popularity** | **Integer** | | [default to 0] | +| **previewYoutubeId** | **String** | | [optional] [default to null] | +| **privateOccupants** | **Integer** | Will always be `0` when unauthenticated. | [optional] [default to 0] | +| **publicOccupants** | **Integer** | Will always be `0` when unauthenticated. | [optional] [default to 0] | +| **publicationDate** | **String** | | [default to null] | +| **recommendedCapacity** | **Integer** | | [default to null] | +| **releaseStatus** | **String** | | [default to public] | +| **storeId** | **String** | | [optional] [default to null] | +| **tags** | **List** | | [default to null] | +| **thumbnailImageUrl** | **String** | | [default to null] | +| **udonProducts** | **List** | | [optional] [default to null] | +| **unityPackages** | [**List**](UnityPackage.md) | Empty if unauthenticated. | [optional] [default to null] | +| **updated\_at** | **Date** | | [default to null] | +| **urlList** | **List** | | [optional] [default to null] | +| **version** | **Integer** | | [default to 0] | +| **visits** | **Integer** | | [default to 0] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/WorldMetadata.md b/Models/WorldMetadata.md new file mode 100644 index 0000000..21563f4 --- /dev/null +++ b/Models/WorldMetadata.md @@ -0,0 +1,10 @@ +# WorldMetadata +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [default to null] | +| **metadata** | [**Object**](.md) | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/WorldPublishStatus.md b/Models/WorldPublishStatus.md new file mode 100644 index 0000000..cadd8c3 --- /dev/null +++ b/Models/WorldPublishStatus.md @@ -0,0 +1,9 @@ +# WorldPublishStatus +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **canPublish** | **Boolean** | | [default to true] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/addFavorite_request.md b/Models/addFavorite_request.md new file mode 100644 index 0000000..23e1346 --- /dev/null +++ b/Models/addFavorite_request.md @@ -0,0 +1,11 @@ +# addFavorite_request +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **favoriteId** | **String** | Must be either AvatarID, WorldID or UserID. | [default to null] | +| **tags** | **List** | Tags indicate which group this favorite belongs to. Adding multiple groups makes it show up in all. Removing it from one in that case removes it from all. | [default to null] | +| **type** | **String** | | [default to friend] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/createPermission_request.md b/Models/createPermission_request.md new file mode 100644 index 0000000..b6a5c39 --- /dev/null +++ b/Models/createPermission_request.md @@ -0,0 +1,10 @@ +# createPermission_request +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **name** | **String** | | [default to null] | +| **ownerId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/getGroupPosts_200_response.md b/Models/getGroupPosts_200_response.md new file mode 100644 index 0000000..d136252 --- /dev/null +++ b/Models/getGroupPosts_200_response.md @@ -0,0 +1,9 @@ +# getGroupPosts_200_response +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **posts** | [**List**](GroupPost.md) | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/getUserGroupInstances_200_response.md b/Models/getUserGroupInstances_200_response.md new file mode 100644 index 0000000..fa0892e --- /dev/null +++ b/Models/getUserGroupInstances_200_response.md @@ -0,0 +1,10 @@ +# getUserGroupInstances_200_response +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **fetchedAt** | **Date** | | [optional] [default to null] | +| **instances** | [**List**](Instance.md) | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/searchGroupMembers_200_response.md b/Models/searchGroupMembers_200_response.md new file mode 100644 index 0000000..c04e09c --- /dev/null +++ b/Models/searchGroupMembers_200_response.md @@ -0,0 +1,10 @@ +# searchGroupMembers_200_response +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **results** | [**List**](GroupMember.md) | | [optional] [default to null] | +| **total** | **Integer** | Number of members returned | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/updateGroupRepresentation_request.md b/Models/updateGroupRepresentation_request.md new file mode 100644 index 0000000..154221b --- /dev/null +++ b/Models/updateGroupRepresentation_request.md @@ -0,0 +1,9 @@ +# updateGroupRepresentation_request +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **isRepresenting** | **Boolean** | Whether the user is representing the group. | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/Models/updatePermission_request.md b/Models/updatePermission_request.md new file mode 100644 index 0000000..142c7a5 --- /dev/null +++ b/Models/updatePermission_request.md @@ -0,0 +1,10 @@ +# updatePermission_request +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **name** | **String** | | [optional] [default to null] | +| **ownerId** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +