Upgrade Rust SDK to spec 1.6.0

2025-12-03 02:58:22 +00:00 · 2021-11-25 21:33:35 +00:00
parent a5cd440e05
commit adf2aa961e
46 changed files with 225 additions and 69 deletions
--- a/docs/ApiConfig.md
+++ b/docs/ApiConfig.md
@@ -47,9 +47,9 @@ Name | Type | Description | Notes
 **dynamic_world_rows** | [**Vec<crate::models::DynamicContentRow>**](DynamicContentRow.md) | Array of DynamicWorldRow objects, used by the game to display the list of world rows | 
 **events** | [**crate::models::ApiEventConfig**](APIEventConfig.md) |  | 
 **gear_demo_room_id** | **String** | Unknown | 
-**home_world_id** | **String** |  | 
+**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** |  | 
+**hub_world_id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | 
 **jobs_email** | **String** | VRChat's job application email | 
 **message_of_the_day** | **String** | MOTD | 
 **moderation_email** | **String** | VRChat's moderation related email | 
@@ -66,8 +66,8 @@ Name | Type | Description | Notes
 **sdk_unity_version** | **String** | Unity version supported by the SDK | 
 **server_name** | **String** | Server name of the API server currently responding | 
 **support_email** | **String** | VRChat's support email | 
-**time_out_world_id** | **String** |  | 
-**tutorial_world_id** | **String** |  | 
+**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. | 
 **update_rate_ms_maximum** | **i32** | Unknown | 
 **update_rate_ms_minimum** | **i32** | Unknown | 
 **update_rate_ms_normal** | **i32** | Unknown | 
--- a/docs/Avatar.md
+++ b/docs/Avatar.md
@@ -6,9 +6,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **asset_url** | Option<**String**> | Not present from general serach `/avatars`, only on specific requests `/avatars/{avatarId}`. | [optional]
 **asset_url_object** | Option<[**serde_json::Value**](.md)> | Not present from general serach `/avatars`, only on specific requests `/avatars/{avatarId}`. **Deprecation:** `Object` has unknown usage/fields, and is always empty. Use normal `Url` field instead. | [optional]
-**author_id** | **String** |  | 
-**author_name** | **String** |  | [readonly]
-**created_at** | **String** |  | [readonly]
+**author_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. | 
+**author_name** | **String** |  | 
+**created_at** | **String** |  | 
 **description** | **String** |  | 
 **featured** | **bool** |  | [default to false]
 **id** | **String** |  | 
@@ -21,7 +21,7 @@ Name | Type | Description | Notes
 **unity_package_url_object** | [**crate::models::AvatarUnityPackageUrlObject**](Avatar_unityPackageUrlObject.md) |  | 
 **unity_packages** | [**Vec<crate::models::UnityPackage>**](UnityPackage.md) |  | 
 **updated_at** | **String** |  | 
-**version** | **i32** |  | [readonly][default to 0]
+**version** | **i32** |  | [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)

--- a/docs/CreateWorldRequest.md
+++ b/docs/CreateWorldRequest.md
@@ -6,11 +6,11 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **asset_url** | **String** |  | 
 **asset_version** | Option<**i32**> |  | [optional]
-**author_id** | Option<**String**> |  | [optional]
+**author_id** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional]
 **author_name** | Option<**String**> |  | [optional]
 **capacity** | Option<**i32**> |  | [optional]
 **description** | Option<**String**> |  | [optional]
-**id** | Option<**String**> |  | [optional]
+**id** | Option<**String**> | WorldID be \"offline\" on User profiles if you are not friends with that user. | [optional]
 **image_url** | **String** |  | 
 **name** | **String** |  | 
 **platform** | Option<**String**> | This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [optional]
--- a/docs/CurrentUser.md
+++ b/docs/CurrentUser.md
@@ -26,8 +26,8 @@ Name | Type | Description | Notes
 **has_email** | **bool** |  | 
 **has_logged_in_from_client** | **bool** |  | 
 **has_pending_email** | **bool** |  | 
-**home_location** | **String** |  | 
-**id** | **String** |  | 
+**home_location** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | 
+**id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | 
 **is_friend** | **bool** |  | [default to false]
 **last_login** | **String** |  | 
 **last_platform** | **String** | This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | 
--- a/docs/FavoriteGroup.md
+++ b/docs/FavoriteGroup.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **id** | **String** |  | 
 **name** | **String** |  | 
 **owner_display_name** | **String** |  | 
-**owner_id** | **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. | 
 **tags** | **Vec<String>** |  | 
 **_type** | [**crate::models::FavoriteType**](FavoriteType.md) |  | 
 **visibility** | [**crate::models::FavoriteGroupVisibility**](FavoriteGroupVisibility.md) |  | 
--- a/docs/File.md
+++ b/docs/File.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **id** | **String** |  | 
 **mime_type** | [**crate::models::MimeType**](MIMEType.md) |  | 
 **name** | **String** |  | 
-**owner_id** | **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. | 
 **tags** | **Vec<String>** |  | 
 **versions** | [**Vec<crate::models::FileVersion>**](FileVersion.md) |  | 

--- a/docs/FileData.md
+++ b/docs/FileData.md
@@ -4,7 +4,7 @@

 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**category** | **String** |  | [readonly][default to Category_Queued]
+**category** | **String** |  | [default to Category_Queued]
 **file_name** | **String** |  | 
 **md5** | **String** |  | 
 **size_in_bytes** | **i32** |  | 
--- a/docs/Instance.md
+++ b/docs/Instance.md
@@ -7,25 +7,25 @@ Name | Type | Description | Notes
 **active** | **bool** |  | [default to true]
 **can_request_invite** | **bool** |  | [default to true]
 **capacity** | **i32** |  | 
-**client_number** | **String** |  | 
+**client_number** | **String** | Always returns \"unknown\". | 
 **full** | **bool** |  | [default to false]
-**id** | **String** |  | 
+**id** | **String** | InstanceID be \"offline\" on User profiles if you are not friends with that user. | 
 **instance_id** | **String** |  | 
-**location** | **String** |  | 
+**location** | **String** | InstanceID be \"offline\" on User profiles if you are not friends with that user. | 
 **n_users** | **i32** |  | 
 **name** | **String** |  | 
-**nonce** | Option<**String**> |  | [optional]
-**owner_id** | Option<**String**> |  | [optional]
+**owner_id** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional]
 **permanent** | **bool** |  | [default to false]
-**photon_region** | **String** |  | 
-**platforms** | [**crate::models::InstancePlatforms**](Instance_platforms.md) |  | 
-**region** | **String** |  | 
+**photon_region** | [**crate::models::Region**](Region.md) |  | 
+**platforms** | [**crate::models::InstancePlatforms**](InstancePlatforms.md) |  | 
+**region** | [**crate::models::Region**](Region.md) |  | 
 **short_name** | **String** |  | 
-**tags** | **Vec<String>** |  | 
-**_type** | **String** |  | 
-**users** | Option<[**Vec<serde_json::Value>**](serde_json::Value.md)> | Always empty on non-existing instances, and non-present on existing instances. | [optional]
-**world** | Option<[**serde_json::Value**](.md)> | Only present on non-existing instances, and only contains a very small subject of World object. Use World API instead. | [optional]
-**world_id** | **String** |  | 
+**tags** | **Vec<String>** | The tags array on Instances usually contain the language tags of the people in the instance.  | 
+**_type** | [**crate::models::InstanceType**](InstanceType.md) |  | 
+**world_id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | 
+**hidden** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional]
+**friends** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional]
+**private** | 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]

 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

--- a/docs/InstanceType.md
+++ b/docs/InstanceType.md
@@ -0,0 +1,10 @@
+# InstanceType
+
+## 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)
+
+
--- a/docs/InstancesApi.md
+++ b/docs/InstancesApi.md
@@ -15,7 +15,7 @@ Method | HTTP request | Description
 > crate::models::Instance get_instance(world_id, instance_id)
 Get Instance

-Returns an instance.
+Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances.  If an invalid instanceId is provided, this endpoint will simply return \"null\"!

 ### Parameters

--- a/docs/InviteRequest.md
+++ b/docs/InviteRequest.md
@@ -4,7 +4,7 @@

 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**instance_id** | **String** |  | 
+**instance_id** | **String** | InstanceID be \"offline\" on User profiles if you are not friends with that user. | 

 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

--- a/docs/LimitedUser.md
+++ b/docs/LimitedUser.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **developer_type** | [**crate::models::DeveloperType**](DeveloperType.md) |  | 
 **display_name** | **String** |  | 
 **fallback_avatar** | **String** |  | 
-**id** | **String** |  | 
+**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. | 
 **is_friend** | **bool** |  | 
 **last_platform** | **String** | This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | 
 **profile_pic_override** | **String** |  | 
--- a/docs/LimitedWorld.md
+++ b/docs/LimitedWorld.md
@@ -4,13 +4,13 @@

 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**author_id** | **String** |  | 
+**author_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. | 
 **author_name** | **String** |  | 
 **capacity** | **i32** |  | 
 **created_at** | **String** |  | 
 **favorites** | **i32** |  | [default to 0]
 **heat** | **i32** |  | [default to 0]
-**id** | **String** |  | 
+**id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | 
 **image_url** | **String** |  | 
 **labs_publication_date** | **String** |  | 
 **name** | **String** |  | 
--- a/docs/ModerateUserRequest.md
+++ b/docs/ModerateUserRequest.md
@@ -4,7 +4,7 @@

 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**moderated** | **String** |  | 
+**moderated** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | 
 **_type** | [**crate::models::PlayerModerationType**](PlayerModerationType.md) |  | 

 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
--- a/docs/Notification.md
+++ b/docs/Notification.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **id** | **String** |  | 
 **message** | **String** |  | 
 **seen** | **bool** |  | [default to false]
-**sender_user_id** | **String** |  | 
+**sender_user_id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | 
 **sender_username** | **String** |  | 
 **_type** | [**crate::models::NotificationType**](NotificationType.md) |  | 

--- a/docs/Permission.md
+++ b/docs/Permission.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** |  | 
 **name** | **String** |  | 
-**owner_id** | **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]

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

 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
--- a/docs/Region.md
+++ b/docs/Region.md
@@ -0,0 +1,10 @@
+# Region
+
+## 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)
+
+
--- a/docs/UpdateWorldRequest.md
+++ b/docs/UpdateWorldRequest.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **asset_url** | Option<**String**> |  | [optional]
 **asset_version** | Option<**String**> |  | [optional]
-**author_id** | Option<**String**> |  | [optional]
+**author_id** | Option<**String**> | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional]
 **author_name** | Option<**String**> |  | [optional]
 **capacity** | Option<**i32**> |  | [optional]
 **description** | Option<**String**> |  | [optional]
--- a/docs/User.md
+++ b/docs/User.md
@@ -4,29 +4,29 @@

 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**allow_avatar_copying** | **bool** |  | 
+**allow_avatar_copying** | **bool** |  | [default to true]
 **bio** | **String** |  | 
 **bio_links** | **Vec<String>** |  | 
 **current_avatar_image_url** | **String** | When profilePicOverride is not empty, use it instead. | 
 **current_avatar_thumbnail_image_url** | **String** | When profilePicOverride is not empty, use it instead. | 
-**date_joined** | [**String**](string.md) |  | [readonly]
+**date_joined** | [**String**](string.md) |  | 
 **developer_type** | [**crate::models::DeveloperType**](DeveloperType.md) |  | 
-**display_name** | **String** |  | 
+**display_name** | **String** | A users visual display name. This is what shows up in-game, and can different from their `username`. Changing display name is restricted to a cooldown period. | 
 **friend_key** | **String** |  | 
-**id** | **String** |  | 
-**instance_id** | Option<**String**> |  | [optional]
-**is_friend** | **bool** |  | 
-**last_login** | **String** |  | 
+**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. | 
+**instance_id** | Option<**String**> | InstanceID be \"offline\" on User profiles if you are not friends with that user. | [optional]
+**is_friend** | **bool** | Either their `friendKey`, or empty string if you are not friends. Unknown usage. | 
+**last_login** | **String** | Either a date-time or empty string. | 
 **last_platform** | **String** | This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | 
-**location** | Option<**String**> |  | [optional]
+**location** | Option<**String**> | WorldID be \"offline\" on User profiles if you are not friends with that user. | [optional]
 **profile_pic_override** | **String** |  | 
 **state** | [**crate::models::UserState**](UserState.md) |  | 
 **status** | [**crate::models::UserStatus**](UserStatus.md) |  | 
 **status_description** | **String** |  | 
 **tags** | **Vec<String>** |  | 
 **user_icon** | **String** |  | 
-**username** | **String** |  | 
-**world_id** | Option<**String**> |  | [optional]
+**username** | **String** | A users unique name, used during login. This is different from `displayName` which is what shows up in-game. A users `username` can never be changed. | 
+**world_id** | Option<**String**> | WorldID be \"offline\" on User profiles if you are not friends with that user. | [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)

--- a/docs/World.md
+++ b/docs/World.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **asset_url** | **String** |  | 
 **asset_url_object** | [**serde_json::Value**](.md) |  | 
-**author_id** | **String** |  | 
+**author_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. | 
 **author_name** | **String** |  | 
 **capacity** | **i32** |  | 
 **created_at** | **String** |  | 
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **favorites** | Option<**i32**> |  | [optional][default to 0]
 **featured** | **bool** |  | [default to false]
 **heat** | **i32** |  | [default to 0]
-**id** | **String** |  | 
+**id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | 
 **image_url** | **String** |  | 
 **instances** | Option<[**Vec<Vec<serde_json::Value>>**](array.md)> |  | [optional]
 **labs_publication_date** | **String** |  | 
--- a/docs/WorldMetadata.md
+++ b/docs/WorldMetadata.md
@@ -4,7 +4,7 @@

 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** |  | 
+**id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | 
 **metadata** | [**serde_json::Value**](.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)