mii/vrchatapi-rust
1
0
Fork 0
mirror of https://github.com/mii443/vrchatapi-rust.git synced 2025-08-22 15:45:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: re-add default generated markdown docs

Browse Source
This commit is contained in:
Foorack
2021-08-07 23:41:51 +02:00
parent 4eb56da5fc
commit c773dd31cb
52 changed files with 2350 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

185
docs/AuthenticationApi.md Normal file
View File

@ -0,0 +1,185 @@
# \AuthenticationApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_user_by_id**](AuthenticationApi.md#delete_user_by_id) | **PUT** /user/{userId}/delete | Delete User
[**get_current_user**](AuthenticationApi.md#get_current_user) | **GET** /auth/user | Login and/or Get Current User Info
[**logout**](AuthenticationApi.md#logout) | **PUT** /logout | Logout
[**verify2_fa**](AuthenticationApi.md#verify2_fa) | **POST** /auth/twofactorauth/totp/verify | Verify 2FA code
[**verify_auth_token**](AuthenticationApi.md#verify_auth_token) | **GET** /auth | Verify Auth Token
[**verify_recovery_code**](AuthenticationApi.md#verify_recovery_code) | **POST** /auth/twofactorauth/otp/verify | Verify 2FA code with Recovery code
## delete_user_by_id
> crate::models::CurrentUser delete_user_by_id(user_id)
Delete User
Deletes the account with given ID. Normal users only have permission to delete their own account. Account deletion is 14 days from this request, and will be cancelled if you do an authenticated request with the account afterwards. **VRC+ NOTE:** Despite the 14-days cooldown, any VRC+ subscription will be cancelled **immediately**. **METHOD NOTE:** Despite this being a Delete action, the method type required is PUT.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
### Return type
[**crate::models::CurrentUser**](CurrentUser.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_current_user
> crate::models::CurrentUser get_current_user()
Login and/or Get Current User Info
Login and/or Get user data from your VRChat account. If `Authorization` header is present then a new login session will be generated, and a new `auth` cookie is returned. **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 whenever you can, and avoid sending the Authorization header unless strictly neccesary. While the exact number of simultaneous open sessions is secret, expect to **very fast** run into the rate-limit and be temporarily blocked from making new sessions until the old ones expire.
### Parameters
This endpoint does not need any parameter.
### Return type
[**crate::models::CurrentUser**](CurrentUser.md)
### Authorization
[authCookie](../README.md#authCookie), [authHeader](../README.md#authHeader), [twoFactorAuthCookie](../README.md#twoFactorAuthCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## logout
> crate::models::Success logout()
Logout
Invalidates the auth cookie.
### Parameters
This endpoint does not need any parameter.
### Return type
[**crate::models::Success**](Success.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## verify2_fa
> crate::models::InlineResponse2001 verify2_fa(inline_object)
Verify 2FA code
Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**inline_object** | Option<[**InlineObject**](InlineObject.md)> | | |
### Return type
[**crate::models::InlineResponse2001**](inline_response_200_1.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## verify_auth_token
> crate::models::InlineResponse200 verify_auth_token()
Verify Auth Token
Verify whether the currently provided Auth Token is valid.
### Parameters
This endpoint does not need any parameter.
### Return type
[**crate::models::InlineResponse200**](inline_response_200.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## verify_recovery_code
> crate::models::InlineResponse2001 verify_recovery_code(inline_object1)
Verify 2FA code with Recovery code
Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**inline_object1** | Option<[**InlineObject1**](InlineObject1.md)> | | |
### Return type
[**crate::models::InlineResponse2001**](inline_response_200_1.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

85
docs/Config.md Normal file
View File

@ -0,0 +1,85 @@
# Config
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**address** | **String** | VRChat's office address | [readonly]
**announcements** | [**Vec<crate::models::ConfigAnnouncements>**](Config_announcements.md) | PSA, Public Announcements | [readonly]
**api_key** | **String** | apiKey to be used for all other requests | [readonly]
**app_name** | **String** | Game name | [readonly][default to VrChat]
**build_version_tag** | **String** | Build tag of the API server | [readonly]
**client_api_key** | **String** | apiKey to be used for all other requests | [readonly]
**client_bps_ceiling** | Option<**f32**> | Unknown | [optional]
**client_disconnect_timeout** | Option<**f32**> | Unknown | [optional]
**client_reserved_player_bps** | Option<**f32**> | Unknown | [optional]
**client_sent_count_allowance** | Option<**f32**> | Unknown | [optional]
**contact_email** | **String** | VRChat's contact email | [readonly]
**copyright_email** | **String** | VRChat's copyright-issues-related email | [readonly]
**current_tos_version** | **f32** | Current version number of the Terms of Service | [readonly]
**default_avatar** | **String** | |
**deployment_group** | [**crate::models::DeploymentGroup**](DeploymentGroup.md) | |
**dev_app_version_standalone** | **String** | Version number for game development build | [readonly]
**dev_download_link_windows** | **String** | Developer Download link | [readonly]
**dev_sdk_url** | **String** | Link to download the development SDK, use downloadUrls instead | [readonly]
**dev_sdk_version** | **String** | Version of the development SDK | [readonly]
**dev_server_version_standalone** | **String** | Version number for server development build | [readonly]
**disable_avatar_copying** | **bool** | Toggles if copying avatars should be disabled | [default to false]
**disable_avatar_gating** | **bool** | Toggles if avatar gating should be disabled. Avatar gating restricts uploading of avatars to people with the `system_avatar_access` Tag or `admin_avatar_access` Tag | [default to false]
**disable_community_labs** | **bool** | Toggles if the Community Labs should be disabled | [default to false]
**disable_community_labs_promotion** | **bool** | Toggles if promotion out of Community Labs should be disabled | [default to false]
**disable_email** | Option<**bool**> | Unknown | [optional][default to false]
**disable_event_stream** | **bool** | Toggles if Analytics should be disabled (this sreportedly not used in the Client) | [default to false]
**disable_feedback_gating** | **bool** | Toggles if feedback gating should be disabled. Feedback gating restricts submission of feedback (reporting a World or User) to people with the `system_feedback_access` Tag. | [default to false]
**disable_hello** | Option<**bool**> | Unknown | [optional][default to false]
**disable_registration** | **bool** | Toggles if new user account registration should be disabled | [default to false]
**disable_steam_networking** | **bool** | Toggles if Steam Networking should be disabled. VRChat these days uses Photon Unity Networking (PUN) instead. | [default to true]
**disable_two_factor_auth** | **bool** | Toggles if 2FA should be disabled. | [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]
**download_link_windows** | **String** | Download link for game on the Oculus Rift website. | [readonly]
**download_urls** | [**crate::models::ConfigDownloadUrls**](Config_downloadUrls.md) | |
**dynamic_world_rows** | [**Vec<crate::models::ConfigDynamicWorldRows>**](Config_dynamicWorldRows.md) | Array of DynamicWorldRow objects, used by the game to display the list of world rows | [readonly]
**events** | [**crate::models::ConfigEvents**](Config_events.md) | |
**gear_demo_room_id** | **String** | Unknown | [readonly]
**homepage_redirect_target** | **String** | Redirect target if you try to open the base API domain in your browser | [readonly][default to https://hello.vrchat.com]
**home_world_id** | **String** | |
**hub_world_id** | **String** | |
**jobs_email** | **String** | VRChat's job application email | [readonly]
**message_of_the_day** | **String** | MOTD | [readonly]
**moderation_email** | **String** | VRChat's moderation related email | [readonly]
**moderation_query_period** | **f32** | Unknown |
**not_allowed_to_select_avatar_in_private_world_message** | **String** | Used in-game to notify a user they aren't allowed to select avatars in private worlds | [readonly]
**plugin** | **String** | Extra [plugin](https://doc.photonengine.com/en-us/server/current/plugins/manual) to run in each instance | [readonly]
**release_app_version_standalone** | **String** | Version number for game release build | [readonly]
**release_sdk_url** | **String** | Link to download the release SDK | [readonly]
**release_sdk_version** | **String** | Version of the release SDK | [readonly]
**release_server_version_standalone** | **String** | Version number for server release build | [readonly]
**sdk_developer_faq_url** | **String** | Link to the developer FAQ | [readonly]
**sdk_discord_url** | **String** | Link to the official VRChat Discord | [readonly]
**sdk_not_allowed_to_publish_message** | **String** | Used in the SDK to notify a user they aren't allowed to upload avatars/worlds yet | [readonly]
**sdk_unity_version** | **String** | Unity version supported by the SDK | [readonly]
**server_name** | **String** | Server name of the API server currently responding | [readonly]
**support_email** | **String** | VRChat's support email | [readonly]
**time_out_world_id** | **String** | |
**tutorial_world_id** | **String** | |
**update_rate_ms_maximum** | **f32** | Unknown | [readonly]
**update_rate_ms_minimum** | **f32** | Unknown | [readonly]
**update_rate_ms_normal** | **f32** | Unknown | [readonly]
**update_rate_ms_udon_manual** | **f32** | Unknown | [readonly]
**upload_analysis_percent** | **f32** | Unknown | [readonly]
**url_list** | **Vec<String>** | List of allowed URLs that bypass the \"Allow untrusted URL's\" setting in-game | [readonly]
**use_reliable_udp_for_voice** | **bool** | Unknown | [default to false]
**user_update_period** | **f32** | Unknown | [readonly]
**user_verification_delay** | **f32** | Unknown | [readonly]
**user_verification_retry** | **f32** | Unknown | [readonly]
**user_verification_timeout** | **f32** | Unknown | [readonly]
**vive_windows_url** | **String** | Download link for game on the Steam website. | [readonly]
**white_listed_asset_urls** | **Vec<String>** | List of allowed URLs that are allowed to host avatar assets | [readonly]
**world_update_period** | **f32** | Unknown | [readonly]
**youtubedl_hash** | **String** | Currently used youtube-dl.exe hash in SHA-256-delimited format | [readonly]
**youtubedl_version** | **String** | Currently used youtube-dl.exe version | [readonly]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/ConfigAnnouncements.md Normal file
View File

@ -0,0 +1,12 @@
# ConfigAnnouncements
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Announcement name | [readonly]
**text** | **String** | Announcement text | [readonly]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
docs/ConfigDownloadUrls.md Normal file
View File

@ -0,0 +1,13 @@
# ConfigDownloadUrls
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**sdk2** | **String** | Download link for legacy SDK2 | [readonly]
**sdk3_avatars** | **String** | Download link for SDK3 for Avatars | [readonly]
**sdk3_worlds** | **String** | Download link for SDK3 for Worlds | [readonly]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

17
docs/ConfigDynamicWorldRows.md Normal file
View File

@ -0,0 +1,17 @@
# ConfigDynamicWorldRows
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**index** | **f32** | | [readonly]
**name** | **String** | | [readonly]
**platform** | **String** | | [readonly]
**sort_heading** | **String** | | [readonly]
**sort_order** | **String** | | [readonly]
**sort_ownership** | **String** | | [readonly]
**tag** | Option<**String**> | Tag to filter worlds for this row | [optional][readonly]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

20
docs/ConfigEvents.md Normal file
View File

@ -0,0 +1,20 @@
# ConfigEvents
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**distance_close** | **f32** | Unknown | [readonly]
**distance_factor** | **f32** | Unknown | [readonly]
**distance_far** | **f32** | Unknown | [readonly]
**group_distance** | **f32** | Unknown | [readonly]
**maximum_bunch_size** | **f32** | Unknown | [readonly]
**not_visible_factor** | **f32** | Unknown | [readonly]
**player_order_bucket_size** | **f32** | Unknown | [readonly]
**player_order_factor** | **f32** | Unknown | [readonly]
**slow_update_factor_threshold** | **f32** | Unknown | [readonly]
**view_segment_length** | **f32** | Unknown | [readonly]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

56
docs/CurrentUser.md Normal file
View File

@ -0,0 +1,56 @@
# CurrentUser
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [readonly]
**username** | **String** | |
**display_name** | **String** | |
**user_icon** | **String** | |
**bio** | **String** | |
**bio_links** | **Vec<String>** | |
**profile_pic_override** | **String** | |
**status_description** | **String** | |
**past_display_names** | **Vec<String>** | |
**has_email** | **bool** | |
**has_pending_email** | **bool** | |
**obfuscated_email** | **String** | |
**obfuscated_pending_email** | **String** | |
**email_verified** | **bool** | |
**has_birthday** | **bool** | |
**unsubscribe** | **bool** | |
**status_history** | **Vec<String>** | |
**status_first_time** | **bool** | |
**friends** | **Vec<String>** | |
**friend_group_names** | **Vec<String>** | |
**current_avatar_image_url** | **String** | |
**current_avatar_thumbnail_image_url** | **String** | |
**fallback_avatar** | **String** | |
**current_avatar** | **String** | |
**current_avatar_asset_url** | **String** | |
**account_deletion_date** | Option<[**String**](string.md)> | | [optional]
**accepted_tos_version** | **f32** | |
**steam_id** | **String** | |
**steam_details** | [**serde_json::Value**](.md) | |
**oculus_id** | **String** | |
**has_logged_in_from_client** | **bool** | |
**home_location** | **String** | |
**two_factor_auth_enabled** | **bool** | |
**state** | [**crate::models::UserState**](UserState.md) | |
**tags** | **Vec<String>** | |
**developer_type** | [**crate::models::DeveloperType**](DeveloperType.md) | |
**last_login** | **String** | |
**last_platform** | [**crate::models::Platform**](Platform.md) | |
**allow_avatar_copying** | **bool** | |
**status** | [**crate::models::UserStatus**](UserStatus.md) | |
**date_joined** | [**String**](string.md) | | [readonly]
**is_friend** | **bool** | | [default to false]
**friend_key** | **String** | |
**online_friends** | **Vec<String>** | |
**active_friends** | **Vec<String>** | |
**offline_friends** | **Vec<String>** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/DeploymentGroup.md Normal file
View File

@ -0,0 +1,10 @@
# DeploymentGroup
## Properties
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)

10
docs/DeveloperType.md Normal file
View File

@ -0,0 +1,10 @@
# DeveloperType
## Properties
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)

11
docs/Error.md Normal file
View File

@ -0,0 +1,11 @@
# Error
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**error** | Option<[**crate::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)

17
docs/File.md Normal file
View File

@ -0,0 +1,17 @@
# File
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | |
**name** | **String** | |
**owner_id** | **String** | | [readonly]
**mime_type** | [**crate::models::MimeType**](MIMEType.md) | |
**extension** | **String** | |
**tags** | **Vec<String>** | |
**versions** | [**Vec<crate::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)

17
docs/FileData.md Normal file
View File

@ -0,0 +1,17 @@
# FileData
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**file_name** | **String** | |
**url** | **String** | |
**md5** | **String** | |
**size_in_bytes** | **f32** | |
**status** | [**crate::models::FileStatus**](FileStatus.md) | |
**category** | **String** | | [readonly]
**upload_id** | **String** | | [default to ]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/FileStatus.md Normal file
View File

@ -0,0 +1,10 @@
# FileStatus
## Properties
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)

17
docs/FileVersion.md Normal file
View File

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

331
docs/FilesApi.md Normal file
View File

@ -0,0 +1,331 @@
# \FilesApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create_file**](FilesApi.md#create_file) | **POST** /file | Create File
[**create_file_version**](FilesApi.md#create_file_version) | **POST** /file/{fileId} | Create File Version
[**delete_file**](FilesApi.md#delete_file) | **DELETE** /file/{fileId} | Delete File
[**delete_file_version**](FilesApi.md#delete_file_version) | **DELETE** /file/{fileId}/{versionId} | Delete File Version
[**download_file_version**](FilesApi.md#download_file_version) | **GET** /file/{fileId}/{versionId} | Download File Version
[**finish_file_data_upload**](FilesApi.md#finish_file_data_upload) | **PUT** /file/{fileId}/{versionId}/{fileType}/finish | Finish FileData Upload
[**get_file**](FilesApi.md#get_file) | **GET** /file/{fileId} | Show File
[**get_file_data_upload_status**](FilesApi.md#get_file_data_upload_status) | **GET** /file/{fileId}/{versionId}/{fileType}/status | Check FileData Upload Status
[**get_files**](FilesApi.md#get_files) | **GET** /files | List Files
[**start_file_data_upload**](FilesApi.md#start_file_data_upload) | **PUT** /file/{fileId}/{versionId}/{fileType}/start | Start FileData Upload
## create_file
> crate::models::File create_file(inline_object3)
Create File
Creates a new File object
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**inline_object3** | Option<[**InlineObject3**](InlineObject3.md)> | | |
### Return type
[**crate::models::File**](File.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## create_file_version
> crate::models::File create_file_version(file_id)
Create File Version
Creates a new FileVersion. Once a Version has been created, proceed to the `/file/{fileId}/{versionId}/file/start` endpoint to start a file upload.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** | | [required] |
### Return type
[**crate::models::File**](File.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## delete_file
> crate::models::Success delete_file(file_id)
Delete File
Deletes a File object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** | | [required] |
### Return type
[**crate::models::Success**](Success.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## delete_file_version
> crate::models::File delete_file_version(file_id, version_id)
Delete File Version
Delete a specific version of a file. You can only delete the latest version.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** | | [required] |
**version_id** | **i32** | | [required] |
### Return type
[**crate::models::File**](File.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## download_file_version
> download_file_version(file_id, version_id)
Download File Version
Downloads the file with the provided version number. **Version Note:** Version 0 is always when the file was created. The real data is usually always located in version 1 and up. **Extension Note:** Files are not guaranteed to have a file extensions. UnityPackage files tends to have it, images through this endpoint do not. You are responsible for appending file extension from the `extension` field when neccesary.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** | | [required] |
**version_id** | **i32** | | [required] |
### Return type
(empty response body)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## finish_file_data_upload
> crate::models::File finish_file_data_upload(file_id, version_id, file_type, inline_object4)
Finish FileData Upload
Finish an upload of a FileData. This will mark it as \"complete\". After uploading the `file` for Avatars and Worlds you then have to upload a `signature` file.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** | | [required] |
**version_id** | **i32** | | [required] |
**file_type** | **String** | | [required] |
**inline_object4** | Option<[**InlineObject4**](InlineObject4.md)> | | |
### Return type
[**crate::models::File**](File.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_file
> crate::models::File get_file(file_id)
Show File
Shows general information about the \"File\" object. Each File can have several \"Version\"'s, and each Version can have multiple real files or \"Data\" blobs.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** | | [required] |
### Return type
[**crate::models::File**](File.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_file_data_upload_status
> crate::models::InlineResponse2004 get_file_data_upload_status(file_id, version_id, file_type)
Check FileData Upload Status
Retrieves the upload status for file upload. Can currently only be accessed when `status` is `waiting`. Trying to access it on a file version already uploaded currently times out.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** | | [required] |
**version_id** | **i32** | | [required] |
**file_type** | **String** | | [required] |
### Return type
[**crate::models::InlineResponse2004**](inline_response_200_4.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_files
> Vec<crate::models::File> get_files(tag, user_id, n, offset)
List Files
Returns a list of files
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**tag** | Option<**String**> | Tag, for example \"icon\" or \"gallery\", not included by default. | |
**user_id** | Option<**String**> | UserID, will always generate a 500 permission error. | |
**n** | Option<**i32**> | The number of objects to return. | |[default to 60]
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. | |
### Return type
[**Vec<crate::models::File>**](File.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## start_file_data_upload
> crate::models::InlineResponse2005 start_file_data_upload(file_id, version_id, file_type, part_number)
Start FileData Upload
Starts an upload of a specific FilePart. This endpoint will return an AWS URL which you can PUT data to. You need to call this and receive a new AWS API URL for each `partNumber`. Please see AWS's REST documentation on \"PUT Object to S3\" on how to upload. Once all parts has been uploaded, proceed to `/finish` endpoint. **Note:** `nextPartNumber` seems like it is always ignored. Despite it returning 0, first partNumber is always 1.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** | | [required] |
**version_id** | **i32** | | [required] |
**file_type** | **String** | | [required] |
**part_number** | **i32** | | [required] |
### Return type
[**crate::models::InlineResponse2005**](inline_response_200_5.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

165
docs/FriendsApi.md Normal file
View File

@ -0,0 +1,165 @@
# \FriendsApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_friend_request**](FriendsApi.md#delete_friend_request) | **DELETE** /user/{userId}/friendRequest | Delete Friend Request
[**friend**](FriendsApi.md#friend) | **POST** /user/{userId}/friendRequest | Send Friend Request
[**get_friend_status**](FriendsApi.md#get_friend_status) | **GET** /user/{userId}/friendStatus | Check Friend Status
[**get_friends**](FriendsApi.md#get_friends) | **GET** /auth/user/friends | List Friends
[**unfriend**](FriendsApi.md#unfriend) | **DELETE** /auth/user/friends/{userId} | Unfriend
## delete_friend_request
> crate::models::Success delete_friend_request(user_id)
Delete Friend Request
Deletes an outgoing pending friend request to another user. To delete an incoming friend request, use the `deleteNotification` endpoint instead.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
### Return type
[**crate::models::Success**](Success.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## friend
> crate::models::Notification friend(user_id)
Send Friend Request
Send a friend request to another user.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
### Return type
[**crate::models::Notification**](Notification.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_friend_status
> crate::models::InlineResponse2003 get_friend_status(user_id)
Check Friend Status
Retrieve if the user is currently a friend with a given user, if they have an outgoing friend request, and if they have an incoming friend request. The proper way to receive and accept friend request is by checking if the user has an incoming `Notification` of type `friendRequest`, and then accepting that notification.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
### Return type
[**crate::models::InlineResponse2003**](inline_response_200_3.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_friends
> Vec<crate::models::LimitedUser> get_friends(offset, n, offline)
List Friends
List information about friends.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. | |
**n** | Option<**i32**> | The number of objects to return. | |[default to 60]
**offline** | Option<**bool**> | Returns *only* offline users if true, returns only online and active users if false | |
### Return type
[**Vec<crate::models::LimitedUser>**](LimitedUser.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## unfriend
> crate::models::Success unfriend(user_id)
Unfriend
Unfriend a user by ID.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
### Return type
[**crate::models::Success**](Success.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

11
docs/InlineObject.md Normal file
View File

@ -0,0 +1,11 @@
# InlineObject
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **String** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
docs/InlineObject1.md Normal file
View File

@ -0,0 +1,11 @@
# InlineObject1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **String** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

19
docs/InlineObject2.md Normal file
View File

@ -0,0 +1,19 @@
# InlineObject2
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | Option<**String**> | | [optional]
**birthday** | Option<[**String**](string.md)> | | [optional]
**accepted_tos_version** | Option<**f32**> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional]
**status** | Option<[**crate::models::UserStatus**](UserStatus.md)> | | [optional]
**status_description** | Option<**String**> | | [optional]
**bio** | Option<**String**> | | [optional]
**bio_links** | Option<**Vec<String>**> | | [optional]
**user_icon** | Option<**String**> | MUST be a valid VRChat /file/ url. | [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)

14
docs/InlineObject3.md Normal file
View File

@ -0,0 +1,14 @@
# InlineObject3
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | |
**mime_type** | [**crate::models::MimeType**](MIMEType.md) | |
**extension** | **String** | |
**tags** | Option<**Vec<String>**> | | [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)

13
docs/InlineObject4.md Normal file
View File

@ -0,0 +1,13 @@
# InlineObject4
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**etags** | Option<**Vec<String>**> | Array of ETags uploaded. | [optional]
**next_part_number** | **String** | Always a zero in string form, despite how many parts uploaded. | [default to NextPartNumber__0]
**max_parts** | **String** | Always a zero in string form, despite how many parts uploaded. | [default to MaxParts__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)

24
docs/InlineObject5.md Normal file
View File

@ -0,0 +1,24 @@
# InlineObject5
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_url** | **String** | |
**asset_version** | Option<**String**> | | [optional]
**author_id** | Option<**String**> | | [optional][readonly]
**author_name** | Option<**String**> | | [optional]
**capacity** | Option<**i32**> | | [optional][default to 16]
**description** | Option<**String**> | | [optional]
**id** | Option<**String**> | | [optional]
**image_url** | **String** | |
**name** | **String** | |
**platform** | Option<[**crate::models::Platform**](Platform.md)> | | [optional]
**release_status** | Option<[**crate::models::ReleaseStatus**](ReleaseStatus.md)> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional]
**unity_package_url** | Option<**String**> | | [optional]
**unity_version** | Option<**String**> | | [optional][default to 5.3.4p1]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

24
docs/InlineObject6.md Normal file
View File

@ -0,0 +1,24 @@
# InlineObject6
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_url** | Option<**String**> | | [optional]
**asset_version** | Option<**String**> | | [optional]
**author_id** | Option<**String**> | | [optional][readonly]
**author_name** | Option<**String**> | | [optional]
**capacity** | Option<**i32**> | | [optional][default to 16]
**description** | Option<**String**> | | [optional]
**id** | Option<**String**> | | [optional]
**image_url** | Option<**String**> | | [optional]
**name** | Option<**String**> | | [optional]
**platform** | Option<[**crate::models::Platform**](Platform.md)> | | [optional]
**release_status** | Option<[**crate::models::ReleaseStatus**](ReleaseStatus.md)> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional]
**unity_package_url** | Option<**String**> | | [optional]
**unity_version** | Option<**String**> | | [optional][default to 5.3.4p1]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/InlineResponse200.md Normal file
View File

@ -0,0 +1,12 @@
# InlineResponse200
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ok** | **bool** | |
**token** | **String** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
docs/InlineResponse2001.md Normal file
View File

@ -0,0 +1,11 @@
# InlineResponse2001
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**verified** | **bool** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
docs/InlineResponse2002.md Normal file
View File

@ -0,0 +1,13 @@
# InlineResponse2002
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ok** | **bool** | |
**server_name** | **String** | |
**build_version_tag** | **String** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
docs/InlineResponse2003.md Normal file
View File

@ -0,0 +1,13 @@
# InlineResponse2003
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**is_friend** | **bool** | | [default to false]
**outgoing_request** | **bool** | | [default to false]
**incoming_request** | **bool** | | [default to false]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16
docs/InlineResponse2004.md Normal file
View File

@ -0,0 +1,16 @@
# InlineResponse2004
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**upload_id** | **String** | | [readonly]
**file_name** | **String** | | [readonly]
**next_part_number** | **f32** | | [readonly]
**max_parts** | **f32** | | [readonly]
**parts** | [**Vec<serde_json::Value>**](serde_json::Value.md) | | [readonly]
**etags** | [**Vec<serde_json::Value>**](serde_json::Value.md) | Unknown | [readonly]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
docs/InlineResponse2005.md Normal file
View File

@ -0,0 +1,11 @@
# InlineResponse2005
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**url** | **String** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
docs/InlineResponse2006.md Normal file
View File

@ -0,0 +1,12 @@
# InlineResponse2006
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | |
**metadata** | [**serde_json::Value**](.md) | | [readonly]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
docs/InlineResponse2007.md Normal file
View File

@ -0,0 +1,11 @@
# InlineResponse2007
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**can_pubilsh** | **bool** | | [readonly][default to true]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
docs/InlineResponse401.md Normal file
View File

@ -0,0 +1,11 @@
# InlineResponse401
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**error** | [**crate::models::Error**](Error.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)

12
docs/LimitedUnityPackage.md Normal file
View File

@ -0,0 +1,12 @@
# LimitedUnityPackage
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**platform** | [**crate::models::Platform**](Platform.md) | |
**unity_version** | **String** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

26
docs/LimitedUser.md Normal file
View File

@ -0,0 +1,26 @@
# LimitedUser
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [readonly]
**username** | **String** | |
**display_name** | **String** | |
**bio** | Option<**String**> | | [optional]
**user_icon** | **String** | |
**profile_pic_override** | **String** | |
**status_description** | **String** | |
**current_avatar_image_url** | **String** | |
**current_avatar_thumbnail_image_url** | **String** | |
**fallback_avatar** | **String** | |
**developer_type** | [**crate::models::DeveloperType**](DeveloperType.md) | |
**last_platform** | [**crate::models::Platform**](Platform.md) | |
**status** | [**crate::models::UserStatus**](UserStatus.md) | |
**is_friend** | **bool** | |
**location** | **String** | |
**tags** | **Vec<String>** | Always empty |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

29
docs/LimitedWorld.md Normal file
View File

@ -0,0 +1,29 @@
# LimitedWorld
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | |
**name** | **String** | |
**author_id** | **String** | |
**author_name** | **String** | |
**capacity** | **f32** | |
**image_url** | **String** | |
**thumbnail_image_url** | **String** | |
**release_status** | **String** | |
**organization** | **String** | |
**tags** | [**Vec<serde_json::Value>**](serde_json::Value.md) | |
**favorites** | **f32** | |
**created_at** | **String** | |
**updated_at** | **String** | |
**publication_date** | **String** | |
**labs_publication_date** | **String** | |
**unity_packages** | [**Vec<crate::models::LimitedUnityPackage>**](LimitedUnityPackage.md) | |
**popularity** | **f32** | |
**heat** | **f32** | |
**occupants** | **f32** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/MimeType.md Normal file
View File

@ -0,0 +1,10 @@
# MimeType
## Properties
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)

18
docs/Notification.md Normal file
View File

@ -0,0 +1,18 @@
# Notification
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | |
**sender_user_id** | **String** | | [readonly]
**sender_username** | **String** | |
**_type** | [**crate::models::NotificationType**](NotificationType.md) | |
**message** | **String** | |
**details** | **String** | **NOTICE:** This is not a JSON object, this is a json **encoded** object, meaning you have to json-de-encode to get the NotificationDetail object depending on the NotificationType. | [default to {}]
**seen** | **bool** | | [default to false]
**created_at** | **String** | | [readonly]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/NotificationType.md Normal file
View File

@ -0,0 +1,10 @@
# NotificationType
## Properties
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)

165
docs/NotificationsApi.md Normal file
View File

@ -0,0 +1,165 @@
# \NotificationsApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**accept_friend_request**](NotificationsApi.md#accept_friend_request) | **PUT** /auth/user/notifications/{notificationId}/accept | Accept Friend Request
[**clear_notifications**](NotificationsApi.md#clear_notifications) | **PUT** /auth/user/notifications/clear | Clear All Notifications
[**delete_notification**](NotificationsApi.md#delete_notification) | **PUT** /auth/user/notifications/{notificationId}/hide | Delete Notification
[**get_notifications**](NotificationsApi.md#get_notifications) | **GET** /auth/user/notifications | List Notifications
[**mark_notification_as_read**](NotificationsApi.md#mark_notification_as_read) | **PUT** /auth/user/notifications/{notificationId}/see | Mark As Read
## accept_friend_request
> crate::models::Success accept_friend_request(notification_id)
Accept Friend Request
Accept a friend request by notification `frq_` ID. Friend requests can be found using the NotificationsAPI `getNotifications` by filtering of type `friendRequest`.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**notification_id** | **String** | | [required] |
### Return type
[**crate::models::Success**](Success.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## clear_notifications
> crate::models::Success clear_notifications()
Clear All Notifications
Clear **all** notifications.
### Parameters
This endpoint does not need any parameter.
### Return type
[**crate::models::Success**](Success.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## delete_notification
> crate::models::Notification delete_notification(notification_id)
Delete Notification
Delete a notification.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**notification_id** | **String** | | [required] |
### Return type
[**crate::models::Notification**](Notification.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_notifications
> Vec<crate::models::Notification> get_notifications(_type, sent, hidden, after, n, offset)
List Notifications
Retrieve all of the current user's notifications.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**_type** | Option<**String**> | Only send notifications of this type (can use `all` for all). | |
**sent** | Option<**bool**> | Return notifications sent by the user. Must be false or omitted. | |
**hidden** | Option<**bool**> | Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`. | |
**after** | Option<**String**> | Only return notifications sent after this Date. Ignored if type is `friendRequest`. | |
**n** | Option<**i32**> | The number of objects to return. | |[default to 60]
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. | |
### Return type
[**Vec<crate::models::Notification>**](Notification.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## mark_notification_as_read
> crate::models::Notification mark_notification_as_read(notification_id)
Mark As Read
Mark a notification as seen.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**notification_id** | **String** | | [required] |
### Return type
[**crate::models::Notification**](Notification.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

10
docs/Platform.md Normal file
View File

@ -0,0 +1,10 @@
# Platform
## Properties
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)

10
docs/ReleaseStatus.md Normal file
View File

@ -0,0 +1,10 @@
# ReleaseStatus
## Properties
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)

12
docs/Response.md Normal file
View File

@ -0,0 +1,12 @@
# Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**message** | **String** | |
**status_code** | **f32** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
docs/Success.md Normal file
View File

@ -0,0 +1,11 @@
# Success
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**success** | Option<[**crate::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)

120
docs/SystemApi.md Normal file
View File

@ -0,0 +1,120 @@
# \SystemApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_config**](SystemApi.md#get_config) | **GET** /config | Fetch API Config
[**get_current_online_users**](SystemApi.md#get_current_online_users) | **GET** /visits | Current Online Users
[**get_health**](SystemApi.md#get_health) | **GET** /health | Check API Health
[**get_system_time**](SystemApi.md#get_system_time) | **GET** /time | Current System Time
## get_config
> crate::models::Config get_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.
### Parameters
This endpoint does not need any parameter.
### Return type
[**crate::models::Config**](Config.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_current_online_users
> i32 get_current_online_users()
Current Online Users
Returns in plain format the number of currently online users. **NOTE:** The response type is not of JSON, but is an integer in plain ASCII format.
### Parameters
This endpoint does not need any parameter.
### Return type
**i32**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_health
> crate::models::InlineResponse2002 get_health()
Check API Health
Gets the overall health status, the server name, and the current build version tag of the API.
### Parameters
This endpoint does not need any parameter.
### Return type
[**crate::models::InlineResponse2002**](inline_response_200_2.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_system_time
> String get_system_time()
Current System Time
Returns in plain format the current time of the API server. **NOTE:** The response type is not of JSON, but is a string in plain ASCII format.
### Parameters
This endpoint does not need any parameter.
### Return type
**String**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

20
docs/UnityPackage.md Normal file
View File

@ -0,0 +1,20 @@
# UnityPackage
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | |
**asset_url** | **String** | |
**asset_url_object** | [**serde_json::Value**](.md) | |
**plugin_url** | **String** | |
**plugin_url_object** | [**serde_json::Value**](.md) | |
**unity_version** | **String** | |
**unity_sort_number** | **f32** | |
**asset_version** | **f32** | |
**platform** | [**crate::models::Platform**](Platform.md) | |
**created_at** | **String** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

34
docs/User.md Normal file
View File

@ -0,0 +1,34 @@
# User
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [readonly]
**username** | **String** | |
**display_name** | **String** | |
**user_icon** | **String** | |
**bio** | **String** | |
**bio_links** | **Vec<String>** | |
**profile_pic_override** | **String** | |
**status_description** | **String** | |
**current_avatar_image_url** | **String** | |
**current_avatar_thumbnail_image_url** | **String** | |
**fallback_avatar** | **String** | |
**state** | [**crate::models::UserState**](UserState.md) | |
**tags** | **Vec<String>** | |
**developer_type** | [**crate::models::DeveloperType**](DeveloperType.md) | |
**last_login** | **String** | |
**last_platform** | [**crate::models::Platform**](Platform.md) | |
**allow_avatar_copying** | **bool** | |
**status** | [**crate::models::UserStatus**](UserStatus.md) | |
**date_joined** | [**String**](string.md) | | [readonly]
**is_friend** | **bool** | |
**friend_key** | **String** | |
**world_id** | Option<**String**> | | [optional]
**instance_id** | Option<**String**> | | [optional]
**location** | Option<**String**> | | [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)

10
docs/UserState.md Normal file
View File

@ -0,0 +1,10 @@
# UserState
## Properties
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)

10
docs/UserStatus.md Normal file
View File

@ -0,0 +1,10 @@
# UserStatus
## Properties
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)

170
docs/UsersApi.md Normal file
View File

@ -0,0 +1,170 @@
# \UsersApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_user**](UsersApi.md#get_user) | **GET** /users/{userId} | Get User by ID
[**get_user_by_name**](UsersApi.md#get_user_by_name) | **GET** /users/{username}/name | Get User by Username
[**search_active_users**](UsersApi.md#search_active_users) | **GET** /users/active | Search Active Users
[**search_users**](UsersApi.md#search_users) | **GET** /users | Search All Users
[**update_user**](UsersApi.md#update_user) | **PUT** /users/{userId} | Update User Info
## get_user
> crate::models::User get_user(user_id)
Get User by ID
Get public user information about a specific user using their ID.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
### Return type
[**crate::models::User**](User.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_user_by_name
> crate::models::User get_user_by_name(username)
Get User by Username
Get public user information about a specific user using their name.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**username** | **String** | | [required] |
### Return type
[**crate::models::User**](User.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## search_active_users
> Vec<crate::models::LimitedUser> search_active_users(search, developer_type, offset, n)
Search Active Users
Search and list any Active users by text query. **Has been locked down and now always respond with \"Invalid Admin Credentials\".**
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**search** | **String** | Username to search for | [required] |
**developer_type** | Option<**String**> | Active user by developer type, none for normal users and internal for moderators | |
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. | |
**n** | Option<**i32**> | The number of objects to return. | |[default to 60]
### Return type
[**Vec<crate::models::LimitedUser>**](LimitedUser.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## search_users
> Vec<crate::models::LimitedUser> search_users(search, developer_type, n, offset)
Search All Users
Search and list any users by text query
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**search** | Option<**String**> | Searches by `displayName`. Will return empty array if search query is empty or missing. | |
**developer_type** | Option<**String**> | Active user by developer type, none for normal users and internal for moderators | |
**n** | Option<**i32**> | The number of objects to return. | |[default to 60]
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. | |
### Return type
[**Vec<crate::models::LimitedUser>**](LimitedUser.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## update_user
> crate::models::CurrentUser update_user(user_id, inline_object2)
Update User Info
Update a users information such as the email and birthday.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**inline_object2** | Option<[**InlineObject2**](InlineObject2.md)> | | |
### Return type
[**crate::models::CurrentUser**](CurrentUser.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

42
docs/World.md Normal file
View File

@ -0,0 +1,42 @@
# World
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_url** | **String** | |
**asset_url_object** | [**serde_json::Value**](.md) | |
**author_id** | **String** | | [readonly]
**author_name** | **String** | | [readonly]
**capacity** | **f32** | | [readonly]
**created_at** | **String** | | [readonly]
**description** | **String** | |
**favorites** | Option<**f32**> | | [optional][readonly][default to 0]
**featured** | **bool** | | [default to false]
**heat** | **f32** | | [readonly][default to 0]
**id** | **String** | |
**image_url** | **String** | |
**instances** | Option<[**Vec<serde_json::Value>**](serde_json::Value.md)> | | [optional]
**labs_publication_date** | **String** | |
**name** | **String** | |
**namespace** | **String** | |
**occupants** | Option<**f32**> | | [optional][readonly][default to 0]
**organization** | **String** | | [default to vrchat]
**plugin_url_object** | [**serde_json::Value**](.md) | |
**popularity** | **f32** | | [readonly][default to 0]
**preview_youtube_id** | Option<**String**> | | [optional]
**private_occupants** | Option<**f32**> | | [optional][readonly][default to 0]
**public_occupants** | Option<**f32**> | | [optional][readonly][default to 0]
**publication_date** | **String** | |
**release_status** | [**crate::models::ReleaseStatus**](ReleaseStatus.md) | |
**tags** | **Vec<String>** | |
**thumbnail_image_url** | **String** | |
**unity_package_url_object** | [**serde_json::Value**](.md) | |
**unity_packages** | [**Vec<crate::models::UnityPackage>**](UnityPackage.md) | |
**updated_at** | **String** | |
**version** | **f32** | | [default to 0]
**visits** | **f32** | | [readonly][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)

429
docs/WorldsApi.md Normal file
View File

@ -0,0 +1,429 @@
# \WorldsApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create_world**](WorldsApi.md#create_world) | **POST** /worlds | Create World
[**delete_world**](WorldsApi.md#delete_world) | **DELETE** /worlds/{worldId} | Delete World
[**get_active_worlds**](WorldsApi.md#get_active_worlds) | **GET** /worlds/active | List Active Worlds
[**get_favorited_worlds**](WorldsApi.md#get_favorited_worlds) | **GET** /worlds/favorites | List Favorited Worlds
[**get_recent_worlds**](WorldsApi.md#get_recent_worlds) | **GET** /worlds/recent | List Recent Worlds
[**get_world**](WorldsApi.md#get_world) | **GET** /worlds/{worldId} | Get World by ID
[**get_world_metadata**](WorldsApi.md#get_world_metadata) | **GET** /worlds/{worldId}/metadata | Get World Metadata
[**get_world_publish**](WorldsApi.md#get_world_publish) | **GET** /worlds/{worldId}/publish | Get World Publish Status
[**publish_world**](WorldsApi.md#publish_world) | **PUT** /worlds/{worldId}/publish |
[**search_worlds**](WorldsApi.md#search_worlds) | **GET** /worlds | Search All Worlds
[**unpublish_world**](WorldsApi.md#unpublish_world) | **DELETE** /worlds/{worldId}/publish |
[**update_world**](WorldsApi.md#update_world) | **PUT** /worlds/{worldId} | Update World
## create_world
> crate::models::World create_world(inline_object5)
Create World
Create a new world. This endpoint requires `assetUrl` to be a valid File object with `.vrcw` file extension, and `imageUrl` to be a valid File object with an image file extension.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**inline_object5** | Option<[**InlineObject5**](InlineObject5.md)> | | |
### Return type
[**crate::models::World**](World.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## delete_world
> delete_world(world_id)
Delete World
Delete a world. Notice a world is never fully \"deleted\", only its ReleaseStatus is set to \"hidden\" and the linked Files are deleted. The WorldID is permanently reserved.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_active_worlds
> Vec<crate::models::LimitedWorld> get_active_worlds(featured, sort, n, order, offset, search, tag, notag, release_status, max_unity_version, min_unity_version, platform)
List Active Worlds
Search and list currently Active worlds by query filters.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**featured** | Option<**String**> | Filters on featured results. | |
**sort** | Option<**String**> | | |[default to popularity]
**n** | Option<**i32**> | The number of objects to return. | |[default to 60]
**order** | Option<**String**> | | |[default to descending]
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. | |
**search** | Option<**String**> | Filters by world name. | |
**tag** | Option<**String**> | Tags to include (comma-separated). | |
**notag** | Option<**String**> | Tags to exclude (comma-separated). | |
**release_status** | Option<**String**> | Filter by ReleaseStatus. | |[default to hidden]
**max_unity_version** | Option<**String**> | The maximum Unity version supported by the asset. | |
**min_unity_version** | Option<**String**> | The minimum Unity version supported by the asset. | |
**platform** | Option<**String**> | The platform the asset supports. | |
### Return type
[**Vec<crate::models::LimitedWorld>**](LimitedWorld.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_favorited_worlds
> Vec<crate::models::LimitedWorld> get_favorited_worlds(featured, sort, n, order, offset, search, tag, notag, release_status, max_unity_version, min_unity_version, platform, user_id)
List Favorited Worlds
Search and list favorited worlds by query filters.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**featured** | Option<**String**> | Filters on featured results. | |
**sort** | Option<**String**> | | |[default to popularity]
**n** | Option<**i32**> | The number of objects to return. | |[default to 60]
**order** | Option<**String**> | | |[default to descending]
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. | |
**search** | Option<**String**> | Filters by world name. | |
**tag** | Option<**String**> | Tags to include (comma-separated). | |
**notag** | Option<**String**> | Tags to exclude (comma-separated). | |
**release_status** | Option<**String**> | Filter by ReleaseStatus. | |[default to hidden]
**max_unity_version** | Option<**String**> | The maximum Unity version supported by the asset. | |
**min_unity_version** | Option<**String**> | The minimum Unity version supported by the asset. | |
**platform** | Option<**String**> | The platform the asset supports. | |
**user_id** | Option<**String**> | Target user to see information on, admin-only. | |
### Return type
[**Vec<crate::models::LimitedWorld>**](LimitedWorld.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_recent_worlds
> Vec<crate::models::LimitedWorld> get_recent_worlds(featured, sort, n, order, offset, search, tag, notag, release_status, max_unity_version, min_unity_version, platform, user_id)
List Recent Worlds
Search and list recently visited worlds by query filters.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**featured** | Option<**String**> | Filters on featured results. | |
**sort** | Option<**String**> | | |[default to popularity]
**n** | Option<**i32**> | The number of objects to return. | |[default to 60]
**order** | Option<**String**> | | |[default to descending]
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. | |
**search** | Option<**String**> | Filters by world name. | |
**tag** | Option<**String**> | Tags to include (comma-separated). | |
**notag** | Option<**String**> | Tags to exclude (comma-separated). | |
**release_status** | Option<**String**> | Filter by ReleaseStatus. | |[default to hidden]
**max_unity_version** | Option<**String**> | The maximum Unity version supported by the asset. | |
**min_unity_version** | Option<**String**> | The minimum Unity version supported by the asset. | |
**platform** | Option<**String**> | The platform the asset supports. | |
**user_id** | Option<**String**> | Target user to see information on, admin-only. | |
### Return type
[**Vec<crate::models::LimitedWorld>**](LimitedWorld.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_world
> crate::models::World get_world(world_id)
Get World by ID
Get information about a specific World.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
### Return type
[**crate::models::World**](World.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_world_metadata
> crate::models::InlineResponse2006 get_world_metadata(world_id)
Get World Metadata
Returns a worlds custom metadata. This is currently believed to be unused. Metadata can be set with `updateWorld` and can be any arbitrary object.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
### Return type
[**crate::models::InlineResponse2006**](inline_response_200_6.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_world_publish
> crate::models::InlineResponse2007 get_world_publish(world_id)
Get World Publish Status
Returns a worlds publish status. This is currently believed to be unused.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
### Return type
[**crate::models::InlineResponse2007**](inline_response_200_7.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## publish_world
> publish_world(world_id)
Publishes a world. You can only publish one world per week.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## search_worlds
> Vec<crate::models::LimitedWorld> search_worlds(featured, sort, user, user_id, n, order, offset, search, tag, notag, release_status, max_unity_version, min_unity_version, platform)
Search All Worlds
Search and list any worlds by query filters.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**featured** | Option<**String**> | Filters on featured results. | |
**sort** | Option<**String**> | | |[default to popularity]
**user** | Option<**String**> | Set to `me` for searching own worlds. | |
**user_id** | Option<**String**> | Filter by author UserID | |
**n** | Option<**i32**> | The number of objects to return. | |[default to 60]
**order** | Option<**String**> | | |[default to descending]
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. | |
**search** | Option<**String**> | Filters by world name. | |
**tag** | Option<**String**> | Tags to include (comma-separated). | |
**notag** | Option<**String**> | Tags to exclude (comma-separated). | |
**release_status** | Option<**String**> | Filter by ReleaseStatus. | |[default to hidden]
**max_unity_version** | Option<**String**> | The maximum Unity version supported by the asset. | |
**min_unity_version** | Option<**String**> | The minimum Unity version supported by the asset. | |
**platform** | Option<**String**> | The platform the asset supports. | |
### Return type
[**Vec<crate::models::LimitedWorld>**](LimitedWorld.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## unpublish_world
> unpublish_world(world_id)
Unpublishes a world.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## update_world
> crate::models::World update_world(world_id, inline_object6)
Update World
Update information about a specific World.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
**inline_object6** | Option<[**InlineObject6**](InlineObject6.md)> | | |
### Return type
[**crate::models::World**](World.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

2
generate.sh
View File

@ -12,8 +12,6 @@ openapi-generator-cli generate \
-i ../specification/openapi.yaml \
--http-user-agent="vrchatapi-rust"
rm docs -rf
sed -i '/^edition = "2018"/i license = "MIT"' Cargo.toml
sed -i '/^edition = "2018"/a description="VRChat API Library for Rust"' Cargo.toml