├── .github └── workflows │ └── ci.yaml ├── .gitignore ├── .gitlab-ci.yml ├── .openapi-generator-ignore ├── .openapi-generator ├── FILES └── VERSION ├── LICENSE ├── README.md ├── docs ├── APIConfig.md ├── APIConfigAccessLogsUrls.md ├── APIConfigAnnouncement.md ├── APIConfigAvatarPerfLimiter.md ├── APIConfigConstants.md ├── APIConfigConstantsGROUPS.md ├── APIConfigConstantsINSTANCE.md ├── APIConfigConstantsINSTANCEPOPULATIONBRACKETS.md ├── APIConfigConstantsINSTANCEPOPULATIONBRACKETSCROWDED.md ├── APIConfigConstantsINSTANCEPOPULATIONBRACKETSFEW.md ├── APIConfigConstantsINSTANCEPOPULATIONBRACKETSMANY.md ├── APIConfigConstantsLANGUAGE.md ├── APIConfigDownloadURLList.md ├── APIConfigEvents.md ├── APIConfigMinSupportedClientBuildNumber.md ├── APIConfigOfflineAnalysis.md ├── APIConfigReportCategories.md ├── APIConfigReportOptions.md ├── APIConfigReportOptionsAvatar.md ├── APIConfigReportOptionsGroup.md ├── APIConfigReportOptionsUser.md ├── APIConfigReportOptionsWorld.md ├── APIConfigReportReasons.md ├── APIHealth.md ├── AccountDeletionLog.md ├── AddFavoriteRequest.md ├── AddGroupGalleryImageRequest.md ├── AgeVerificationStatus.md ├── AuthenticationApi.md ├── Avatar.md ├── AvatarPublishedListingsInner.md ├── AvatarStyles.md ├── AvatarUnityPackageUrlObject.md ├── AvatarsApi.md ├── Badge.md ├── Balance.md ├── BanGroupMemberRequest.md ├── ChangeUserTagsRequest.md ├── CreateAvatarRequest.md ├── CreateFileRequest.md ├── CreateFileVersionRequest.md ├── CreateGroupAnnouncementRequest.md ├── CreateGroupGalleryRequest.md ├── CreateGroupInviteRequest.md ├── CreateGroupPostRequest.md ├── CreateGroupRequest.md ├── CreateGroupRoleRequest.md ├── CreateInstanceRequest.md ├── CreateWorldRequest.md ├── CurrentUser.md ├── CurrentUserPlatformHistoryInner.md ├── CurrentUserPresence.md ├── DeveloperType.md ├── Disable2FAResult.md ├── DynamicContentRow.md ├── EconomyApi.md ├── Error.md ├── Favorite.md ├── FavoriteGroup.md ├── FavoriteGroupLimits.md ├── FavoriteGroupVisibility.md ├── FavoriteLimits.md ├── FavoriteType.md ├── FavoritedWorld.md ├── FavoritesApi.md ├── Feedback.md ├── File.md ├── FileAnalysis.md ├── FileAnalysisAvatarStats.md ├── FileData.md ├── FileStatus.md ├── FileUploadURL.md ├── FileVersion.md ├── FileVersionUploadStatus.md ├── FilesApi.md ├── FinishFileDataUploadRequest.md ├── FriendStatus.md ├── FriendsApi.md ├── GetGroupPosts200Response.md ├── GetUserGroupInstances200Response.md ├── Group.md ├── GroupAccessType.md ├── GroupAnnouncement.md ├── GroupAuditLogEntry.md ├── GroupGallery.md ├── GroupGalleryImage.md ├── GroupInstance.md ├── GroupJoinRequestAction.md ├── GroupJoinState.md ├── GroupLimitedMember.md ├── GroupMember.md ├── GroupMemberLimitedUser.md ├── GroupMemberStatus.md ├── GroupMyMember.md ├── GroupPermission.md ├── GroupPermissions.md ├── GroupPost.md ├── GroupPostVisibility.md ├── GroupPrivacy.md ├── GroupRole.md ├── GroupRoleTemplate.md ├── GroupRoleTemplateValues.md ├── GroupRoleTemplateValuesRoles.md ├── GroupSearchSort.md ├── GroupUserVisibility.md ├── GroupsApi.md ├── InfoPush.md ├── InfoPushData.md ├── InfoPushDataArticle.md ├── InfoPushDataArticleContent.md ├── InfoPushDataClickable.md ├── Instance.md ├── InstanceContentSettings.md ├── InstancePlatforms.md ├── InstanceRegion.md ├── InstanceShortNameResponse.md ├── InstanceType.md ├── InstancesApi.md ├── InviteApi.md ├── InviteMessage.md ├── InviteMessageType.md ├── InviteRequest.md ├── InviteResponse.md ├── Jam.md ├── JamStateChangeDates.md ├── JamsApi.md ├── License.md ├── LicenseAction.md ├── LicenseGroup.md ├── LicenseType.md ├── LimitedGroup.md ├── LimitedUnityPackage.md ├── LimitedUser.md ├── LimitedUserGroups.md ├── LimitedWorld.md ├── MIMEType.md ├── MiscellaneousApi.md ├── ModelPrint.md ├── ModerateUserRequest.md ├── Notification.md ├── NotificationDetailInvite.md ├── NotificationDetailInviteResponse.md ├── NotificationDetailRequestInvite.md ├── NotificationDetailRequestInviteResponse.md ├── NotificationDetailVoteToKick.md ├── NotificationType.md ├── NotificationsApi.md ├── OrderOption.md ├── PaginatedGroupAuditLogEntryList.md ├── PastDisplayName.md ├── Pending2FAResult.md ├── PerformanceLimiterInfo.md ├── PerformanceRatings.md ├── Permission.md ├── PlatformBuildInfo.md ├── PlayerModeration.md ├── PlayerModerationType.md ├── PlayermoderationApi.md ├── PrintFiles.md ├── PrintsApi.md ├── Product.md ├── ProductListing.md ├── ProductListingType.md ├── ProductListingVariant.md ├── ProductType.md ├── Region.md ├── RegisterUserAccountRequest.md ├── ReleaseStatus.md ├── ReportCategory.md ├── ReportReason.md ├── RepresentedGroup.md ├── RequestInviteRequest.md ├── RespondGroupJoinRequest.md ├── Response.md ├── SentNotification.md ├── ServiceQueueStats.md ├── ServiceStatus.md ├── SortOption.md ├── Submission.md ├── Subscription.md ├── SubscriptionPeriod.md ├── Success.md ├── TiliaStatus.md ├── TiliaTOS.md ├── TokenBundle.md ├── Transaction.md ├── TransactionAgreement.md ├── TransactionStatus.md ├── TransactionSteamInfo.md ├── TransactionSteamWalletInfo.md ├── TwoFactorAuthCode.md ├── TwoFactorEmailCode.md ├── TwoFactorRecoveryCodes.md ├── TwoFactorRecoveryCodesOtpInner.md ├── UnityPackage.md ├── UpdateAvatarRequest.md ├── UpdateFavoriteGroupRequest.md ├── UpdateGroupGalleryRequest.md ├── UpdateGroupMemberRequest.md ├── UpdateGroupRepresentationRequest.md ├── UpdateGroupRequest.md ├── UpdateGroupRoleRequest.md ├── UpdateInviteMessageRequest.md ├── UpdateUserBadgeRequest.md ├── UpdateUserNoteRequest.md ├── UpdateUserRequest.md ├── UpdateWorldRequest.md ├── User.md ├── UserExists.md ├── UserNote.md ├── UserNoteTargetUser.md ├── UserState.md ├── UserStatus.md ├── UserSubscription.md ├── UsersApi.md ├── Verify2FAEmailCodeResult.md ├── Verify2FAResult.md ├── VerifyAuthTokenResult.md ├── World.md ├── WorldMetadata.md ├── WorldPublishStatus.md └── WorldsApi.md ├── examples ├── README.md └── examples-source │ ├── cookies_load.py │ ├── cookies_store.py │ ├── login.py │ └── noauth.py ├── generate.sh ├── git_push.sh ├── openapitools.json ├── package-lock.json ├── package.json ├── patches ├── cookiejar.patch ├── error_2fa_verify_readable.patch ├── query_param_bool.patch └── safe_param_symbols.patch ├── pyproject.toml ├── requirements.txt ├── setup.cfg ├── setup.py ├── test-requirements.txt ├── tox.ini └── vrchatapi ├── __init__.py ├── api ├── __init__.py ├── authentication_api.py ├── avatars_api.py ├── economy_api.py ├── favorites_api.py ├── files_api.py ├── friends_api.py ├── groups_api.py ├── instances_api.py ├── invite_api.py ├── jams_api.py ├── miscellaneous_api.py ├── notifications_api.py ├── playermoderation_api.py ├── prints_api.py ├── users_api.py └── worlds_api.py ├── api_client.py ├── configuration.py ├── exceptions.py ├── models ├── __init__.py ├── account_deletion_log.py ├── add_favorite_request.py ├── add_group_gallery_image_request.py ├── age_verification_status.py ├── api_config.py ├── api_config_access_logs_urls.py ├── api_config_announcement.py ├── api_config_avatar_perf_limiter.py ├── api_config_constants.py ├── api_config_constants_groups.py ├── api_config_constants_instance.py ├── api_config_constants_instancepopulationbrackets.py ├── api_config_constants_instancepopulationbracketscrowded.py ├── api_config_constants_instancepopulationbracketsfew.py ├── api_config_constants_instancepopulationbracketsmany.py ├── api_config_constants_language.py ├── api_config_download_url_list.py ├── api_config_events.py ├── api_config_min_supported_client_build_number.py ├── api_config_offline_analysis.py ├── api_config_report_categories.py ├── api_config_report_options.py ├── api_config_report_options_avatar.py ├── api_config_report_options_group.py ├── api_config_report_options_user.py ├── api_config_report_options_world.py ├── api_config_report_reasons.py ├── api_health.py ├── avatar.py ├── avatar_published_listings_inner.py ├── avatar_styles.py ├── avatar_unity_package_url_object.py ├── badge.py ├── balance.py ├── ban_group_member_request.py ├── change_user_tags_request.py ├── create_avatar_request.py ├── create_file_request.py ├── create_file_version_request.py ├── create_group_announcement_request.py ├── create_group_gallery_request.py ├── create_group_invite_request.py ├── create_group_post_request.py ├── create_group_request.py ├── create_group_role_request.py ├── create_instance_request.py ├── create_world_request.py ├── current_user.py ├── current_user_platform_history_inner.py ├── current_user_presence.py ├── developer_type.py ├── disable2_fa_result.py ├── dynamic_content_row.py ├── error.py ├── favorite.py ├── favorite_group.py ├── favorite_group_limits.py ├── favorite_group_visibility.py ├── favorite_limits.py ├── favorite_type.py ├── favorited_world.py ├── feedback.py ├── file.py ├── file_analysis.py ├── file_analysis_avatar_stats.py ├── file_data.py ├── file_status.py ├── file_upload_url.py ├── file_version.py ├── file_version_upload_status.py ├── finish_file_data_upload_request.py ├── friend_status.py ├── get_group_posts200_response.py ├── get_user_group_instances200_response.py ├── group.py ├── group_access_type.py ├── group_announcement.py ├── group_audit_log_entry.py ├── group_gallery.py ├── group_gallery_image.py ├── group_instance.py ├── group_join_request_action.py ├── group_join_state.py ├── group_limited_member.py ├── group_member.py ├── group_member_limited_user.py ├── group_member_status.py ├── group_my_member.py ├── group_permission.py ├── group_permissions.py ├── group_post.py ├── group_post_visibility.py ├── group_privacy.py ├── group_role.py ├── group_role_template.py ├── group_role_template_values.py ├── group_role_template_values_roles.py ├── group_search_sort.py ├── group_user_visibility.py ├── info_push.py ├── info_push_data.py ├── info_push_data_article.py ├── info_push_data_article_content.py ├── info_push_data_clickable.py ├── instance.py ├── instance_content_settings.py ├── instance_platforms.py ├── instance_region.py ├── instance_short_name_response.py ├── instance_type.py ├── invite_message.py ├── invite_message_type.py ├── invite_request.py ├── invite_response.py ├── jam.py ├── jam_state_change_dates.py ├── license.py ├── license_action.py ├── license_group.py ├── license_type.py ├── limited_group.py ├── limited_unity_package.py ├── limited_user.py ├── limited_user_groups.py ├── limited_world.py ├── mime_type.py ├── model_print.py ├── moderate_user_request.py ├── notification.py ├── notification_detail_invite.py ├── notification_detail_invite_response.py ├── notification_detail_request_invite.py ├── notification_detail_request_invite_response.py ├── notification_detail_vote_to_kick.py ├── notification_type.py ├── order_option.py ├── paginated_group_audit_log_entry_list.py ├── past_display_name.py ├── pending2_fa_result.py ├── performance_limiter_info.py ├── performance_ratings.py ├── permission.py ├── platform_build_info.py ├── player_moderation.py ├── player_moderation_type.py ├── print_files.py ├── product.py ├── product_listing.py ├── product_listing_type.py ├── product_listing_variant.py ├── product_type.py ├── region.py ├── register_user_account_request.py ├── release_status.py ├── report_category.py ├── report_reason.py ├── represented_group.py ├── request_invite_request.py ├── respond_group_join_request.py ├── response.py ├── sent_notification.py ├── service_queue_stats.py ├── service_status.py ├── sort_option.py ├── submission.py ├── subscription.py ├── subscription_period.py ├── success.py ├── tilia_status.py ├── tilia_tos.py ├── token_bundle.py ├── transaction.py ├── transaction_agreement.py ├── transaction_status.py ├── transaction_steam_info.py ├── transaction_steam_wallet_info.py ├── two_factor_auth_code.py ├── two_factor_email_code.py ├── two_factor_recovery_codes.py ├── two_factor_recovery_codes_otp_inner.py ├── unity_package.py ├── update_avatar_request.py ├── update_favorite_group_request.py ├── update_group_gallery_request.py ├── update_group_member_request.py ├── update_group_representation_request.py ├── update_group_request.py ├── update_group_role_request.py ├── update_invite_message_request.py ├── update_user_badge_request.py ├── update_user_note_request.py ├── update_user_request.py ├── update_world_request.py ├── user.py ├── user_exists.py ├── user_note.py ├── user_note_target_user.py ├── user_state.py ├── user_status.py ├── user_subscription.py ├── verify2_fa_email_code_result.py ├── verify2_fa_result.py ├── verify_auth_token_result.py ├── world.py ├── world_metadata.py └── world_publish_status.py └── rest.py /.github/workflows/ci.yaml: -------------------------------------------------------------------------------- 1 | on: 2 | repository_dispatch: 3 | types: [spec_release] 4 | workflow_dispatch: 5 | #on: push 6 | 7 | name: Generate VRChat API SDK 8 | 9 | jobs: 10 | generate: 11 | runs-on: ubuntu-latest 12 | name: Generate VRChat API SDK 13 | steps: 14 | - uses: actions/setup-node@v1 15 | with: 16 | node-version: 16 17 | - uses: actions/checkout@v2 18 | - name: 'Cache node_modules' 19 | uses: actions/cache@v4 20 | with: 21 | path: node_modules 22 | key: ${{ runner.os }}-node-v16-${{ hashFiles('**/generate.sh') }} 23 | restore-keys: | 24 | ${{ runner.os }}-node-v16 25 | - name: Install OpenAPI Generator CLI 26 | run: npm install @openapitools/openapi-generator-cli 27 | - name: Set OpenAPI Generator version 28 | run: ./node_modules/\@openapitools/openapi-generator-cli/main.js version-manager set 6.2.1 29 | - name: Set up Python 3.9 30 | uses: actions/setup-python@v1 31 | with: 32 | python-version: 3.9 33 | - name: Generate SDK Client 34 | run: bash ./generate.sh 35 | - name: Check version number 36 | run: | 37 | echo "spec_version=$(grep "VERSION =" setup.py | cut -d "\"" -f 2)" >> $GITHUB_ENV 38 | - name: Print version number 39 | run: echo ${{ env.spec_version }} 40 | - name: Deploy SDK back into main branch 41 | uses: JamesIves/github-pages-deploy-action@v4 42 | with: 43 | branch: main 44 | folder: . 45 | commit-message: "Upgrade Python SDK to spec ${{ env.spec_version }}" 46 | - name: Install pypa/build 47 | run: python -m pip install build --user 48 | - name: Build a binary wheel and a source tarball 49 | run: python -m build --sdist --wheel --outdir dist/ . 50 | - name: Publish SDK 📦 to PyPI 51 | uses: pypa/gh-action-pypi-publish@release/v1 52 | with: 53 | skip_existing: true 54 | password: ${{ secrets.PYPI_API_TOKEN }} 55 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | venv/ 48 | .venv/ 49 | .python-version 50 | .pytest_cache 51 | 52 | # Translations 53 | *.mo 54 | *.pot 55 | 56 | # Django stuff: 57 | *.log 58 | 59 | # Sphinx documentation 60 | docs/_build/ 61 | 62 | # PyBuilder 63 | target/ 64 | 65 | #Ipython Notebook 66 | .ipynb_checkpoints 67 | 68 | # Dependency directory 69 | node_modules 70 | 71 | # Patch leftovers 72 | *.orig 73 | *.rej -------------------------------------------------------------------------------- /.gitlab-ci.yml: -------------------------------------------------------------------------------- 1 | # ref: https://docs.gitlab.com/ee/ci/README.html 2 | 3 | stages: 4 | - test 5 | 6 | .nosetest: 7 | stage: test 8 | script: 9 | - pip install -r requirements.txt 10 | - pip install -r test-requirements.txt 11 | - pytest --cov=vrchatapi 12 | 13 | nosetest-2.7: 14 | extends: .nosetest 15 | image: python:2.7-alpine 16 | nosetest-3.3: 17 | extends: .nosetest 18 | image: python:3.3-alpine 19 | nosetest-3.4: 20 | extends: .nosetest 21 | image: python:3.4-alpine 22 | nosetest-3.5: 23 | extends: .nosetest 24 | image: python:3.5-alpine 25 | nosetest-3.6: 26 | extends: .nosetest 27 | image: python:3.6-alpine 28 | nosetest-3.7: 29 | extends: .nosetest 30 | image: python:3.7-alpine 31 | nosetest-3.8: 32 | extends: .nosetest 33 | image: python:3.8-alpine 34 | -------------------------------------------------------------------------------- /.openapi-generator-ignore: -------------------------------------------------------------------------------- 1 | # OpenAPI Generator Ignore 2 | # Generated by openapi-generator https://github.com/openapitools/openapi-generator 3 | 4 | # Use this file to prevent files from being overwritten by the generator. 5 | # The patterns follow closely to .gitignore or .dockerignore. 6 | 7 | # As an example, the C# client generator defines ApiClient.cs. 8 | # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: 9 | #ApiClient.cs 10 | 11 | # You can match any string of characters against a directory, file or extension with a single asterisk (*): 12 | #foo/*/qux 13 | # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux 14 | 15 | # You can recursively match patterns against a directory, file or extension with a double asterisk (**): 16 | #foo/**/qux 17 | # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux 18 | 19 | # You can also negate patterns with an exclamation (!). 20 | # For example, you can ignore all files in a docs folder with the file extension .md: 21 | #docs/*.md 22 | # Then explicitly reverse the ignore rule for a single file: 23 | #!docs/README.md 24 | 25 | .travis.yml 26 | README.md 27 | test/ 28 | .gitignore -------------------------------------------------------------------------------- /.openapi-generator/VERSION: -------------------------------------------------------------------------------- 1 | 6.2.1 -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2021 Owners of GitHub organisation "vrchatapi" and individual contributors. 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. -------------------------------------------------------------------------------- /docs/APIConfigAccessLogsUrls.md: -------------------------------------------------------------------------------- 1 | # APIConfigAccessLogsUrls 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **default** | **str** | | [optional] 8 | **pico** | **str** | | [optional] 9 | **quest** | **str** | | [optional] 10 | **xr_elite** | **str** | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/APIConfigAnnouncement.md: -------------------------------------------------------------------------------- 1 | # APIConfigAnnouncement 2 | 3 | Public Announcement 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **name** | **str** | Announcement name | 9 | **text** | **str** | Announcement text | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/APIConfigAvatarPerfLimiter.md: -------------------------------------------------------------------------------- 1 | # APIConfigAvatarPerfLimiter 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **android_mobile** | [**PerformanceLimiterInfo**](PerformanceLimiterInfo.md) | | 8 | **pc** | [**PerformanceLimiterInfo**](PerformanceLimiterInfo.md) | | 9 | **pico** | [**PerformanceLimiterInfo**](PerformanceLimiterInfo.md) | | 10 | **quest** | [**PerformanceLimiterInfo**](PerformanceLimiterInfo.md) | | 11 | **xr_elite** | [**PerformanceLimiterInfo**](PerformanceLimiterInfo.md) | | 12 | **i_os_mobile** | [**PerformanceLimiterInfo**](PerformanceLimiterInfo.md) | | 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/APIConfigConstants.md: -------------------------------------------------------------------------------- 1 | # APIConfigConstants 2 | 3 | Constants 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **groups** | [**APIConfigConstantsGROUPS**](APIConfigConstantsGROUPS.md) | | 9 | **instance** | [**APIConfigConstantsINSTANCE**](APIConfigConstantsINSTANCE.md) | | 10 | **language** | [**APIConfigConstantsLANGUAGE**](APIConfigConstantsLANGUAGE.md) | | 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/APIConfigConstantsGROUPS.md: -------------------------------------------------------------------------------- 1 | # APIConfigConstantsGROUPS 2 | 3 | Group-related constants 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **capacity** | **int** | Maximum group capacity | [optional] [default to 100000] 9 | **group_transfer_requirements** | **list[str]** | Requirements for transferring group ownership | [optional] 10 | **max_invites_requests** | **int** | Maximum number of invite requests | [optional] [default to 50] 11 | **max_joined** | **int** | Maximum number of joined groups | [optional] [default to 100] 12 | **max_joined_plus** | **int** | Maximum number of joined groups for VRChat Plus members | [optional] [default to 200] 13 | **max_languages** | **int** | Maximum number of supported languages | [optional] [default to 10] 14 | **max_links** | **int** | Maximum number of group links | [optional] [default to 3] 15 | **max_management_roles** | **int** | Maximum number of management roles in a group | [optional] [default to 5] 16 | **max_owned** | **int** | Maximum number of groups a user can own | [optional] [default to 5] 17 | **max_roles** | **int** | Maximum number of roles in a group | [optional] [default to 50] 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/APIConfigConstantsINSTANCE.md: -------------------------------------------------------------------------------- 1 | # APIConfigConstantsINSTANCE 2 | 3 | Instance-related constants 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **population_brackets** | [**APIConfigConstantsINSTANCEPOPULATIONBRACKETS**](APIConfigConstantsINSTANCEPOPULATIONBRACKETS.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/APIConfigConstantsINSTANCEPOPULATIONBRACKETS.md: -------------------------------------------------------------------------------- 1 | # APIConfigConstantsINSTANCEPOPULATIONBRACKETS 2 | 3 | Population brackets based on instance population 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **crowded** | [**APIConfigConstantsINSTANCEPOPULATIONBRACKETSCROWDED**](APIConfigConstantsINSTANCEPOPULATIONBRACKETSCROWDED.md) | | [optional] 9 | **few** | [**APIConfigConstantsINSTANCEPOPULATIONBRACKETSFEW**](APIConfigConstantsINSTANCEPOPULATIONBRACKETSFEW.md) | | [optional] 10 | **many** | [**APIConfigConstantsINSTANCEPOPULATIONBRACKETSMANY**](APIConfigConstantsINSTANCEPOPULATIONBRACKETSMANY.md) | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/APIConfigConstantsINSTANCEPOPULATIONBRACKETSCROWDED.md: -------------------------------------------------------------------------------- 1 | # APIConfigConstantsINSTANCEPOPULATIONBRACKETSCROWDED 2 | 3 | Crowded population range 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **max** | **int** | Maximum population for a crowded instance | [optional] 9 | **min** | **int** | Minimum population for a crowded instance | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/APIConfigConstantsINSTANCEPOPULATIONBRACKETSFEW.md: -------------------------------------------------------------------------------- 1 | # APIConfigConstantsINSTANCEPOPULATIONBRACKETSFEW 2 | 3 | Few population range 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **max** | **int** | Maximum population for a few instance | [optional] 9 | **min** | **int** | Minimum population for a few instance | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/APIConfigConstantsINSTANCEPOPULATIONBRACKETSMANY.md: -------------------------------------------------------------------------------- 1 | # APIConfigConstantsINSTANCEPOPULATIONBRACKETSMANY 2 | 3 | Many population range 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **max** | **int** | Maximum population for a many instance | [optional] 9 | **min** | **int** | Minimum population for a many instance | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/APIConfigConstantsLANGUAGE.md: -------------------------------------------------------------------------------- 1 | # APIConfigConstantsLANGUAGE 2 | 3 | Language-related constants 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **spoken_language_options** | **dict(str, str)** | Supported spoken language options | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/APIConfigDownloadURLList.md: -------------------------------------------------------------------------------- 1 | # APIConfigDownloadURLList 2 | 3 | Download links for various development assets. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **sdk2** | **str** | Download link for legacy SDK2 | 9 | **sdk3_avatars** | **str** | Download link for SDK3 for Avatars | 10 | **sdk3_worlds** | **str** | Download link for SDK3 for Worlds | 11 | **vcc** | **str** | Download link for the Creator Companion | 12 | **bootstrap** | **str** | Download link for ??? | 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/APIConfigEvents.md: -------------------------------------------------------------------------------- 1 | # APIConfigEvents 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **distance_close** | **int** | Unknown | 8 | **distance_factor** | **int** | Unknown | 9 | **distance_far** | **int** | Unknown | 10 | **group_distance** | **int** | Unknown | 11 | **maximum_bunch_size** | **int** | Unknown | 12 | **not_visible_factor** | **int** | Unknown | 13 | **player_order_bucket_size** | **int** | Unknown | 14 | **player_order_factor** | **int** | Unknown | 15 | **slow_update_factor_threshold** | **int** | Unknown | 16 | **view_segment_length** | **int** | Unknown | 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/APIConfigMinSupportedClientBuildNumber.md: -------------------------------------------------------------------------------- 1 | # APIConfigMinSupportedClientBuildNumber 2 | 3 | Minimum supported client build number for various platforms 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **app_store** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | 9 | **default** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | 10 | **firebase** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | 11 | **firebasei_os** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | 12 | **google_play** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | 13 | **pc** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | 14 | **pico_store** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | 15 | **quest_app_lab** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | 16 | **quest_store** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | 17 | **test_flight** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | 18 | **xr_elite** | [**PlatformBuildInfo**](PlatformBuildInfo.md) | | 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/APIConfigOfflineAnalysis.md: -------------------------------------------------------------------------------- 1 | # APIConfigOfflineAnalysis 2 | 3 | Whether to allow offline analysis 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **android** | **bool** | Whether to allow offline analysis | [optional] [default to True] 9 | **standalonewindows** | **bool** | Whether to allow offline analysis | [optional] [default to True] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/APIConfigReportCategories.md: -------------------------------------------------------------------------------- 1 | # APIConfigReportCategories 2 | 3 | Categories available for reporting objectionable content 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **avatar** | [**ReportCategory**](ReportCategory.md) | | 9 | **avatarpage** | [**ReportCategory**](ReportCategory.md) | | [optional] 10 | **behavior** | [**ReportCategory**](ReportCategory.md) | | 11 | **chat** | [**ReportCategory**](ReportCategory.md) | | 12 | **emoji** | [**ReportCategory**](ReportCategory.md) | | [optional] 13 | **environment** | [**ReportCategory**](ReportCategory.md) | | 14 | **groupstore** | [**ReportCategory**](ReportCategory.md) | | 15 | **image** | [**ReportCategory**](ReportCategory.md) | | 16 | **text** | [**ReportCategory**](ReportCategory.md) | | 17 | **sticker** | [**ReportCategory**](ReportCategory.md) | | [optional] 18 | **warnings** | [**ReportCategory**](ReportCategory.md) | | 19 | **worldimage** | [**ReportCategory**](ReportCategory.md) | | 20 | **worldstore** | [**ReportCategory**](ReportCategory.md) | | 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/APIConfigReportOptions.md: -------------------------------------------------------------------------------- 1 | # APIConfigReportOptions 2 | 3 | Options for reporting content 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **avatar** | [**APIConfigReportOptionsAvatar**](APIConfigReportOptionsAvatar.md) | | [optional] 9 | **group** | [**APIConfigReportOptionsGroup**](APIConfigReportOptionsGroup.md) | | [optional] 10 | **user** | [**APIConfigReportOptionsUser**](APIConfigReportOptionsUser.md) | | [optional] 11 | **world** | [**APIConfigReportOptionsWorld**](APIConfigReportOptionsWorld.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/APIConfigReportOptionsAvatar.md: -------------------------------------------------------------------------------- 1 | # APIConfigReportOptionsAvatar 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **avatar** | **list[str]** | | [optional] 8 | **avatarpage** | **list[str]** | | [optional] 9 | **warnings** | **list[str]** | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/APIConfigReportOptionsGroup.md: -------------------------------------------------------------------------------- 1 | # APIConfigReportOptionsGroup 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **groupstore** | **list[str]** | | [optional] 8 | **image** | **list[str]** | | [optional] 9 | **text** | **list[str]** | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/APIConfigReportOptionsUser.md: -------------------------------------------------------------------------------- 1 | # APIConfigReportOptionsUser 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **behavior** | **list[str]** | | [optional] 8 | **chat** | **list[str]** | | [optional] 9 | **emoji** | **list[str]** | | [optional] 10 | **image** | **list[str]** | | [optional] 11 | **sticker** | **list[str]** | | [optional] 12 | **text** | **list[str]** | | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/APIConfigReportOptionsWorld.md: -------------------------------------------------------------------------------- 1 | # APIConfigReportOptionsWorld 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **environment** | **list[str]** | | [optional] 8 | **text** | **list[str]** | | [optional] 9 | **warnings** | **list[str]** | | [optional] 10 | **worldimage** | **list[str]** | | [optional] 11 | **worldstore** | **list[str]** | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/APIConfigReportReasons.md: -------------------------------------------------------------------------------- 1 | # APIConfigReportReasons 2 | 3 | Reasons available for reporting users 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **billing** | [**ReportReason**](ReportReason.md) | | 9 | **botting** | [**ReportReason**](ReportReason.md) | | 10 | **cancellation** | [**ReportReason**](ReportReason.md) | | 11 | **copyright** | [**ReportReason**](ReportReason.md) | | [optional] 12 | **fraud** | [**ReportReason**](ReportReason.md) | | [optional] 13 | **gore** | [**ReportReason**](ReportReason.md) | | 14 | **hacking** | [**ReportReason**](ReportReason.md) | | 15 | **harassing** | [**ReportReason**](ReportReason.md) | | 16 | **hateful** | [**ReportReason**](ReportReason.md) | | 17 | **impersonation** | [**ReportReason**](ReportReason.md) | | 18 | **inappropriate** | [**ReportReason**](ReportReason.md) | | 19 | **leaking** | [**ReportReason**](ReportReason.md) | | 20 | **malicious** | [**ReportReason**](ReportReason.md) | | 21 | **missing** | [**ReportReason**](ReportReason.md) | | 22 | **nudity** | [**ReportReason**](ReportReason.md) | | 23 | **renewal** | [**ReportReason**](ReportReason.md) | | 24 | **security** | [**ReportReason**](ReportReason.md) | | 25 | **service** | [**ReportReason**](ReportReason.md) | | 26 | **sexual** | [**ReportReason**](ReportReason.md) | | 27 | **technical** | [**ReportReason**](ReportReason.md) | | [optional] 28 | **threatening** | [**ReportReason**](ReportReason.md) | | 29 | **visuals** | [**ReportReason**](ReportReason.md) | | 30 | 31 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/APIHealth.md: -------------------------------------------------------------------------------- 1 | # APIHealth 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ok** | **bool** | | 8 | **server_name** | **str** | | 9 | **build_version_tag** | **str** | | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/AccountDeletionLog.md: -------------------------------------------------------------------------------- 1 | # AccountDeletionLog 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **message** | **str** | 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'] 8 | **deletion_scheduled** | **datetime** | When the deletion is scheduled to happen, standard is 14 days after the request. | [optional] 9 | **date_time** | **datetime** | Date and time of the deletion request. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/AddFavoriteRequest.md: -------------------------------------------------------------------------------- 1 | # AddFavoriteRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | [**FavoriteType**](FavoriteType.md) | | 8 | **favorite_id** | **str** | Must be either AvatarID, WorldID or UserID. | 9 | **tags** | **list[str]** | 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. | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/AddGroupGalleryImageRequest.md: -------------------------------------------------------------------------------- 1 | # AddGroupGalleryImageRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **file_id** | **str** | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/AgeVerificationStatus.md: -------------------------------------------------------------------------------- 1 | # AgeVerificationStatus 2 | 3 | `verified` is obsolete. User who have verified and are 18+ can switch to `plus18` status. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Avatar.md: -------------------------------------------------------------------------------- 1 | # Avatar 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **acknowledgements** | **str** | | [optional] 9 | **asset_url** | **str** | Not present from general search `/avatars`, only on specific requests `/avatars/{avatarId}`. | [optional] 10 | **asset_url_object** | **object** | 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] 11 | **author_id** | **str** | 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. | 12 | **author_name** | **str** | | 13 | **created_at** | **datetime** | | 14 | **description** | **str** | | 15 | **featured** | **bool** | | [default to False] 16 | **highest_price** | **int** | | [optional] 17 | **id** | **str** | | 18 | **image_url** | **str** | | 19 | **lock** | **bool** | | [optional] 20 | **lowest_price** | **int** | | [optional] 21 | **name** | **str** | | 22 | **product_id** | **str** | | [optional] 23 | **published_listings** | [**list[AvatarPublishedListingsInner]**](AvatarPublishedListingsInner.md) | | [optional] 24 | **release_status** | [**ReleaseStatus**](ReleaseStatus.md) | | 25 | **searchable** | **bool** | | [optional] [default to False] 26 | **styles** | [**AvatarStyles**](AvatarStyles.md) | | 27 | **tags** | **list[str]** | | 28 | **thumbnail_image_url** | **str** | | 29 | **unity_package_url** | **str** | | 30 | **unity_package_url_object** | [**AvatarUnityPackageUrlObject**](AvatarUnityPackageUrlObject.md) | | 31 | **unity_packages** | [**list[UnityPackage]**](UnityPackage.md) | | 32 | **updated_at** | **datetime** | | 33 | **version** | **int** | | [default to 0] 34 | 35 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 36 | 37 | 38 | -------------------------------------------------------------------------------- /docs/AvatarPublishedListingsInner.md: -------------------------------------------------------------------------------- 1 | # AvatarPublishedListingsInner 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **description** | **str** | | [optional] 8 | **display_name** | **str** | | [optional] 9 | **image_id** | **str** | | [optional] 10 | **listing_id** | **str** | | [optional] 11 | **listing_type** | **str** | | [optional] 12 | **price_tokens** | **int** | | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/AvatarStyles.md: -------------------------------------------------------------------------------- 1 | # AvatarStyles 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **primary** | **str** | | [optional] 8 | **secondary** | **str** | | [optional] 9 | **supplementary** | **list[str]** | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/AvatarUnityPackageUrlObject.md: -------------------------------------------------------------------------------- 1 | # AvatarUnityPackageUrlObject 2 | 3 | **Deprecation:** `Object` has unknown usage/fields, and is always empty. Use normal `Url` field instead. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **unity_package_url** | **str** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Badge.md: -------------------------------------------------------------------------------- 1 | # Badge 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **assigned_at** | **datetime** | only present in CurrentUser badges | [optional] 8 | **badge_description** | **str** | | 9 | **badge_id** | **str** | | 10 | **badge_image_url** | **str** | direct url to image | 11 | **badge_name** | **str** | | 12 | **hidden** | **bool** | only present in CurrentUser badges | [optional] 13 | **showcased** | **bool** | | 14 | **updated_at** | **datetime** | only present in CurrentUser badges | [optional] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/Balance.md: -------------------------------------------------------------------------------- 1 | # Balance 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **balance** | **int** | | [default to 0] 9 | **no_transactions** | **bool** | | [optional] 10 | **tilia_response** | **bool** | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/BanGroupMemberRequest.md: -------------------------------------------------------------------------------- 1 | # BanGroupMemberRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **user_id** | **str** | 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. | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ChangeUserTagsRequest.md: -------------------------------------------------------------------------------- 1 | # ChangeUserTagsRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **tags** | **list[str]** | The tags being added or removed. | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateAvatarRequest.md: -------------------------------------------------------------------------------- 1 | # CreateAvatarRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **asset_url** | **str** | | [optional] 8 | **asset_version** | **str** | | [optional] 9 | **platform** | **str** | This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [optional] 10 | **created_at** | **str** | A date and time of the pattern `M/d/yyyy h:mm:ss tt` (see C Sharp `System.DateTime`) | [optional] 11 | **updated_at** | **str** | A date and time of the pattern `M/d/yyyy h:mm:ss tt` (see C Sharp `System.DateTime`) | [optional] 12 | **id** | **str** | | [optional] 13 | **name** | **str** | | 14 | **description** | **str** | | [optional] 15 | **tags** | **list[str]** | | [optional] 16 | **image_url** | **str** | | 17 | **thumbnail_image_url** | **str** | | [optional] 18 | **release_status** | [**ReleaseStatus**](ReleaseStatus.md) | | [optional] 19 | **version** | **int** | | [optional] [default to 1] 20 | **unity_package_url** | **str** | | [optional] 21 | **unity_version** | **str** | | [optional] [default to '5.3.4p1'] 22 | 23 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/CreateFileRequest.md: -------------------------------------------------------------------------------- 1 | # CreateFileRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | | 8 | **mime_type** | [**MIMEType**](MIMEType.md) | | 9 | **extension** | **str** | | 10 | **tags** | **list[str]** | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CreateFileVersionRequest.md: -------------------------------------------------------------------------------- 1 | # CreateFileVersionRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **signature_md5** | **str** | | 8 | **signature_size_in_bytes** | **int** | | 9 | **file_md5** | **str** | | [optional] 10 | **file_size_in_bytes** | **int** | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CreateGroupAnnouncementRequest.md: -------------------------------------------------------------------------------- 1 | # CreateGroupAnnouncementRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **title** | **str** | Announcement title | 8 | **text** | **str** | Announcement text | [optional] 9 | **image_id** | **str** | | [optional] 10 | **send_notification** | **bool** | Send notification to group members. | [optional] [default to False] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CreateGroupGalleryRequest.md: -------------------------------------------------------------------------------- 1 | # CreateGroupGalleryRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | Name of the gallery. | 8 | **description** | **str** | Description of the gallery. | [optional] 9 | **members_only** | **bool** | Whether the gallery is members only. | [optional] [default to False] 10 | **role_ids_to_view** | **list[str]** | | [optional] 11 | **role_ids_to_submit** | **list[str]** | | [optional] 12 | **role_ids_to_auto_approve** | **list[str]** | | [optional] 13 | **role_ids_to_manage** | **list[str]** | | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/CreateGroupInviteRequest.md: -------------------------------------------------------------------------------- 1 | # CreateGroupInviteRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **user_id** | **str** | 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. | 8 | **confirm_override_block** | **bool** | | [optional] [default to True] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateGroupPostRequest.md: -------------------------------------------------------------------------------- 1 | # CreateGroupPostRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **title** | **str** | Post title | 8 | **text** | **str** | Post text | 9 | **image_id** | **str** | | [optional] 10 | **send_notification** | **bool** | Send notification to group members. | [default to False] 11 | **role_ids** | **list[str]** | | [optional] 12 | **visibility** | [**GroupPostVisibility**](GroupPostVisibility.md) | | 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CreateGroupRequest.md: -------------------------------------------------------------------------------- 1 | # CreateGroupRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | | 8 | **short_code** | **str** | | 9 | **description** | **str** | | [optional] 10 | **join_state** | [**GroupJoinState**](GroupJoinState.md) | | [optional] 11 | **icon_id** | **str** | | [optional] 12 | **banner_id** | **str** | | [optional] 13 | **privacy** | [**GroupPrivacy**](GroupPrivacy.md) | | [optional] 14 | **role_template** | [**GroupRoleTemplate**](GroupRoleTemplate.md) | | 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/CreateGroupRoleRequest.md: -------------------------------------------------------------------------------- 1 | # CreateGroupRoleRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | | [optional] 8 | **name** | **str** | | [optional] 9 | **description** | **str** | | [optional] 10 | **is_self_assignable** | **bool** | | [optional] [default to False] 11 | **permissions** | [**list[GroupPermissions]**](GroupPermissions.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CreateInstanceRequest.md: -------------------------------------------------------------------------------- 1 | # CreateInstanceRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **world_id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. | 8 | **type** | [**InstanceType**](InstanceType.md) | | 9 | **region** | [**InstanceRegion**](InstanceRegion.md) | | 10 | **owner_id** | **str** | A groupId if the instance type is \"group\", null if instance type is public, or a userId otherwise | [optional] 11 | **role_ids** | **list[str]** | Group roleIds that are allowed to join if the type is \"group\" and groupAccessType is \"member\" | [optional] 12 | **group_access_type** | [**GroupAccessType**](GroupAccessType.md) | | [optional] 13 | **queue_enabled** | **bool** | | [optional] [default to False] 14 | **closed_at** | **datetime** | The time after which users won't be allowed to join the instance. This doesn't work for public instances. | [optional] 15 | **can_request_invite** | **bool** | Only applies to invite type instances to make them invite+ | [optional] [default to False] 16 | **hard_close** | **bool** | Currently unused, but will eventually be a flag to set if the closing of the instance should kick people. | [optional] [default to False] 17 | **invite_only** | **bool** | | [optional] [default to False] 18 | **age_gate** | **bool** | | [optional] [default to False] 19 | **instance_persistence_enabled** | **bool** | | [optional] 20 | **display_name** | **str** | | [optional] 21 | **content_settings** | [**InstanceContentSettings**](InstanceContentSettings.md) | | [optional] 22 | 23 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/CreateWorldRequest.md: -------------------------------------------------------------------------------- 1 | # CreateWorldRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **asset_url** | **str** | | 8 | **asset_version** | **int** | | [optional] 9 | **author_id** | **str** | 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] 10 | **author_name** | **str** | | [optional] 11 | **capacity** | **int** | | [optional] 12 | **description** | **str** | | [optional] 13 | **id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [optional] 14 | **image_url** | **str** | | 15 | **name** | **str** | | 16 | **platform** | **str** | This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [optional] 17 | **release_status** | [**ReleaseStatus**](ReleaseStatus.md) | | [optional] 18 | **tags** | **list[str]** | | [optional] 19 | **unity_package_url** | **str** | | [optional] 20 | **unity_version** | **str** | | [optional] [default to '5.3.4p1'] 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/CurrentUserPlatformHistoryInner.md: -------------------------------------------------------------------------------- 1 | # CurrentUserPlatformHistoryInner 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **is_mobile** | **bool** | | [optional] 8 | **platform** | **str** | | [optional] 9 | **recorded** | **datetime** | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CurrentUserPresence.md: -------------------------------------------------------------------------------- 1 | # CurrentUserPresence 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **avatar_thumbnail** | **str** | | [optional] 8 | **current_avatar_tags** | **str** | | [optional] 9 | **display_name** | **str** | | [optional] 10 | **groups** | **list[str]** | | [optional] 11 | **id** | **str** | 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] 12 | **instance** | **str** | | [optional] 13 | **instance_type** | **str** | either an InstanceType or an empty string | [optional] 14 | **is_rejoining** | **str** | | [optional] 15 | **platform** | **str** | either a Platform or an empty string | [optional] 16 | **profile_pic_override** | **str** | | [optional] 17 | **status** | **str** | either a UserStatus or empty string | [optional] 18 | **traveling_to_instance** | **str** | | [optional] 19 | **traveling_to_world** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [optional] 20 | **user_icon** | **str** | | [optional] 21 | **world** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [optional] 22 | 23 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/DeveloperType.md: -------------------------------------------------------------------------------- 1 | # DeveloperType 2 | 3 | \"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. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Disable2FAResult.md: -------------------------------------------------------------------------------- 1 | # Disable2FAResult 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **removed** | **bool** | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/DynamicContentRow.md: -------------------------------------------------------------------------------- 1 | # DynamicContentRow 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **index** | **int** | | [optional] 8 | **name** | **str** | | 9 | **platform** | **str** | Usually \"ThisPlatformSupported\", but can also be other values such as \"all\" or platform specific identifiers. | 10 | **sort_heading** | **str** | | 11 | **sort_order** | **str** | | 12 | **sort_ownership** | **str** | | 13 | **tag** | **str** | Tag to filter content for this row. | [optional] 14 | **type** | **str** | Type is not present if it is a world. | [optional] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/Error.md: -------------------------------------------------------------------------------- 1 | # Error 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **error** | [**Response**](Response.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Favorite.md: -------------------------------------------------------------------------------- 1 | # Favorite 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **favorite_id** | **str** | MUST be either AvatarID, UserID or WorldID. | 9 | **id** | **str** | | 10 | **tags** | **list[str]** | | 11 | **type** | [**FavoriteType**](FavoriteType.md) | | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/FavoriteGroup.md: -------------------------------------------------------------------------------- 1 | # FavoriteGroup 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **display_name** | **str** | | 9 | **id** | **str** | | 10 | **name** | **str** | | 11 | **owner_display_name** | **str** | | 12 | **owner_id** | **str** | 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. | 13 | **tags** | **list[str]** | | 14 | **type** | [**FavoriteType**](FavoriteType.md) | | 15 | **visibility** | [**FavoriteGroupVisibility**](FavoriteGroupVisibility.md) | | 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/FavoriteGroupLimits.md: -------------------------------------------------------------------------------- 1 | # FavoriteGroupLimits 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **avatar** | **int** | | 8 | **friend** | **int** | | 9 | **world** | **int** | | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/FavoriteGroupVisibility.md: -------------------------------------------------------------------------------- 1 | # FavoriteGroupVisibility 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/FavoriteLimits.md: -------------------------------------------------------------------------------- 1 | # FavoriteLimits 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **default_max_favorite_groups** | **int** | | 8 | **default_max_favorites_per_group** | **int** | | 9 | **max_favorite_groups** | [**FavoriteGroupLimits**](FavoriteGroupLimits.md) | | 10 | **max_favorites_per_group** | [**FavoriteGroupLimits**](FavoriteGroupLimits.md) | | 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/FavoriteType.md: -------------------------------------------------------------------------------- 1 | # FavoriteType 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/FavoritedWorld.md: -------------------------------------------------------------------------------- 1 | # FavoritedWorld 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **author_id** | **str** | 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. | 9 | **author_name** | **str** | | 10 | **capacity** | **int** | | 11 | **description** | **str** | | 12 | **recommended_capacity** | **int** | | [optional] 13 | **created_at** | **datetime** | | 14 | **default_content_settings** | [**InstanceContentSettings**](InstanceContentSettings.md) | | [optional] 15 | **favorites** | **int** | | [default to 0] 16 | **favorite_group** | **str** | | 17 | **favorite_id** | **str** | | 18 | **featured** | **bool** | | [default to False] 19 | **visits** | **int** | | [optional] [default to 0] 20 | **heat** | **int** | | [default to 0] 21 | **id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. | 22 | **image_url** | **str** | | 23 | **labs_publication_date** | **str** | | 24 | **name** | **str** | | 25 | **occupants** | **int** | | [default to 0] 26 | **organization** | **str** | | [default to 'vrchat'] 27 | **popularity** | **int** | | [default to 0] 28 | **preview_youtube_id** | **str** | | [optional] 29 | **publication_date** | **str** | | 30 | **release_status** | [**ReleaseStatus**](ReleaseStatus.md) | | 31 | **tags** | **list[str]** | | 32 | **thumbnail_image_url** | **str** | | 33 | **unity_packages** | [**list[UnityPackage]**](UnityPackage.md) | | 34 | **updated_at** | **datetime** | | 35 | **url_list** | **list[str]** | | 36 | **udon_products** | **list[str]** | | [optional] 37 | **version** | **int** | | 38 | 39 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 40 | 41 | 42 | -------------------------------------------------------------------------------- /docs/Feedback.md: -------------------------------------------------------------------------------- 1 | # Feedback 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **commenter_id** | **str** | 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. | 8 | **commenter_name** | **str** | | 9 | **content_author_id** | **str** | 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. | 10 | **content_author_name** | **str** | | 11 | **content_id** | **str** | | 12 | **content_name** | **str** | | [optional] 13 | **content_type** | **str** | | 14 | **content_version** | **int** | | 15 | **description** | **str** | | [optional] 16 | **id** | **str** | | 17 | **reason** | **str** | | 18 | **tags** | **list[str]** | | 19 | **type** | **str** | | 20 | 21 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/File.md: -------------------------------------------------------------------------------- 1 | # File 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **animation_style** | **str** | | [optional] 9 | **mask_tag** | **str** | | [optional] 10 | **extension** | **str** | | 11 | **id** | **str** | | 12 | **mime_type** | [**MIMEType**](MIMEType.md) | | 13 | **name** | **str** | | 14 | **owner_id** | **str** | 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. | 15 | **tags** | **list[str]** | | 16 | **versions** | [**list[FileVersion]**](FileVersion.md) | | 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/FileAnalysis.md: -------------------------------------------------------------------------------- 1 | # FileAnalysis 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **avatar_stats** | [**FileAnalysisAvatarStats**](FileAnalysisAvatarStats.md) | | 8 | **created_at** | **datetime** | | [optional] 9 | **encryption_key** | **str** | | [optional] 10 | **file_size** | **int** | | 11 | **performance_rating** | **str** | | [optional] 12 | **success** | **bool** | | 13 | **uncompressed_size** | **int** | | 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/FileAnalysisAvatarStats.md: -------------------------------------------------------------------------------- 1 | # FileAnalysisAvatarStats 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **animator_count** | **int** | | 8 | **audio_source_count** | **int** | | 9 | **blend_shape_count** | **int** | | 10 | **bone_count** | **int** | | 11 | **bounds** | **list[float]** | | 12 | **camera_count** | **int** | | [optional] 13 | **cloth_count** | **int** | | 14 | **constraint_count** | **int** | | 15 | **contact_count** | **int** | | 16 | **custom_expressions** | **bool** | | 17 | **customize_animation_layers** | **bool** | | 18 | **enable_eye_look** | **bool** | | 19 | **light_count** | **int** | | 20 | **line_renderer_count** | **int** | | 21 | **lip_sync** | **int** | | 22 | **material_count** | **int** | | 23 | **material_slots_used** | **int** | | 24 | **mesh_count** | **int** | | 25 | **mesh_indices** | **int** | | 26 | **mesh_particle_max_polygons** | **int** | | 27 | **mesh_polygons** | **int** | | 28 | **mesh_vertices** | **int** | | 29 | **particle_collision_enabled** | **bool** | | 30 | **particle_system_count** | **int** | | 31 | **particle_trails_enabled** | **bool** | | 32 | **phys_bone_collider_count** | **int** | | 33 | **phys_bone_collision_check_count** | **int** | | 34 | **phys_bone_component_count** | **int** | | 35 | **phys_bone_transform_count** | **int** | | 36 | **physics_colliders** | **int** | | 37 | **physics_rigidbodies** | **int** | | 38 | **skinned_mesh_count** | **int** | | 39 | **skinned_mesh_indices** | **int** | | 40 | **skinned_mesh_polygons** | **int** | | 41 | **skinned_mesh_vertices** | **int** | | 42 | **total_cloth_vertices** | **int** | | 43 | **total_indices** | **int** | | 44 | **total_max_particles** | **int** | | 45 | **total_polygons** | **int** | | 46 | **total_texture_usage** | **int** | | 47 | **total_vertices** | **int** | | 48 | **trail_renderer_count** | **int** | | 49 | **write_defaults_used** | **bool** | | 50 | 51 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 52 | 53 | 54 | -------------------------------------------------------------------------------- /docs/FileData.md: -------------------------------------------------------------------------------- 1 | # FileData 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **category** | **str** | | [default to 'queued'] 9 | **file_name** | **str** | | 10 | **md5** | **str** | | [optional] 11 | **size_in_bytes** | **int** | | 12 | **status** | [**FileStatus**](FileStatus.md) | | 13 | **upload_id** | **str** | | [default to ''] 14 | **url** | **str** | | 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/FileStatus.md: -------------------------------------------------------------------------------- 1 | # FileStatus 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/FileUploadURL.md: -------------------------------------------------------------------------------- 1 | # FileUploadURL 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **url** | **str** | | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/FileVersion.md: -------------------------------------------------------------------------------- 1 | # FileVersion 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **created_at** | **datetime** | | 9 | **deleted** | **bool** | Usually only present if `true` | [optional] [default to True] 10 | **delta** | [**FileData**](FileData.md) | | [optional] 11 | **file** | [**FileData**](FileData.md) | | [optional] 12 | **signature** | [**FileData**](FileData.md) | | [optional] 13 | **status** | [**FileStatus**](FileStatus.md) | | 14 | **version** | **int** | Incremental version counter, can only be increased. | [default to 0] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/FileVersionUploadStatus.md: -------------------------------------------------------------------------------- 1 | # FileVersionUploadStatus 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **upload_id** | **str** | | 9 | **file_name** | **str** | | 10 | **next_part_number** | **int** | | 11 | **max_parts** | **int** | | 12 | **parts** | **list[object]** | | 13 | **etags** | **list[object]** | Unknown | 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/FinishFileDataUploadRequest.md: -------------------------------------------------------------------------------- 1 | # FinishFileDataUploadRequest 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **etags** | **list[str]** | Array of ETags uploaded. | [optional] 9 | **next_part_number** | **str** | Always a zero in string form, despite how many parts uploaded. | [default to '0'] 10 | **max_parts** | **str** | Always a zero in string form, despite how many parts uploaded. | [default to '0'] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/FriendStatus.md: -------------------------------------------------------------------------------- 1 | # FriendStatus 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **incoming_request** | **bool** | | [default to False] 8 | **is_friend** | **bool** | | [default to False] 9 | **outgoing_request** | **bool** | | [default to False] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetGroupPosts200Response.md: -------------------------------------------------------------------------------- 1 | # GetGroupPosts200Response 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **posts** | [**list[GroupPost]**](GroupPost.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetUserGroupInstances200Response.md: -------------------------------------------------------------------------------- 1 | # GetUserGroupInstances200Response 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **fetched_at** | **datetime** | | [optional] 8 | **instances** | [**list[Instance]**](Instance.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Group.md: -------------------------------------------------------------------------------- 1 | # Group 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **age_verification_slots_available** | **bool** | | [optional] 8 | **age_verification_beta_code** | **str** | | [optional] 9 | **age_verification_beta_slots** | **float** | | [optional] 10 | **badges** | **list[str]** | | [optional] 11 | **id** | **str** | | [optional] 12 | **name** | **str** | | [optional] 13 | **short_code** | **str** | | [optional] 14 | **discriminator** | **str** | | [optional] 15 | **description** | **str** | | [optional] 16 | **icon_url** | **str** | | [optional] 17 | **banner_url** | **str** | | [optional] 18 | **privacy** | [**GroupPrivacy**](GroupPrivacy.md) | | [optional] 19 | **owner_id** | **str** | 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] 20 | **rules** | **str** | | [optional] 21 | **links** | **list[str]** | | [optional] 22 | **languages** | **list[str]** | | [optional] 23 | **icon_id** | **str** | | [optional] 24 | **banner_id** | **str** | | [optional] 25 | **member_count** | **int** | | [optional] 26 | **member_count_synced_at** | **datetime** | | [optional] 27 | **is_verified** | **bool** | | [optional] [default to False] 28 | **join_state** | [**GroupJoinState**](GroupJoinState.md) | | [optional] 29 | **tags** | **list[str]** | | [optional] 30 | **transfer_target_id** | **str** | 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] 31 | **galleries** | [**list[GroupGallery]**](GroupGallery.md) | | [optional] 32 | **created_at** | **datetime** | | [optional] 33 | **updated_at** | **datetime** | | [optional] 34 | **last_post_created_at** | **datetime** | | [optional] 35 | **online_member_count** | **int** | | [optional] 36 | **membership_status** | [**GroupMemberStatus**](GroupMemberStatus.md) | | [optional] 37 | **my_member** | [**GroupMyMember**](GroupMyMember.md) | | [optional] 38 | **roles** | [**list[GroupRole]**](GroupRole.md) | Only returned if ?includeRoles=true is specified. | [optional] 39 | 40 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 41 | 42 | 43 | -------------------------------------------------------------------------------- /docs/GroupAccessType.md: -------------------------------------------------------------------------------- 1 | # GroupAccessType 2 | 3 | Group access type when the instance type is \"group\" 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GroupAnnouncement.md: -------------------------------------------------------------------------------- 1 | # GroupAnnouncement 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | | [optional] 8 | **group_id** | **str** | | [optional] 9 | **author_id** | **str** | 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] 10 | **title** | **str** | | [optional] 11 | **text** | **str** | | [optional] 12 | **image_id** | **str** | | [optional] 13 | **image_url** | **str** | | [optional] 14 | **created_at** | **datetime** | | [optional] 15 | **updated_at** | **datetime** | | [optional] 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/GroupAuditLogEntry.md: -------------------------------------------------------------------------------- 1 | # GroupAuditLogEntry 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | | [optional] 8 | **created_at** | **datetime** | | [optional] 9 | **group_id** | **str** | | [optional] 10 | **actor_id** | **str** | 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] 11 | **actor_display_name** | **str** | | [optional] 12 | **target_id** | **str** | Typically a UserID, GroupID, GroupRoleID, or Location, but could be other types of IDs. | [optional] 13 | **event_type** | **str** | 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'] 14 | **description** | **str** | A human-readable description of the event. | [optional] 15 | **data** | **object** | The data associated with the event. The format of this data is dependent on the event type. | [optional] 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/GroupGallery.md: -------------------------------------------------------------------------------- 1 | # GroupGallery 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | | [optional] 8 | **name** | **str** | Name of the gallery. | [optional] 9 | **description** | **str** | Description of the gallery. | [optional] 10 | **members_only** | **bool** | Whether the gallery is members only. | [optional] [default to False] 11 | **role_ids_to_view** | **list[str]** | | [optional] 12 | **role_ids_to_submit** | **list[str]** | | [optional] 13 | **role_ids_to_auto_approve** | **list[str]** | | [optional] 14 | **role_ids_to_manage** | **list[str]** | | [optional] 15 | **created_at** | **datetime** | | [optional] 16 | **updated_at** | **datetime** | | [optional] 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/GroupGalleryImage.md: -------------------------------------------------------------------------------- 1 | # GroupGalleryImage 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | | [optional] 8 | **group_id** | **str** | | [optional] 9 | **gallery_id** | **str** | | [optional] 10 | **file_id** | **str** | | [optional] 11 | **image_url** | **str** | | [optional] 12 | **created_at** | **datetime** | | [optional] 13 | **submitted_by_user_id** | **str** | 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] 14 | **approved** | **bool** | | [optional] [default to False] 15 | **approved_by_user_id** | **str** | 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] 16 | **approved_at** | **datetime** | | [optional] 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/GroupInstance.md: -------------------------------------------------------------------------------- 1 | # GroupInstance 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **instance_id** | **str** | | 8 | **location** | **str** | 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. | 9 | **world** | [**World**](World.md) | | 10 | **member_count** | **int** | | 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GroupJoinRequestAction.md: -------------------------------------------------------------------------------- 1 | # GroupJoinRequestAction 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GroupJoinState.md: -------------------------------------------------------------------------------- 1 | # GroupJoinState 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GroupLimitedMember.md: -------------------------------------------------------------------------------- 1 | # GroupLimitedMember 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | | [optional] 8 | **group_id** | **str** | | [optional] 9 | **user_id** | **str** | 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] 10 | **is_representing** | **bool** | Whether the user is representing the group. This makes the group show up above the name tag in-game. | [optional] [default to False] 11 | **role_ids** | **list[str]** | | [optional] 12 | **m_role_ids** | **list[str]** | | [optional] 13 | **joined_at** | **datetime** | | [optional] 14 | **membership_status** | [**GroupMemberStatus**](GroupMemberStatus.md) | | [optional] 15 | **visibility** | **str** | | [optional] 16 | **is_subscribed_to_announcements** | **bool** | | [optional] [default to False] 17 | **created_at** | **datetime** | Only visible via the /groups/:groupId/members endpoint, **not** when fetching a specific user. | [optional] 18 | **banned_at** | **datetime** | Only visible via the /groups/:groupId/members endpoint, **not** when fetching a specific user. | [optional] 19 | **manager_notes** | **str** | Only visible via the /groups/:groupId/members endpoint, **not** when fetching a specific user. | [optional] 20 | **last_post_read_at** | **datetime** | | [optional] 21 | **has_joined_from_purchase** | **bool** | | [optional] 22 | 23 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/GroupMember.md: -------------------------------------------------------------------------------- 1 | # GroupMember 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **accepted_by_display_name** | **str** | | [optional] 8 | **accepted_by_id** | **str** | | [optional] 9 | **id** | **str** | | [optional] 10 | **group_id** | **str** | | [optional] 11 | **user_id** | **str** | 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] 12 | **is_representing** | **bool** | Whether the user is representing the group. This makes the group show up above the name tag in-game. | [optional] [default to False] 13 | **user** | [**GroupMemberLimitedUser**](GroupMemberLimitedUser.md) | | [optional] 14 | **role_ids** | **list[str]** | | [optional] 15 | **m_role_ids** | **list[str]** | | [optional] 16 | **joined_at** | **datetime** | | [optional] 17 | **membership_status** | [**GroupMemberStatus**](GroupMemberStatus.md) | | [optional] 18 | **visibility** | **str** | | [optional] 19 | **is_subscribed_to_announcements** | **bool** | | [optional] [default to False] 20 | **created_at** | **datetime** | Only visible via the /groups/:groupId/members endpoint, **not** when fetching a specific user. | [optional] 21 | **banned_at** | **datetime** | Only visible via the /groups/:groupId/members endpoint, **not** when fetching a specific user. | [optional] 22 | **manager_notes** | **str** | Only visible via the /groups/:groupId/members endpoint, **not** when fetching a specific user. | [optional] 23 | **last_post_read_at** | **datetime** | | [optional] 24 | **has_joined_from_purchase** | **bool** | | [optional] 25 | 26 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/GroupMemberLimitedUser.md: -------------------------------------------------------------------------------- 1 | # GroupMemberLimitedUser 2 | 3 | Only visible via the /groups/:groupId/members endpoint, **not** when fetching a specific user. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | 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] 9 | **display_name** | **str** | | [optional] 10 | **thumbnail_url** | **str** | | [optional] 11 | **icon_url** | **str** | | [optional] 12 | **profile_pic_override** | **str** | | [optional] 13 | **current_avatar_thumbnail_image_url** | **str** | | [optional] 14 | **current_avatar_tags** | **list[str]** | | [optional] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/GroupMemberStatus.md: -------------------------------------------------------------------------------- 1 | # GroupMemberStatus 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GroupMyMember.md: -------------------------------------------------------------------------------- 1 | # GroupMyMember 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | | [optional] 8 | **group_id** | **str** | | [optional] 9 | **user_id** | **str** | 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] 10 | **role_ids** | **list[str]** | | [optional] 11 | **accepted_by_display_name** | **str** | | [optional] 12 | **accepted_by_id** | **str** | | [optional] 13 | **created_at** | **datetime** | | [optional] 14 | **manager_notes** | **str** | | [optional] 15 | **membership_status** | **str** | | [optional] 16 | **is_subscribed_to_announcements** | **bool** | | [optional] [default to True] 17 | **visibility** | **str** | | [optional] 18 | **is_representing** | **bool** | | [optional] [default to False] 19 | **joined_at** | **datetime** | | [optional] 20 | **banned_at** | **str** | | [optional] 21 | **has2_fa** | **bool** | | [optional] [default to False] 22 | **has_joined_from_purchase** | **bool** | | [optional] [default to False] 23 | **last_post_read_at** | **datetime** | | [optional] 24 | **m_role_ids** | **list[str]** | | [optional] 25 | **permissions** | [**list[GroupPermissions]**](GroupPermissions.md) | | [optional] 26 | 27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/GroupPermission.md: -------------------------------------------------------------------------------- 1 | # GroupPermission 2 | 3 | A permission that can be granted to a role in a group. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **name** | **str** | The name of the permission. | [optional] 9 | **display_name** | **str** | The display name of the permission. | [optional] 10 | **help** | **str** | Human-readable description of the permission. | [optional] 11 | **is_management_permission** | **bool** | Whether this permission is a \"management\" permission. | [optional] [default to False] 12 | **allowed_to_add** | **bool** | Whether the user is allowed to add this permission to a role. | [optional] [default to False] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/GroupPermissions.md: -------------------------------------------------------------------------------- 1 | # GroupPermissions 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GroupPost.md: -------------------------------------------------------------------------------- 1 | # GroupPost 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | | [optional] 8 | **group_id** | **str** | | [optional] 9 | **author_id** | **str** | 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] 10 | **editor_id** | **str** | 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] 11 | **visibility** | [**GroupPostVisibility**](GroupPostVisibility.md) | | [optional] 12 | **role_id** | **list[str]** | | [optional] 13 | **title** | **str** | | [optional] 14 | **text** | **str** | | [optional] 15 | **image_id** | **str** | | [optional] 16 | **image_url** | **str** | | [optional] 17 | **created_at** | **datetime** | | [optional] 18 | **updated_at** | **datetime** | | [optional] 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/GroupPostVisibility.md: -------------------------------------------------------------------------------- 1 | # GroupPostVisibility 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GroupPrivacy.md: -------------------------------------------------------------------------------- 1 | # GroupPrivacy 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GroupRole.md: -------------------------------------------------------------------------------- 1 | # GroupRole 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | | [optional] 8 | **group_id** | **str** | | [optional] 9 | **name** | **str** | | [optional] 10 | **description** | **str** | | [optional] 11 | **is_self_assignable** | **bool** | | [optional] [default to False] 12 | **permissions** | [**list[GroupPermissions]**](GroupPermissions.md) | | [optional] 13 | **is_management_role** | **bool** | | [optional] [default to False] 14 | **requires_two_factor** | **bool** | | [optional] [default to False] 15 | **requires_purchase** | **bool** | | [optional] [default to False] 16 | **order** | **int** | | [optional] 17 | **created_at** | **datetime** | | [optional] 18 | **updated_at** | **datetime** | | [optional] 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/GroupRoleTemplate.md: -------------------------------------------------------------------------------- 1 | # GroupRoleTemplate 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GroupRoleTemplateValues.md: -------------------------------------------------------------------------------- 1 | # GroupRoleTemplateValues 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **base_permissions** | [**list[GroupPermissions]**](GroupPermissions.md) | | 8 | **description** | **str** | | 9 | **name** | **str** | | 10 | **roles** | [**GroupRoleTemplateValuesRoles**](GroupRoleTemplateValuesRoles.md) | | 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GroupRoleTemplateValuesRoles.md: -------------------------------------------------------------------------------- 1 | # GroupRoleTemplateValuesRoles 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **description** | **str** | | [optional] 8 | **name** | **str** | | [optional] 9 | **base_permissions** | [**list[GroupPermissions]**](GroupPermissions.md) | | [optional] 10 | **is_added_on_join** | **bool** | | [optional] [default to False] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GroupSearchSort.md: -------------------------------------------------------------------------------- 1 | # GroupSearchSort 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GroupUserVisibility.md: -------------------------------------------------------------------------------- 1 | # GroupUserVisibility 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/InfoPush.md: -------------------------------------------------------------------------------- 1 | # InfoPush 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | | 9 | **is_enabled** | **bool** | | [default to True] 10 | **release_status** | [**ReleaseStatus**](ReleaseStatus.md) | | 11 | **priority** | **int** | | 12 | **tags** | **list[str]** | | 13 | **data** | [**InfoPushData**](InfoPushData.md) | | 14 | **hash** | **str** | Unknown usage, MD5 | 15 | **created_at** | **datetime** | | 16 | **updated_at** | **datetime** | | 17 | **start_date** | **datetime** | | [optional] 18 | **end_date** | **datetime** | | [optional] 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/InfoPushData.md: -------------------------------------------------------------------------------- 1 | # InfoPushData 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **content_list** | [**DynamicContentRow**](DynamicContentRow.md) | | [optional] 9 | **description** | **str** | | [optional] 10 | **image_url** | **str** | | [optional] 11 | **name** | **str** | | [optional] 12 | **on_pressed** | [**InfoPushDataClickable**](InfoPushDataClickable.md) | | [optional] 13 | **template** | **str** | | [optional] 14 | **version** | **str** | | [optional] 15 | **article** | [**InfoPushDataArticle**](InfoPushDataArticle.md) | | [optional] 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/InfoPushDataArticle.md: -------------------------------------------------------------------------------- 1 | # InfoPushDataArticle 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **content** | [**InfoPushDataArticleContent**](InfoPushDataArticleContent.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/InfoPushDataArticleContent.md: -------------------------------------------------------------------------------- 1 | # InfoPushDataArticleContent 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **text** | **str** | | [optional] 8 | **image_url** | **str** | | [optional] 9 | **on_pressed** | [**InfoPushDataClickable**](InfoPushDataClickable.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/InfoPushDataClickable.md: -------------------------------------------------------------------------------- 1 | # InfoPushDataClickable 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **command** | **str** | | 8 | **parameters** | **list[str]** | In case of OpenURL, this would contain the link. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/InstanceContentSettings.md: -------------------------------------------------------------------------------- 1 | # InstanceContentSettings 2 | 3 | Types of dynamic user content permitted in an instance 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **drones** | **bool** | | [optional] [default to True] 9 | **emoji** | **bool** | | [optional] [default to True] 10 | **pedestals** | **bool** | | [optional] [default to True] 11 | **prints** | **bool** | | [optional] [default to True] 12 | **stickers** | **bool** | | [optional] [default to True] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/InstancePlatforms.md: -------------------------------------------------------------------------------- 1 | # InstancePlatforms 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **android** | **int** | | 8 | **ios** | **int** | | [optional] 9 | **standalonewindows** | **int** | | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/InstanceRegion.md: -------------------------------------------------------------------------------- 1 | # InstanceRegion 2 | 3 | Instance region 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/InstanceShortNameResponse.md: -------------------------------------------------------------------------------- 1 | # InstanceShortNameResponse 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **secure_name** | **str** | | 8 | **short_name** | **str** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/InstanceType.md: -------------------------------------------------------------------------------- 1 | # InstanceType 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/InviteMessage.md: -------------------------------------------------------------------------------- 1 | # InviteMessage 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **can_be_updated** | **bool** | | [default to True] 9 | **id** | **str** | | 10 | **message** | **str** | | 11 | **message_type** | [**InviteMessageType**](InviteMessageType.md) | | 12 | **remaining_cooldown_minutes** | **int** | Changes to 60 when updated, although probably server-side configurable. | [default to 0] 13 | **slot** | **int** | | 14 | **updated_at** | **datetime** | | 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/InviteMessageType.md: -------------------------------------------------------------------------------- 1 | # InviteMessageType 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/InviteRequest.md: -------------------------------------------------------------------------------- 1 | # InviteRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **instance_id** | **str** | 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. | 8 | **message_slot** | **int** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/InviteResponse.md: -------------------------------------------------------------------------------- 1 | # InviteResponse 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **response_slot** | **int** | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Jam.md: -------------------------------------------------------------------------------- 1 | # Jam 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **description** | **str** | | 9 | **id** | **str** | | 10 | **is_visible** | **bool** | | 11 | **more_info** | **str** | | 12 | **state** | **str** | One of: - submissions_open - closed | 13 | **state_change_dates** | [**JamStateChangeDates**](JamStateChangeDates.md) | | 14 | **submission_content_gate_date** | **datetime** | | 15 | **submission_content_gated** | **bool** | | 16 | **title** | **str** | | 17 | **updated_at** | **datetime** | | 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/JamStateChangeDates.md: -------------------------------------------------------------------------------- 1 | # JamStateChangeDates 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **closed** | **datetime** | | [optional] 8 | **submissions_closed** | **datetime** | | [optional] 9 | **submissions_opened** | **datetime** | | [optional] 10 | **winners_selected** | **datetime** | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/License.md: -------------------------------------------------------------------------------- 1 | # License 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **for_id** | **str** | Either a AvatarID, LicenseGroupID, PermissionID or ProductID. This depends on the `forType` field. | 8 | **for_type** | [**LicenseType**](LicenseType.md) | | 9 | **for_name** | **str** | | 10 | **for_action** | [**LicenseAction**](LicenseAction.md) | | 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/LicenseAction.md: -------------------------------------------------------------------------------- 1 | # LicenseAction 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/LicenseGroup.md: -------------------------------------------------------------------------------- 1 | # LicenseGroup 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | | 9 | **name** | **str** | | 10 | **description** | **str** | | 11 | **licenses** | [**list[License]**](License.md) | | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/LicenseType.md: -------------------------------------------------------------------------------- 1 | # LicenseType 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/LimitedGroup.md: -------------------------------------------------------------------------------- 1 | # LimitedGroup 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | | [optional] 8 | **name** | **str** | | [optional] 9 | **short_code** | **str** | | [optional] 10 | **discriminator** | **str** | | [optional] 11 | **description** | **str** | | [optional] 12 | **icon_url** | **str** | | [optional] 13 | **banner_url** | **str** | | [optional] 14 | **owner_id** | **str** | 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] 15 | **rules** | **str** | | [optional] 16 | **icon_id** | **str** | | [optional] 17 | **banner_id** | **str** | | [optional] 18 | **member_count** | **int** | | [optional] 19 | **tags** | **list[str]** | | [optional] 20 | **created_at** | **datetime** | | [optional] 21 | **membership_status** | [**GroupMemberStatus**](GroupMemberStatus.md) | | [optional] 22 | **is_searchable** | **bool** | | [optional] 23 | **galleries** | [**list[GroupGallery]**](GroupGallery.md) | | [optional] 24 | 25 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/LimitedUnityPackage.md: -------------------------------------------------------------------------------- 1 | # LimitedUnityPackage 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **platform** | **str** | This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | 9 | **unity_version** | **str** | | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/LimitedUser.md: -------------------------------------------------------------------------------- 1 | # LimitedUser 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **bio** | **str** | | [optional] 9 | **bio_links** | **list[str]** | | [optional] 10 | **current_avatar_image_url** | **str** | When profilePicOverride is not empty, use it instead. | [optional] 11 | **current_avatar_thumbnail_image_url** | **str** | When profilePicOverride is not empty, use it instead. | [optional] 12 | **current_avatar_tags** | **list[str]** | | [optional] 13 | **developer_type** | [**DeveloperType**](DeveloperType.md) | | 14 | **display_name** | **str** | | 15 | **fallback_avatar** | **str** | | [optional] 16 | **id** | **str** | 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. | 17 | **is_friend** | **bool** | | 18 | **last_platform** | **str** | This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | 19 | **last_login** | **datetime** | | [optional] 20 | **profile_pic_override** | **str** | | [optional] 21 | **pronouns** | **str** | | [optional] 22 | **status** | [**UserStatus**](UserStatus.md) | | 23 | **status_description** | **str** | | 24 | **tags** | **list[str]** | <- Always empty. | 25 | **user_icon** | **str** | | [optional] 26 | **username** | **str** | -| **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] 27 | **location** | **str** | | [optional] 28 | **friend_key** | **str** | | [optional] 29 | 30 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/LimitedUserGroups.md: -------------------------------------------------------------------------------- 1 | # LimitedUserGroups 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | | [optional] 8 | **name** | **str** | | [optional] 9 | **short_code** | **str** | | [optional] 10 | **discriminator** | **str** | | [optional] 11 | **description** | **str** | | [optional] 12 | **icon_id** | **str** | | [optional] 13 | **icon_url** | **str** | | [optional] 14 | **banner_id** | **str** | | [optional] 15 | **banner_url** | **str** | | [optional] 16 | **privacy** | **str** | | [optional] 17 | **last_post_created_at** | **datetime** | | [optional] 18 | **owner_id** | **str** | 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] 19 | **member_count** | **int** | | [optional] 20 | **group_id** | **str** | | [optional] 21 | **member_visibility** | **str** | | [optional] 22 | **is_representing** | **bool** | | [optional] 23 | **mutual_group** | **bool** | | [optional] 24 | **last_post_read_at** | **datetime** | | [optional] 25 | 26 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/LimitedWorld.md: -------------------------------------------------------------------------------- 1 | # LimitedWorld 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **author_id** | **str** | 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. | 9 | **author_name** | **str** | | 10 | **capacity** | **int** | | 11 | **recommended_capacity** | **int** | | [optional] 12 | **created_at** | **datetime** | | 13 | **default_content_settings** | [**InstanceContentSettings**](InstanceContentSettings.md) | | [optional] 14 | **favorites** | **int** | | [default to 0] 15 | **visits** | **int** | | [optional] [default to 0] 16 | **heat** | **int** | | [default to 0] 17 | **id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. | 18 | **image_url** | **str** | | 19 | **labs_publication_date** | **str** | | 20 | **name** | **str** | | 21 | **occupants** | **int** | | [default to 0] 22 | **organization** | **str** | | [default to 'vrchat'] 23 | **popularity** | **int** | | [default to 0] 24 | **preview_youtube_id** | **str** | | [optional] 25 | **publication_date** | **str** | | 26 | **release_status** | [**ReleaseStatus**](ReleaseStatus.md) | | 27 | **store_id** | **str** | | [optional] 28 | **tags** | **list[str]** | | 29 | **thumbnail_image_url** | **str** | | 30 | **unity_packages** | [**list[LimitedUnityPackage]**](LimitedUnityPackage.md) | | 31 | **updated_at** | **datetime** | | 32 | **udon_products** | **list[str]** | | [optional] 33 | 34 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 35 | 36 | 37 | -------------------------------------------------------------------------------- /docs/MIMEType.md: -------------------------------------------------------------------------------- 1 | # MIMEType 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ModelPrint.md: -------------------------------------------------------------------------------- 1 | # ModelPrint 2 | 3 | Info about a print 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **author_id** | **str** | 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. | 9 | **author_name** | **str** | | 10 | **created_at** | **datetime** | | 11 | **files** | [**PrintFiles**](PrintFiles.md) | | 12 | **id** | **str** | | 13 | **note** | **str** | | 14 | **owner_id** | **str** | 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] 15 | **timestamp** | **datetime** | | 16 | **world_id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. | 17 | **world_name** | **str** | | 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/ModerateUserRequest.md: -------------------------------------------------------------------------------- 1 | # ModerateUserRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **moderated** | **str** | 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. | 8 | **type** | [**PlayerModerationType**](PlayerModerationType.md) | | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Notification.md: -------------------------------------------------------------------------------- 1 | # Notification 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **created_at** | **datetime** | | 9 | **details** | **str** | **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 '{}'] 10 | **id** | **str** | | 11 | **message** | **str** | | 12 | **seen** | **bool** | Not included in notification objects received from the Websocket API | [optional] [default to False] 13 | **receiver_user_id** | **str** | 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] 14 | **sender_user_id** | **str** | 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. | 15 | **sender_username** | **str** | -| **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] 16 | **type** | [**NotificationType**](NotificationType.md) | | 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/NotificationDetailInvite.md: -------------------------------------------------------------------------------- 1 | # NotificationDetailInvite 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **invite_message** | **str** | | [optional] 8 | **world_id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. | 9 | **world_name** | **str** | | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/NotificationDetailInviteResponse.md: -------------------------------------------------------------------------------- 1 | # NotificationDetailInviteResponse 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **in_response_to** | **str** | | 8 | **response_message** | **str** | | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/NotificationDetailRequestInvite.md: -------------------------------------------------------------------------------- 1 | # NotificationDetailRequestInvite 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **platform** | **str** | TODO: Does this still exist? | [optional] 8 | **request_message** | **str** | Used when using InviteMessage Slot. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/NotificationDetailRequestInviteResponse.md: -------------------------------------------------------------------------------- 1 | # NotificationDetailRequestInviteResponse 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **in_response_to** | **str** | | 8 | **request_message** | **str** | Used when using InviteMessage Slot. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/NotificationDetailVoteToKick.md: -------------------------------------------------------------------------------- 1 | # NotificationDetailVoteToKick 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **initiator_user_id** | **str** | 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. | 8 | **user_to_kick_id** | **str** | 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. | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/NotificationType.md: -------------------------------------------------------------------------------- 1 | # NotificationType 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/OrderOption.md: -------------------------------------------------------------------------------- 1 | # OrderOption 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PaginatedGroupAuditLogEntryList.md: -------------------------------------------------------------------------------- 1 | # PaginatedGroupAuditLogEntryList 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**list[GroupAuditLogEntry]**](GroupAuditLogEntry.md) | | [optional] 8 | **total_count** | **int** | The total number of results that the query would return if there were no pagination. | [optional] 9 | **has_next** | **bool** | Whether there are more results after this page. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/PastDisplayName.md: -------------------------------------------------------------------------------- 1 | # PastDisplayName 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **display_name** | **str** | | 8 | **updated_at** | **datetime** | | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Pending2FAResult.md: -------------------------------------------------------------------------------- 1 | # Pending2FAResult 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **qr_code_data_url** | **str** | | 8 | **secret** | **str** | | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PerformanceLimiterInfo.md: -------------------------------------------------------------------------------- 1 | # PerformanceLimiterInfo 2 | 3 | Info about the performance limits on a platform 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **max_seats** | **int** | Maximum amount of seats. -1 means no limit. | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PerformanceRatings.md: -------------------------------------------------------------------------------- 1 | # PerformanceRatings 2 | 3 | Avatar Performance ratings. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Permission.md: -------------------------------------------------------------------------------- 1 | # Permission 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **display_name** | **str** | | [optional] 9 | **description** | **str** | | [optional] 10 | **id** | **str** | | 11 | **owner_display_name** | **str** | | 12 | **name** | **str** | | 13 | **owner_id** | **str** | 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. | 14 | **type** | **str** | | [optional] 15 | **data** | **object** | | [optional] 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/PlatformBuildInfo.md: -------------------------------------------------------------------------------- 1 | # PlatformBuildInfo 2 | 3 | Build information for a platform 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **min_build_number** | **int** | Minimum build number required for the platform | 9 | **redirection_address** | **str** | Redirection URL for updating the app | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/PlayerModeration.md: -------------------------------------------------------------------------------- 1 | # PlayerModeration 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **created** | **datetime** | | 8 | **id** | **str** | | 9 | **source_display_name** | **str** | | 10 | **source_user_id** | **str** | 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. | 11 | **target_display_name** | **str** | | 12 | **target_user_id** | **str** | 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. | 13 | **type** | [**PlayerModerationType**](PlayerModerationType.md) | | 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/PlayerModerationType.md: -------------------------------------------------------------------------------- 1 | # PlayerModerationType 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PrintFiles.md: -------------------------------------------------------------------------------- 1 | # PrintFiles 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **file_id** | **str** | | [optional] 8 | **image** | **str** | Link to file, e.g. https://api.vrchat.cloud/api/1/file/file_66fe782d-f2bd-4462-9761-1d766d7b2b26/1/file | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Product.md: -------------------------------------------------------------------------------- 1 | # Product 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **archived** | **bool** | | 8 | **created** | **datetime** | | 9 | **description** | **str** | | 10 | **display_name** | **str** | | 11 | **group_access** | **bool** | | [optional] [default to False] 12 | **group_access_remove** | **bool** | | [optional] [default to False] 13 | **group_id** | **str** | | [optional] 14 | **group_role_id** | **str** | | [optional] 15 | **id** | **str** | | 16 | **image_id** | **str** | | 17 | **parent_listings** | **list[str]** | | 18 | **product_type** | [**ProductType**](ProductType.md) | | 19 | **seller_display_name** | **str** | | 20 | **seller_id** | **str** | | 21 | **tags** | **list[str]** | | 22 | **updated** | **datetime** | | 23 | **use_for_subscriber_list** | **bool** | | [optional] [default to False] 24 | 25 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/ProductListing.md: -------------------------------------------------------------------------------- 1 | # ProductListing 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **active** | **bool** | | 8 | **archived** | **bool** | | 9 | **buyer_refundable** | **bool** | | 10 | **created** | **datetime** | | 11 | **description** | **str** | | 12 | **display_name** | **str** | | 13 | **duration** | **int** | | [optional] 14 | **duration_type** | **str** | | [optional] 15 | **group_icon** | **str** | | 16 | **group_id** | **str** | | 17 | **group_name** | **str** | | 18 | **hydrated_products** | [**list[Product]**](Product.md) | | [optional] 19 | **id** | **str** | | 20 | **image_id** | **str** | | 21 | **instant** | **bool** | | 22 | **listing_type** | [**ProductListingType**](ProductListingType.md) | | 23 | **listing_variants** | [**list[ProductListingVariant]**](ProductListingVariant.md) | | 24 | **permanent** | **bool** | | 25 | **price_tokens** | **int** | | 26 | **product_ids** | **list[str]** | | 27 | **product_type** | [**ProductType**](ProductType.md) | | 28 | **products** | **list[object]** | | 29 | **quantifiable** | **bool** | | [optional] 30 | **recurrable** | **bool** | | 31 | **refundable** | **bool** | | 32 | **seller_display_name** | **str** | | 33 | **seller_id** | **str** | | 34 | **stackable** | **bool** | | 35 | **store_ids** | **list[str]** | | 36 | **tags** | **list[str]** | | 37 | **updated** | **datetime** | | 38 | 39 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 40 | 41 | 42 | -------------------------------------------------------------------------------- /docs/ProductListingType.md: -------------------------------------------------------------------------------- 1 | # ProductListingType 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ProductListingVariant.md: -------------------------------------------------------------------------------- 1 | # ProductListingVariant 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **effective_from** | **datetime** | | [optional] 8 | **listing_variant_id** | **str** | | 9 | **non_refundable** | **bool** | | 10 | **quantity** | **int** | | 11 | **seller_variant** | **bool** | | 12 | **unit_price_tokens** | **int** | | 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ProductType.md: -------------------------------------------------------------------------------- 1 | # ProductType 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Region.md: -------------------------------------------------------------------------------- 1 | # Region 2 | 3 | API/Photon region. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RegisterUserAccountRequest.md: -------------------------------------------------------------------------------- 1 | # RegisterUserAccountRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **username** | **str** | Display Name / Username (Username is a sanitized version) | 8 | **password** | **str** | Password | 9 | **email** | **str** | Email address | 10 | **year** | **str** | Birth year | 11 | **month** | **str** | Birth month of year | 12 | **day** | **str** | Birth day of month | 13 | **captcha_code** | **str** | Captcha code | 14 | **subscribe** | **bool** | Whether to recieve promotional emails | 15 | **accepted_tos_version** | **int** | The most recent version of the TOS | 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/ReleaseStatus.md: -------------------------------------------------------------------------------- 1 | # ReleaseStatus 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ReportCategory.md: -------------------------------------------------------------------------------- 1 | # ReportCategory 2 | 3 | A category used for reporting content 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **description** | **str** | The description of the report category | [optional] 9 | **title** | **str** | The title of the report category | [optional] 10 | **text** | **str** | The label of the report category | 11 | **tooltip** | **str** | The tooltip that describes the category | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/ReportReason.md: -------------------------------------------------------------------------------- 1 | # ReportReason 2 | 3 | A reason used for reporting users 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **text** | **str** | The label or name of the report reason | 9 | **tooltip** | **str** | A brief explanation of what this reason entails | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/RepresentedGroup.md: -------------------------------------------------------------------------------- 1 | # RepresentedGroup 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | | [optional] 8 | **short_code** | **str** | | [optional] 9 | **discriminator** | **str** | | [optional] 10 | **description** | **str** | | [optional] 11 | **icon_id** | **str** | | [optional] 12 | **icon_url** | **str** | | [optional] 13 | **banner_id** | **str** | | [optional] 14 | **banner_url** | **str** | | [optional] 15 | **privacy** | [**GroupPrivacy**](GroupPrivacy.md) | | [optional] 16 | **owner_id** | **str** | 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] 17 | **member_count** | **int** | | [optional] 18 | **group_id** | **str** | | [optional] 19 | **member_visibility** | [**GroupUserVisibility**](GroupUserVisibility.md) | | [optional] 20 | **is_representing** | **bool** | | [optional] 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/RequestInviteRequest.md: -------------------------------------------------------------------------------- 1 | # RequestInviteRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **message_slot** | **int** | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RespondGroupJoinRequest.md: -------------------------------------------------------------------------------- 1 | # RespondGroupJoinRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **action** | [**GroupJoinRequestAction**](GroupJoinRequestAction.md) | | 8 | **block** | **bool** | Whether to block the user from requesting again | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Response.md: -------------------------------------------------------------------------------- 1 | # Response 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **message** | **str** | | [optional] 8 | **status_code** | **int** | | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SentNotification.md: -------------------------------------------------------------------------------- 1 | # SentNotification 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **created_at** | **datetime** | | 9 | **details** | **object** | | 10 | **id** | **str** | | 11 | **message** | **str** | | 12 | **receiver_user_id** | **str** | 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. | 13 | **sender_user_id** | **str** | 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. | 14 | **sender_username** | **str** | -| **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] 15 | **type** | [**NotificationType**](NotificationType.md) | | 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/ServiceQueueStats.md: -------------------------------------------------------------------------------- 1 | # ServiceQueueStats 2 | 3 | Statistics about the user's currently queued service request 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **estimated_service_duration_seconds** | **int** | | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ServiceStatus.md: -------------------------------------------------------------------------------- 1 | # ServiceStatus 2 | 3 | Status information for a service request 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **created_at** | **datetime** | | 9 | **id** | **str** | The id of this service, NOT the id of the thing this service was requested for. | 10 | **progress** | **list[object]** | | 11 | **requester_user_id** | **str** | 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. | 12 | **state** | **str** | | 13 | **subject_id** | **str** | The id of the thing this service was requested for. | 14 | **subject_type** | **str** | The kind of the thing this service was requested for. | 15 | **type** | **str** | The kind of service that was requested. | 16 | **updated_at** | **datetime** | | 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/SortOption.md: -------------------------------------------------------------------------------- 1 | # SortOption 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Submission.md: -------------------------------------------------------------------------------- 1 | # Submission 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **content_id** | **str** | Either world ID or avatar ID | 9 | **created_at** | **datetime** | | 10 | **description** | **str** | | 11 | **id** | **str** | | 12 | **jam_id** | **str** | | 13 | **rating_score** | **int** | | [optional] 14 | **submitter_id** | **str** | 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. | 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/Subscription.md: -------------------------------------------------------------------------------- 1 | # Subscription 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | | 9 | **steam_item_id** | **str** | | 10 | **oculus_sku** | **str** | | [optional] 11 | **google_product_id** | **str** | | [optional] 12 | **google_plan_id** | **str** | | [optional] 13 | **pico_sku** | **str** | | [optional] 14 | **amount** | **float** | | 15 | **description** | **str** | | 16 | **period** | [**SubscriptionPeriod**](SubscriptionPeriod.md) | | 17 | **tier** | **int** | | 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/SubscriptionPeriod.md: -------------------------------------------------------------------------------- 1 | # SubscriptionPeriod 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Success.md: -------------------------------------------------------------------------------- 1 | # Success 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **success** | [**Response**](Response.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/TiliaStatus.md: -------------------------------------------------------------------------------- 1 | # TiliaStatus 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **economy_online** | **bool** | | 9 | **economy_state** | **int** | | [optional] 10 | **planned_offline_window_start** | **datetime** | | [optional] 11 | **planned_offline_window_end** | **datetime** | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/TiliaTOS.md: -------------------------------------------------------------------------------- 1 | # TiliaTOS 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **signed_tos** | **bool** | | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/TokenBundle.md: -------------------------------------------------------------------------------- 1 | # TokenBundle 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | | 8 | **steam_item_id** | **str** | | 9 | **oculus_sku** | **str** | | 10 | **amount** | **int** | price of the bundle | 11 | **description** | **str** | | 12 | **tokens** | **int** | number of tokens received | 13 | **image_url** | **str** | direct url to image | 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/Transaction.md: -------------------------------------------------------------------------------- 1 | # Transaction 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | | 9 | **user_id** | **str** | 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] 10 | **user_display_name** | **str** | | [optional] 11 | **status** | [**TransactionStatus**](TransactionStatus.md) | | 12 | **subscription** | [**Subscription**](Subscription.md) | | 13 | **sandbox** | **bool** | | [default to False] 14 | **created_at** | **datetime** | | 15 | **updated_at** | **datetime** | | 16 | **steam** | [**TransactionSteamInfo**](TransactionSteamInfo.md) | | [optional] 17 | **agreement** | [**TransactionAgreement**](TransactionAgreement.md) | | [optional] 18 | **error** | **str** | | 19 | **is_gift** | **bool** | | [optional] [default to False] 20 | **is_tokens** | **bool** | | [optional] [default to False] 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/TransactionAgreement.md: -------------------------------------------------------------------------------- 1 | # TransactionAgreement 2 | 3 | Represents a single Transaction, which is likely between VRChat and Steam. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **agreement_id** | **str** | | 9 | **item_id** | **int** | | 10 | **agreement** | **str** | | 11 | **status** | **str** | This is NOT TransactionStatus, but whatever Steam return. | 12 | **period** | **str** | | 13 | **frequency** | **int** | | 14 | **billing_type** | **str** | | 15 | **start_date** | **str** | | 16 | **end_date** | **str** | | 17 | **recurring_amt** | **float** | | 18 | **currency** | **str** | | 19 | **time_created** | **str** | | 20 | **next_payment** | **str** | | 21 | **last_payment** | **str** | | 22 | **last_amount** | **float** | | 23 | **last_amount_vat** | **float** | | 24 | **outstanding** | **int** | | 25 | **failed_attempts** | **int** | | 26 | 27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/TransactionStatus.md: -------------------------------------------------------------------------------- 1 | # TransactionStatus 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/TransactionSteamInfo.md: -------------------------------------------------------------------------------- 1 | # TransactionSteamInfo 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **wallet_info** | [**TransactionSteamWalletInfo**](TransactionSteamWalletInfo.md) | | 9 | **steam_id** | **str** | Steam User ID | 10 | **order_id** | **str** | Steam Order ID | 11 | **steam_url** | **str** | Empty | 12 | **trans_id** | **str** | Steam Transaction ID, NOT the same as VRChat TransactionID | 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/TransactionSteamWalletInfo.md: -------------------------------------------------------------------------------- 1 | # TransactionSteamWalletInfo 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **state** | **str** | | 9 | **country** | **str** | | [default to 'US'] 10 | **currency** | **str** | | [default to 'USD'] 11 | **status** | **str** | | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/TwoFactorAuthCode.md: -------------------------------------------------------------------------------- 1 | # TwoFactorAuthCode 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **code** | **str** | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/TwoFactorEmailCode.md: -------------------------------------------------------------------------------- 1 | # TwoFactorEmailCode 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **code** | **str** | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/TwoFactorRecoveryCodes.md: -------------------------------------------------------------------------------- 1 | # TwoFactorRecoveryCodes 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **requires_two_factor_auth** | **list[str]** | | [optional] 8 | **otp** | [**list[TwoFactorRecoveryCodesOtpInner]**](TwoFactorRecoveryCodesOtpInner.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/TwoFactorRecoveryCodesOtpInner.md: -------------------------------------------------------------------------------- 1 | # TwoFactorRecoveryCodesOtpInner 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **code** | **str** | | 8 | **used** | **bool** | | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UnityPackage.md: -------------------------------------------------------------------------------- 1 | # UnityPackage 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | | 9 | **asset_url** | **str** | | [optional] 10 | **asset_url_object** | **object** | | [optional] 11 | **asset_version** | **int** | | 12 | **created_at** | **datetime** | | [optional] 13 | **impostorizer_version** | **str** | | [optional] 14 | **performance_rating** | [**PerformanceRatings**](PerformanceRatings.md) | | [optional] 15 | **platform** | **str** | This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | 16 | **plugin_url** | **str** | | [optional] 17 | **plugin_url_object** | **object** | | [optional] 18 | **unity_sort_number** | **int** | | [optional] 19 | **unity_version** | **str** | | [default to '5.3.4p1'] 20 | **world_signature** | **str** | | [optional] 21 | **impostor_url** | **str** | | [optional] 22 | **scan_status** | **str** | | [optional] 23 | **variant** | **str** | | [optional] 24 | 25 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/UpdateAvatarRequest.md: -------------------------------------------------------------------------------- 1 | # UpdateAvatarRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **asset_url** | **str** | | [optional] 8 | **id** | **str** | | [optional] 9 | **name** | **str** | | [optional] 10 | **description** | **str** | | [optional] 11 | **tags** | **list[str]** | | [optional] 12 | **image_url** | **str** | | [optional] 13 | **release_status** | [**ReleaseStatus**](ReleaseStatus.md) | | [optional] 14 | **version** | **int** | | [optional] [default to 1] 15 | **unity_package_url** | **str** | | [optional] 16 | **unity_version** | **str** | | [optional] [default to '5.3.4p1'] 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/UpdateFavoriteGroupRequest.md: -------------------------------------------------------------------------------- 1 | # UpdateFavoriteGroupRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **display_name** | **str** | | [optional] 8 | **visibility** | [**FavoriteGroupVisibility**](FavoriteGroupVisibility.md) | | [optional] 9 | **tags** | **list[str]** | Tags on FavoriteGroups are believed to do nothing. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/UpdateGroupGalleryRequest.md: -------------------------------------------------------------------------------- 1 | # UpdateGroupGalleryRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | Name of the gallery. | [optional] 8 | **description** | **str** | Description of the gallery. | [optional] 9 | **members_only** | **bool** | Whether the gallery is members only. | [optional] [default to False] 10 | **role_ids_to_view** | **list[str]** | | [optional] 11 | **role_ids_to_submit** | **list[str]** | | [optional] 12 | **role_ids_to_auto_approve** | **list[str]** | | [optional] 13 | **role_ids_to_manage** | **list[str]** | | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/UpdateGroupMemberRequest.md: -------------------------------------------------------------------------------- 1 | # UpdateGroupMemberRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **visibility** | [**GroupUserVisibility**](GroupUserVisibility.md) | | [optional] 8 | **is_subscribed_to_announcements** | **bool** | | [optional] 9 | **manager_notes** | **str** | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/UpdateGroupRepresentationRequest.md: -------------------------------------------------------------------------------- 1 | # UpdateGroupRepresentationRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **is_representing** | **bool** | Whether the user is representing the group. | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UpdateGroupRequest.md: -------------------------------------------------------------------------------- 1 | # UpdateGroupRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | | [optional] 8 | **short_code** | **str** | | [optional] 9 | **description** | **str** | | [optional] 10 | **join_state** | [**GroupJoinState**](GroupJoinState.md) | | [optional] 11 | **icon_id** | **str** | | [optional] 12 | **banner_id** | **str** | | [optional] 13 | **languages** | **list[str]** | 3 letter language code | [optional] 14 | **links** | **list[str]** | | [optional] 15 | **rules** | **str** | | [optional] 16 | **tags** | **list[str]** | | [optional] 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/UpdateGroupRoleRequest.md: -------------------------------------------------------------------------------- 1 | # UpdateGroupRoleRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | | [optional] 8 | **description** | **str** | | [optional] 9 | **is_self_assignable** | **bool** | | [optional] [default to False] 10 | **permissions** | [**list[GroupPermissions]**](GroupPermissions.md) | | [optional] 11 | **order** | **int** | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UpdateInviteMessageRequest.md: -------------------------------------------------------------------------------- 1 | # UpdateInviteMessageRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **message** | **str** | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UpdateUserBadgeRequest.md: -------------------------------------------------------------------------------- 1 | # UpdateUserBadgeRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **hidden** | **bool** | | [optional] 8 | **showcased** | **bool** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UpdateUserNoteRequest.md: -------------------------------------------------------------------------------- 1 | # UpdateUserNoteRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **target_user_id** | **str** | 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. | 8 | **note** | **str** | | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UpdateUserRequest.md: -------------------------------------------------------------------------------- 1 | # UpdateUserRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **str** | | [optional] 8 | **unsubscribe** | **bool** | | [optional] 9 | **birthday** | **date** | | [optional] 10 | **accepted_tos_version** | **int** | | [optional] 11 | **tags** | **list[str]** | | [optional] 12 | **status** | [**UserStatus**](UserStatus.md) | | [optional] 13 | **status_description** | **str** | | [optional] 14 | **bio** | **str** | | [optional] 15 | **bio_links** | **list[str]** | | [optional] 16 | **pronouns** | **str** | | [optional] 17 | **is_booping_enabled** | **bool** | | [optional] 18 | **user_icon** | **str** | MUST be a valid VRChat /file/ url. | [optional] 19 | **content_filters** | **list[str]** | These tags begin with `content_` and control content gating | [optional] 20 | **display_name** | **str** | MUST specify currentPassword as well to change display name | [optional] 21 | **revert_display_name** | **bool** | MUST specify currentPassword as well to revert display name | [optional] 22 | **password** | **str** | MUST specify currentPassword as well to change password | [optional] 23 | **current_password** | **str** | | [optional] 24 | 25 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/UpdateWorldRequest.md: -------------------------------------------------------------------------------- 1 | # UpdateWorldRequest 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **asset_url** | **str** | | [optional] 8 | **asset_version** | **str** | | [optional] 9 | **author_id** | **str** | 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] 10 | **author_name** | **str** | | [optional] 11 | **capacity** | **int** | | [optional] 12 | **description** | **str** | | [optional] 13 | **image_url** | **str** | | [optional] 14 | **name** | **str** | | [optional] 15 | **platform** | **str** | This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [optional] 16 | **release_status** | [**ReleaseStatus**](ReleaseStatus.md) | | [optional] 17 | **tags** | **list[str]** | | [optional] 18 | **unity_package_url** | **str** | | [optional] 19 | **unity_version** | **str** | | [optional] [default to '5.3.4p1'] 20 | 21 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/User.md: -------------------------------------------------------------------------------- 1 | # User 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **age_verification_status** | [**AgeVerificationStatus**](AgeVerificationStatus.md) | | 8 | **age_verified** | **bool** | `true` if, user is age verified (not 18+). | 9 | **allow_avatar_copying** | **bool** | | [default to True] 10 | **badges** | [**list[Badge]**](Badge.md) | | [optional] 11 | **bio** | **str** | | 12 | **bio_links** | **list[str]** | | 13 | **current_avatar_image_url** | **str** | When profilePicOverride is not empty, use it instead. | 14 | **current_avatar_thumbnail_image_url** | **str** | When profilePicOverride is not empty, use it instead. | 15 | **current_avatar_tags** | **list[str]** | | 16 | **date_joined** | **date** | | 17 | **developer_type** | [**DeveloperType**](DeveloperType.md) | | 18 | **display_name** | **str** | 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. | 19 | **friend_key** | **str** | | 20 | **friend_request_status** | **str** | | [optional] 21 | **id** | **str** | 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. | 22 | **instance_id** | **str** | 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] 23 | **is_friend** | **bool** | Either their `friendKey`, or empty string if you are not friends. Unknown usage. | 24 | **last_activity** | **str** | Either a date-time or empty string. | 25 | **last_login** | **str** | Either a date-time or empty string. | 26 | **last_mobile** | **str** | | [optional] 27 | **last_platform** | **str** | This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | 28 | **location** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [optional] 29 | **note** | **str** | | [optional] 30 | **platform** | **str** | | [optional] 31 | **profile_pic_override** | **str** | | 32 | **profile_pic_override_thumbnail** | **str** | | 33 | **pronouns** | **str** | | 34 | **state** | [**UserState**](UserState.md) | | 35 | **status** | [**UserStatus**](UserStatus.md) | | 36 | **status_description** | **str** | | 37 | **tags** | **list[str]** | | 38 | **traveling_to_instance** | **str** | | [optional] 39 | **traveling_to_location** | **str** | | [optional] 40 | **traveling_to_world** | **str** | | [optional] 41 | **user_icon** | **str** | | 42 | **username** | **str** | -| 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] 43 | **world_id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [optional] 44 | 45 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 46 | 47 | 48 | -------------------------------------------------------------------------------- /docs/UserExists.md: -------------------------------------------------------------------------------- 1 | # UserExists 2 | 3 | Status object representing if a queried user by username or userId exists or not. This model is primarily used by the `/auth/exists` endpoint, which in turn is used during registration. Please see the documentation on that endpoint for more information on usage. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **user_exists** | **bool** | Status if a user exist with that username or userId. | [default to False] 9 | **name_ok** | **bool** | Is the username valid? | [optional] [default to False] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/UserNote.md: -------------------------------------------------------------------------------- 1 | # UserNote 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **created_at** | **datetime** | | 8 | **id** | **str** | | 9 | **note** | **str** | | 10 | **target_user** | [**UserNoteTargetUser**](UserNoteTargetUser.md) | | [optional] 11 | **target_user_id** | **str** | 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. | 12 | **user_id** | **str** | 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. | 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/UserNoteTargetUser.md: -------------------------------------------------------------------------------- 1 | # UserNoteTargetUser 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **current_avatar_tags** | **list[str]** | | [optional] 8 | **current_avatar_thumbnail_image_url** | **str** | When profilePicOverride is not empty, use it instead. | [optional] 9 | **display_name** | **str** | | [optional] 10 | **id** | **str** | | [optional] 11 | **profile_pic_override** | **str** | | [optional] 12 | **user_icon** | **str** | | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/UserState.md: -------------------------------------------------------------------------------- 1 | # UserState 2 | 3 | * \"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). 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UserStatus.md: -------------------------------------------------------------------------------- 1 | # UserStatus 2 | 3 | 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. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UserSubscription.md: -------------------------------------------------------------------------------- 1 | # UserSubscription 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | | 9 | **transaction_id** | **str** | | 10 | **store** | **str** | Which \"Store\" it came from. Right now only Stores are \"Steam\" and \"Admin\". | 11 | **steam_item_id** | **str** | | [optional] 12 | **amount** | **float** | | 13 | **description** | **str** | | 14 | **period** | [**SubscriptionPeriod**](SubscriptionPeriod.md) | | 15 | **tier** | **int** | | 16 | **active** | **bool** | | [default to True] 17 | **status** | [**TransactionStatus**](TransactionStatus.md) | | 18 | **starts** | **str** | | [optional] 19 | **expires** | **datetime** | | 20 | **created_at** | **datetime** | | 21 | **updated_at** | **datetime** | | 22 | **license_groups** | **list[str]** | | 23 | **is_gift** | **bool** | | [default to False] 24 | **is_bulk_gift** | **bool** | | [default to False] 25 | 26 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/Verify2FAEmailCodeResult.md: -------------------------------------------------------------------------------- 1 | # Verify2FAEmailCodeResult 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **verified** | **bool** | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Verify2FAResult.md: -------------------------------------------------------------------------------- 1 | # Verify2FAResult 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **verified** | **bool** | | 8 | **enabled** | **bool** | | [optional] [default to True] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/VerifyAuthTokenResult.md: -------------------------------------------------------------------------------- 1 | # VerifyAuthTokenResult 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ok** | **bool** | | 8 | **token** | **str** | | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/World.md: -------------------------------------------------------------------------------- 1 | # World 2 | 3 | 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **author_id** | **str** | 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. | 9 | **author_name** | **str** | | 10 | **capacity** | **int** | | 11 | **recommended_capacity** | **int** | | 12 | **created_at** | **datetime** | | 13 | **default_content_settings** | [**InstanceContentSettings**](InstanceContentSettings.md) | | [optional] 14 | **description** | **str** | | 15 | **favorites** | **int** | | [optional] [default to 0] 16 | **featured** | **bool** | | [default to False] 17 | **heat** | **int** | | [default to 0] 18 | **id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. | 19 | **image_url** | **str** | | 20 | **instances** | **list[list[object]]** | Will always be an empty list when unauthenticated. | [optional] 21 | **labs_publication_date** | **str** | | 22 | **name** | **str** | | 23 | **namespace** | **str** | | [optional] 24 | **occupants** | **int** | Will always be `0` when unauthenticated. | [optional] [default to 0] 25 | **organization** | **str** | | [default to 'vrchat'] 26 | **popularity** | **int** | | [default to 0] 27 | **preview_youtube_id** | **str** | | [optional] 28 | **private_occupants** | **int** | Will always be `0` when unauthenticated. | [optional] [default to 0] 29 | **public_occupants** | **int** | Will always be `0` when unauthenticated. | [optional] [default to 0] 30 | **publication_date** | **str** | | 31 | **release_status** | [**ReleaseStatus**](ReleaseStatus.md) | | 32 | **store_id** | **str** | | [optional] 33 | **tags** | **list[str]** | | 34 | **thumbnail_image_url** | **str** | | 35 | **unity_packages** | [**list[UnityPackage]**](UnityPackage.md) | Empty if unauthenticated. | [optional] 36 | **updated_at** | **datetime** | | 37 | **url_list** | **list[str]** | | [optional] 38 | **version** | **int** | | [default to 0] 39 | **visits** | **int** | | [default to 0] 40 | **udon_products** | **list[str]** | | [optional] 41 | 42 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 43 | 44 | 45 | -------------------------------------------------------------------------------- /docs/WorldMetadata.md: -------------------------------------------------------------------------------- 1 | # WorldMetadata 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. | 8 | **metadata** | **object** | | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/WorldPublishStatus.md: -------------------------------------------------------------------------------- 1 | # WorldPublishStatus 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **can_publish** | **bool** | | [default to True] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /examples/examples-source/cookies_load.py: -------------------------------------------------------------------------------- 1 | import vrchatapi 2 | from http.cookiejar import Cookie 3 | 4 | from vrchatapi.api import authentication_api 5 | 6 | 7 | def make_cookie(name, value): 8 | return Cookie(0, name, value, 9 | None, False, 10 | "api.vrchat.cloud", True, False, 11 | "/", False, 12 | False, 13 | 173106866300, 14 | False, 15 | None, 16 | None, {}) 17 | 18 | 19 | configuration = vrchatapi.Configuration( 20 | username='username', 21 | password='password', 22 | ) 23 | 24 | with vrchatapi.ApiClient(configuration) as api_client: 25 | api_client.user_agent = "ExampleProgram/0.0.1 my@email.com" 26 | api_client.rest_client.cookie_jar.set_cookie( 27 | make_cookie("auth", "[AUTH_COOKIE_HERE]")) 28 | api_client.rest_client.cookie_jar.set_cookie( 29 | make_cookie("twoFactorAuth", "[TWO_FACTOR_AUTH_COOKIE_HERE]")) 30 | 31 | auth_api = authentication_api.AuthenticationApi(api_client) 32 | current_user = auth_api.get_current_user() 33 | print("Logged in as:", current_user.display_name) 34 | -------------------------------------------------------------------------------- /examples/examples-source/cookies_store.py: -------------------------------------------------------------------------------- 1 | import vrchatapi 2 | from vrchatapi.api import authentication_api 3 | from vrchatapi.exceptions import UnauthorizedException 4 | from vrchatapi.models.two_factor_auth_code import TwoFactorAuthCode 5 | from vrchatapi.models.two_factor_email_code import TwoFactorEmailCode 6 | 7 | configuration = vrchatapi.Configuration( 8 | username='username', 9 | password='password', 10 | ) 11 | 12 | with vrchatapi.ApiClient(configuration) as api_client: 13 | api_client.user_agent = "ExampleProgram/0.0.1 my@email.com" 14 | auth_api = authentication_api.AuthenticationApi(api_client) 15 | 16 | try: 17 | current_user = auth_api.get_current_user() 18 | except UnauthorizedException as e: 19 | if e.status == 200: 20 | if "Email 2 Factor Authentication" in e.reason: 21 | auth_api.verify2_fa_email_code(two_factor_email_code=TwoFactorEmailCode(input("Email 2FA Code: "))) 22 | elif "2 Factor Authentication" in e.reason: 23 | auth_api.verify2_fa(two_factor_auth_code=TwoFactorAuthCode(input("2FA Code: "))) 24 | current_user = auth_api.get_current_user() 25 | else: 26 | print("Exception when calling API: %s\n", e) 27 | except vrchatapi.ApiException as e: 28 | print("Exception when calling API: %s\n", e) 29 | 30 | cookie_jar = api_client.rest_client.cookie_jar._cookies["api.vrchat.cloud"]["/"] 31 | print("Logged in as:", current_user.display_name) 32 | print("auth: " + cookie_jar["auth"].value) 33 | print("twoFactorAuth: " + cookie_jar["twoFactorAuth"].value) 34 | -------------------------------------------------------------------------------- /examples/examples-source/login.py: -------------------------------------------------------------------------------- 1 | # Step 1. We begin with creating a Configuration, which contains the username and password for authentication. 2 | import vrchatapi 3 | from vrchatapi.api import authentication_api 4 | from vrchatapi.exceptions import UnauthorizedException 5 | from vrchatapi.models.two_factor_auth_code import TwoFactorAuthCode 6 | from vrchatapi.models.two_factor_email_code import TwoFactorEmailCode 7 | 8 | configuration = vrchatapi.Configuration( 9 | username='username', 10 | password='password', 11 | ) 12 | 13 | # Step 2. VRChat consists of several API's (WorldsApi, UsersApi, FilesApi, NotificationsApi, FriendsApi, etc...) 14 | # Here we enter a context of the API Client and instantiate the Authentication API which is required for logging in. 15 | 16 | # Enter a context with an instance of the API client 17 | with vrchatapi.ApiClient(configuration) as api_client: 18 | # Set our User-Agent as per VRChat Usage Policy 19 | api_client.user_agent = "ExampleProgram/0.0.1 my@email.com" 20 | 21 | # Instantiate instances of API classes 22 | auth_api = authentication_api.AuthenticationApi(api_client) 23 | 24 | try: 25 | # Step 3. Calling getCurrentUser on Authentication API logs you in if the user isn't already logged in. 26 | current_user = auth_api.get_current_user() 27 | except UnauthorizedException as e: 28 | if e.status == 200: 29 | if "Email 2 Factor Authentication" in e.reason: 30 | # Step 3.5. Calling email verify2fa if the account has 2FA disabled 31 | auth_api.verify2_fa_email_code(two_factor_email_code=TwoFactorEmailCode(input("Email 2FA Code: "))) 32 | elif "2 Factor Authentication" in e.reason: 33 | # Step 3.5. Calling verify2fa if the account has 2FA enabled 34 | auth_api.verify2_fa(two_factor_auth_code=TwoFactorAuthCode(input("2FA Code: "))) 35 | current_user = auth_api.get_current_user() 36 | else: 37 | print("Exception when calling API: %s\n", e) 38 | except vrchatapi.ApiException as e: 39 | print("Exception when calling API: %s\n", e) 40 | 41 | print("Logged in as:", current_user.display_name) 42 | -------------------------------------------------------------------------------- /examples/examples-source/noauth.py: -------------------------------------------------------------------------------- 1 | import vrchatapi 2 | 3 | # We import the class that corrisponds to the section of the API we want to use 4 | from vrchatapi.api.worlds_api import WorldsApi 5 | 6 | # We don't add a configuration file/set a username and password 7 | with vrchatapi.ApiClient() as api_client: 8 | api_client.user_agent = "ExampleProgram/0.0.1 my@email.com" 9 | 10 | # We don't use the authentication API at all, since we don't need to 11 | world_api = WorldsApi(api_client) 12 | world = world_api.get_world("wrld_000000000-0000-0000-0000-000000000000") 13 | 14 | print(f"World `{world.name}` was made by `{world.author_name}` ({world.author_id})") -------------------------------------------------------------------------------- /generate.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | npm install @openapitools/openapi-generator-cli 4 | 5 | rm vrchatapi docs -rf 6 | 7 | ./node_modules/\@openapitools/openapi-generator-cli/main.js generate \ 8 | -g python-legacy \ 9 | --additional-properties=packageName=vrchatapi,projectName=vrchatapi \ 10 | --git-user-id=vrchatapi \ 11 | --git-repo-id=vrchatapi-python \ 12 | -o . \ 13 | -i https://raw.githubusercontent.com/vrchatapi/specification/gh-pages/openapi.yaml \ 14 | --http-user-agent="vrchatapi-py" 15 | 16 | # Fix description, keywords, etc... 17 | # Echo to trim whitespace 18 | VERSION=`echo $(cat setup.py | grep "The version of the OpenAPI document" | cut -d ":" -f 2)` 19 | sed -i "s/VERSION = \"1.0.0\"/VERSION = \"$VERSION\"/" ./setup.py 20 | sed -i 's/description="VRChat API Documentation"/description="VRChat API Library for Python"/' ./setup.py 21 | sed -i 's/keywords=\["OpenAPI", "OpenAPI-Generator", "VRChat API Documentation"\]/keywords=["vrchat", "vrchatapi", "vrc"]/' ./setup.py 22 | 23 | # Fix long_description error during pypi upload 24 | sed -i 's/.*VRChat API Banner.*/abcdefvrc/g' ./setup.py 25 | sed -i '/abcdefvrc/r README.md' ./setup.py 26 | sed -i 's/abcdefvrc//g' ./setup.py 27 | 28 | # Remove messily pasted markdown at top of every file 29 | find vrchatapi -type f -exec sed -i '/VRChat API Banner/d' {} \; 30 | 31 | # Enable Global cookies 32 | patch ./vrchatapi/rest.py < ./patches/cookiejar.patch 33 | 34 | # Make 2fa required error readable 35 | patch ./vrchatapi/rest.py < ./patches/error_2fa_verify_readable.patch 36 | 37 | # Add common symbols to safe path parameter symbols 38 | patch ./vrchatapi/configuration.py < ./patches/safe_param_symbols.patch 39 | 40 | # Boolean to lower str conversion for query parameters 41 | patch ./vrchatapi/api_client.py < ./patches/query_param_bool.patch -------------------------------------------------------------------------------- /git_push.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ 3 | # 4 | # Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" 5 | 6 | git_user_id=$1 7 | git_repo_id=$2 8 | release_note=$3 9 | git_host=$4 10 | 11 | if [ "$git_host" = "" ]; then 12 | git_host="github.com" 13 | echo "[INFO] No command line input provided. Set \$git_host to $git_host" 14 | fi 15 | 16 | if [ "$git_user_id" = "" ]; then 17 | git_user_id="vrchatapi" 18 | echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" 19 | fi 20 | 21 | if [ "$git_repo_id" = "" ]; then 22 | git_repo_id="vrchatapi-python" 23 | echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" 24 | fi 25 | 26 | if [ "$release_note" = "" ]; then 27 | release_note="Minor update" 28 | echo "[INFO] No command line input provided. Set \$release_note to $release_note" 29 | fi 30 | 31 | # Initialize the local directory as a Git repository 32 | git init 33 | 34 | # Adds the files in the local repository and stages them for commit. 35 | git add . 36 | 37 | # Commits the tracked changes and prepares them to be pushed to a remote repository. 38 | git commit -m "$release_note" 39 | 40 | # Sets the new remote 41 | git_remote=$(git remote) 42 | if [ "$git_remote" = "" ]; then # git remote not defined 43 | 44 | if [ "$GIT_TOKEN" = "" ]; then 45 | echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." 46 | git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git 47 | else 48 | git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git 49 | fi 50 | 51 | fi 52 | 53 | git pull origin master 54 | 55 | # Pushes (Forces) the changes in the local repository up to the remote repository 56 | echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" 57 | git push origin master 2>&1 | grep -v 'To https' 58 | -------------------------------------------------------------------------------- /openapitools.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json", 3 | "spaces": 2, 4 | "generator-cli": { 5 | "version": "6.2.1" 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "dependencies": { 3 | "@openapitools/openapi-generator-cli": "^2.20.2" 4 | } 5 | } 6 | -------------------------------------------------------------------------------- /patches/cookiejar.patch: -------------------------------------------------------------------------------- 1 | diff --git a/rest.py b/restpatch.py 2 | index b8da0751..3702266e 100644 3 | --- a/rest.py 4 | +++ b/restpatch.py 5 | @@ -61,6 +61,10 @@ class RESTClientObject(object): 6 | else: 7 | cert_reqs = ssl.CERT_NONE 8 | 9 | + # VRChatAPI: Init global cookie storage 10 | + from http.cookiejar import CookieJar 11 | + self.cookie_jar = CookieJar() 12 | + 13 | addition_pool_args = {} 14 | if configuration.assert_hostname is not None: 15 | addition_pool_args['assert_hostname'] = configuration.assert_hostname # noqa: E501 16 | @@ -134,6 +138,13 @@ class RESTClientObject(object): 17 | post_params = post_params or {} 18 | headers = headers or {} 19 | 20 | + # VRChatAPI: Build a mock Request object to work with 21 | + from urllib.request import Request 22 | + mock_request_object = Request(url=url, method=method, headers=headers) 23 | + self.cookie_jar.add_cookie_header(mock_request_object) 24 | + if "Cookie" in mock_request_object.unredirected_hdrs: 25 | + headers["Cookie"] = mock_request_object.unredirected_hdrs["Cookie"] 26 | + 27 | timeout = None 28 | if _request_timeout: 29 | if isinstance(_request_timeout, six.integer_types + (float, )): # noqa: E501,F821 30 | @@ -209,6 +220,10 @@ class RESTClientObject(object): 31 | msg = "{0}\n{1}".format(type(e).__name__, str(e)) 32 | raise ApiException(status=0, reason=msg) 33 | 34 | + 35 | + # VRChatAPI: Extract and save cookies for global storage 36 | + self.cookie_jar.extract_cookies(r, mock_request_object) 37 | + 38 | if _preload_content: 39 | r = RESTResponse(r) 40 | 41 | -------------------------------------------------------------------------------- /patches/error_2fa_verify_readable.patch: -------------------------------------------------------------------------------- 1 | diff --git a/./rest.py b/./restpatch.py 2 | index 3702266e..c19c578c 100644 3 | --- a/./rest.py 4 | +++ b/./restpatch.py 5 | @@ -245,6 +245,13 @@ class RESTClientObject(object): 6 | 7 | raise ApiException(http_resp=r) 8 | 9 | + if re.match(b'{"\w{21}":\["totp","otp"]}', r.data) is not None: 10 | + r.reason = "2 Factor Authentication verification is required" 11 | + raise UnauthorizedException(http_resp=r) 12 | + elif re.match(b'{"\w{21}":\["emailOtp"]}', r.data) is not None: 13 | + r.reason = "Email 2 Factor Authentication verification is required" 14 | + raise UnauthorizedException(http_resp=r) 15 | + 16 | return r 17 | 18 | def GET(self, url, headers=None, query_params=None, _preload_content=True, 19 | -------------------------------------------------------------------------------- /patches/query_param_bool.patch: -------------------------------------------------------------------------------- 1 | diff --git a/api_client.py b/api_clientpatch.py 2 | index 68529871..f0d06f96 100644 3 | --- a/api_client.py 4 | +++ b/api_clientpatch.py 5 | @@ -151,6 +151,12 @@ class ApiClient(object): 6 | 7 | # query parameters 8 | if query_params: 9 | + ## PATCH -- convert boolean value into lower str for query param 10 | + for param in query_params: 11 | + if type(param[1]) == bool: 12 | + query_params[query_params.index(param)] = \ 13 | + (param[0], "true" if param[1] else "false") 14 | + 15 | query_params = self.sanitize_for_serialization(query_params) 16 | query_params = self.parameters_to_tuples(query_params, 17 | collection_formats) 18 | -------------------------------------------------------------------------------- /patches/safe_param_symbols.patch: -------------------------------------------------------------------------------- 1 | diff --git a/vrchatapi/configuration.py b/vrchatapi/configuration.py 2 | index 4d594f94..70354d29 100644 3 | --- a/vrchatapi/configuration.py 4 | +++ b/vrchatapi/configuration.py 5 | @@ -221,7 +221,7 @@ conf = vrchatapi.Configuration( 6 | self.proxy_headers = None 7 | """Proxy headers 8 | """ 9 | - self.safe_chars_for_path_param = '' 10 | + self.safe_chars_for_path_param = '~()' 11 | """Safe chars for path_param 12 | """ 13 | self.retries = None 14 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = [ 3 | "setuptools>=42", 4 | "wheel" 5 | ] 6 | build-backend = "setuptools.build_meta" -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | future; python_version<="2.7" 2 | six >= 1.10 3 | python_dateutil >= 2.5.3 4 | setuptools >= 21.0.0 5 | urllib3 >= 1.25.3 6 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [flake8] 2 | max-line-length=99 3 | -------------------------------------------------------------------------------- /test-requirements.txt: -------------------------------------------------------------------------------- 1 | pytest~=4.6.7 # needed for python 2.7+3.4 2 | pytest-cov>=2.8.1 3 | pytest-randomly==1.2.3 # needed for python 2.7+3.4 4 | mock; python_version<'3.0' 5 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = py27, py3 3 | 4 | [testenv] 5 | deps=-r{toxinidir}/requirements.txt 6 | -r{toxinidir}/test-requirements.txt 7 | 8 | commands= 9 | pytest --cov=vrchatapi 10 | -------------------------------------------------------------------------------- /vrchatapi/api/__init__.py: -------------------------------------------------------------------------------- 1 | from __future__ import absolute_import 2 | 3 | # flake8: noqa 4 | 5 | # import apis into api package 6 | from vrchatapi.api.authentication_api import AuthenticationApi 7 | from vrchatapi.api.avatars_api import AvatarsApi 8 | from vrchatapi.api.economy_api import EconomyApi 9 | from vrchatapi.api.favorites_api import FavoritesApi 10 | from vrchatapi.api.files_api import FilesApi 11 | from vrchatapi.api.friends_api import FriendsApi 12 | from vrchatapi.api.groups_api import GroupsApi 13 | from vrchatapi.api.instances_api import InstancesApi 14 | from vrchatapi.api.invite_api import InviteApi 15 | from vrchatapi.api.jams_api import JamsApi 16 | from vrchatapi.api.miscellaneous_api import MiscellaneousApi 17 | from vrchatapi.api.notifications_api import NotificationsApi 18 | from vrchatapi.api.playermoderation_api import PlayermoderationApi 19 | from vrchatapi.api.prints_api import PrintsApi 20 | from vrchatapi.api.users_api import UsersApi 21 | from vrchatapi.api.worlds_api import WorldsApi 22 | -------------------------------------------------------------------------------- /vrchatapi/models/group_privacy.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | VRChat API Documentation 5 | 6 | 7 | The version of the OpenAPI document: 1.19.4 8 | Contact: vrchatapi.lpv0t@aries.fyi 9 | Generated by: https://openapi-generator.tech 10 | """ 11 | 12 | 13 | try: 14 | from inspect import getfullargspec 15 | except ImportError: 16 | from inspect import getargspec as getfullargspec 17 | import pprint 18 | import re # noqa: F401 19 | import six 20 | 21 | from vrchatapi.configuration import Configuration 22 | 23 | 24 | class GroupPrivacy(object): 25 | """NOTE: This class is auto generated by OpenAPI Generator. 26 | Ref: https://openapi-generator.tech 27 | 28 | Do not edit the class manually. 29 | """ 30 | 31 | """ 32 | allowed enum values 33 | """ 34 | DEFAULT = "default" 35 | PRIVATE = "private" 36 | 37 | allowable_values = [DEFAULT, PRIVATE] # noqa: E501 38 | 39 | """ 40 | Attributes: 41 | openapi_types (dict): The key is attribute name 42 | and the value is attribute type. 43 | attribute_map (dict): The key is attribute name 44 | and the value is json key in definition. 45 | """ 46 | openapi_types = { 47 | } 48 | 49 | attribute_map = { 50 | } 51 | 52 | def __init__(self, local_vars_configuration=None): # noqa: E501 53 | """GroupPrivacy - a model defined in OpenAPI""" # noqa: E501 54 | if local_vars_configuration is None: 55 | local_vars_configuration = Configuration.get_default_copy() 56 | self.local_vars_configuration = local_vars_configuration 57 | self.discriminator = None 58 | 59 | def to_dict(self, serialize=False): 60 | """Returns the model properties as a dict""" 61 | result = {} 62 | 63 | def convert(x): 64 | if hasattr(x, "to_dict"): 65 | args = getfullargspec(x.to_dict).args 66 | if len(args) == 1: 67 | return x.to_dict() 68 | else: 69 | return x.to_dict(serialize) 70 | else: 71 | return x 72 | 73 | for attr, _ in six.iteritems(self.openapi_types): 74 | value = getattr(self, attr) 75 | attr = self.attribute_map.get(attr, attr) if serialize else attr 76 | if isinstance(value, list): 77 | result[attr] = list(map( 78 | lambda x: convert(x), 79 | value 80 | )) 81 | elif isinstance(value, dict): 82 | result[attr] = dict(map( 83 | lambda item: (item[0], convert(item[1])), 84 | value.items() 85 | )) 86 | else: 87 | result[attr] = convert(value) 88 | 89 | return result 90 | 91 | def to_str(self): 92 | """Returns the string representation of the model""" 93 | return pprint.pformat(self.to_dict()) 94 | 95 | def __repr__(self): 96 | """For `print` and `pprint`""" 97 | return self.to_str() 98 | 99 | def __eq__(self, other): 100 | """Returns true if both objects are equal""" 101 | if not isinstance(other, GroupPrivacy): 102 | return False 103 | 104 | return self.to_dict() == other.to_dict() 105 | 106 | def __ne__(self, other): 107 | """Returns true if both objects are not equal""" 108 | if not isinstance(other, GroupPrivacy): 109 | return True 110 | 111 | return self.to_dict() != other.to_dict() 112 | -------------------------------------------------------------------------------- /vrchatapi/models/group_search_sort.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | VRChat API Documentation 5 | 6 | 7 | The version of the OpenAPI document: 1.19.4 8 | Contact: vrchatapi.lpv0t@aries.fyi 9 | Generated by: https://openapi-generator.tech 10 | """ 11 | 12 | 13 | try: 14 | from inspect import getfullargspec 15 | except ImportError: 16 | from inspect import getargspec as getfullargspec 17 | import pprint 18 | import re # noqa: F401 19 | import six 20 | 21 | from vrchatapi.configuration import Configuration 22 | 23 | 24 | class GroupSearchSort(object): 25 | """NOTE: This class is auto generated by OpenAPI Generator. 26 | Ref: https://openapi-generator.tech 27 | 28 | Do not edit the class manually. 29 | """ 30 | 31 | """ 32 | allowed enum values 33 | """ 34 | ASC = "joinedAt:asc" 35 | DESC = "joinedAt:desc" 36 | 37 | allowable_values = [ASC, DESC] # noqa: E501 38 | 39 | """ 40 | Attributes: 41 | openapi_types (dict): The key is attribute name 42 | and the value is attribute type. 43 | attribute_map (dict): The key is attribute name 44 | and the value is json key in definition. 45 | """ 46 | openapi_types = { 47 | } 48 | 49 | attribute_map = { 50 | } 51 | 52 | def __init__(self, local_vars_configuration=None): # noqa: E501 53 | """GroupSearchSort - a model defined in OpenAPI""" # noqa: E501 54 | if local_vars_configuration is None: 55 | local_vars_configuration = Configuration.get_default_copy() 56 | self.local_vars_configuration = local_vars_configuration 57 | self.discriminator = None 58 | 59 | def to_dict(self, serialize=False): 60 | """Returns the model properties as a dict""" 61 | result = {} 62 | 63 | def convert(x): 64 | if hasattr(x, "to_dict"): 65 | args = getfullargspec(x.to_dict).args 66 | if len(args) == 1: 67 | return x.to_dict() 68 | else: 69 | return x.to_dict(serialize) 70 | else: 71 | return x 72 | 73 | for attr, _ in six.iteritems(self.openapi_types): 74 | value = getattr(self, attr) 75 | attr = self.attribute_map.get(attr, attr) if serialize else attr 76 | if isinstance(value, list): 77 | result[attr] = list(map( 78 | lambda x: convert(x), 79 | value 80 | )) 81 | elif isinstance(value, dict): 82 | result[attr] = dict(map( 83 | lambda item: (item[0], convert(item[1])), 84 | value.items() 85 | )) 86 | else: 87 | result[attr] = convert(value) 88 | 89 | return result 90 | 91 | def to_str(self): 92 | """Returns the string representation of the model""" 93 | return pprint.pformat(self.to_dict()) 94 | 95 | def __repr__(self): 96 | """For `print` and `pprint`""" 97 | return self.to_str() 98 | 99 | def __eq__(self, other): 100 | """Returns true if both objects are equal""" 101 | if not isinstance(other, GroupSearchSort): 102 | return False 103 | 104 | return self.to_dict() == other.to_dict() 105 | 106 | def __ne__(self, other): 107 | """Returns true if both objects are not equal""" 108 | if not isinstance(other, GroupSearchSort): 109 | return True 110 | 111 | return self.to_dict() != other.to_dict() 112 | -------------------------------------------------------------------------------- /vrchatapi/models/license_action.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | VRChat API Documentation 5 | 6 | 7 | The version of the OpenAPI document: 1.19.4 8 | Contact: vrchatapi.lpv0t@aries.fyi 9 | Generated by: https://openapi-generator.tech 10 | """ 11 | 12 | 13 | try: 14 | from inspect import getfullargspec 15 | except ImportError: 16 | from inspect import getargspec as getfullargspec 17 | import pprint 18 | import re # noqa: F401 19 | import six 20 | 21 | from vrchatapi.configuration import Configuration 22 | 23 | 24 | class LicenseAction(object): 25 | """NOTE: This class is auto generated by OpenAPI Generator. 26 | Ref: https://openapi-generator.tech 27 | 28 | Do not edit the class manually. 29 | """ 30 | 31 | """ 32 | allowed enum values 33 | """ 34 | WEAR = "wear" 35 | HAVE = "have" 36 | 37 | allowable_values = [WEAR, HAVE] # noqa: E501 38 | 39 | """ 40 | Attributes: 41 | openapi_types (dict): The key is attribute name 42 | and the value is attribute type. 43 | attribute_map (dict): The key is attribute name 44 | and the value is json key in definition. 45 | """ 46 | openapi_types = { 47 | } 48 | 49 | attribute_map = { 50 | } 51 | 52 | def __init__(self, local_vars_configuration=None): # noqa: E501 53 | """LicenseAction - a model defined in OpenAPI""" # noqa: E501 54 | if local_vars_configuration is None: 55 | local_vars_configuration = Configuration.get_default_copy() 56 | self.local_vars_configuration = local_vars_configuration 57 | self.discriminator = None 58 | 59 | def to_dict(self, serialize=False): 60 | """Returns the model properties as a dict""" 61 | result = {} 62 | 63 | def convert(x): 64 | if hasattr(x, "to_dict"): 65 | args = getfullargspec(x.to_dict).args 66 | if len(args) == 1: 67 | return x.to_dict() 68 | else: 69 | return x.to_dict(serialize) 70 | else: 71 | return x 72 | 73 | for attr, _ in six.iteritems(self.openapi_types): 74 | value = getattr(self, attr) 75 | attr = self.attribute_map.get(attr, attr) if serialize else attr 76 | if isinstance(value, list): 77 | result[attr] = list(map( 78 | lambda x: convert(x), 79 | value 80 | )) 81 | elif isinstance(value, dict): 82 | result[attr] = dict(map( 83 | lambda item: (item[0], convert(item[1])), 84 | value.items() 85 | )) 86 | else: 87 | result[attr] = convert(value) 88 | 89 | return result 90 | 91 | def to_str(self): 92 | """Returns the string representation of the model""" 93 | return pprint.pformat(self.to_dict()) 94 | 95 | def __repr__(self): 96 | """For `print` and `pprint`""" 97 | return self.to_str() 98 | 99 | def __eq__(self, other): 100 | """Returns true if both objects are equal""" 101 | if not isinstance(other, LicenseAction): 102 | return False 103 | 104 | return self.to_dict() == other.to_dict() 105 | 106 | def __ne__(self, other): 107 | """Returns true if both objects are not equal""" 108 | if not isinstance(other, LicenseAction): 109 | return True 110 | 111 | return self.to_dict() != other.to_dict() 112 | -------------------------------------------------------------------------------- /vrchatapi/models/order_option.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | VRChat API Documentation 5 | 6 | 7 | The version of the OpenAPI document: 1.19.4 8 | Contact: vrchatapi.lpv0t@aries.fyi 9 | Generated by: https://openapi-generator.tech 10 | """ 11 | 12 | 13 | try: 14 | from inspect import getfullargspec 15 | except ImportError: 16 | from inspect import getargspec as getfullargspec 17 | import pprint 18 | import re # noqa: F401 19 | import six 20 | 21 | from vrchatapi.configuration import Configuration 22 | 23 | 24 | class OrderOption(object): 25 | """NOTE: This class is auto generated by OpenAPI Generator. 26 | Ref: https://openapi-generator.tech 27 | 28 | Do not edit the class manually. 29 | """ 30 | 31 | """ 32 | allowed enum values 33 | """ 34 | ASCENDING = "ascending" 35 | DESCENDING = "descending" 36 | 37 | allowable_values = [ASCENDING, DESCENDING] # noqa: E501 38 | 39 | """ 40 | Attributes: 41 | openapi_types (dict): The key is attribute name 42 | and the value is attribute type. 43 | attribute_map (dict): The key is attribute name 44 | and the value is json key in definition. 45 | """ 46 | openapi_types = { 47 | } 48 | 49 | attribute_map = { 50 | } 51 | 52 | def __init__(self, local_vars_configuration=None): # noqa: E501 53 | """OrderOption - a model defined in OpenAPI""" # noqa: E501 54 | if local_vars_configuration is None: 55 | local_vars_configuration = Configuration.get_default_copy() 56 | self.local_vars_configuration = local_vars_configuration 57 | self.discriminator = None 58 | 59 | def to_dict(self, serialize=False): 60 | """Returns the model properties as a dict""" 61 | result = {} 62 | 63 | def convert(x): 64 | if hasattr(x, "to_dict"): 65 | args = getfullargspec(x.to_dict).args 66 | if len(args) == 1: 67 | return x.to_dict() 68 | else: 69 | return x.to_dict(serialize) 70 | else: 71 | return x 72 | 73 | for attr, _ in six.iteritems(self.openapi_types): 74 | value = getattr(self, attr) 75 | attr = self.attribute_map.get(attr, attr) if serialize else attr 76 | if isinstance(value, list): 77 | result[attr] = list(map( 78 | lambda x: convert(x), 79 | value 80 | )) 81 | elif isinstance(value, dict): 82 | result[attr] = dict(map( 83 | lambda item: (item[0], convert(item[1])), 84 | value.items() 85 | )) 86 | else: 87 | result[attr] = convert(value) 88 | 89 | return result 90 | 91 | def to_str(self): 92 | """Returns the string representation of the model""" 93 | return pprint.pformat(self.to_dict()) 94 | 95 | def __repr__(self): 96 | """For `print` and `pprint`""" 97 | return self.to_str() 98 | 99 | def __eq__(self, other): 100 | """Returns true if both objects are equal""" 101 | if not isinstance(other, OrderOption): 102 | return False 103 | 104 | return self.to_dict() == other.to_dict() 105 | 106 | def __ne__(self, other): 107 | """Returns true if both objects are not equal""" 108 | if not isinstance(other, OrderOption): 109 | return True 110 | 111 | return self.to_dict() != other.to_dict() 112 | -------------------------------------------------------------------------------- /vrchatapi/models/product_listing_type.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | VRChat API Documentation 5 | 6 | 7 | The version of the OpenAPI document: 1.19.4 8 | Contact: vrchatapi.lpv0t@aries.fyi 9 | Generated by: https://openapi-generator.tech 10 | """ 11 | 12 | 13 | try: 14 | from inspect import getfullargspec 15 | except ImportError: 16 | from inspect import getargspec as getfullargspec 17 | import pprint 18 | import re # noqa: F401 19 | import six 20 | 21 | from vrchatapi.configuration import Configuration 22 | 23 | 24 | class ProductListingType(object): 25 | """NOTE: This class is auto generated by OpenAPI Generator. 26 | Ref: https://openapi-generator.tech 27 | 28 | Do not edit the class manually. 29 | """ 30 | 31 | """ 32 | allowed enum values 33 | """ 34 | SUBSCRIPTION = "subscription" 35 | 36 | allowable_values = [SUBSCRIPTION] # noqa: E501 37 | 38 | """ 39 | Attributes: 40 | openapi_types (dict): The key is attribute name 41 | and the value is attribute type. 42 | attribute_map (dict): The key is attribute name 43 | and the value is json key in definition. 44 | """ 45 | openapi_types = { 46 | } 47 | 48 | attribute_map = { 49 | } 50 | 51 | def __init__(self, local_vars_configuration=None): # noqa: E501 52 | """ProductListingType - a model defined in OpenAPI""" # noqa: E501 53 | if local_vars_configuration is None: 54 | local_vars_configuration = Configuration.get_default_copy() 55 | self.local_vars_configuration = local_vars_configuration 56 | self.discriminator = None 57 | 58 | def to_dict(self, serialize=False): 59 | """Returns the model properties as a dict""" 60 | result = {} 61 | 62 | def convert(x): 63 | if hasattr(x, "to_dict"): 64 | args = getfullargspec(x.to_dict).args 65 | if len(args) == 1: 66 | return x.to_dict() 67 | else: 68 | return x.to_dict(serialize) 69 | else: 70 | return x 71 | 72 | for attr, _ in six.iteritems(self.openapi_types): 73 | value = getattr(self, attr) 74 | attr = self.attribute_map.get(attr, attr) if serialize else attr 75 | if isinstance(value, list): 76 | result[attr] = list(map( 77 | lambda x: convert(x), 78 | value 79 | )) 80 | elif isinstance(value, dict): 81 | result[attr] = dict(map( 82 | lambda item: (item[0], convert(item[1])), 83 | value.items() 84 | )) 85 | else: 86 | result[attr] = convert(value) 87 | 88 | return result 89 | 90 | def to_str(self): 91 | """Returns the string representation of the model""" 92 | return pprint.pformat(self.to_dict()) 93 | 94 | def __repr__(self): 95 | """For `print` and `pprint`""" 96 | return self.to_str() 97 | 98 | def __eq__(self, other): 99 | """Returns true if both objects are equal""" 100 | if not isinstance(other, ProductListingType): 101 | return False 102 | 103 | return self.to_dict() == other.to_dict() 104 | 105 | def __ne__(self, other): 106 | """Returns true if both objects are not equal""" 107 | if not isinstance(other, ProductListingType): 108 | return True 109 | 110 | return self.to_dict() != other.to_dict() 111 | -------------------------------------------------------------------------------- /vrchatapi/models/product_type.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | VRChat API Documentation 5 | 6 | 7 | The version of the OpenAPI document: 1.19.4 8 | Contact: vrchatapi.lpv0t@aries.fyi 9 | Generated by: https://openapi-generator.tech 10 | """ 11 | 12 | 13 | try: 14 | from inspect import getfullargspec 15 | except ImportError: 16 | from inspect import getargspec as getfullargspec 17 | import pprint 18 | import re # noqa: F401 19 | import six 20 | 21 | from vrchatapi.configuration import Configuration 22 | 23 | 24 | class ProductType(object): 25 | """NOTE: This class is auto generated by OpenAPI Generator. 26 | Ref: https://openapi-generator.tech 27 | 28 | Do not edit the class manually. 29 | """ 30 | 31 | """ 32 | allowed enum values 33 | """ 34 | LISTING = "listing" 35 | ROLE = "role" 36 | UDON = "udon" 37 | 38 | allowable_values = [LISTING, ROLE, UDON] # noqa: E501 39 | 40 | """ 41 | Attributes: 42 | openapi_types (dict): The key is attribute name 43 | and the value is attribute type. 44 | attribute_map (dict): The key is attribute name 45 | and the value is json key in definition. 46 | """ 47 | openapi_types = { 48 | } 49 | 50 | attribute_map = { 51 | } 52 | 53 | def __init__(self, local_vars_configuration=None): # noqa: E501 54 | """ProductType - a model defined in OpenAPI""" # noqa: E501 55 | if local_vars_configuration is None: 56 | local_vars_configuration = Configuration.get_default_copy() 57 | self.local_vars_configuration = local_vars_configuration 58 | self.discriminator = None 59 | 60 | def to_dict(self, serialize=False): 61 | """Returns the model properties as a dict""" 62 | result = {} 63 | 64 | def convert(x): 65 | if hasattr(x, "to_dict"): 66 | args = getfullargspec(x.to_dict).args 67 | if len(args) == 1: 68 | return x.to_dict() 69 | else: 70 | return x.to_dict(serialize) 71 | else: 72 | return x 73 | 74 | for attr, _ in six.iteritems(self.openapi_types): 75 | value = getattr(self, attr) 76 | attr = self.attribute_map.get(attr, attr) if serialize else attr 77 | if isinstance(value, list): 78 | result[attr] = list(map( 79 | lambda x: convert(x), 80 | value 81 | )) 82 | elif isinstance(value, dict): 83 | result[attr] = dict(map( 84 | lambda item: (item[0], convert(item[1])), 85 | value.items() 86 | )) 87 | else: 88 | result[attr] = convert(value) 89 | 90 | return result 91 | 92 | def to_str(self): 93 | """Returns the string representation of the model""" 94 | return pprint.pformat(self.to_dict()) 95 | 96 | def __repr__(self): 97 | """For `print` and `pprint`""" 98 | return self.to_str() 99 | 100 | def __eq__(self, other): 101 | """Returns true if both objects are equal""" 102 | if not isinstance(other, ProductType): 103 | return False 104 | 105 | return self.to_dict() == other.to_dict() 106 | 107 | def __ne__(self, other): 108 | """Returns true if both objects are not equal""" 109 | if not isinstance(other, ProductType): 110 | return True 111 | 112 | return self.to_dict() != other.to_dict() 113 | --------------------------------------------------------------------------------