mii/vrchatapi-rust
1
0
Fork 0
mirror of https://github.com/mii443/vrchatapi-rust.git synced 2025-12-03 02:58:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Upgrade Rust SDK to spec 1.18.1

Browse Source
This commit is contained in:
VRCCat
2024-07-22 21:38:50 +00:00
parent 06549589c0
commit 81b7d01d13
22 changed files with 189 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/ApiConfig.md
View File

@@ -9,28 +9,41 @@ Name | Type | Description | Notes
**address** | **String** | VRChat's office address |
**announcements** | [**Vec<models::ApiConfigAnnouncement>**](APIConfigAnnouncement.md) | Public Announcements |
**app_name** | **String** | Game name | [default to VrChat]
**available_language_codes** | **Vec<String>** | List of supported Languages |
**available_languages** | **Vec<String>** | List of supported Languages |
**build_version_tag** | **String** | Build tag of the API server |
**client_api_key** | **String** | apiKey to be used for all other requests |
**client_bps_ceiling** | **i32** | Unknown | [default to 18432]
**client_disconnect_timeout** | **i32** | Unknown | [default to 30000]
**client_net_dispatch_thread** | Option<**bool**> | Unknown | [optional][default to false]
**client_net_in_thread** | Option<**bool**> | Unknown | [optional][default to false]
**client_net_in_thread2** | Option<**bool**> | Unknown | [optional][default to false]
**client_net_in_thread_mobile** | Option<**bool**> | Unknown | [optional][default to false]
**client_net_in_thread_mobile2** | Option<**bool**> | Unknown | [optional][default to false]
**client_net_out_thread** | Option<**bool**> | Unknown | [optional][default to false]
**client_net_out_thread2** | Option<**bool**> | Unknown | [optional][default to false]
**client_net_out_thread_mobile** | Option<**bool**> | Unknown | [optional][default to false]
**client_net_out_thread_mobile2** | Option<**bool**> | Unknown | [optional][default to false]
**client_qr** | Option<**i32**> | Unknown | [optional][default to 1]
**client_reserved_player_bps** | **i32** | Unknown | [default to 7168]
**client_sent_count_allowance** | **i32** | Unknown | [default to 15]
**contact_email** | **String** | VRChat's contact email |
**copyright_email** | **String** | VRChat's copyright-issues-related email |
**current_privacy_version** | Option<**i32**> | Current version number of the Privacy Agreement | [optional][default to 1]
**current_tos_version** | **i32** | Current version number of the Terms of Service |
**default_avatar** | **String** | |
**deployment_group** | [**models::DeploymentGroup**](DeploymentGroup.md) | |
**dev_app_version_standalone** | **String** | Version number for game development build |
**dev_download_link_windows** | **String** | Developer Download link |
**dev_language_codes** | Option<**Vec<String>**> | Unknown | [optional]
**dev_sdk_url** | **String** | Link to download the development SDK, use downloadUrls instead |
**dev_sdk_version** | **String** | Version of the development SDK |
**dev_server_version_standalone** | **String** | Version number for server development build |
**dis_countdown** | **String** | Unknown, \"dis\" maybe for disconnect? |
**disable_av_pro_in_proton** | Option<**bool**> | Unknown | [optional][default to false]
**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** | **bool** | Unknown | [default to false]
**disable_captcha** | Option<**bool**> | Unknown | [optional][default to true]
**disable_event_stream** | **bool** | Toggles if Analytics should be disabled. | [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_frontend_builds** | **bool** | Unknown, probably toggles compilation of frontend web builds? So internal flag? | [default to false]
@@ -44,26 +57,23 @@ Name | Type | Description | Notes
**download_link_windows** | **String** | Download link for game on the Oculus Rift website. |
**download_urls** | [**models::ApiConfigDownloadUrlList**](APIConfigDownloadURLList.md) | |
**dynamic_world_rows** | [**Vec<models::DynamicContentRow>**](DynamicContentRow.md) | Array of DynamicWorldRow objects, used by the game to display the list of world rows |
**economy_pause_end** | Option<**String**> | Unknown | [optional]
**economy_pause_start** | Option<**String**> | Unknown | [optional]
**economy_state** | Option<**i32**> | Unknown | [optional][default to 1]
**events** | [**models::ApiConfigEvents**](APIConfigEvents.md) | |
**gear_demo_room_id** | **String** | Unknown |
**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]
**hub_world_id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
**image_host_url_list** | **Vec<String>** | A list of explicitly allowed origins that worlds can request images from via the Udon's [VRCImageDownloader#DownloadImage](https://creators.vrchat.com/worlds/udon/image-loading/#downloadimage). |
**jobs_email** | **String** | VRChat's job application email |
**message_of_the_day** | **String** | MOTD |
**moderation_email** | **String** | VRChat's moderation related email |
**moderation_query_period** | **i32** | 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 |
**plugin** | **String** | Extra [plugin](https://doc.photonengine.com/en-us/server/current/plugins/manual) to run in each instance |
**release_app_version_standalone** | **String** | Version number for game release build |
**release_sdk_url** | **String** | Link to download the release SDK |
**release_sdk_version** | **String** | Version of the release SDK |
**release_server_version_standalone** | **String** | Version number for server release build |
**sdk_developer_faq_url** | **String** | Link to the developer FAQ |
**sdk_discord_url** | **String** | Link to the official VRChat Discord |
**sdk_not_allowed_to_publish_message** | **String** | Used in the SDK to notify a user they aren't allowed to upload avatars/worlds yet |
**sdk_unity_version** | **String** | Unity version supported by the SDK |
**server_name** | **String** | Server name of the API server currently responding |
**string_host_url_list** | **Vec<String>** | A list of explicitly allowed origins that worlds can request strings from via the Udon's [VRCStringDownloader.LoadUrl](https://creators.vrchat.com/worlds/udon/string-loading/#ivrcstringdownload). |
**support_email** | **String** | VRChat's support email |
**time_out_world_id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
**tutorial_world_id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
@@ -74,15 +84,10 @@ Name | Type | Description | Notes
**upload_analysis_percent** | **i32** | Unknown |
**url_list** | **Vec<String>** | List of allowed URLs that bypass the \"Allow untrusted URL's\" setting in-game |
**use_reliable_udp_for_voice** | **bool** | Unknown | [default to false]
**user_update_period** | **i32** | Unknown |
**user_verification_delay** | **i32** | Unknown |
**user_verification_retry** | **i32** | Unknown |
**user_verification_timeout** | **i32** | Unknown |
**vive_windows_url** | **String** | Download link for game on the Steam website. |
**white_listed_asset_urls** | **Vec<String>** | List of allowed URLs that are allowed to host avatar assets |
**world_update_period** | **i32** | Unknown |
**player_url_resolver_hash** | **String** | Currently used youtube-dl.exe hash in SHA-256-delimited format |
**player_url_resolver_version** | **String** | Currently used youtube-dl.exe version |
**player_url_resolver_sha1** | **String** | Currently used youtube-dl.exe hash in SHA1-delimited format |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

4
docs/AuthenticationApi.md
View File

@@ -17,7 +17,7 @@ Method | HTTP request | Description
## check_user_exists
> models::UserExists check_user_exists(email, display_name, user_id, exclude_user_id)
> models::UserExists check_user_exists(email, display_name, username, exclude_user_id)
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.
@@ -29,7 +29,7 @@ Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**email** | Option<**String**> | Filter by email. | |
**display_name** | Option<**String**> | Filter by displayName. | |
**user_id** | Option<**String**> | Filter by UserID. | |
**username** | Option<**String**> | Filter by Username. | |
**exclude_user_id** | Option<**String**> | Exclude by UserID. | |
### Return type

2
docs/FileData.md
View File

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**category** | **String** | | [default to Queued]
**file_name** | **String** | |
**md5** | **String** | |
**md5** | Option<**String**> | | [optional]
**size_in_bytes** | **i32** | |
**status** | [**models::FileStatus**](FileStatus.md) | |
**upload_id** | **String** | | [default to ]

6
docs/FilesApi.md
View File

@@ -80,7 +80,7 @@ Name | Type | Description | Required | Notes
## delete_file
> models::Success delete_file(file_id)
> models::File delete_file(file_id)
Delete File
Deletes a File object.
@@ -94,7 +94,7 @@ Name | Type | Description | Required | Notes
### Return type
[**models::Success**](Success.md)
[**models::File**](File.md)
### Authorization
@@ -165,7 +165,7 @@ Name | Type | Description | Required | Notes
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: 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)

3
docs/Group.md
View File

@@ -23,8 +23,11 @@ Name | Type | Description | Notes
**is_verified** | Option<**bool**> | | [optional][default to false]
**join_state** | Option<[**models::GroupJoinState**](GroupJoinState.md)> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional]
**transfer_target_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]
**galleries** | Option<[**Vec<models::GroupGallery>**](GroupGallery.md)> | | [optional]
**created_at** | Option<**String**> | | [optional]
**updated_at** | Option<**String**> | | [optional]
**last_post_created_at** | Option<**String**> | | [optional]
**online_member_count** | Option<**i32**> | | [optional]
**membership_status** | Option<[**models::GroupMemberStatus**](GroupMemberStatus.md)> | | [optional]
**my_member** | Option<[**models::GroupMyMember**](GroupMyMember.md)> | | [optional]

6
docs/GroupMyMember.md
View File

@@ -8,6 +8,9 @@ Name | Type | Description | Notes
**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]
**role_ids** | Option<**Vec<String>**> | | [optional]
**accepted_by_display_name** | Option<**String**> | | [optional]
**accepted_by_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]
**created_at** | Option<**String**> | | [optional]
**manager_notes** | Option<**String**> | | [optional]
**membership_status** | Option<**String**> | | [optional]
**is_subscribed_to_announcements** | Option<**bool**> | | [optional][default to true]
@@ -16,6 +19,9 @@ Name | Type | Description | Notes
**joined_at** | Option<**String**> | | [optional]
**banned_at** | Option<**String**> | | [optional]
**has2_fa** | Option<**bool**> | | [optional][default to false]
**has_joined_from_purchase** | Option<**bool**> | | [optional][default to false]
**last_post_read_at** | Option<**String**> | | [optional]
**m_role_ids** | Option<**Vec<String>**> | | [optional]
**permissions** | 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)

1
docs/Permission.md
View File

@@ -5,6 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | |
**owner_display_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. |
**data** | Option<[**serde_json::Value**](.md)> | | [optional]

1
docs/TransactionAgreement.md
View File

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**agreement_id** | **String** | |
**item_id** | **f64** | |
**agreement** | **String** | |
**status** | **String** | This is NOT TransactionStatus, but whatever Steam return. |
**period** | **String** | |
**frequency** | **f64** | |

1
docs/UserSubscription.md
View File

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
**tier** | **f64** | |
**active** | **bool** | | [default to true]
**status** | [**models::TransactionStatus**](TransactionStatus.md) | |
**starts** | Option<**String**> | | [optional]
**expires** | **String** | |
**created_at** | **String** | |
**updated_at** | **String** | |

3
docs/WorldsApi.md
View File

@@ -358,7 +358,7 @@ Name | Type | Description | Required | Notes
## search_worlds
> Vec<models::LimitedWorld> search_worlds(featured, sort, user, user_id, n, order, offset, search, tag, notag, release_status, max_unity_version, min_unity_version, platform)
> Vec<models::LimitedWorld> search_worlds(featured, sort, user, user_id, n, order, offset, search, tag, notag, release_status, max_unity_version, min_unity_version, platform, fuzzy)
Search All Worlds
Search and list any worlds by query filters.
@@ -382,6 +382,7 @@ Name | Type | Description | Required | Notes
**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. | |
**fuzzy** | Option<**bool**> | | |
### Return type