Upgrade Rust SDK to spec 1.7.3

2025-12-03 02:58:22 +00:00 · 2022-09-03 10:14:53 +00:00
parent 4f361c161d
commit 2f9ff05bfe
17 changed files with 293 additions and 27 deletions
--- a/docs/ApiConfig.md
+++ b/docs/ApiConfig.md
@@ -82,8 +82,8 @@ Name | Type | Description | Notes
 **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 | 
-**youtubedl_hash** | **String** | Currently used youtube-dl.exe hash in SHA-256-delimited format | 
-**youtubedl_version** | **String** | Currently used youtube-dl.exe version | 
+**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 | 

 [[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
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.vrchat.cloud/api/1*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_instance**](InstancesApi.md#get_instance) | **GET** /instances/{worldId}:{instanceId} | Get Instance
+[**get_instance_by_short_name**](InstancesApi.md#get_instance_by_short_name) | **GET** /instances/s/{shortName} | Get Instance By Short Name
 [**get_short_name**](InstancesApi.md#get_short_name) | **GET** /instances/{worldId}:{instanceId}/shortName | Get Instance Short Name
 [**send_self_invite**](InstancesApi.md#send_self_invite) | **POST** /instances/{worldId}:{instanceId}/invite | Send Self Invite

@@ -41,6 +42,36 @@ Name | Type | Description  | Required | Notes
 [[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_instance_by_short_name
+
+> crate::models::Instance get_instance_by_short_name(short_name)
+Get Instance By Short Name
+
+Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**short_name** | **String** |  | [required] |
+
+### Return type
+
+[**crate::models::Instance**](Instance.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_short_name

 > String get_short_name(world_id, instance_id)
--- a/docs/InviteApi.md
+++ b/docs/InviteApi.md
@@ -6,6 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_invite_message**](InviteApi.md#get_invite_message) | **GET** /message/{userId}/{messageType}/{slot} | Get Invite Message
 [**get_invite_messages**](InviteApi.md#get_invite_messages) | **GET** /message/{userId}/{messageType} | List Invite Messages
+[**invite_myself_to**](InviteApi.md#invite_myself_to) | **POST** /invite/myself/to/{worldId}:{instanceId} | Invite Myself To Instance
 [**invite_user**](InviteApi.md#invite_user) | **POST** /invite/{userId} | Invite User
 [**request_invite**](InviteApi.md#request_invite) | **POST** /requestInvite/{userId} | Request Invite
 [**reset_invite_message**](InviteApi.md#reset_invite_message) | **DELETE** /message/{userId}/{messageType}/{slot} | Reset Invite Message
@@ -77,9 +78,41 @@ Name | Type | Description  | Required | Notes
 [[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)


+## invite_myself_to
+
+> crate::models::SentNotification invite_myself_to(world_id, instance_id, invite_myself_to_request)
+Invite Myself To Instance
+
+Sends self an invite to an instance
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**world_id** | **String** |  | [required] |
+**instance_id** | **String** |  | [required] |
+**invite_myself_to_request** | Option<[**InviteMyselfToRequest**](InviteMyselfToRequest.md)> |  |  |
+
+### Return type
+
+[**crate::models::SentNotification**](SentNotification.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)
+
+
 ## invite_user

-> crate::models::Notification invite_user(user_id, invite_request)
+> crate::models::SentNotification invite_user(user_id, invite_request)
 Invite User

 Sends an invite to a user. Returns the Notification of type `invite` that was sent.
@@ -94,7 +127,7 @@ Name | Type | Description  | Required | Notes

 ### Return type

-[**crate::models::Notification**](Notification.md)
+[**crate::models::SentNotification**](SentNotification.md)

 ### Authorization

--- a/docs/InviteMyselfToRequest.md
+++ b/docs/InviteMyselfToRequest.md
@@ -0,0 +1,11 @@
+# InviteMyselfToRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**short_name** | **String** | Short Name of the Instance; can be retrieved from the Get Instance Short Name endpoint. | 
+
+[[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/SentNotification.md
+++ b/docs/SentNotification.md
@@ -0,0 +1,18 @@
+# SentNotification
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **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 {}]
+**id** | **String** |  | 
+**message** | **String** |  | 
+**reciever_user_id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | 
+**sender_user_id** | **String** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | 
+**sender_username** | **String** |  | 
+**_type** | [**crate::models::NotificationType**](NotificationType.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/docs/User.md
+++ b/docs/User.md
@@ -13,17 +13,23 @@ Name | Type | Description | Notes
 **developer_type** | [**crate::models::DeveloperType**](DeveloperType.md) |  | 
 **display_name** | **String** | A users visual display name. This is what shows up in-game, and can different from their `username`. Changing display name is restricted to a cooldown period. | 
 **friend_key** | **String** |  | 
+**friend_request_status** | **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 can be \"offline\" on User profiles if you are not friends with that user and \"private\" if you are friends and user is in private instance. | [optional]
 **is_friend** | **bool** | Either their `friendKey`, or empty string if you are not friends. Unknown usage. | 
+**last_activity** | **String** | Either a date-time or empty string. | 
 **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**> | WorldID be \"offline\" on User profiles if you are not friends with that user. | [optional]
+**note** | Option<**String**> |  | [optional]
 **profile_pic_override** | **String** |  | 
 **state** | [**crate::models::UserState**](UserState.md) |  | 
 **status** | [**crate::models::UserStatus**](UserStatus.md) |  | 
 **status_description** | **String** |  | 
 **tags** | **Vec<String>** |  | 
+**traveling_to_instance** | Option<**String**> |  | [optional]
+**traveling_to_location** | Option<**String**> |  | [optional]
+**traveling_to_world** | Option<**String**> |  | [optional]
 **user_icon** | **String** |  | 
 **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]
--- a/docs/World.md
+++ b/docs/World.md
@@ -5,7 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **asset_url** | **String** | Empty if unauthenticated. | 
-**asset_url_object** | [**serde_json::Value**](.md) |  | 
 **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** |  | 
@@ -22,7 +21,6 @@ Name | Type | Description | Notes
 **namespace** | **String** |  | 
 **occupants** | Option<**i32**> |  | [optional][default to 0]
 **organization** | **String** |  | [default to vrchat]
-**plugin_url_object** | [**serde_json::Value**](.md) |  | 
 **popularity** | **i32** |  | [default to 0]
 **preview_youtube_id** | Option<**String**> |  | [optional]
 **private_occupants** | Option<**i32**> |  | [optional][default to 0]
@@ -31,7 +29,6 @@ Name | Type | Description | Notes
 **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) | Empty if unauthenticated. | 
 **updated_at** | **String** |  | 
 **version** | **i32** |  | [default to 0]