Bump openapi-generator to 7.7.0 (#14)

* bump: openapi-generator to 7.7.0

* fix: remove empty doc comments to silence clippy

* bump: remove unessecary patches fixed by the update

* bump: run generate.sh
This commit is contained in:
DerTiedemann
2024-07-21 02:18:01 +02:00
committed by GitHub
parent 169cbe48b0
commit 2c4cf7d817
263 changed files with 1978 additions and 2062 deletions

View File

@ -1 +1 @@
6.2.1 7.7.0

View File

@ -4,13 +4,12 @@ version = "1.17.6"
authors = ["vrchatapi.lpv0t@aries.fyi"] authors = ["vrchatapi.lpv0t@aries.fyi"]
description = "VRChat API Client for Rust" description = "VRChat API Client for Rust"
license = "MIT" license = "MIT"
edition = "2018" edition = "2021"
[dependencies] [dependencies]
serde = "^1.0" serde = { version = "^1.0", features = ["derive"] }
serde_derive = "^1.0" serde_with = { version = "^3.8", default-features = false, features = ["base64", "std", "macros"] }
serde_with = "^2.0"
serde_json = "^1.0" serde_json = "^1.0"
url = "^2.2" url = "^2.5"
uuid = { version = "^1.0", features = ["serde"] } uuid = { version = "^1.8", features = ["serde", "v4"] }
reqwest = "~0.9" reqwest = { version = "^0.12", features = ["json", "blocking", "cookies", "multipart"] }

View File

@ -4,7 +4,7 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**r#type** | [**crate::models::FavoriteType**](FavoriteType.md) | | **r#type** | [**models::FavoriteType**](FavoriteType.md) | |
**favorite_id** | **String** | Must be either AvatarID, WorldID or UserID. | **favorite_id** | **String** | Must be either AvatarID, WorldID or UserID. |
**tags** | **Vec<String>** | 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. | **tags** | **Vec<String>** | 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. |

View File

@ -7,7 +7,7 @@ Name | Type | Description | Notes
**voice_enable_degradation** | **bool** | Unknown, probably voice optimization testing | [default to false] **voice_enable_degradation** | **bool** | Unknown, probably voice optimization testing | [default to false]
**voice_enable_receiver_limiting** | **bool** | Unknown, probably voice optimization testing | [default to true] **voice_enable_receiver_limiting** | **bool** | Unknown, probably voice optimization testing | [default to true]
**address** | **String** | VRChat's office address | **address** | **String** | VRChat's office address |
**announcements** | [**Vec<crate::models::ApiConfigAnnouncement>**](APIConfigAnnouncement.md) | Public Announcements | **announcements** | [**Vec<models::ApiConfigAnnouncement>**](APIConfigAnnouncement.md) | Public Announcements |
**app_name** | **String** | Game name | [default to VrChat] **app_name** | **String** | Game name | [default to VrChat]
**build_version_tag** | **String** | Build tag of the API server | **build_version_tag** | **String** | Build tag of the API server |
**client_api_key** | **String** | apiKey to be used for all other requests | **client_api_key** | **String** | apiKey to be used for all other requests |
@ -19,7 +19,7 @@ Name | Type | Description | Notes
**copyright_email** | **String** | VRChat's copyright-issues-related email | **copyright_email** | **String** | VRChat's copyright-issues-related email |
**current_tos_version** | **i32** | Current version number of the Terms of Service | **current_tos_version** | **i32** | Current version number of the Terms of Service |
**default_avatar** | **String** | | **default_avatar** | **String** | |
**deployment_group** | [**crate::models::DeploymentGroup**](DeploymentGroup.md) | | **deployment_group** | [**models::DeploymentGroup**](DeploymentGroup.md) | |
**dev_app_version_standalone** | **String** | Version number for game development build | **dev_app_version_standalone** | **String** | Version number for game development build |
**dev_download_link_windows** | **String** | Developer Download link | **dev_download_link_windows** | **String** | Developer Download link |
**dev_sdk_url** | **String** | Link to download the development SDK, use downloadUrls instead | **dev_sdk_url** | **String** | Link to download the development SDK, use downloadUrls instead |
@ -42,9 +42,9 @@ Name | Type | Description | Notes
**disable_udon** | **bool** | Toggles if Udon should be universally disabled in-game. | [default to false] **disable_udon** | **bool** | Toggles if Udon should be universally disabled in-game. | [default to false]
**disable_upgrade_account** | **bool** | Toggles if account upgrading \"linking with Steam/Oculus\" should be disabled. | [default to false] **disable_upgrade_account** | **bool** | Toggles if account upgrading \"linking with Steam/Oculus\" should be disabled. | [default to false]
**download_link_windows** | **String** | Download link for game on the Oculus Rift website. | **download_link_windows** | **String** | Download link for game on the Oculus Rift website. |
**download_urls** | [**crate::models::ApiConfigDownloadUrlList**](APIConfigDownloadURLList.md) | | **download_urls** | [**models::ApiConfigDownloadUrlList**](APIConfigDownloadURLList.md) | |
**dynamic_world_rows** | [**Vec<crate::models::DynamicContentRow>**](DynamicContentRow.md) | Array of DynamicWorldRow objects, used by the game to display the list of world rows | **dynamic_world_rows** | [**Vec<models::DynamicContentRow>**](DynamicContentRow.md) | Array of DynamicWorldRow objects, used by the game to display the list of world rows |
**events** | [**crate::models::ApiConfigEvents**](APIConfigEvents.md) | | **events** | [**models::ApiConfigEvents**](APIConfigEvents.md) | |
**gear_demo_room_id** | **String** | Unknown | **gear_demo_room_id** | **String** | Unknown |
**home_world_id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | **home_world_id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
**homepage_redirect_target** | **String** | Redirect target if you try to open the base API domain in your browser | [default to https://hello.vrchat.com] **homepage_redirect_target** | **String** | Redirect target if you try to open the base API domain in your browser | [default to https://hello.vrchat.com]

View File

@ -17,7 +17,7 @@ Method | HTTP request | Description
## check_user_exists ## check_user_exists
> crate::models::UserExists check_user_exists(email, display_name, user_id, exclude_user_id) > models::UserExists check_user_exists(email, display_name, user_id, exclude_user_id)
Check User Exists Check User Exists
Checks if a user by a given `username`, `displayName` or `email` exist. This is used during registration to check if a username has already been taken, during change of displayName to check if a displayName is available, and during change of email to check if the email is already used. In the later two cases the `excludeUserId` is used to exclude oneself, otherwise the result would always be true. It is **REQUIRED** to include **AT LEAST** `username`, `displayName` **or** `email` query parameter. Although they can be combined - in addition with `excludeUserId` (generally to exclude yourself) - to further fine-tune the search. Checks if a user by a given `username`, `displayName` or `email` exist. This is used during registration to check if a username has already been taken, during change of displayName to check if a displayName is available, and during change of email to check if the email is already used. In the later two cases the `excludeUserId` is used to exclude oneself, otherwise the result would always be true. It is **REQUIRED** to include **AT LEAST** `username`, `displayName` **or** `email` query parameter. Although they can be combined - in addition with `excludeUserId` (generally to exclude yourself) - to further fine-tune the search.
@ -34,7 +34,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::UserExists**](UserExists.md) [**models::UserExists**](UserExists.md)
### Authorization ### Authorization
@ -50,7 +50,7 @@ No authorization required
## delete_user ## delete_user
> crate::models::CurrentUser delete_user(user_id) > models::CurrentUser delete_user(user_id)
Delete User Delete User
Deletes the account with given ID. Normal users only have permission to delete their own account. Account deletion is 14 days from this request, and will be cancelled if you do an authenticated request with the account afterwards. **VRC+ NOTE:** Despite the 14-days cooldown, any VRC+ subscription will be cancelled **immediately**. **METHOD NOTE:** Despite this being a Delete action, the method type required is PUT. Deletes the account with given ID. Normal users only have permission to delete their own account. Account deletion is 14 days from this request, and will be cancelled if you do an authenticated request with the account afterwards. **VRC+ NOTE:** Despite the 14-days cooldown, any VRC+ subscription will be cancelled **immediately**. **METHOD NOTE:** Despite this being a Delete action, the method type required is PUT.
@ -64,7 +64,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::CurrentUser**](CurrentUser.md) [**models::CurrentUser**](CurrentUser.md)
### Authorization ### Authorization
@ -80,7 +80,7 @@ Name | Type | Description | Required | Notes
## get_current_user ## get_current_user
> crate::models::CurrentUser get_current_user() > models::CurrentUser get_current_user()
Login and/or Get Current User Info Login and/or Get Current User Info
This endpoint does the following two operations: 1) Checks if you are already logged in by looking for a valid `auth` cookie. If you are have a valid auth cookie then no additional auth-related actions are taken. If you are **not** logged in then it will log you in with the `Authorization` header and set the `auth` cookie. The `auth` cookie will only be sent once. 2) If logged in, this function will also return the CurrentUser object containing detailed information about the currently logged in user. The auth string after `Authorization: Basic {string}` is a base64-encoded string of the username and password, both individually url-encoded, and then joined with a colon. > base64(urlencode(username):urlencode(password)) **WARNING: Session Limit:** Each authentication with login credentials counts as a separate session, out of which you have a limited amount. Make sure to save and reuse the `auth` cookie if you are often restarting the program. The provided API libraries automatically save cookies during runtime, but does not persist during restart. While it can be fine to use username/password during development, expect in production to very fast run into the rate-limit and be temporarily blocked from making new sessions until older ones expire. The exact number of simultaneous sessions is unknown/undisclosed. This endpoint does the following two operations: 1) Checks if you are already logged in by looking for a valid `auth` cookie. If you are have a valid auth cookie then no additional auth-related actions are taken. If you are **not** logged in then it will log you in with the `Authorization` header and set the `auth` cookie. The `auth` cookie will only be sent once. 2) If logged in, this function will also return the CurrentUser object containing detailed information about the currently logged in user. The auth string after `Authorization: Basic {string}` is a base64-encoded string of the username and password, both individually url-encoded, and then joined with a colon. > base64(urlencode(username):urlencode(password)) **WARNING: Session Limit:** Each authentication with login credentials counts as a separate session, out of which you have a limited amount. Make sure to save and reuse the `auth` cookie if you are often restarting the program. The provided API libraries automatically save cookies during runtime, but does not persist during restart. While it can be fine to use username/password during development, expect in production to very fast run into the rate-limit and be temporarily blocked from making new sessions until older ones expire. The exact number of simultaneous sessions is unknown/undisclosed.
@ -91,11 +91,11 @@ This endpoint does not need any parameter.
### Return type ### Return type
[**crate::models::CurrentUser**](CurrentUser.md) [**models::CurrentUser**](CurrentUser.md)
### Authorization ### Authorization
[authCookie](../README.md#authCookie), [authHeader](../README.md#authHeader), [twoFactorAuthCookie](../README.md#twoFactorAuthCookie) [authHeader](../README.md#authHeader), [twoFactorAuthCookie](../README.md#twoFactorAuthCookie), [authCookie](../README.md#authCookie)
### HTTP request headers ### HTTP request headers
@ -107,7 +107,7 @@ This endpoint does not need any parameter.
## logout ## logout
> crate::models::Success logout() > models::Success logout()
Logout Logout
Invalidates the login session. Invalidates the login session.
@ -118,7 +118,7 @@ This endpoint does not need any parameter.
### Return type ### Return type
[**crate::models::Success**](Success.md) [**models::Success**](Success.md)
### Authorization ### Authorization
@ -134,7 +134,7 @@ This endpoint does not need any parameter.
## verify2_fa ## verify2_fa
> crate::models::Verify2FaResult verify2_fa(two_factor_auth_code) > models::Verify2FaResult verify2_fa(two_factor_auth_code)
Verify 2FA code Verify 2FA code
Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled. Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
@ -148,7 +148,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Verify2FaResult**](Verify2FAResult.md) [**models::Verify2FaResult**](Verify2FAResult.md)
### Authorization ### Authorization
@ -164,7 +164,7 @@ Name | Type | Description | Required | Notes
## verify2_fa_email_code ## verify2_fa_email_code
> crate::models::Verify2FaEmailCodeResult verify2_fa_email_code(two_factor_email_code) > models::Verify2FaEmailCodeResult verify2_fa_email_code(two_factor_email_code)
Verify 2FA email code Verify 2FA email code
Finishes the login sequence with an 2FA email code. Finishes the login sequence with an 2FA email code.
@ -178,7 +178,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Verify2FaEmailCodeResult**](Verify2FAEmailCodeResult.md) [**models::Verify2FaEmailCodeResult**](Verify2FAEmailCodeResult.md)
### Authorization ### Authorization
@ -194,7 +194,7 @@ Name | Type | Description | Required | Notes
## verify_auth_token ## verify_auth_token
> crate::models::VerifyAuthTokenResult verify_auth_token() > models::VerifyAuthTokenResult verify_auth_token()
Verify Auth Token Verify Auth Token
Verify whether the currently provided Auth Token is valid. Verify whether the currently provided Auth Token is valid.
@ -205,7 +205,7 @@ This endpoint does not need any parameter.
### Return type ### Return type
[**crate::models::VerifyAuthTokenResult**](VerifyAuthTokenResult.md) [**models::VerifyAuthTokenResult**](VerifyAuthTokenResult.md)
### Authorization ### Authorization
@ -221,7 +221,7 @@ This endpoint does not need any parameter.
## verify_recovery_code ## verify_recovery_code
> crate::models::Verify2FaResult verify_recovery_code(two_factor_auth_code) > models::Verify2FaResult verify_recovery_code(two_factor_auth_code)
Verify 2FA code with Recovery code Verify 2FA code with Recovery code
Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled. Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
@ -235,7 +235,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Verify2FaResult**](Verify2FAResult.md) [**models::Verify2FaResult**](Verify2FAResult.md)
### Authorization ### Authorization

View File

@ -14,12 +14,12 @@ Name | Type | Description | Notes
**id** | **String** | | **id** | **String** | |
**image_url** | **String** | | **image_url** | **String** | |
**name** | **String** | | **name** | **String** | |
**release_status** | [**crate::models::ReleaseStatus**](ReleaseStatus.md) | | **release_status** | [**models::ReleaseStatus**](ReleaseStatus.md) | |
**tags** | **Vec<String>** | | **tags** | **Vec<String>** | |
**thumbnail_image_url** | **String** | | **thumbnail_image_url** | **String** | |
**unity_package_url** | **String** | | **unity_package_url** | **String** | |
**unity_package_url_object** | [**crate::models::AvatarUnityPackageUrlObject**](Avatar_unityPackageUrlObject.md) | | **unity_package_url_object** | [**models::AvatarUnityPackageUrlObject**](Avatar_unityPackageUrlObject.md) | |
**unity_packages** | [**Vec<crate::models::UnityPackage>**](UnityPackage.md) | | **unity_packages** | [**Vec<models::UnityPackage>**](UnityPackage.md) | |
**updated_at** | **String** | | **updated_at** | **String** | |
**version** | **i32** | | [default to 0] **version** | **i32** | | [default to 0]

View File

@ -18,7 +18,7 @@ Method | HTTP request | Description
## create_avatar ## create_avatar
> crate::models::Avatar create_avatar(create_avatar_request) > models::Avatar create_avatar(create_avatar_request)
Create Avatar Create Avatar
Create an avatar. It's possible to optionally specify a ID if you want a custom one. Attempting to create an Avatar with an already claimed ID will result in a DB error. Create an avatar. It's possible to optionally specify a ID if you want a custom one. Attempting to create an Avatar with an already claimed ID will result in a DB error.
@ -32,7 +32,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Avatar**](Avatar.md) [**models::Avatar**](Avatar.md)
### Authorization ### Authorization
@ -48,7 +48,7 @@ Name | Type | Description | Required | Notes
## delete_avatar ## delete_avatar
> crate::models::Avatar delete_avatar(avatar_id) > models::Avatar delete_avatar(avatar_id)
Delete Avatar Delete Avatar
Delete an avatar. Notice an avatar is never fully \"deleted\", only its ReleaseStatus is set to \"hidden\" and the linked Files are deleted. The AvatarID is permanently reserved. Delete an avatar. Notice an avatar is never fully \"deleted\", only its ReleaseStatus is set to \"hidden\" and the linked Files are deleted. The AvatarID is permanently reserved.
@ -62,7 +62,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Avatar**](Avatar.md) [**models::Avatar**](Avatar.md)
### Authorization ### Authorization
@ -78,7 +78,7 @@ Name | Type | Description | Required | Notes
## get_avatar ## get_avatar
> crate::models::Avatar get_avatar(avatar_id) > models::Avatar get_avatar(avatar_id)
Get Avatar Get Avatar
Get information about a specific Avatar. Get information about a specific Avatar.
@ -92,7 +92,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Avatar**](Avatar.md) [**models::Avatar**](Avatar.md)
### Authorization ### Authorization
@ -108,7 +108,7 @@ Name | Type | Description | Required | Notes
## get_favorited_avatars ## get_favorited_avatars
> Vec<crate::models::Avatar> get_favorited_avatars(featured, sort, n, order, offset, search, tag, notag, release_status, max_unity_version, min_unity_version, platform, user_id) > Vec<models::Avatar> get_favorited_avatars(featured, sort, n, order, offset, search, tag, notag, release_status, max_unity_version, min_unity_version, platform, user_id)
List Favorited Avatars List Favorited Avatars
Search and list favorited avatars by query filters. Search and list favorited avatars by query filters.
@ -134,7 +134,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::Avatar>**](Avatar.md) [**Vec<models::Avatar>**](Avatar.md)
### Authorization ### Authorization
@ -150,7 +150,7 @@ Name | Type | Description | Required | Notes
## get_own_avatar ## get_own_avatar
> crate::models::Avatar get_own_avatar(user_id) > models::Avatar get_own_avatar(user_id)
Get Own Avatar Get Own Avatar
Get the current avatar for the user. This will return an error for any other user than the one logged in. Get the current avatar for the user. This will return an error for any other user than the one logged in.
@ -164,7 +164,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Avatar**](Avatar.md) [**models::Avatar**](Avatar.md)
### Authorization ### Authorization
@ -180,7 +180,7 @@ Name | Type | Description | Required | Notes
## search_avatars ## search_avatars
> Vec<crate::models::Avatar> search_avatars(featured, sort, user, user_id, n, order, offset, tag, notag, release_status, max_unity_version, min_unity_version, platform) > Vec<models::Avatar> search_avatars(featured, sort, user, user_id, n, order, offset, tag, notag, release_status, max_unity_version, min_unity_version, platform)
Search Avatars Search Avatars
Search and list avatars by query filters. You can only search your own or featured avatars. It is not possible as a normal user to search other peoples avatars. Search and list avatars by query filters. You can only search your own or featured avatars. It is not possible as a normal user to search other peoples avatars.
@ -206,7 +206,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::Avatar>**](Avatar.md) [**Vec<models::Avatar>**](Avatar.md)
### Authorization ### Authorization
@ -222,7 +222,7 @@ Name | Type | Description | Required | Notes
## select_avatar ## select_avatar
> crate::models::CurrentUser select_avatar(avatar_id) > models::CurrentUser select_avatar(avatar_id)
Select Avatar Select Avatar
Switches into that avatar. Switches into that avatar.
@ -236,7 +236,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::CurrentUser**](CurrentUser.md) [**models::CurrentUser**](CurrentUser.md)
### Authorization ### Authorization
@ -252,7 +252,7 @@ Name | Type | Description | Required | Notes
## select_fallback_avatar ## select_fallback_avatar
> crate::models::CurrentUser select_fallback_avatar(avatar_id) > models::CurrentUser select_fallback_avatar(avatar_id)
Select Fallback Avatar Select Fallback Avatar
Switches into that avatar as your fallback avatar. Switches into that avatar as your fallback avatar.
@ -266,7 +266,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::CurrentUser**](CurrentUser.md) [**models::CurrentUser**](CurrentUser.md)
### Authorization ### Authorization
@ -282,7 +282,7 @@ Name | Type | Description | Required | Notes
## update_avatar ## update_avatar
> crate::models::Avatar update_avatar(avatar_id, update_avatar_request) > models::Avatar update_avatar(avatar_id, update_avatar_request)
Update Avatar Update Avatar
Update information about a specific avatar. Update information about a specific avatar.
@ -297,7 +297,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Avatar**](Avatar.md) [**models::Avatar**](Avatar.md)
### Authorization ### Authorization

View File

@ -10,8 +10,8 @@ Name | Type | Description | Notes
**description** | Option<**String**> | | [optional] **description** | Option<**String**> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional] **tags** | Option<**Vec<String>**> | | [optional]
**image_url** | **String** | | **image_url** | **String** | |
**release_status** | Option<[**crate::models::ReleaseStatus**](ReleaseStatus.md)> | | [optional] **release_status** | Option<[**models::ReleaseStatus**](ReleaseStatus.md)> | | [optional]
**version** | Option<**f32**> | | [optional][default to 1] **version** | Option<**f64**> | | [optional][default to 1]
**unity_package_url** | Option<**String**> | | [optional] **unity_package_url** | Option<**String**> | | [optional]
**unity_version** | Option<**String**> | | [optional][default to 5.3.4p1] **unity_version** | Option<**String**> | | [optional][default to 5.3.4p1]

View File

@ -5,7 +5,7 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**name** | **String** | | **name** | **String** | |
**mime_type** | [**crate::models::MimeType**](MIMEType.md) | | **mime_type** | [**models::MimeType**](MIMEType.md) | |
**extension** | **String** | | **extension** | **String** | |
**tags** | Option<**Vec<String>**> | | [optional] **tags** | Option<**Vec<String>**> | | [optional]

View File

@ -5,9 +5,9 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**signature_md5** | **String** | | **signature_md5** | **String** | |
**signature_size_in_bytes** | **f32** | | **signature_size_in_bytes** | **f64** | |
**file_md5** | Option<**String**> | | [optional] **file_md5** | Option<**String**> | | [optional]
**file_size_in_bytes** | Option<**f32**> | | [optional] **file_size_in_bytes** | Option<**f64**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -9,7 +9,7 @@ Name | Type | Description | Notes
**image_id** | Option<**String**> | | [optional] **image_id** | Option<**String**> | | [optional]
**send_notification** | **bool** | Send notification to group members. | [default to false] **send_notification** | **bool** | Send notification to group members. | [default to false]
**role_ids** | Option<**Vec<String>**> | | [optional] **role_ids** | Option<**Vec<String>**> | | [optional]
**visibility** | [**crate::models::GroupPostVisibility**](GroupPostVisibility.md) | | **visibility** | [**models::GroupPostVisibility**](GroupPostVisibility.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -7,11 +7,11 @@ Name | Type | Description | Notes
**name** | **String** | | **name** | **String** | |
**short_code** | **String** | | **short_code** | **String** | |
**description** | Option<**String**> | | [optional] **description** | Option<**String**> | | [optional]
**join_state** | Option<[**crate::models::GroupJoinState**](GroupJoinState.md)> | | [optional] **join_state** | Option<[**models::GroupJoinState**](GroupJoinState.md)> | | [optional]
**icon_id** | Option<**String**> | | [optional] **icon_id** | Option<**String**> | | [optional]
**banner_id** | Option<**String**> | | [optional] **banner_id** | Option<**String**> | | [optional]
**privacy** | Option<[**crate::models::GroupPrivacy**](GroupPrivacy.md)> | | [optional] **privacy** | Option<[**models::GroupPrivacy**](GroupPrivacy.md)> | | [optional]
**role_template** | [**crate::models::GroupRoleTemplate**](GroupRoleTemplate.md) | | **role_template** | [**models::GroupRoleTemplate**](GroupRoleTemplate.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -5,11 +5,11 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**world_id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | **world_id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
**r#type** | [**crate::models::InstanceType**](InstanceType.md) | | **r#type** | [**models::InstanceType**](InstanceType.md) | |
**region** | [**crate::models::InstanceRegion**](InstanceRegion.md) | | **region** | [**models::InstanceRegion**](InstanceRegion.md) | |
**owner_id** | Option<**String**> | A groupId if the instance type is \"group\", null if instance type is public, or a userId otherwise | [optional] **owner_id** | Option<**String**> | A groupId if the instance type is \"group\", null if instance type is public, or a userId otherwise | [optional]
**role_ids** | Option<**Vec<String>**> | Group roleIds that are allowed to join if the type is \"group\" and groupAccessType is \"member\" | [optional] **role_ids** | Option<**Vec<String>**> | Group roleIds that are allowed to join if the type is \"group\" and groupAccessType is \"member\" | [optional]
**group_access_type** | Option<[**crate::models::GroupAccessType**](GroupAccessType.md)> | | [optional] **group_access_type** | Option<[**models::GroupAccessType**](GroupAccessType.md)> | | [optional]
**queue_enabled** | Option<**bool**> | | [optional][default to false] **queue_enabled** | Option<**bool**> | | [optional][default to false]
**closed_at** | Option<**String**> | The time after which users won't be allowed to join the instance. This doesn't work for public instances. | [optional] **closed_at** | Option<**String**> | The time after which users won't be allowed to join the instance. This doesn't work for public instances. | [optional]
**can_request_invite** | Option<**bool**> | Only applies to invite type instances to make them invite+ | [optional][default to false] **can_request_invite** | Option<**bool**> | Only applies to invite type instances to make them invite+ | [optional][default to false]

View File

@ -14,7 +14,7 @@ Name | Type | Description | Notes
**image_url** | **String** | | **image_url** | **String** | |
**name** | **String** | | **name** | **String** | |
**platform** | Option<**String**> | 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] **platform** | Option<**String**> | 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]
**release_status** | Option<[**crate::models::ReleaseStatus**](ReleaseStatus.md)> | | [optional] **release_status** | Option<[**models::ReleaseStatus**](ReleaseStatus.md)> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional] **tags** | Option<**Vec<String>**> | | [optional]
**unity_package_url** | Option<**String**> | | [optional] **unity_package_url** | Option<**String**> | | [optional]
**unity_version** | Option<**String**> | | [optional][default to 5.3.4p1] **unity_version** | Option<**String**> | | [optional][default to 5.3.4p1]

View File

@ -7,10 +7,10 @@ Name | Type | Description | Notes
**accepted_tos_version** | **i32** | | **accepted_tos_version** | **i32** | |
**accepted_privacy_version** | Option<**i32**> | | [optional] **accepted_privacy_version** | Option<**i32**> | | [optional]
**account_deletion_date** | Option<[**String**](string.md)> | | [optional] **account_deletion_date** | Option<[**String**](string.md)> | | [optional]
**account_deletion_log** | Option<[**Vec<crate::models::AccountDeletionLog>**](AccountDeletionLog.md)> | | [optional] **account_deletion_log** | Option<[**Vec<models::AccountDeletionLog>**](AccountDeletionLog.md)> | | [optional]
**active_friends** | Option<**Vec<String>**> | | [optional] **active_friends** | Option<**Vec<String>**> | | [optional]
**allow_avatar_copying** | **bool** | | **allow_avatar_copying** | **bool** | |
**badges** | Option<[**Vec<crate::models::Badge>**](Badge.md)> | | [optional] **badges** | Option<[**Vec<models::Badge>**](Badge.md)> | | [optional]
**bio** | **String** | | **bio** | **String** | |
**bio_links** | **Vec<String>** | | **bio_links** | **Vec<String>** | |
**current_avatar** | **String** | | **current_avatar** | **String** | |
@ -19,7 +19,7 @@ Name | Type | Description | Notes
**current_avatar_thumbnail_image_url** | **String** | When profilePicOverride is not empty, use it instead. | **current_avatar_thumbnail_image_url** | **String** | When profilePicOverride is not empty, use it instead. |
**current_avatar_tags** | **Vec<String>** | | **current_avatar_tags** | **Vec<String>** | |
**date_joined** | [**String**](string.md) | | **date_joined** | [**String**](string.md) | |
**developer_type** | [**crate::models::DeveloperType**](DeveloperType.md) | | **developer_type** | [**models::DeveloperType**](DeveloperType.md) | |
**display_name** | **String** | | **display_name** | **String** | |
**email_verified** | **bool** | | **email_verified** | **bool** | |
**fallback_avatar** | Option<**String**> | | [optional] **fallback_avatar** | Option<**String**> | | [optional]
@ -50,13 +50,13 @@ Name | Type | Description | Notes
**vive_id** | Option<**String**> | | [optional] **vive_id** | Option<**String**> | | [optional]
**offline_friends** | Option<**Vec<String>**> | | [optional] **offline_friends** | Option<**Vec<String>**> | | [optional]
**online_friends** | Option<**Vec<String>**> | | [optional] **online_friends** | Option<**Vec<String>**> | | [optional]
**past_display_names** | [**Vec<crate::models::PastDisplayName>**](PastDisplayName.md) | | **past_display_names** | [**Vec<models::PastDisplayName>**](PastDisplayName.md) | |
**presence** | Option<[**crate::models::CurrentUserPresence**](CurrentUserPresence.md)> | | [optional] **presence** | Option<[**models::CurrentUserPresence**](CurrentUserPresence.md)> | | [optional]
**profile_pic_override** | **String** | | **profile_pic_override** | **String** | |
**profile_pic_override_thumbnail** | **String** | | **profile_pic_override_thumbnail** | **String** | |
**pronouns** | **String** | | **pronouns** | **String** | |
**state** | [**crate::models::UserState**](UserState.md) | | **state** | [**models::UserState**](UserState.md) | |
**status** | [**crate::models::UserStatus**](UserStatus.md) | | **status** | [**models::UserStatus**](UserStatus.md) | |
**status_description** | **String** | | **status_description** | **String** | |
**status_first_time** | **bool** | | **status_first_time** | **bool** | |
**status_history** | **Vec<String>** | | **status_history** | **Vec<String>** | |

View File

@ -1,9 +1,14 @@
# DeploymentGroup # DeploymentGroup
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Blue | blue |
| Green | green |
| Grape | grape |
| Cherry | cherry |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,14 @@
# DeveloperType # DeveloperType
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| None | none |
| Trusted | trusted |
| Internal | internal |
| Moderator | moderator |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -14,7 +14,7 @@ Method | HTTP request | Description
## get_current_subscriptions ## get_current_subscriptions
> Vec<crate::models::UserSubscription> get_current_subscriptions() > Vec<models::UserSubscription> get_current_subscriptions()
Get Current Subscriptions Get Current Subscriptions
Get a list of all current user subscriptions. Get a list of all current user subscriptions.
@ -25,7 +25,7 @@ This endpoint does not need any parameter.
### Return type ### Return type
[**Vec<crate::models::UserSubscription>**](UserSubscription.md) [**Vec<models::UserSubscription>**](UserSubscription.md)
### Authorization ### Authorization
@ -41,7 +41,7 @@ This endpoint does not need any parameter.
## get_license_group ## get_license_group
> crate::models::LicenseGroup get_license_group(license_group_id) > models::LicenseGroup get_license_group(license_group_id)
Get License Group Get License Group
Get a single License Group by given ID. Get a single License Group by given ID.
@ -55,7 +55,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::LicenseGroup**](LicenseGroup.md) [**models::LicenseGroup**](LicenseGroup.md)
### Authorization ### Authorization
@ -71,7 +71,7 @@ Name | Type | Description | Required | Notes
## get_steam_transaction ## get_steam_transaction
> crate::models::Transaction get_steam_transaction(transaction_id) > models::Transaction get_steam_transaction(transaction_id)
Get Steam Transaction Get Steam Transaction
Get a single Steam transactions by ID. This returns the exact same information as `getSteamTransactions`, so no point in using this endpoint. Get a single Steam transactions by ID. This returns the exact same information as `getSteamTransactions`, so no point in using this endpoint.
@ -85,7 +85,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Transaction**](Transaction.md) [**models::Transaction**](Transaction.md)
### Authorization ### Authorization
@ -101,7 +101,7 @@ Name | Type | Description | Required | Notes
## get_steam_transactions ## get_steam_transactions
> Vec<crate::models::Transaction> get_steam_transactions() > Vec<models::Transaction> get_steam_transactions()
List Steam Transactions List Steam Transactions
Get all own Steam transactions. Get all own Steam transactions.
@ -112,7 +112,7 @@ This endpoint does not need any parameter.
### Return type ### Return type
[**Vec<crate::models::Transaction>**](Transaction.md) [**Vec<models::Transaction>**](Transaction.md)
### Authorization ### Authorization
@ -128,7 +128,7 @@ This endpoint does not need any parameter.
## get_subscriptions ## get_subscriptions
> Vec<crate::models::Subscription> get_subscriptions() > Vec<models::Subscription> get_subscriptions()
List Subscriptions List Subscriptions
List all existing Subscriptions. For example, \"vrchatplus-monthly\" and \"vrchatplus-yearly\". List all existing Subscriptions. For example, \"vrchatplus-monthly\" and \"vrchatplus-yearly\".
@ -139,7 +139,7 @@ This endpoint does not need any parameter.
### Return type ### Return type
[**Vec<crate::models::Subscription>**](Subscription.md) [**Vec<models::Subscription>**](Subscription.md)
### Authorization ### Authorization

View File

@ -4,7 +4,7 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**error** | Option<[**crate::models::Response**](Response.md)> | | [optional] **error** | Option<[**models::Response**](Response.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -7,7 +7,7 @@ Name | Type | Description | Notes
**favorite_id** | **String** | MUST be either AvatarID, UserID or WorldID. | **favorite_id** | **String** | MUST be either AvatarID, UserID or WorldID. |
**id** | **String** | | **id** | **String** | |
**tags** | **Vec<String>** | | **tags** | **Vec<String>** | |
**r#type** | [**crate::models::FavoriteType**](FavoriteType.md) | | **r#type** | [**models::FavoriteType**](FavoriteType.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -10,8 +10,8 @@ Name | Type | Description | Notes
**owner_display_name** | **String** | | **owner_display_name** | **String** | |
**owner_id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | **owner_id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. |
**tags** | **Vec<String>** | | **tags** | **Vec<String>** | |
**r#type** | [**crate::models::FavoriteType**](FavoriteType.md) | | **r#type** | [**models::FavoriteType**](FavoriteType.md) | |
**visibility** | [**crate::models::FavoriteGroupVisibility**](FavoriteGroupVisibility.md) | | **visibility** | [**models::FavoriteGroupVisibility**](FavoriteGroupVisibility.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,13 @@
# FavoriteGroupVisibility # FavoriteGroupVisibility
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Private | private |
| Friends | friends |
| Public | public |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,13 @@
# FavoriteType # FavoriteType
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| World | world |
| Friend | friend |
| Avatar | avatar |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -17,7 +17,7 @@ Method | HTTP request | Description
## add_favorite ## add_favorite
> crate::models::Favorite add_favorite(add_favorite_request) > models::Favorite add_favorite(add_favorite_request)
Add Favorite Add Favorite
Add a new favorite. Friend groups are named `group_0` through `group_3`. Avatar and World groups are named `avatars1` to `avatars4` and `worlds1` to `worlds4`. You cannot add people whom you are not friends with to your friends list. Destroying a friendship removes the person as favorite on both sides. Add a new favorite. Friend groups are named `group_0` through `group_3`. Avatar and World groups are named `avatars1` to `avatars4` and `worlds1` to `worlds4`. You cannot add people whom you are not friends with to your friends list. Destroying a friendship removes the person as favorite on both sides.
@ -31,7 +31,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Favorite**](Favorite.md) [**models::Favorite**](Favorite.md)
### Authorization ### Authorization
@ -47,7 +47,7 @@ Name | Type | Description | Required | Notes
## clear_favorite_group ## clear_favorite_group
> crate::models::Success clear_favorite_group(favorite_group_type, favorite_group_name, user_id) > models::Success clear_favorite_group(favorite_group_type, favorite_group_name, user_id)
Clear Favorite Group Clear Favorite Group
Clear ALL contents of a specific favorite group. Clear ALL contents of a specific favorite group.
@ -63,7 +63,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Success**](Success.md) [**models::Success**](Success.md)
### Authorization ### Authorization
@ -79,7 +79,7 @@ Name | Type | Description | Required | Notes
## get_favorite ## get_favorite
> crate::models::Favorite get_favorite(favorite_id) > models::Favorite get_favorite(favorite_id)
Show Favorite Show Favorite
Return information about a specific Favorite. Return information about a specific Favorite.
@ -93,7 +93,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Favorite**](Favorite.md) [**models::Favorite**](Favorite.md)
### Authorization ### Authorization
@ -109,7 +109,7 @@ Name | Type | Description | Required | Notes
## get_favorite_group ## get_favorite_group
> crate::models::FavoriteGroup get_favorite_group(favorite_group_type, favorite_group_name, user_id) > models::FavoriteGroup get_favorite_group(favorite_group_type, favorite_group_name, user_id)
Show Favorite Group Show Favorite Group
Fetch information about a specific favorite group. Fetch information about a specific favorite group.
@ -125,7 +125,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::FavoriteGroup**](FavoriteGroup.md) [**models::FavoriteGroup**](FavoriteGroup.md)
### Authorization ### Authorization
@ -141,7 +141,7 @@ Name | Type | Description | Required | Notes
## get_favorite_groups ## get_favorite_groups
> Vec<crate::models::FavoriteGroup> get_favorite_groups(n, offset, owner_id) > Vec<models::FavoriteGroup> get_favorite_groups(n, offset, owner_id)
List Favorite Groups List Favorite Groups
Return a list of favorite groups owned by a user. Returns the same information as `getFavoriteGroups`. Return a list of favorite groups owned by a user. Returns the same information as `getFavoriteGroups`.
@ -157,7 +157,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::FavoriteGroup>**](FavoriteGroup.md) [**Vec<models::FavoriteGroup>**](FavoriteGroup.md)
### Authorization ### Authorization
@ -173,7 +173,7 @@ Name | Type | Description | Required | Notes
## get_favorites ## get_favorites
> Vec<crate::models::Favorite> get_favorites(n, offset, r#type, tag) > Vec<models::Favorite> get_favorites(n, offset, r#type, tag)
List Favorites List Favorites
Returns a list of favorites. Returns a list of favorites.
@ -190,7 +190,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::Favorite>**](Favorite.md) [**Vec<models::Favorite>**](Favorite.md)
### Authorization ### Authorization
@ -206,7 +206,7 @@ Name | Type | Description | Required | Notes
## remove_favorite ## remove_favorite
> crate::models::Success remove_favorite(favorite_id) > models::Success remove_favorite(favorite_id)
Remove Favorite Remove Favorite
Remove a favorite from your favorites list. Remove a favorite from your favorites list.
@ -220,7 +220,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Success**](Success.md) [**models::Success**](Success.md)
### Authorization ### Authorization

View File

@ -6,11 +6,11 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**extension** | **String** | | **extension** | **String** | |
**id** | **String** | | **id** | **String** | |
**mime_type** | [**crate::models::MimeType**](MIMEType.md) | | **mime_type** | [**models::MimeType**](MIMEType.md) | |
**name** | **String** | | **name** | **String** | |
**owner_id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | **owner_id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. |
**tags** | **Vec<String>** | | **tags** | **Vec<String>** | |
**versions** | [**Vec<crate::models::FileVersion>**](FileVersion.md) | | **versions** | [**Vec<models::FileVersion>**](FileVersion.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -8,7 +8,7 @@ Name | Type | Description | Notes
**file_name** | **String** | | **file_name** | **String** | |
**md5** | **String** | | **md5** | **String** | |
**size_in_bytes** | **i32** | | **size_in_bytes** | **i32** | |
**status** | [**crate::models::FileStatus**](FileStatus.md) | | **status** | [**models::FileStatus**](FileStatus.md) | |
**upload_id** | **String** | | [default to ] **upload_id** | **String** | | [default to ]
**url** | **String** | | **url** | **String** | |

View File

@ -1,9 +1,14 @@
# FileStatus # FileStatus
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Waiting | waiting |
| Complete | complete |
| None | none |
| Queued | queued |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -6,10 +6,10 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**created_at** | **String** | | **created_at** | **String** | |
**deleted** | Option<**bool**> | Usually only present if `true` | [optional][default to true] **deleted** | Option<**bool**> | Usually only present if `true` | [optional][default to true]
**delta** | Option<[**crate::models::FileData**](FileData.md)> | | [optional] **delta** | Option<[**models::FileData**](FileData.md)> | | [optional]
**file** | Option<[**crate::models::FileData**](FileData.md)> | | [optional] **file** | Option<[**models::FileData**](FileData.md)> | | [optional]
**signature** | Option<[**crate::models::FileData**](FileData.md)> | | [optional] **signature** | Option<[**models::FileData**](FileData.md)> | | [optional]
**status** | [**crate::models::FileStatus**](FileStatus.md) | | **status** | [**models::FileStatus**](FileStatus.md) | |
**version** | **i32** | Incremental version counter, can only be increased. | [default to 0] **version** | **i32** | Incremental version counter, can only be increased. | [default to 0]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -6,8 +6,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**upload_id** | **String** | | **upload_id** | **String** | |
**file_name** | **String** | | **file_name** | **String** | |
**next_part_number** | **f32** | | **next_part_number** | **f64** | |
**max_parts** | **f32** | | **max_parts** | **f64** | |
**parts** | [**Vec<serde_json::Value>**](serde_json::Value.md) | | **parts** | [**Vec<serde_json::Value>**](serde_json::Value.md) | |
**etags** | [**Vec<serde_json::Value>**](serde_json::Value.md) | Unknown | **etags** | [**Vec<serde_json::Value>**](serde_json::Value.md) | Unknown |

View File

@ -19,7 +19,7 @@ Method | HTTP request | Description
## create_file ## create_file
> crate::models::File create_file(create_file_request) > models::File create_file(create_file_request)
Create File Create File
Creates a new File object Creates a new File object
@ -33,7 +33,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::File**](File.md) [**models::File**](File.md)
### Authorization ### Authorization
@ -49,7 +49,7 @@ Name | Type | Description | Required | Notes
## create_file_version ## create_file_version
> crate::models::File create_file_version(file_id, create_file_version_request) > models::File create_file_version(file_id, create_file_version_request)
Create File Version Create File Version
Creates a new FileVersion. Once a Version has been created, proceed to the `/file/{fileId}/{versionId}/file/start` endpoint to start a file upload. Creates a new FileVersion. Once a Version has been created, proceed to the `/file/{fileId}/{versionId}/file/start` endpoint to start a file upload.
@ -64,7 +64,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::File**](File.md) [**models::File**](File.md)
### Authorization ### Authorization
@ -80,7 +80,7 @@ Name | Type | Description | Required | Notes
## delete_file ## delete_file
> crate::models::Success delete_file(file_id) > models::Success delete_file(file_id)
Delete File Delete File
Deletes a File object. Deletes a File object.
@ -94,7 +94,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Success**](Success.md) [**models::Success**](Success.md)
### Authorization ### Authorization
@ -110,7 +110,7 @@ Name | Type | Description | Required | Notes
## delete_file_version ## delete_file_version
> crate::models::File delete_file_version(file_id, version_id) > models::File delete_file_version(file_id, version_id)
Delete File Version Delete File Version
Delete a specific version of a file. You can only delete the latest version. Delete a specific version of a file. You can only delete the latest version.
@ -125,7 +125,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::File**](File.md) [**models::File**](File.md)
### Authorization ### Authorization
@ -172,7 +172,7 @@ Name | Type | Description | Required | Notes
## finish_file_data_upload ## finish_file_data_upload
> crate::models::File finish_file_data_upload(file_id, version_id, file_type, finish_file_data_upload_request) > models::File finish_file_data_upload(file_id, version_id, file_type, finish_file_data_upload_request)
Finish FileData Upload Finish FileData Upload
Finish an upload of a FileData. This will mark it as \"complete\". After uploading the `file` for Avatars and Worlds you then have to upload a `signature` file. Finish an upload of a FileData. This will mark it as \"complete\". After uploading the `file` for Avatars and Worlds you then have to upload a `signature` file.
@ -189,7 +189,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::File**](File.md) [**models::File**](File.md)
### Authorization ### Authorization
@ -205,7 +205,7 @@ Name | Type | Description | Required | Notes
## get_file ## get_file
> crate::models::File get_file(file_id) > models::File get_file(file_id)
Show File Show File
Shows general information about the \"File\" object. Each File can have several \"Version\"'s, and each Version can have multiple real files or \"Data\" blobs. Shows general information about the \"File\" object. Each File can have several \"Version\"'s, and each Version can have multiple real files or \"Data\" blobs.
@ -219,7 +219,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::File**](File.md) [**models::File**](File.md)
### Authorization ### Authorization
@ -235,7 +235,7 @@ Name | Type | Description | Required | Notes
## get_file_data_upload_status ## get_file_data_upload_status
> crate::models::FileVersionUploadStatus get_file_data_upload_status(file_id, version_id, file_type) > models::FileVersionUploadStatus get_file_data_upload_status(file_id, version_id, file_type)
Check FileData Upload Status Check FileData Upload Status
Retrieves the upload status for file upload. Can currently only be accessed when `status` is `waiting`. Trying to access it on a file version already uploaded currently times out. Retrieves the upload status for file upload. Can currently only be accessed when `status` is `waiting`. Trying to access it on a file version already uploaded currently times out.
@ -251,7 +251,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::FileVersionUploadStatus**](FileVersionUploadStatus.md) [**models::FileVersionUploadStatus**](FileVersionUploadStatus.md)
### Authorization ### Authorization
@ -267,7 +267,7 @@ Name | Type | Description | Required | Notes
## get_files ## get_files
> Vec<crate::models::File> get_files(tag, user_id, n, offset) > Vec<models::File> get_files(tag, user_id, n, offset)
List Files List Files
Returns a list of files Returns a list of files
@ -284,7 +284,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::File>**](File.md) [**Vec<models::File>**](File.md)
### Authorization ### Authorization
@ -300,7 +300,7 @@ Name | Type | Description | Required | Notes
## start_file_data_upload ## start_file_data_upload
> crate::models::FileUploadUrl start_file_data_upload(file_id, version_id, file_type, part_number) > models::FileUploadUrl start_file_data_upload(file_id, version_id, file_type, part_number)
Start FileData Upload Start FileData Upload
Starts an upload of a specific FilePart. This endpoint will return an AWS URL which you can PUT data to. You need to call this and receive a new AWS API URL for each `partNumber`. Please see AWS's REST documentation on \"PUT Object to S3\" on how to upload. Once all parts has been uploaded, proceed to `/finish` endpoint. **Note:** `nextPartNumber` seems like it is always ignored. Despite it returning 0, first partNumber is always 1. Starts an upload of a specific FilePart. This endpoint will return an AWS URL which you can PUT data to. You need to call this and receive a new AWS API URL for each `partNumber`. Please see AWS's REST documentation on \"PUT Object to S3\" on how to upload. Once all parts has been uploaded, proceed to `/finish` endpoint. **Note:** `nextPartNumber` seems like it is always ignored. Despite it returning 0, first partNumber is always 1.
@ -317,7 +317,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::FileUploadUrl**](FileUploadURL.md) [**models::FileUploadUrl**](FileUploadURL.md)
### Authorization ### Authorization

View File

@ -14,7 +14,7 @@ Method | HTTP request | Description
## delete_friend_request ## delete_friend_request
> crate::models::Success delete_friend_request(user_id) > models::Success delete_friend_request(user_id)
Delete Friend Request Delete Friend Request
Deletes an outgoing pending friend request to another user. To delete an incoming friend request, use the `deleteNotification` endpoint instead. Deletes an outgoing pending friend request to another user. To delete an incoming friend request, use the `deleteNotification` endpoint instead.
@ -28,7 +28,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Success**](Success.md) [**models::Success**](Success.md)
### Authorization ### Authorization
@ -44,7 +44,7 @@ Name | Type | Description | Required | Notes
## friend ## friend
> crate::models::Notification friend(user_id) > models::Notification friend(user_id)
Send Friend Request Send Friend Request
Send a friend request to another user. Send a friend request to another user.
@ -58,7 +58,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Notification**](Notification.md) [**models::Notification**](Notification.md)
### Authorization ### Authorization
@ -74,7 +74,7 @@ Name | Type | Description | Required | Notes
## get_friend_status ## get_friend_status
> crate::models::FriendStatus get_friend_status(user_id) > models::FriendStatus get_friend_status(user_id)
Check Friend Status Check Friend Status
Retrieve if the user is currently a friend with a given user, if they have an outgoing friend request, and if they have an incoming friend request. The proper way to receive and accept friend request is by checking if the user has an incoming `Notification` of type `friendRequest`, and then accepting that notification. Retrieve if the user is currently a friend with a given user, if they have an outgoing friend request, and if they have an incoming friend request. The proper way to receive and accept friend request is by checking if the user has an incoming `Notification` of type `friendRequest`, and then accepting that notification.
@ -88,7 +88,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::FriendStatus**](FriendStatus.md) [**models::FriendStatus**](FriendStatus.md)
### Authorization ### Authorization
@ -104,7 +104,7 @@ Name | Type | Description | Required | Notes
## get_friends ## get_friends
> Vec<crate::models::LimitedUser> get_friends(offset, n, offline) > Vec<models::LimitedUser> get_friends(offset, n, offline)
List Friends List Friends
List information about friends. List information about friends.
@ -120,7 +120,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::LimitedUser>**](LimitedUser.md) [**Vec<models::LimitedUser>**](LimitedUser.md)
### Authorization ### Authorization
@ -136,7 +136,7 @@ Name | Type | Description | Required | Notes
## unfriend ## unfriend
> crate::models::Success unfriend(user_id) > models::Success unfriend(user_id)
Unfriend Unfriend
Unfriend a user by ID. Unfriend a user by ID.
@ -150,7 +150,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Success**](Success.md) [**models::Success**](Success.md)
### Authorization ### Authorization

View File

@ -11,7 +11,7 @@ Name | Type | Description | Notes
**description** | Option<**String**> | | [optional] **description** | Option<**String**> | | [optional]
**icon_url** | Option<**String**> | | [optional] **icon_url** | Option<**String**> | | [optional]
**banner_url** | Option<**String**> | | [optional] **banner_url** | Option<**String**> | | [optional]
**privacy** | Option<[**crate::models::GroupPrivacy**](GroupPrivacy.md)> | | [optional] **privacy** | Option<[**models::GroupPrivacy**](GroupPrivacy.md)> | | [optional]
**owner_id** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] **owner_id** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional]
**rules** | Option<**String**> | | [optional] **rules** | Option<**String**> | | [optional]
**links** | Option<**Vec<String>**> | | [optional] **links** | Option<**Vec<String>**> | | [optional]
@ -21,14 +21,14 @@ Name | Type | Description | Notes
**member_count** | Option<**i32**> | | [optional] **member_count** | Option<**i32**> | | [optional]
**member_count_synced_at** | Option<**String**> | | [optional] **member_count_synced_at** | Option<**String**> | | [optional]
**is_verified** | Option<**bool**> | | [optional][default to false] **is_verified** | Option<**bool**> | | [optional][default to false]
**join_state** | Option<[**crate::models::GroupJoinState**](GroupJoinState.md)> | | [optional] **join_state** | Option<[**models::GroupJoinState**](GroupJoinState.md)> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional] **tags** | Option<**Vec<String>**> | | [optional]
**galleries** | Option<[**Vec<crate::models::GroupGallery>**](GroupGallery.md)> | | [optional] **galleries** | Option<[**Vec<models::GroupGallery>**](GroupGallery.md)> | | [optional]
**created_at** | Option<**String**> | | [optional] **created_at** | Option<**String**> | | [optional]
**online_member_count** | Option<**i32**> | | [optional] **online_member_count** | Option<**i32**> | | [optional]
**membership_status** | Option<[**crate::models::GroupMemberStatus**](GroupMemberStatus.md)> | | [optional] **membership_status** | Option<[**models::GroupMemberStatus**](GroupMemberStatus.md)> | | [optional]
**my_member** | Option<[**crate::models::GroupMyMember**](GroupMyMember.md)> | | [optional] **my_member** | Option<[**models::GroupMyMember**](GroupMyMember.md)> | | [optional]
**roles** | Option<[**Vec<crate::models::GroupRole>**](GroupRole.md)> | Only returned if ?includeRoles=true is specified. | [optional] **roles** | Option<[**Vec<models::GroupRole>**](GroupRole.md)> | Only returned if ?includeRoles=true is specified. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,13 @@
# GroupAccessType # GroupAccessType
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Public | public |
| Plus | plus |
| Members | members |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**instance_id** | **String** | | **instance_id** | **String** | |
**location** | **String** | InstanceID can be \"offline\" on User profiles if you are not friends with that user and \"private\" if you are friends and user is in private instance. | **location** | **String** | InstanceID can be \"offline\" on User profiles if you are not friends with that user and \"private\" if you are friends and user is in private instance. |
**world** | [**crate::models::World**](World.md) | | **world** | [**models::World**](World.md) | |
**member_count** | **i32** | | **member_count** | **i32** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,12 @@
# GroupJoinRequestAction # GroupJoinRequestAction
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Accept | accept |
| Reject | reject |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,14 @@
# GroupJoinState # GroupJoinState
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Closed | closed |
| Invite | invite |
| Request | request |
| Open | open |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -11,7 +11,7 @@ Name | Type | Description | Notes
**role_ids** | Option<**Vec<String>**> | | [optional] **role_ids** | Option<**Vec<String>**> | | [optional]
**m_role_ids** | Option<**Vec<String>**> | | [optional] **m_role_ids** | Option<**Vec<String>**> | | [optional]
**joined_at** | Option<**String**> | | [optional] **joined_at** | Option<**String**> | | [optional]
**membership_status** | Option<[**crate::models::GroupMemberStatus**](GroupMemberStatus.md)> | | [optional] **membership_status** | Option<[**models::GroupMemberStatus**](GroupMemberStatus.md)> | | [optional]
**visibility** | Option<**String**> | | [optional] **visibility** | Option<**String**> | | [optional]
**is_subscribed_to_announcements** | Option<**bool**> | | [optional][default to false] **is_subscribed_to_announcements** | Option<**bool**> | | [optional][default to false]
**created_at** | Option<**String**> | Only visible via the /groups/:groupId/members endpoint, **not** when fetching a specific user. | [optional] **created_at** | Option<**String**> | Only visible via the /groups/:groupId/members endpoint, **not** when fetching a specific user. | [optional]

View File

@ -8,11 +8,11 @@ Name | Type | Description | Notes
**group_id** | Option<**String**> | | [optional] **group_id** | Option<**String**> | | [optional]
**user_id** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] **user_id** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional]
**is_representing** | Option<**bool**> | Whether the user is representing the group. This makes the group show up above the name tag in-game. | [optional][default to false] **is_representing** | Option<**bool**> | Whether the user is representing the group. This makes the group show up above the name tag in-game. | [optional][default to false]
**user** | Option<[**crate::models::GroupMemberLimitedUser**](GroupMemberLimitedUser.md)> | | [optional] **user** | Option<[**models::GroupMemberLimitedUser**](GroupMemberLimitedUser.md)> | | [optional]
**role_ids** | Option<**Vec<String>**> | | [optional] **role_ids** | Option<**Vec<String>**> | | [optional]
**m_role_ids** | Option<**Vec<String>**> | | [optional] **m_role_ids** | Option<**Vec<String>**> | | [optional]
**joined_at** | Option<**String**> | | [optional] **joined_at** | Option<**String**> | | [optional]
**membership_status** | Option<[**crate::models::GroupMemberStatus**](GroupMemberStatus.md)> | | [optional] **membership_status** | Option<[**models::GroupMemberStatus**](GroupMemberStatus.md)> | | [optional]
**visibility** | Option<**String**> | | [optional] **visibility** | Option<**String**> | | [optional]
**is_subscribed_to_announcements** | Option<**bool**> | | [optional][default to false] **is_subscribed_to_announcements** | Option<**bool**> | | [optional][default to false]
**created_at** | Option<**String**> | Only visible via the /groups/:groupId/members endpoint, **not** when fetching a specific user. | [optional] **created_at** | Option<**String**> | Only visible via the /groups/:groupId/members endpoint, **not** when fetching a specific user. | [optional]

View File

@ -1,9 +1,16 @@
# GroupMemberStatus # GroupMemberStatus
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Inactive | inactive |
| Member | member |
| Requested | requested |
| Invited | invited |
| Banned | banned |
| Userblocked | userblocked |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -8,7 +8,7 @@ Name | Type | Description | Notes
**group_id** | Option<**String**> | | [optional] **group_id** | Option<**String**> | | [optional]
**author_id** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] **author_id** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional]
**editor_id** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] **editor_id** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional]
**visibility** | Option<[**crate::models::GroupPostVisibility**](GroupPostVisibility.md)> | | [optional] **visibility** | Option<[**models::GroupPostVisibility**](GroupPostVisibility.md)> | | [optional]
**role_id** | Option<**Vec<String>**> | | [optional] **role_id** | Option<**Vec<String>**> | | [optional]
**title** | Option<**String**> | | [optional] **title** | Option<**String**> | | [optional]
**text** | Option<**String**> | | [optional] **text** | Option<**String**> | | [optional]

View File

@ -1,9 +1,12 @@
# GroupPostVisibility # GroupPostVisibility
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Group | group |
| Public | public |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,12 @@
# GroupPrivacy # GroupPrivacy
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Default | default |
| Private | private |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,14 @@
# GroupRoleTemplate # GroupRoleTemplate
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Default | default |
| ManagedFree | managedFree |
| ManagedInvite | managedInvite |
| ManagedRequest | managedRequest |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,12 @@
# GroupSearchSort # GroupSearchSort
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Asc | joinedAt:asc |
| Desc | joinedAt:desc |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,13 @@
# GroupUserVisibility # GroupUserVisibility
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Visible | visible |
| Hidden | hidden |
| Friends | friends |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -51,7 +51,7 @@ Method | HTTP request | Description
## add_group_gallery_image ## add_group_gallery_image
> crate::models::GroupGalleryImage add_group_gallery_image(group_id, group_gallery_id, add_group_gallery_image_request) > models::GroupGalleryImage add_group_gallery_image(group_id, group_gallery_id, add_group_gallery_image_request)
Add Group Gallery Image Add Group Gallery Image
Adds an image to a Group gallery. Adds an image to a Group gallery.
@ -67,7 +67,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::GroupGalleryImage**](GroupGalleryImage.md) [**models::GroupGalleryImage**](GroupGalleryImage.md)
### Authorization ### Authorization
@ -115,7 +115,7 @@ Name | Type | Description | Required | Notes
## add_group_post ## add_group_post
> crate::models::GroupPost add_group_post(group_id, create_group_post_request) > models::GroupPost add_group_post(group_id, create_group_post_request)
Create a post in a Group Create a post in a Group
Create a post in a Group. Create a post in a Group.
@ -130,7 +130,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::GroupPost**](GroupPost.md) [**models::GroupPost**](GroupPost.md)
### Authorization ### Authorization
@ -146,7 +146,7 @@ Name | Type | Description | Required | Notes
## ban_group_member ## ban_group_member
> crate::models::GroupMember ban_group_member(group_id, ban_group_member_request) > models::GroupMember ban_group_member(group_id, ban_group_member_request)
Ban Group Member Ban Group Member
Bans a user from a Group. Bans a user from a Group.
@ -161,7 +161,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::GroupMember**](GroupMember.md) [**models::GroupMember**](GroupMember.md)
### Authorization ### Authorization
@ -207,7 +207,7 @@ Name | Type | Description | Required | Notes
## create_group ## create_group
> crate::models::Group create_group(create_group_request) > models::Group create_group(create_group_request)
Create Group Create Group
Creates a Group and returns a Group object. **Requires VRC+ Subscription.** Creates a Group and returns a Group object. **Requires VRC+ Subscription.**
@ -221,7 +221,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Group**](Group.md) [**models::Group**](Group.md)
### Authorization ### Authorization
@ -237,7 +237,7 @@ Name | Type | Description | Required | Notes
## create_group_announcement ## create_group_announcement
> crate::models::GroupAnnouncement create_group_announcement(group_id, create_group_announcement_request) > models::GroupAnnouncement create_group_announcement(group_id, create_group_announcement_request)
Create Group Announcement Create Group Announcement
Creates an Announcement for a Group. Creates an Announcement for a Group.
@ -252,7 +252,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::GroupAnnouncement**](GroupAnnouncement.md) [**models::GroupAnnouncement**](GroupAnnouncement.md)
### Authorization ### Authorization
@ -268,7 +268,7 @@ Name | Type | Description | Required | Notes
## create_group_gallery ## create_group_gallery
> crate::models::GroupGallery create_group_gallery(group_id, create_group_gallery_request) > models::GroupGallery create_group_gallery(group_id, create_group_gallery_request)
Create Group Gallery Create Group Gallery
Creates a gallery for a Group. Creates a gallery for a Group.
@ -283,7 +283,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::GroupGallery**](GroupGallery.md) [**models::GroupGallery**](GroupGallery.md)
### Authorization ### Authorization
@ -330,7 +330,7 @@ Name | Type | Description | Required | Notes
## create_group_role ## create_group_role
> crate::models::GroupRole create_group_role(group_id, create_group_role_request) > models::GroupRole create_group_role(group_id, create_group_role_request)
Create GroupRole Create GroupRole
Create a Group role. Create a Group role.
@ -345,7 +345,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::GroupRole**](GroupRole.md) [**models::GroupRole**](GroupRole.md)
### Authorization ### Authorization
@ -361,7 +361,7 @@ Name | Type | Description | Required | Notes
## delete_group ## delete_group
> crate::models::Success delete_group(group_id) > models::Success delete_group(group_id)
Delete Group Delete Group
Deletes a Group. Deletes a Group.
@ -375,7 +375,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Success**](Success.md) [**models::Success**](Success.md)
### Authorization ### Authorization
@ -391,7 +391,7 @@ Name | Type | Description | Required | Notes
## delete_group_announcement ## delete_group_announcement
> crate::models::Success delete_group_announcement(group_id) > models::Success delete_group_announcement(group_id)
Delete Group Announcement Delete Group Announcement
Deletes the announcement for a Group. Deletes the announcement for a Group.
@ -405,7 +405,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Success**](Success.md) [**models::Success**](Success.md)
### Authorization ### Authorization
@ -421,7 +421,7 @@ Name | Type | Description | Required | Notes
## delete_group_gallery ## delete_group_gallery
> crate::models::Success delete_group_gallery(group_id, group_gallery_id) > models::Success delete_group_gallery(group_id, group_gallery_id)
Delete Group Gallery Delete Group Gallery
Deletes a gallery for a Group. Deletes a gallery for a Group.
@ -436,7 +436,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Success**](Success.md) [**models::Success**](Success.md)
### Authorization ### Authorization
@ -452,7 +452,7 @@ Name | Type | Description | Required | Notes
## delete_group_gallery_image ## delete_group_gallery_image
> crate::models::Success delete_group_gallery_image(group_id, group_gallery_id, group_gallery_image_id) > models::Success delete_group_gallery_image(group_id, group_gallery_id, group_gallery_image_id)
Delete Group Gallery Image Delete Group Gallery Image
Deletes an image from a Group gallery. Deletes an image from a Group gallery.
@ -468,7 +468,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Success**](Success.md) [**models::Success**](Success.md)
### Authorization ### Authorization
@ -515,7 +515,7 @@ Name | Type | Description | Required | Notes
## delete_group_post ## delete_group_post
> crate::models::Success delete_group_post(group_id, notification_id) > models::Success delete_group_post(group_id, notification_id)
Delete a Group post Delete a Group post
Delete a Group post Delete a Group post
@ -530,7 +530,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Success**](Success.md) [**models::Success**](Success.md)
### Authorization ### Authorization
@ -546,7 +546,7 @@ Name | Type | Description | Required | Notes
## delete_group_role ## delete_group_role
> Vec<crate::models::GroupRole> delete_group_role(group_id, group_role_id) > Vec<models::GroupRole> delete_group_role(group_id, group_role_id)
Delete Group Role Delete Group Role
Deletes a Group Role by ID and returns the remaining roles. Deletes a Group Role by ID and returns the remaining roles.
@ -561,7 +561,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::GroupRole>**](GroupRole.md) [**Vec<models::GroupRole>**](GroupRole.md)
### Authorization ### Authorization
@ -577,7 +577,7 @@ Name | Type | Description | Required | Notes
## get_group ## get_group
> crate::models::Group get_group(group_id, include_roles) > models::Group get_group(group_id, include_roles)
Get Group by ID Get Group by ID
Returns a single Group by ID. Returns a single Group by ID.
@ -592,7 +592,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Group**](Group.md) [**models::Group**](Group.md)
### Authorization ### Authorization
@ -608,7 +608,7 @@ Name | Type | Description | Required | Notes
## get_group_announcements ## get_group_announcements
> crate::models::GroupAnnouncement get_group_announcements(group_id) > models::GroupAnnouncement get_group_announcements(group_id)
Get Group Announcement Get Group Announcement
Returns the announcement for a Group. If no announcement has been made, then it returns **empty object**. If an announcement exists, then it will always return all fields except `imageId` and `imageUrl` which may be null. Returns the announcement for a Group. If no announcement has been made, then it returns **empty object**. If an announcement exists, then it will always return all fields except `imageId` and `imageUrl` which may be null.
@ -622,7 +622,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::GroupAnnouncement**](GroupAnnouncement.md) [**models::GroupAnnouncement**](GroupAnnouncement.md)
### Authorization ### Authorization
@ -638,7 +638,7 @@ Name | Type | Description | Required | Notes
## get_group_audit_logs ## get_group_audit_logs
> crate::models::PaginatedGroupAuditLogEntryList get_group_audit_logs(group_id, n, offset, start_date, end_date) > models::PaginatedGroupAuditLogEntryList get_group_audit_logs(group_id, n, offset, start_date, end_date)
Get Group Audit Logs Get Group Audit Logs
Returns a list of audit logs for a Group. Returns a list of audit logs for a Group.
@ -656,7 +656,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::PaginatedGroupAuditLogEntryList**](PaginatedGroupAuditLogEntryList.md) [**models::PaginatedGroupAuditLogEntryList**](PaginatedGroupAuditLogEntryList.md)
### Authorization ### Authorization
@ -672,7 +672,7 @@ Name | Type | Description | Required | Notes
## get_group_bans ## get_group_bans
> Vec<crate::models::GroupMember> get_group_bans(group_id, n, offset) > Vec<models::GroupMember> get_group_bans(group_id, n, offset)
Get Group Bans Get Group Bans
Returns a list of banned users for a Group. Returns a list of banned users for a Group.
@ -688,7 +688,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::GroupMember>**](GroupMember.md) [**Vec<models::GroupMember>**](GroupMember.md)
### Authorization ### Authorization
@ -704,7 +704,7 @@ Name | Type | Description | Required | Notes
## get_group_gallery_images ## get_group_gallery_images
> Vec<crate::models::GroupGalleryImage> get_group_gallery_images(group_id, group_gallery_id, n, offset, approved) > Vec<models::GroupGalleryImage> get_group_gallery_images(group_id, group_gallery_id, n, offset, approved)
Get Group Gallery Images Get Group Gallery Images
Returns a list of images for a Group gallery. Returns a list of images for a Group gallery.
@ -722,7 +722,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::GroupGalleryImage>**](GroupGalleryImage.md) [**Vec<models::GroupGalleryImage>**](GroupGalleryImage.md)
### Authorization ### Authorization
@ -738,7 +738,7 @@ Name | Type | Description | Required | Notes
## get_group_instances ## get_group_instances
> Vec<crate::models::GroupInstance> get_group_instances(group_id) > Vec<models::GroupInstance> get_group_instances(group_id)
Get Group Instances Get Group Instances
Returns a list of group instances Returns a list of group instances
@ -752,7 +752,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::GroupInstance>**](GroupInstance.md) [**Vec<models::GroupInstance>**](GroupInstance.md)
### Authorization ### Authorization
@ -768,7 +768,7 @@ Name | Type | Description | Required | Notes
## get_group_invites ## get_group_invites
> Vec<crate::models::GroupMember> get_group_invites(group_id, n, offset) > Vec<models::GroupMember> get_group_invites(group_id, n, offset)
Get Group Invites Sent Get Group Invites Sent
Returns a list of members that have been invited to the Group. Returns a list of members that have been invited to the Group.
@ -784,7 +784,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::GroupMember>**](GroupMember.md) [**Vec<models::GroupMember>**](GroupMember.md)
### Authorization ### Authorization
@ -800,7 +800,7 @@ Name | Type | Description | Required | Notes
## get_group_member ## get_group_member
> crate::models::GroupLimitedMember get_group_member(group_id, user_id) > models::GroupLimitedMember get_group_member(group_id, user_id)
Get Group Member Get Group Member
Returns a LimitedGroup Member. Returns a LimitedGroup Member.
@ -815,7 +815,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::GroupLimitedMember**](GroupLimitedMember.md) [**models::GroupLimitedMember**](GroupLimitedMember.md)
### Authorization ### Authorization
@ -831,7 +831,7 @@ Name | Type | Description | Required | Notes
## get_group_members ## get_group_members
> Vec<crate::models::GroupMember> get_group_members(group_id, n, offset, sort) > Vec<models::GroupMember> get_group_members(group_id, n, offset, sort)
List Group Members List Group Members
Returns a List of all **other** Group Members. This endpoint will never return the user calling the endpoint. Information about the user calling the endpoint must be found in the `myMember` field of the Group object. Returns a List of all **other** Group Members. This endpoint will never return the user calling the endpoint. Information about the user calling the endpoint must be found in the `myMember` field of the Group object.
@ -848,7 +848,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::GroupMember>**](GroupMember.md) [**Vec<models::GroupMember>**](GroupMember.md)
### Authorization ### Authorization
@ -864,7 +864,7 @@ Name | Type | Description | Required | Notes
## get_group_permissions ## get_group_permissions
> Vec<crate::models::GroupPermission> get_group_permissions(group_id) > Vec<models::GroupPermission> get_group_permissions(group_id)
List Group Permissions List Group Permissions
Returns a List of all possible/available permissions for a Group. Returns a List of all possible/available permissions for a Group.
@ -878,7 +878,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::GroupPermission>**](GroupPermission.md) [**Vec<models::GroupPermission>**](GroupPermission.md)
### Authorization ### Authorization
@ -894,7 +894,7 @@ Name | Type | Description | Required | Notes
## get_group_post ## get_group_post
> crate::models::GroupPost get_group_post(group_id, n, offset, public_only) > models::GroupPost get_group_post(group_id, n, offset, public_only)
Get posts from a Group Get posts from a Group
Get posts from a Group Get posts from a Group
@ -911,7 +911,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::GroupPost**](GroupPost.md) [**models::GroupPost**](GroupPost.md)
### Authorization ### Authorization
@ -927,7 +927,7 @@ Name | Type | Description | Required | Notes
## get_group_requests ## get_group_requests
> Vec<crate::models::GroupMember> get_group_requests(group_id, n, offset, blocked) > Vec<models::GroupMember> get_group_requests(group_id, n, offset, blocked)
Get Group Join Requests Get Group Join Requests
Returns a list of members that have requested to join the Group. Returns a list of members that have requested to join the Group.
@ -944,7 +944,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::GroupMember>**](GroupMember.md) [**Vec<models::GroupMember>**](GroupMember.md)
### Authorization ### Authorization
@ -960,7 +960,7 @@ Name | Type | Description | Required | Notes
## get_group_roles ## get_group_roles
> Vec<crate::models::GroupRole> get_group_roles(group_id) > Vec<models::GroupRole> get_group_roles(group_id)
Get Group Roles Get Group Roles
Returns a Group Role by ID. Returns a Group Role by ID.
@ -974,7 +974,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::GroupRole>**](GroupRole.md) [**Vec<models::GroupRole>**](GroupRole.md)
### Authorization ### Authorization
@ -990,7 +990,7 @@ Name | Type | Description | Required | Notes
## join_group ## join_group
> crate::models::GroupMember join_group(group_id) > models::GroupMember join_group(group_id)
Join Group Join Group
Join a Group by ID and returns the member object. Join a Group by ID and returns the member object.
@ -1004,7 +1004,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::GroupMember**](GroupMember.md) [**models::GroupMember**](GroupMember.md)
### Authorization ### Authorization
@ -1145,7 +1145,7 @@ Name | Type | Description | Required | Notes
## search_groups ## search_groups
> Vec<crate::models::LimitedGroup> search_groups(query, offset, n) > Vec<models::LimitedGroup> search_groups(query, offset, n)
Search Group Search Group
Searches Groups by name or shortCode Searches Groups by name or shortCode
@ -1161,7 +1161,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::LimitedGroup>**](LimitedGroup.md) [**Vec<models::LimitedGroup>**](LimitedGroup.md)
### Authorization ### Authorization
@ -1177,7 +1177,7 @@ No authorization required
## unban_group_member ## unban_group_member
> crate::models::GroupMember unban_group_member(group_id, user_id) > models::GroupMember unban_group_member(group_id, user_id)
Unban Group Member Unban Group Member
Unbans a user from a Group. Unbans a user from a Group.
@ -1192,7 +1192,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::GroupMember**](GroupMember.md) [**models::GroupMember**](GroupMember.md)
### Authorization ### Authorization
@ -1208,7 +1208,7 @@ Name | Type | Description | Required | Notes
## update_group ## update_group
> crate::models::Group update_group(group_id, update_group_request) > models::Group update_group(group_id, update_group_request)
Update Group Update Group
Updates a Group and returns it. Updates a Group and returns it.
@ -1223,7 +1223,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Group**](Group.md) [**models::Group**](Group.md)
### Authorization ### Authorization
@ -1239,7 +1239,7 @@ Name | Type | Description | Required | Notes
## update_group_gallery ## update_group_gallery
> crate::models::GroupGallery update_group_gallery(group_id, group_gallery_id, update_group_gallery_request) > models::GroupGallery update_group_gallery(group_id, group_gallery_id, update_group_gallery_request)
Update Group Gallery Update Group Gallery
Updates a gallery for a Group. Updates a gallery for a Group.
@ -1255,7 +1255,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::GroupGallery**](GroupGallery.md) [**models::GroupGallery**](GroupGallery.md)
### Authorization ### Authorization
@ -1271,7 +1271,7 @@ Name | Type | Description | Required | Notes
## update_group_member ## update_group_member
> crate::models::GroupLimitedMember update_group_member(group_id, user_id, update_group_member_request) > models::GroupLimitedMember update_group_member(group_id, user_id, update_group_member_request)
Update Group Member Update Group Member
Updates a Group Member Updates a Group Member
@ -1287,7 +1287,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::GroupLimitedMember**](GroupLimitedMember.md) [**models::GroupLimitedMember**](GroupLimitedMember.md)
### Authorization ### Authorization
@ -1303,7 +1303,7 @@ Name | Type | Description | Required | Notes
## update_group_post ## update_group_post
> crate::models::GroupPost update_group_post(group_id, notification_id, create_group_post_request) > models::GroupPost update_group_post(group_id, notification_id, create_group_post_request)
Edits a Group post Edits a Group post
Edits a Group post Edits a Group post
@ -1319,7 +1319,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::GroupPost**](GroupPost.md) [**models::GroupPost**](GroupPost.md)
### Authorization ### Authorization
@ -1335,7 +1335,7 @@ Name | Type | Description | Required | Notes
## update_group_role ## update_group_role
> Vec<crate::models::GroupRole> update_group_role(group_id, group_role_id, update_group_role_request) > Vec<models::GroupRole> update_group_role(group_id, group_role_id, update_group_role_request)
Update Group Role Update Group Role
Updates a group role by ID. Updates a group role by ID.
@ -1351,7 +1351,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::GroupRole>**](GroupRole.md) [**Vec<models::GroupRole>**](GroupRole.md)
### Authorization ### Authorization

View File

@ -6,10 +6,10 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**id** | **String** | | **id** | **String** | |
**is_enabled** | **bool** | | [default to true] **is_enabled** | **bool** | | [default to true]
**release_status** | [**crate::models::ReleaseStatus**](ReleaseStatus.md) | | **release_status** | [**models::ReleaseStatus**](ReleaseStatus.md) | |
**priority** | **i32** | | **priority** | **i32** | |
**tags** | **Vec<String>** | | **tags** | **Vec<String>** | |
**data** | [**crate::models::InfoPushData**](InfoPushData.md) | | **data** | [**models::InfoPushData**](InfoPushData.md) | |
**hash** | **String** | Unknown usage, MD5 | **hash** | **String** | Unknown usage, MD5 |
**created_at** | **String** | | **created_at** | **String** | |
**updated_at** | **String** | | **updated_at** | **String** | |

View File

@ -4,14 +4,14 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**content_list** | Option<[**crate::models::DynamicContentRow**](DynamicContentRow.md)> | | [optional] **content_list** | Option<[**models::DynamicContentRow**](DynamicContentRow.md)> | | [optional]
**description** | Option<**String**> | | [optional] **description** | Option<**String**> | | [optional]
**image_url** | Option<**String**> | | [optional] **image_url** | Option<**String**> | | [optional]
**name** | Option<**String**> | | [optional] **name** | Option<**String**> | | [optional]
**on_pressed** | Option<[**crate::models::InfoPushDataClickable**](InfoPushDataClickable.md)> | | [optional] **on_pressed** | Option<[**models::InfoPushDataClickable**](InfoPushDataClickable.md)> | | [optional]
**template** | Option<**String**> | | [optional] **template** | Option<**String**> | | [optional]
**version** | Option<**String**> | | [optional] **version** | Option<**String**> | | [optional]
**article** | Option<[**crate::models::InfoPushDataArticle**](InfoPushDataArticle.md)> | | [optional] **article** | Option<[**models::InfoPushDataArticle**](InfoPushDataArticle.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -4,7 +4,7 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**content** | Option<[**crate::models::InfoPushDataArticleContent**](InfoPushDataArticleContent.md)> | | [optional] **content** | Option<[**models::InfoPushDataArticleContent**](InfoPushDataArticleContent.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**text** | Option<**String**> | | [optional] **text** | Option<**String**> | | [optional]
**image_url** | Option<**String**> | | [optional] **image_url** | Option<**String**> | | [optional]
**on_pressed** | Option<[**crate::models::InfoPushDataClickable**](InfoPushDataClickable.md)> | | [optional] **on_pressed** | Option<[**models::InfoPushDataClickable**](InfoPushDataClickable.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -16,13 +16,13 @@ Name | Type | Description | Notes
**name** | **String** | | **name** | **String** | |
**owner_id** | Option<**String**> | A groupId if the instance type is \"group\", null if instance type is public, or a userId otherwise | [optional] **owner_id** | Option<**String**> | A groupId if the instance type is \"group\", null if instance type is public, or a userId otherwise | [optional]
**permanent** | **bool** | | [default to false] **permanent** | **bool** | | [default to false]
**photon_region** | [**crate::models::Region**](Region.md) | | **photon_region** | [**models::Region**](Region.md) | |
**platforms** | [**crate::models::InstancePlatforms**](InstancePlatforms.md) | | **platforms** | [**models::InstancePlatforms**](InstancePlatforms.md) | |
**region** | [**crate::models::InstanceRegion**](InstanceRegion.md) | | **region** | [**models::InstanceRegion**](InstanceRegion.md) | |
**secure_name** | **String** | | **secure_name** | **String** | |
**short_name** | Option<**String**> | | [optional] **short_name** | Option<**String**> | | [optional]
**tags** | **Vec<String>** | The tags array on Instances usually contain the language tags of the people in the instance. | **tags** | **Vec<String>** | The tags array on Instances usually contain the language tags of the people in the instance. |
**r#type** | [**crate::models::InstanceType**](InstanceType.md) | | **r#type** | [**models::InstanceType**](InstanceType.md) | |
**world_id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | **world_id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
**hidden** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] **hidden** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional]
**friends** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] **friends** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional]
@ -33,9 +33,9 @@ Name | Type | Description | Notes
**role_restricted** | Option<**bool**> | | [optional] **role_restricted** | Option<**bool**> | | [optional]
**strict** | **bool** | | **strict** | **bool** | |
**user_count** | **i32** | | **user_count** | **i32** | |
**world** | [**crate::models::World**](World.md) | | **world** | [**models::World**](World.md) | |
**users** | Option<[**Vec<crate::models::LimitedUser>**](LimitedUser.md)> | The users field is present on instances created by the requesting user. | [optional] **users** | Option<[**Vec<models::LimitedUser>**](LimitedUser.md)> | The users field is present on instances created by the requesting user. | [optional]
**group_access_type** | Option<[**crate::models::GroupAccessType**](GroupAccessType.md)> | | [optional] **group_access_type** | Option<[**models::GroupAccessType**](GroupAccessType.md)> | | [optional]
**has_capacity_for_you** | Option<**bool**> | | [optional] **has_capacity_for_you** | Option<**bool**> | | [optional]
**nonce** | Option<**String**> | | [optional] **nonce** | Option<**String**> | | [optional]
**closed_at** | Option<**String**> | | [optional] **closed_at** | Option<**String**> | | [optional]

View File

@ -1,9 +1,14 @@
# InstanceRegion # InstanceRegion
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Us | us |
| Use | use |
| Eu | eu |
| Jp | jp |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,15 @@
# InstanceType # InstanceType
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Public | public |
| Hidden | hidden |
| Friends | friends |
| Private | private |
| Group | group |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -15,7 +15,7 @@ Method | HTTP request | Description
## close_instance ## close_instance
> crate::models::Instance close_instance(world_id, instance_id, hard_close, closed_at) > models::Instance close_instance(world_id, instance_id, hard_close, closed_at)
Close Instance Close Instance
Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-moderate` permission. Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-moderate` permission.
@ -32,7 +32,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Instance**](Instance.md) [**models::Instance**](Instance.md)
### Authorization ### Authorization
@ -48,7 +48,7 @@ Name | Type | Description | Required | Notes
## create_instance ## create_instance
> crate::models::Instance create_instance(create_instance_request) > models::Instance create_instance(create_instance_request)
Create Instance Create Instance
Create an instance Create an instance
@ -62,7 +62,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Instance**](Instance.md) [**models::Instance**](Instance.md)
### Authorization ### Authorization
@ -78,7 +78,7 @@ Name | Type | Description | Required | Notes
## get_instance ## get_instance
> crate::models::Instance get_instance(world_id, instance_id) > models::Instance get_instance(world_id, instance_id)
Get Instance Get Instance
Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return \"null\"! Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return \"null\"!
@ -93,7 +93,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Instance**](Instance.md) [**models::Instance**](Instance.md)
### Authorization ### Authorization
@ -109,7 +109,7 @@ Name | Type | Description | Required | Notes
## get_instance_by_short_name ## get_instance_by_short_name
> crate::models::Instance get_instance_by_short_name(short_name) > models::Instance get_instance_by_short_name(short_name)
Get Instance By Short Name Get Instance By Short Name
Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances.
@ -123,7 +123,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Instance**](Instance.md) [**models::Instance**](Instance.md)
### Authorization ### Authorization
@ -139,7 +139,7 @@ Name | Type | Description | Required | Notes
## get_short_name ## get_short_name
> crate::models::InstanceShortNameResponse get_short_name(world_id, instance_id) > models::InstanceShortNameResponse get_short_name(world_id, instance_id)
Get Instance Short Name Get Instance Short Name
Returns an instance short name. Returns an instance short name.
@ -154,7 +154,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::InstanceShortNameResponse**](InstanceShortNameResponse.md) [**models::InstanceShortNameResponse**](InstanceShortNameResponse.md)
### Authorization ### Authorization
@ -170,7 +170,7 @@ Name | Type | Description | Required | Notes
## send_self_invite ## send_self_invite
> crate::models::Success send_self_invite(world_id, instance_id) > models::Success send_self_invite(world_id, instance_id)
Send Self Invite Send Self Invite
Sends an invite to the instance to yourself. Sends an invite to the instance to yourself.
@ -185,7 +185,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Success**](Success.md) [**models::Success**](Success.md)
### Authorization ### Authorization

View File

@ -17,7 +17,7 @@ Method | HTTP request | Description
## get_invite_message ## get_invite_message
> crate::models::InviteMessage get_invite_message(user_id, message_type, slot) > models::InviteMessage get_invite_message(user_id, message_type, slot)
Get Invite Message Get Invite Message
Returns a single Invite Message. This returns the exact same information but less than `getInviteMessages`. Admin Credentials are required to view messages of other users! Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite Returns a single Invite Message. This returns the exact same information but less than `getInviteMessages`. Admin Credentials are required to view messages of other users! Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite
@ -33,7 +33,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::InviteMessage**](InviteMessage.md) [**models::InviteMessage**](InviteMessage.md)
### Authorization ### Authorization
@ -49,7 +49,7 @@ Name | Type | Description | Required | Notes
## get_invite_messages ## get_invite_messages
> Vec<crate::models::InviteMessage> get_invite_messages(user_id, message_type) > Vec<models::InviteMessage> get_invite_messages(user_id, message_type)
List Invite Messages List Invite Messages
Returns a list of all the users Invite Messages. Admin Credentials are required to view messages of other users! Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite Returns a list of all the users Invite Messages. Admin Credentials are required to view messages of other users! Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite
@ -64,7 +64,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::InviteMessage>**](InviteMessage.md) [**Vec<models::InviteMessage>**](InviteMessage.md)
### Authorization ### Authorization
@ -80,7 +80,7 @@ Name | Type | Description | Required | Notes
## invite_myself_to ## invite_myself_to
> crate::models::SentNotification invite_myself_to(world_id, instance_id) > models::SentNotification invite_myself_to(world_id, instance_id)
Invite Myself To Instance Invite Myself To Instance
Sends self an invite to an instance Sends self an invite to an instance
@ -95,7 +95,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::SentNotification**](SentNotification.md) [**models::SentNotification**](SentNotification.md)
### Authorization ### Authorization
@ -111,7 +111,7 @@ Name | Type | Description | Required | Notes
## invite_user ## invite_user
> crate::models::SentNotification invite_user(user_id, invite_request) > models::SentNotification invite_user(user_id, invite_request)
Invite User Invite User
Sends an invite to a user. Returns the Notification of type `invite` that was sent. Sends an invite to a user. Returns the Notification of type `invite` that was sent.
@ -126,7 +126,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::SentNotification**](SentNotification.md) [**models::SentNotification**](SentNotification.md)
### Authorization ### Authorization
@ -142,7 +142,7 @@ Name | Type | Description | Required | Notes
## request_invite ## request_invite
> crate::models::Notification request_invite(user_id, request_invite_request) > models::Notification request_invite(user_id, request_invite_request)
Request Invite Request Invite
Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent. Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
@ -157,7 +157,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Notification**](Notification.md) [**models::Notification**](Notification.md)
### Authorization ### Authorization
@ -173,7 +173,7 @@ Name | Type | Description | Required | Notes
## reset_invite_message ## reset_invite_message
> Vec<crate::models::InviteMessage> reset_invite_message(user_id, message_type, slot) > Vec<models::InviteMessage> reset_invite_message(user_id, message_type, slot)
Reset Invite Message Reset Invite Message
Resets a single Invite Message back to its original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users! Resetting a message respects the rate-limit, so it is not possible to reset within the 60 minutes countdown. Resetting it does however not set the rate-limit to 60 like when editing it. It is possible to edit it right after resetting it. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite The DELETE endpoint does not have/require any request body. Resets a single Invite Message back to its original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users! Resetting a message respects the rate-limit, so it is not possible to reset within the 60 minutes countdown. Resetting it does however not set the rate-limit to 60 like when editing it. It is possible to edit it right after resetting it. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite The DELETE endpoint does not have/require any request body.
@ -189,7 +189,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::InviteMessage>**](InviteMessage.md) [**Vec<models::InviteMessage>**](InviteMessage.md)
### Authorization ### Authorization
@ -205,7 +205,7 @@ Name | Type | Description | Required | Notes
## respond_invite ## respond_invite
> crate::models::Notification respond_invite(notification_id, invite_response) > models::Notification respond_invite(notification_id, invite_response)
Respond Invite Respond Invite
Respond to an invite request by sending a world invite to the requesting user. `:notificationId` is the ID of the requesting notification. Respond to an invite request by sending a world invite to the requesting user. `:notificationId` is the ID of the requesting notification.
@ -220,7 +220,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Notification**](Notification.md) [**models::Notification**](Notification.md)
### Authorization ### Authorization
@ -236,7 +236,7 @@ Name | Type | Description | Required | Notes
## update_invite_message ## update_invite_message
> Vec<crate::models::InviteMessage> update_invite_message(user_id, message_type, slot, update_invite_message_request) > Vec<models::InviteMessage> update_invite_message(user_id, message_type, slot, update_invite_message_request)
Update Invite Message Update Invite Message
Updates a single Invite Message and then returns a list of all of them. Admin Credentials are required to update messages of other users! Updating a message automatically sets the cooldown timer to 60 minutes. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite Updates a single Invite Message and then returns a list of all of them. Admin Credentials are required to update messages of other users! Updating a message automatically sets the cooldown timer to 60 minutes. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite
@ -253,7 +253,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::InviteMessage>**](InviteMessage.md) [**Vec<models::InviteMessage>**](InviteMessage.md)
### Authorization ### Authorization

View File

@ -7,7 +7,7 @@ Name | Type | Description | Notes
**can_be_updated** | **bool** | | [default to true] **can_be_updated** | **bool** | | [default to true]
**id** | **String** | | **id** | **String** | |
**message** | **String** | | **message** | **String** | |
**message_type** | [**crate::models::InviteMessageType**](InviteMessageType.md) | | **message_type** | [**models::InviteMessageType**](InviteMessageType.md) | |
**remaining_cooldown_minutes** | **i32** | Changes to 60 when updated, although probably server-side configurable. | [default to 0] **remaining_cooldown_minutes** | **i32** | Changes to 60 when updated, although probably server-side configurable. | [default to 0]
**slot** | **i32** | | **slot** | **i32** | |
**updated_at** | **String** | | **updated_at** | **String** | |

View File

@ -1,9 +1,14 @@
# InviteMessageType # InviteMessageType
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Message | message |
| Response | response |
| Request | request |
| RequestResponse | requestResponse |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -5,9 +5,9 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**for_id** | **String** | Either a AvatarID, LicenseGroupID, PermissionID or ProductID. This depends on the `forType` field. | **for_id** | **String** | Either a AvatarID, LicenseGroupID, PermissionID or ProductID. This depends on the `forType` field. |
**for_type** | [**crate::models::LicenseType**](LicenseType.md) | | **for_type** | [**models::LicenseType**](LicenseType.md) | |
**for_name** | **String** | | **for_name** | **String** | |
**for_action** | [**crate::models::LicenseAction**](LicenseAction.md) | | **for_action** | [**models::LicenseAction**](LicenseAction.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,12 @@
# LicenseAction # LicenseAction
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Wear | wear |
| Have | have |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -7,7 +7,7 @@ Name | Type | Description | Notes
**id** | **String** | | **id** | **String** | |
**name** | **String** | | **name** | **String** | |
**description** | **String** | | **description** | **String** | |
**licenses** | [**Vec<crate::models::License>**](License.md) | | **licenses** | [**Vec<models::License>**](License.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,14 @@
# LicenseType # LicenseType
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Avatar | avatar |
| LicenseGroup | licenseGroup |
| Permission | permission |
| Product | product |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -18,9 +18,9 @@ Name | Type | Description | Notes
**member_count** | Option<**i32**> | | [optional] **member_count** | Option<**i32**> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional] **tags** | Option<**Vec<String>**> | | [optional]
**created_at** | Option<**String**> | | [optional] **created_at** | Option<**String**> | | [optional]
**membership_status** | Option<[**crate::models::GroupMemberStatus**](GroupMemberStatus.md)> | | [optional] **membership_status** | Option<[**models::GroupMemberStatus**](GroupMemberStatus.md)> | | [optional]
**is_searchable** | Option<**bool**> | | [optional] **is_searchable** | Option<**bool**> | | [optional]
**galleries** | Option<[**Vec<crate::models::GroupGallery>**](GroupGallery.md)> | | [optional] **galleries** | Option<[**Vec<models::GroupGallery>**](GroupGallery.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -9,7 +9,7 @@ Name | Type | Description | Notes
**current_avatar_image_url** | Option<**String**> | When profilePicOverride is not empty, use it instead. | [optional] **current_avatar_image_url** | Option<**String**> | When profilePicOverride is not empty, use it instead. | [optional]
**current_avatar_thumbnail_image_url** | Option<**String**> | When profilePicOverride is not empty, use it instead. | [optional] **current_avatar_thumbnail_image_url** | Option<**String**> | When profilePicOverride is not empty, use it instead. | [optional]
**current_avatar_tags** | Option<**Vec<String>**> | | [optional] **current_avatar_tags** | Option<**Vec<String>**> | | [optional]
**developer_type** | [**crate::models::DeveloperType**](DeveloperType.md) | | **developer_type** | [**models::DeveloperType**](DeveloperType.md) | |
**display_name** | **String** | | **display_name** | **String** | |
**fallback_avatar** | Option<**String**> | | [optional] **fallback_avatar** | Option<**String**> | | [optional]
**id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | **id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. |
@ -17,7 +17,7 @@ Name | Type | Description | Notes
**last_platform** | **String** | 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`. | **last_platform** | **String** | 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`. |
**profile_pic_override** | Option<**String**> | | [optional] **profile_pic_override** | Option<**String**> | | [optional]
**pronouns** | Option<**String**> | | [optional] **pronouns** | Option<**String**> | | [optional]
**status** | [**crate::models::UserStatus**](UserStatus.md) | | **status** | [**models::UserStatus**](UserStatus.md) | |
**status_description** | **String** | | **status_description** | **String** | |
**tags** | **Vec<String>** | <- Always empty. | **tags** | **Vec<String>** | <- Always empty. |
**user_icon** | Option<**String**> | | [optional] **user_icon** | Option<**String**> | | [optional]

View File

@ -21,10 +21,10 @@ Name | Type | Description | Notes
**popularity** | **i32** | | [default to 0] **popularity** | **i32** | | [default to 0]
**preview_youtube_id** | Option<**String**> | | [optional] **preview_youtube_id** | Option<**String**> | | [optional]
**publication_date** | **String** | | **publication_date** | **String** | |
**release_status** | [**crate::models::ReleaseStatus**](ReleaseStatus.md) | | **release_status** | [**models::ReleaseStatus**](ReleaseStatus.md) | |
**tags** | **Vec<String>** | | **tags** | **Vec<String>** | |
**thumbnail_image_url** | **String** | | **thumbnail_image_url** | **String** | |
**unity_packages** | [**Vec<crate::models::LimitedUnityPackage>**](LimitedUnityPackage.md) | | **unity_packages** | [**Vec<models::LimitedUnityPackage>**](LimitedUnityPackage.md) | |
**updated_at** | **String** | | **updated_at** | **String** | |
**udon_products** | Option<**Vec<String>**> | | [optional] **udon_products** | Option<**Vec<String>**> | | [optional]

View File

@ -1,9 +1,24 @@
# MimeType # MimeType
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| ImageSlashJpeg | image/jpeg |
| ImageSlashJpg | image/jpg |
| ImageSlashPng | image/png |
| ImageSlashWebp | image/webp |
| ImageSlashGif | image/gif |
| ImageSlashBmp | image/bmp |
| ImageSlashSvgxml | image/svgxml |
| ImageSlashTiff | image/tiff |
| ApplicationSlashXAvatar | application/x-avatar |
| ApplicationSlashXWorld | application/x-world |
| ApplicationSlashGzip | application/gzip |
| ApplicationSlashXRsyncSignature | application/x-rsync-signature |
| ApplicationSlashXRsyncDelta | application/x-rsync-delta |
| ApplicationSlashOctetStream | application/octet-stream |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -5,7 +5,7 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**moderated** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | **moderated** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. |
**r#type** | [**crate::models::PlayerModerationType**](PlayerModerationType.md) | | **r#type** | [**models::PlayerModerationType**](PlayerModerationType.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -12,7 +12,7 @@ Name | Type | Description | Notes
**receiver_user_id** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] **receiver_user_id** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional]
**sender_user_id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | **sender_user_id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. |
**sender_username** | Option<**String**> | -| **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). | [optional] **sender_username** | Option<**String**> | -| **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). | [optional]
**r#type** | [**crate::models::NotificationType**](NotificationType.md) | | **r#type** | [**models::NotificationType**](NotificationType.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,17 @@
# NotificationType # NotificationType
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| FriendRequest | friendRequest |
| Invite | invite |
| InviteResponse | inviteResponse |
| Message | message |
| RequestInvite | requestInvite |
| RequestInviteResponse | requestInviteResponse |
| Votetokick | votetokick |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -14,7 +14,7 @@ Method | HTTP request | Description
## accept_friend_request ## accept_friend_request
> crate::models::Success accept_friend_request(notification_id) > models::Success accept_friend_request(notification_id)
Accept Friend Request Accept Friend Request
Accept a friend request by notification `frq_` ID. Friend requests can be found using the NotificationsAPI `getNotifications` by filtering of type `friendRequest`. Accept a friend request by notification `frq_` ID. Friend requests can be found using the NotificationsAPI `getNotifications` by filtering of type `friendRequest`.
@ -28,7 +28,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Success**](Success.md) [**models::Success**](Success.md)
### Authorization ### Authorization
@ -44,7 +44,7 @@ Name | Type | Description | Required | Notes
## clear_notifications ## clear_notifications
> crate::models::Success clear_notifications() > models::Success clear_notifications()
Clear All Notifications Clear All Notifications
Clear **all** notifications. Clear **all** notifications.
@ -55,7 +55,7 @@ This endpoint does not need any parameter.
### Return type ### Return type
[**crate::models::Success**](Success.md) [**models::Success**](Success.md)
### Authorization ### Authorization
@ -71,7 +71,7 @@ This endpoint does not need any parameter.
## delete_notification ## delete_notification
> crate::models::Notification delete_notification(notification_id) > models::Notification delete_notification(notification_id)
Delete Notification Delete Notification
Delete a notification. Delete a notification.
@ -85,7 +85,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Notification**](Notification.md) [**models::Notification**](Notification.md)
### Authorization ### Authorization
@ -101,7 +101,7 @@ Name | Type | Description | Required | Notes
## get_notifications ## get_notifications
> Vec<crate::models::Notification> get_notifications(r#type, sent, hidden, after, n, offset) > Vec<models::Notification> get_notifications(r#type, sent, hidden, after, n, offset)
List Notifications List Notifications
Retrieve all of the current user's notifications. Retrieve all of the current user's notifications.
@ -120,7 +120,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::Notification>**](Notification.md) [**Vec<models::Notification>**](Notification.md)
### Authorization ### Authorization
@ -136,7 +136,7 @@ Name | Type | Description | Required | Notes
## mark_notification_as_read ## mark_notification_as_read
> crate::models::Notification mark_notification_as_read(notification_id) > models::Notification mark_notification_as_read(notification_id)
Mark Notification As Read Mark Notification As Read
Mark a notification as seen. Mark a notification as seen.
@ -150,7 +150,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Notification**](Notification.md) [**models::Notification**](Notification.md)
### Authorization ### Authorization

View File

@ -1,9 +1,12 @@
# OrderOption # OrderOption
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Ascending | ascending |
| Descending | descending |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -4,7 +4,7 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**results** | Option<[**Vec<crate::models::GroupAuditLogEntry>**](GroupAuditLogEntry.md)> | | [optional] **results** | Option<[**Vec<models::GroupAuditLogEntry>**](GroupAuditLogEntry.md)> | | [optional]
**total_count** | Option<**i32**> | The total number of results that the query would return if there were no pagination. | [optional] **total_count** | Option<**i32**> | The total number of results that the query would return if there were no pagination. | [optional]
**has_next** | Option<**bool**> | Whether there are more results after this page. | [optional] **has_next** | Option<**bool**> | Whether there are more results after this page. | [optional]

View File

@ -11,7 +11,7 @@ Method | HTTP request | Description
## get_assigned_permissions ## get_assigned_permissions
> Vec<crate::models::Permission> get_assigned_permissions() > Vec<models::Permission> get_assigned_permissions()
Get Assigned Permissions Get Assigned Permissions
Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+. Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
@ -22,7 +22,7 @@ This endpoint does not need any parameter.
### Return type ### Return type
[**Vec<crate::models::Permission>**](Permission.md) [**Vec<models::Permission>**](Permission.md)
### Authorization ### Authorization
@ -38,7 +38,7 @@ This endpoint does not need any parameter.
## get_permission ## get_permission
> crate::models::Permission get_permission(permission_id) > models::Permission get_permission(permission_id)
Get Permission Get Permission
Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`. Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
@ -52,7 +52,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Permission**](Permission.md) [**models::Permission**](Permission.md)
### Authorization ### Authorization

View File

@ -10,7 +10,7 @@ Name | Type | Description | Notes
**source_user_id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | **source_user_id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. |
**target_display_name** | **String** | | **target_display_name** | **String** | |
**target_user_id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | **target_user_id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. |
**r#type** | [**crate::models::PlayerModerationType**](PlayerModerationType.md) | | **r#type** | [**models::PlayerModerationType**](PlayerModerationType.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,16 @@
# PlayerModerationType # PlayerModerationType
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Mute | mute |
| Unmute | unmute |
| Block | block |
| Unblock | unblock |
| InteractOn | interactOn |
| InteractOff | interactOff |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -15,7 +15,7 @@ Method | HTTP request | Description
## clear_all_player_moderations ## clear_all_player_moderations
> crate::models::Success clear_all_player_moderations() > models::Success clear_all_player_moderations()
Clear All Player Moderations Clear All Player Moderations
⚠️ **This will delete every single player moderation you've ever made.** ⚠️ **This will delete every single player moderation you've ever made.**
@ -26,7 +26,7 @@ This endpoint does not need any parameter.
### Return type ### Return type
[**crate::models::Success**](Success.md) [**models::Success**](Success.md)
### Authorization ### Authorization
@ -42,7 +42,7 @@ This endpoint does not need any parameter.
## delete_player_moderation ## delete_player_moderation
> crate::models::Success delete_player_moderation(player_moderation_id) > models::Success delete_player_moderation(player_moderation_id)
Delete Player Moderation Delete Player Moderation
Deletes a specific player moderation based on it's `pmod_` ID. The website uses `unmoderateUser` instead. You can delete the same player moderation multiple times successfully. Deletes a specific player moderation based on it's `pmod_` ID. The website uses `unmoderateUser` instead. You can delete the same player moderation multiple times successfully.
@ -56,7 +56,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Success**](Success.md) [**models::Success**](Success.md)
### Authorization ### Authorization
@ -72,7 +72,7 @@ Name | Type | Description | Required | Notes
## get_player_moderation ## get_player_moderation
> crate::models::PlayerModeration get_player_moderation(player_moderation_id) > models::PlayerModeration get_player_moderation(player_moderation_id)
Get Player Moderation Get Player Moderation
Returns a single Player Moderation. This returns the exact same amount of information as the more generalised `getPlayerModerations`. Returns a single Player Moderation. This returns the exact same amount of information as the more generalised `getPlayerModerations`.
@ -86,7 +86,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::PlayerModeration**](PlayerModeration.md) [**models::PlayerModeration**](PlayerModeration.md)
### Authorization ### Authorization
@ -102,7 +102,7 @@ Name | Type | Description | Required | Notes
## get_player_moderations ## get_player_moderations
> Vec<crate::models::PlayerModeration> get_player_moderations(r#type, target_user_id) > Vec<models::PlayerModeration> get_player_moderations(r#type, target_user_id)
Search Player Moderations Search Player Moderations
Returns a list of all player moderations made by **you**. This endpoint does not have pagination, and will return *all* results. Use query parameters to limit your query if needed. Returns a list of all player moderations made by **you**. This endpoint does not have pagination, and will return *all* results. Use query parameters to limit your query if needed.
@ -117,7 +117,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::PlayerModeration>**](PlayerModeration.md) [**Vec<models::PlayerModeration>**](PlayerModeration.md)
### Authorization ### Authorization
@ -133,7 +133,7 @@ Name | Type | Description | Required | Notes
## moderate_user ## moderate_user
> crate::models::PlayerModeration moderate_user(moderate_user_request) > models::PlayerModeration moderate_user(moderate_user_request)
Moderate User Moderate User
Moderate a user, e.g. unmute them or show their avatar. Please see the [Player Moderation docs](https://vrchatapi.github.io/docs/api/#tag--playermoderation) on what playerModerations are, and how they differ from staff moderations. Moderate a user, e.g. unmute them or show their avatar. Please see the [Player Moderation docs](https://vrchatapi.github.io/docs/api/#tag--playermoderation) on what playerModerations are, and how they differ from staff moderations.
@ -147,7 +147,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::PlayerModeration**](PlayerModeration.md) [**models::PlayerModeration**](PlayerModeration.md)
### Authorization ### Authorization
@ -163,7 +163,7 @@ Name | Type | Description | Required | Notes
## unmoderate_user ## unmoderate_user
> crate::models::Success unmoderate_user(moderate_user_request) > models::Success unmoderate_user(moderate_user_request)
Unmoderate User Unmoderate User
Removes a player moderation previously added through `moderateUser`. E.g if you previously have shown their avatar, but now want to reset it to default. Removes a player moderation previously added through `moderateUser`. E.g if you previously have shown their avatar, but now want to reset it to default.
@ -177,7 +177,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::Success**](Success.md) [**models::Success**](Success.md)
### Authorization ### Authorization

View File

@ -1,9 +1,16 @@
# Region # Region
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Us | us |
| Use | use |
| Usw | usw |
| Eu | eu |
| Jp | jp |
| Unknown | unknown |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,14 @@
# ReleaseStatus # ReleaseStatus
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Public | public |
| Private | private |
| Hidden | hidden |
| All | all |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -12,11 +12,11 @@ Name | Type | Description | Notes
**icon_url** | Option<**String**> | | [optional] **icon_url** | Option<**String**> | | [optional]
**banner_id** | Option<**String**> | | [optional] **banner_id** | Option<**String**> | | [optional]
**banner_url** | Option<**String**> | | [optional] **banner_url** | Option<**String**> | | [optional]
**privacy** | Option<[**crate::models::GroupPrivacy**](GroupPrivacy.md)> | | [optional] **privacy** | Option<[**models::GroupPrivacy**](GroupPrivacy.md)> | | [optional]
**owner_id** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] **owner_id** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional]
**member_count** | Option<**i32**> | | [optional] **member_count** | Option<**i32**> | | [optional]
**group_id** | Option<**String**> | | [optional] **group_id** | Option<**String**> | | [optional]
**member_visibility** | Option<[**crate::models::GroupUserVisibility**](GroupUserVisibility.md)> | | [optional] **member_visibility** | Option<[**models::GroupUserVisibility**](GroupUserVisibility.md)> | | [optional]
**is_representing** | Option<**bool**> | | [optional] **is_representing** | Option<**bool**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -4,7 +4,7 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**action** | [**crate::models::GroupJoinRequestAction**](GroupJoinRequestAction.md) | | **action** | [**models::GroupJoinRequestAction**](GroupJoinRequestAction.md) | |
**block** | Option<**bool**> | Whether to block the user from requesting again | [optional] **block** | Option<**bool**> | Whether to block the user from requesting again | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -11,7 +11,7 @@ Name | Type | Description | Notes
**receiver_user_id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | **receiver_user_id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. |
**sender_user_id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | **sender_user_id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. |
**sender_username** | Option<**String**> | -| **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). | [optional] **sender_username** | Option<**String**> | -| **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). | [optional]
**r#type** | [**crate::models::NotificationType**](NotificationType.md) | | **r#type** | [**models::NotificationType**](NotificationType.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,28 @@
# SortOption # SortOption
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Popularity | popularity |
| Heat | heat |
| Trust | trust |
| Shuffle | shuffle |
| Random | random |
| Favorites | favorites |
| ReportScore | reportScore |
| ReportCount | reportCount |
| PublicationDate | publicationDate |
| LabsPublicationDate | labsPublicationDate |
| Created | created |
| CreatedAt | _created_at |
| Updated | updated |
| UpdatedAt | _updated_at |
| Order | order |
| Relevance | relevance |
| Magic | magic |
| Name | name |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -10,10 +10,10 @@ Name | Type | Description | Notes
**google_product_id** | Option<**String**> | | [optional] **google_product_id** | Option<**String**> | | [optional]
**google_plan_id** | Option<**String**> | | [optional] **google_plan_id** | Option<**String**> | | [optional]
**pico_sku** | Option<**String**> | | [optional] **pico_sku** | Option<**String**> | | [optional]
**amount** | **f32** | | **amount** | **f64** | |
**description** | **String** | | **description** | **String** | |
**period** | [**crate::models::SubscriptionPeriod**](SubscriptionPeriod.md) | | **period** | [**models::SubscriptionPeriod**](SubscriptionPeriod.md) | |
**tier** | **f32** | | **tier** | **f64** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,15 @@
# SubscriptionPeriod # SubscriptionPeriod
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Hour | hour |
| Day | day |
| Week | week |
| Month | month |
| Year | year |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -4,7 +4,7 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**success** | Option<[**crate::models::Response**](Response.md)> | | [optional] **success** | Option<[**models::Response**](Response.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -16,7 +16,7 @@ Method | HTTP request | Description
## get_config ## get_config
> crate::models::ApiConfig get_config() > models::ApiConfig get_config()
Fetch API Config Fetch API Config
API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints. API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
@ -27,7 +27,7 @@ This endpoint does not need any parameter.
### Return type ### Return type
[**crate::models::ApiConfig**](APIConfig.md) [**models::ApiConfig**](APIConfig.md)
### Authorization ### Authorization
@ -101,7 +101,7 @@ No authorization required
## get_health ## get_health
> crate::models::ApiHealth get_health() > models::ApiHealth get_health()
Check API Health Check API Health
~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized. ~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
@ -112,7 +112,7 @@ This endpoint does not need any parameter.
### Return type ### Return type
[**crate::models::ApiHealth**](APIHealth.md) [**models::ApiHealth**](APIHealth.md)
### Authorization ### Authorization
@ -128,7 +128,7 @@ No authorization required
## get_info_push ## get_info_push
> Vec<crate::models::InfoPush> get_info_push(require, include) > Vec<models::InfoPush> get_info_push(require, include)
Show Information Notices Show Information Notices
IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an \"any of\" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an \"all of\" search. IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an \"any of\" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an \"all of\" search.
@ -143,7 +143,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::InfoPush>**](InfoPush.md) [**Vec<models::InfoPush>**](InfoPush.md)
### Authorization ### Authorization

View File

@ -7,13 +7,13 @@ Name | Type | Description | Notes
**id** | **String** | | **id** | **String** | |
**user_id** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] **user_id** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional]
**user_display_name** | Option<**String**> | | [optional] **user_display_name** | Option<**String**> | | [optional]
**status** | [**crate::models::TransactionStatus**](TransactionStatus.md) | | **status** | [**models::TransactionStatus**](TransactionStatus.md) | |
**subscription** | [**crate::models::Subscription**](Subscription.md) | | **subscription** | [**models::Subscription**](Subscription.md) | |
**sandbox** | **bool** | | [default to false] **sandbox** | **bool** | | [default to false]
**created_at** | **String** | | **created_at** | **String** | |
**updated_at** | **String** | | **updated_at** | **String** | |
**steam** | Option<[**crate::models::TransactionSteamInfo**](TransactionSteamInfo.md)> | | [optional] **steam** | Option<[**models::TransactionSteamInfo**](TransactionSteamInfo.md)> | | [optional]
**agreement** | Option<[**crate::models::TransactionAgreement**](TransactionAgreement.md)> | | [optional] **agreement** | Option<[**models::TransactionAgreement**](TransactionAgreement.md)> | | [optional]
**error** | **String** | | **error** | **String** | |
**is_gift** | Option<**bool**> | | [optional][default to false] **is_gift** | Option<**bool**> | | [optional][default to false]
**is_tokens** | Option<**bool**> | | [optional][default to false] **is_tokens** | Option<**bool**> | | [optional][default to false]

View File

@ -5,22 +5,22 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**agreement_id** | **String** | | **agreement_id** | **String** | |
**item_id** | **f32** | | **item_id** | **f64** | |
**status** | **String** | This is NOT TransactionStatus, but whatever Steam return. | **status** | **String** | This is NOT TransactionStatus, but whatever Steam return. |
**period** | **String** | | **period** | **String** | |
**frequency** | **f32** | | **frequency** | **f64** | |
**billing_type** | **String** | | **billing_type** | **String** | |
**start_date** | **String** | | **start_date** | **String** | |
**end_date** | **String** | | **end_date** | **String** | |
**recurring_amt** | **f32** | | **recurring_amt** | **f64** | |
**currency** | **String** | | **currency** | **String** | |
**time_created** | **String** | | **time_created** | **String** | |
**next_payment** | **String** | | **next_payment** | **String** | |
**last_payment** | **String** | | **last_payment** | **String** | |
**last_amount** | **f32** | | **last_amount** | **f64** | |
**last_amount_vat** | **f32** | | **last_amount_vat** | **f64** | |
**outstanding** | **f32** | | **outstanding** | **f64** | |
**failed_attempts** | **f32** | | **failed_attempts** | **f64** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,14 @@
# TransactionStatus # TransactionStatus
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Active | active |
| Failed | failed |
| Expired | expired |
| Chargeback | chargeback |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -4,7 +4,7 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**wallet_info** | [**crate::models::TransactionSteamWalletInfo**](TransactionSteamWalletInfo.md) | | **wallet_info** | [**models::TransactionSteamWalletInfo**](TransactionSteamWalletInfo.md) | |
**steam_id** | **String** | Steam User ID | **steam_id** | **String** | Steam User ID |
**order_id** | **String** | Steam Order ID | **order_id** | **String** | Steam Order ID |
**steam_url** | **String** | Empty | **steam_url** | **String** | Empty |

View File

@ -10,8 +10,8 @@ Name | Type | Description | Notes
**description** | Option<**String**> | | [optional] **description** | Option<**String**> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional] **tags** | Option<**Vec<String>**> | | [optional]
**image_url** | Option<**String**> | | [optional] **image_url** | Option<**String**> | | [optional]
**release_status** | Option<[**crate::models::ReleaseStatus**](ReleaseStatus.md)> | | [optional] **release_status** | Option<[**models::ReleaseStatus**](ReleaseStatus.md)> | | [optional]
**version** | Option<**f32**> | | [optional][default to 1] **version** | Option<**f64**> | | [optional][default to 1]
**unity_package_url** | Option<**String**> | | [optional] **unity_package_url** | Option<**String**> | | [optional]
**unity_version** | Option<**String**> | | [optional][default to 5.3.4p1] **unity_version** | Option<**String**> | | [optional][default to 5.3.4p1]

View File

@ -5,7 +5,7 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**display_name** | Option<**String**> | | [optional] **display_name** | Option<**String**> | | [optional]
**visibility** | Option<[**crate::models::FavoriteGroupVisibility**](FavoriteGroupVisibility.md)> | | [optional] **visibility** | Option<[**models::FavoriteGroupVisibility**](FavoriteGroupVisibility.md)> | | [optional]
**tags** | Option<**Vec<String>**> | Tags on FavoriteGroups are believed to do nothing. | [optional] **tags** | Option<**Vec<String>**> | Tags on FavoriteGroups are believed to do nothing. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -4,7 +4,7 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**visibility** | Option<[**crate::models::GroupUserVisibility**](GroupUserVisibility.md)> | | [optional] **visibility** | Option<[**models::GroupUserVisibility**](GroupUserVisibility.md)> | | [optional]
**is_subscribed_to_announcements** | Option<**bool**> | | [optional] **is_subscribed_to_announcements** | Option<**bool**> | | [optional]
**manager_notes** | Option<**String**> | | [optional] **manager_notes** | Option<**String**> | | [optional]

View File

@ -7,7 +7,7 @@ Name | Type | Description | Notes
**name** | Option<**String**> | | [optional] **name** | Option<**String**> | | [optional]
**short_code** | Option<**String**> | | [optional] **short_code** | Option<**String**> | | [optional]
**description** | Option<**String**> | | [optional] **description** | Option<**String**> | | [optional]
**join_state** | Option<[**crate::models::GroupJoinState**](GroupJoinState.md)> | | [optional] **join_state** | Option<[**models::GroupJoinState**](GroupJoinState.md)> | | [optional]
**icon_id** | Option<**String**> | | [optional] **icon_id** | Option<**String**> | | [optional]
**banner_id** | Option<**String**> | | [optional] **banner_id** | Option<**String**> | | [optional]
**languages** | Option<**Vec<String>**> | 3 letter language code | [optional] **languages** | Option<**Vec<String>**> | 3 letter language code | [optional]

View File

@ -6,9 +6,9 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**email** | Option<**String**> | | [optional] **email** | Option<**String**> | | [optional]
**birthday** | Option<[**String**](string.md)> | | [optional] **birthday** | Option<[**String**](string.md)> | | [optional]
**accepted_tos_version** | Option<**f32**> | | [optional] **accepted_tos_version** | Option<**f64**> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional] **tags** | Option<**Vec<String>**> | | [optional]
**status** | Option<[**crate::models::UserStatus**](UserStatus.md)> | | [optional] **status** | Option<[**models::UserStatus**](UserStatus.md)> | | [optional]
**status_description** | Option<**String**> | | [optional] **status_description** | Option<**String**> | | [optional]
**bio** | Option<**String**> | | [optional] **bio** | Option<**String**> | | [optional]
**bio_links** | Option<**Vec<String>**> | | [optional] **bio_links** | Option<**Vec<String>**> | | [optional]

View File

@ -13,7 +13,7 @@ Name | Type | Description | Notes
**image_url** | Option<**String**> | | [optional] **image_url** | Option<**String**> | | [optional]
**name** | Option<**String**> | | [optional] **name** | Option<**String**> | | [optional]
**platform** | Option<**String**> | 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] **platform** | Option<**String**> | 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]
**release_status** | Option<[**crate::models::ReleaseStatus**](ReleaseStatus.md)> | | [optional] **release_status** | Option<[**models::ReleaseStatus**](ReleaseStatus.md)> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional] **tags** | Option<**Vec<String>**> | | [optional]
**unity_package_url** | Option<**String**> | | [optional] **unity_package_url** | Option<**String**> | | [optional]
**unity_version** | Option<**String**> | | [optional][default to 5.3.4p1] **unity_version** | Option<**String**> | | [optional][default to 5.3.4p1]

View File

@ -5,14 +5,14 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**allow_avatar_copying** | **bool** | | [default to true] **allow_avatar_copying** | **bool** | | [default to true]
**badges** | Option<[**Vec<crate::models::Badge>**](Badge.md)> | | [optional] **badges** | Option<[**Vec<models::Badge>**](Badge.md)> | | [optional]
**bio** | **String** | | **bio** | **String** | |
**bio_links** | **Vec<String>** | | **bio_links** | **Vec<String>** | |
**current_avatar_image_url** | **String** | When profilePicOverride is not empty, use it instead. | **current_avatar_image_url** | **String** | When profilePicOverride is not empty, use it instead. |
**current_avatar_thumbnail_image_url** | **String** | When profilePicOverride is not empty, use it instead. | **current_avatar_thumbnail_image_url** | **String** | When profilePicOverride is not empty, use it instead. |
**current_avatar_tags** | **Vec<String>** | | **current_avatar_tags** | **Vec<String>** | |
**date_joined** | [**String**](string.md) | | **date_joined** | [**String**](string.md) | |
**developer_type** | [**crate::models::DeveloperType**](DeveloperType.md) | | **developer_type** | [**models::DeveloperType**](DeveloperType.md) | |
**display_name** | **String** | A users visual display name. This is what shows up in-game, and can different from their `username`. Changing display name is restricted to a cooldown period. | **display_name** | **String** | A users visual display name. This is what shows up in-game, and can different from their `username`. Changing display name is restricted to a cooldown period. |
**friend_key** | **String** | | **friend_key** | **String** | |
**friend_request_status** | Option<**String**> | | [optional] **friend_request_status** | Option<**String**> | | [optional]
@ -27,8 +27,8 @@ Name | Type | Description | Notes
**profile_pic_override** | **String** | | **profile_pic_override** | **String** | |
**profile_pic_override_thumbnail** | **String** | | **profile_pic_override_thumbnail** | **String** | |
**pronouns** | **String** | | **pronouns** | **String** | |
**state** | [**crate::models::UserState**](UserState.md) | | **state** | [**models::UserState**](UserState.md) | |
**status** | [**crate::models::UserStatus**](UserStatus.md) | | **status** | [**models::UserStatus**](UserStatus.md) | |
**status_description** | **String** | | **status_description** | **String** | |
**tags** | **Vec<String>** | | **tags** | **Vec<String>** | |
**traveling_to_instance** | Option<**String**> | | [optional] **traveling_to_instance** | Option<**String**> | | [optional]

View File

@ -1,9 +1,13 @@
# UserState # UserState
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Offline | offline |
| Active | active |
| Online | online |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -1,9 +1,15 @@
# UserStatus # UserStatus
## Properties ## Enum Variants
| Name | Value |
|---- | -----|
| Active | active |
| JoinMe | join me |
| AskMe | ask me |
| Busy | busy |
| Offline | offline |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -8,12 +8,12 @@ Name | Type | Description | Notes
**transaction_id** | **String** | | **transaction_id** | **String** | |
**store** | **String** | Which \"Store\" it came from. Right now only Stores are \"Steam\" and \"Admin\". | **store** | **String** | Which \"Store\" it came from. Right now only Stores are \"Steam\" and \"Admin\". |
**steam_item_id** | Option<**String**> | | [optional] **steam_item_id** | Option<**String**> | | [optional]
**amount** | **f32** | | **amount** | **f64** | |
**description** | **String** | | **description** | **String** | |
**period** | [**crate::models::SubscriptionPeriod**](SubscriptionPeriod.md) | | **period** | [**models::SubscriptionPeriod**](SubscriptionPeriod.md) | |
**tier** | **f32** | | **tier** | **f64** | |
**active** | **bool** | | [default to true] **active** | **bool** | | [default to true]
**status** | [**crate::models::TransactionStatus**](TransactionStatus.md) | | **status** | [**models::TransactionStatus**](TransactionStatus.md) | |
**expires** | **String** | | **expires** | **String** | |
**created_at** | **String** | | **created_at** | **String** | |
**updated_at** | **String** | | **updated_at** | **String** | |

View File

@ -16,7 +16,7 @@ Method | HTTP request | Description
## get_user ## get_user
> crate::models::User get_user(user_id) > models::User get_user(user_id)
Get User by ID Get User by ID
Get public user information about a specific user using their ID. Get public user information about a specific user using their ID.
@ -30,7 +30,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::User**](User.md) [**models::User**](User.md)
### Authorization ### Authorization
@ -46,7 +46,7 @@ Name | Type | Description | Required | Notes
## get_user_by_name ## get_user_by_name
> crate::models::User get_user_by_name(username) > models::User get_user_by_name(username)
Get User by Username Get User by Username
~~Get public user information about a specific user using their name.~~ **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). This endpoint now require Admin Credentials. ~~Get public user information about a specific user using their name.~~ **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). This endpoint now require Admin Credentials.
@ -60,7 +60,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::User**](User.md) [**models::User**](User.md)
### Authorization ### Authorization
@ -76,7 +76,7 @@ Name | Type | Description | Required | Notes
## get_user_group_requests ## get_user_group_requests
> Vec<crate::models::Group> get_user_group_requests(user_id) > Vec<models::Group> get_user_group_requests(user_id)
Get User Group Requests Get User Group Requests
Returns a list of Groups the user has requested to be invited into. Returns a list of Groups the user has requested to be invited into.
@ -90,7 +90,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::Group>**](Group.md) [**Vec<models::Group>**](Group.md)
### Authorization ### Authorization
@ -106,7 +106,7 @@ Name | Type | Description | Required | Notes
## get_user_groups ## get_user_groups
> Vec<crate::models::LimitedUserGroups> get_user_groups(user_id) > Vec<models::LimitedUserGroups> get_user_groups(user_id)
Get User Groups Get User Groups
Get user's public groups Get user's public groups
@ -120,7 +120,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::LimitedUserGroups>**](LimitedUserGroups.md) [**Vec<models::LimitedUserGroups>**](LimitedUserGroups.md)
### Authorization ### Authorization
@ -136,7 +136,7 @@ Name | Type | Description | Required | Notes
## get_user_represented_group ## get_user_represented_group
> crate::models::RepresentedGroup get_user_represented_group(user_id) > models::RepresentedGroup get_user_represented_group(user_id)
Get user's current represented group Get user's current represented group
Returns the current group that the user is currently representing Returns the current group that the user is currently representing
@ -150,7 +150,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::RepresentedGroup**](representedGroup.md) [**models::RepresentedGroup**](representedGroup.md)
### Authorization ### Authorization
@ -166,7 +166,7 @@ Name | Type | Description | Required | Notes
## search_users ## search_users
> Vec<crate::models::LimitedUser> search_users(search, developer_type, n, offset) > Vec<models::LimitedUser> search_users(search, developer_type, n, offset)
Search All Users Search All Users
Search and list any users by text query Search and list any users by text query
@ -183,7 +183,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**Vec<crate::models::LimitedUser>**](LimitedUser.md) [**Vec<models::LimitedUser>**](LimitedUser.md)
### Authorization ### Authorization
@ -199,7 +199,7 @@ Name | Type | Description | Required | Notes
## update_user ## update_user
> crate::models::CurrentUser update_user(user_id, update_user_request) > models::CurrentUser update_user(user_id, update_user_request)
Update User Info Update User Info
Update a users information such as the email and birthday. Update a users information such as the email and birthday.
@ -214,7 +214,7 @@ Name | Type | Description | Required | Notes
### Return type ### Return type
[**crate::models::CurrentUser**](CurrentUser.md) [**models::CurrentUser**](CurrentUser.md)
### Authorization ### Authorization

Some files were not shown because too many files have changed in this diff Show More