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

Upgrade Rust SDK to spec 1.5.0

Browse Source
This commit is contained in:
VRCCat
2021-10-28 20:54:23 +00:00
parent ed45aec710
commit 91bcf683ce
73 changed files with 381 additions and 426 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/InlineObject8.md → docs/AddFavoriteRequest.md
View File

@ -1,4 +1,4 @@
# InlineObject8
# AddFavoriteRequest
## Properties

2
docs/InlineResponse2002.md → docs/ApiHealth.md
View File

@ -1,4 +1,4 @@
# InlineResponse2002
# ApiHealth
## Properties

16
docs/AuthenticationApi.md
View File

@ -133,7 +133,7 @@ This endpoint does not need any parameter.
## verify2_fa
> crate::models::InlineResponse2001 verify2_fa(inline_object)
> crate::models::Verify2FaResult verify2_fa(two_factor_auth_code)
Verify 2FA code
Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
@ -143,11 +143,11 @@ Finishes the login sequence with a normal 2FA-generated code for accounts with 2
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**inline_object** | Option<[**InlineObject**](InlineObject.md)> | | |
**two_factor_auth_code** | Option<[**TwoFactorAuthCode**](TwoFactorAuthCode.md)> | | |
### Return type
[**crate::models::InlineResponse2001**](inline_response_200_1.md)
[**crate::models::Verify2FaResult**](Verify2FAResult.md)
### Authorization
@ -163,7 +163,7 @@ Name | Type | Description | Required | Notes
## verify_auth_token
> crate::models::InlineResponse200 verify_auth_token()
> crate::models::VerifyAuthTokenResult verify_auth_token()
Verify Auth Token
Verify whether the currently provided Auth Token is valid.
@ -174,7 +174,7 @@ This endpoint does not need any parameter.
### Return type
[**crate::models::InlineResponse200**](inline_response_200.md)
[**crate::models::VerifyAuthTokenResult**](VerifyAuthTokenResult.md)
### Authorization
@ -190,7 +190,7 @@ This endpoint does not need any parameter.
## verify_recovery_code
> crate::models::InlineResponse2001 verify_recovery_code(inline_object1)
> crate::models::Verify2FaResult verify_recovery_code(two_factor_auth_code)
Verify 2FA code with Recovery code
Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
@ -200,11 +200,11 @@ Finishes the login sequence with an OTP (One Time Password) recovery code for ac
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**inline_object1** | Option<[**InlineObject1**](InlineObject1.md)> | | |
**two_factor_auth_code** | Option<[**TwoFactorAuthCode**](TwoFactorAuthCode.md)> | | |
### Return type
[**crate::models::InlineResponse2001**](inline_response_200_1.md)
[**crate::models::Verify2FaResult**](Verify2FAResult.md)
### Authorization

39
docs/AvatarsApi.md
View File

@ -10,13 +10,14 @@ Method | HTTP request | Description
[**get_favorited_avatars**](AvatarsApi.md#get_favorited_avatars) | **GET** /avatars/favorites | List Favorited Avatars
[**search_avatars**](AvatarsApi.md#search_avatars) | **GET** /avatars | Search Avatars
[**select_avatar**](AvatarsApi.md#select_avatar) | **PUT** /avatars/{avatarId}/select | Select Avatar
[**select_fallback_avatar**](AvatarsApi.md#select_fallback_avatar) | **PUT** /avatars/{avatarId}/selectFallback | Select Fallback Avatar
[**update_avatar**](AvatarsApi.md#update_avatar) | **PUT** /avatars/{avatarId} | Update Avatar
## create_avatar
> crate::models::Avatar create_avatar(inline_object10)
> crate::models::Avatar create_avatar(create_avatar_request)
Create Avatar
Create an avatar. It's possible to optionally specify a ID if you want a custom one. Attempting to create an Avatar with an already claimed ID will result in a DB error.
@ -26,7 +27,7 @@ Create an avatar. It's possible to optionally specify a ID if you want a custom
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**inline_object10** | Option<[**InlineObject10**](InlineObject10.md)> | | |
**create_avatar_request** | Option<[**CreateAvatarRequest**](CreateAvatarRequest.md)> | | |
### Return type
@ -218,9 +219,39 @@ 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)
## select_fallback_avatar
> crate::models::CurrentUser select_fallback_avatar(avatar_id)
Select Fallback Avatar
Switches into that avatar as your fallback avatar.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**avatar_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)
## update_avatar
> crate::models::Avatar update_avatar(avatar_id, inline_object11)
> crate::models::Avatar update_avatar(avatar_id, update_avatar_request)
Update Avatar
Update information about a specific avatar.
@ -231,7 +262,7 @@ Update information about a specific avatar.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**avatar_id** | **String** | | [required] |
**inline_object11** | Option<[**InlineObject11**](InlineObject11.md)> | | |
**update_avatar_request** | Option<[**UpdateAvatarRequest**](UpdateAvatarRequest.md)> | | |
### Return type

2
docs/InlineObject10.md → docs/CreateAvatarRequest.md
View File

@ -1,4 +1,4 @@
# InlineObject10
# CreateAvatarRequest
## Properties

2
docs/InlineObject3.md → docs/CreateFileRequest.md
View File

@ -1,4 +1,4 @@
# InlineObject3
# CreateFileRequest
## Properties

2
docs/InlineObject4.md → docs/CreateFileVersionRequest.md
View File

@ -1,4 +1,4 @@
# InlineObject4
# CreateFileVersionRequest
## Properties

6
docs/InlineObject6.md → docs/CreateWorldRequest.md
View File

@ -1,14 +1,14 @@
# InlineObject6
# CreateWorldRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_url** | **String** | |
**asset_version** | Option<**String**> | | [optional]
**asset_version** | Option<**i32**> | | [optional]
**author_id** | Option<**String**> | | [optional]
**author_name** | Option<**String**> | | [optional]
**capacity** | Option<**i32**> | | [optional][default to 16]
**capacity** | Option<**i32**> | | [optional]
**description** | Option<**String**> | | [optional]
**id** | Option<**String**> | | [optional]
**image_url** | **String** | |

10
docs/FavoritesApi.md
View File

@ -17,17 +17,17 @@ Method | HTTP request | Description
## add_favorite
> crate::models::Favorite add_favorite(inline_object8)
> crate::models::Favorite add_favorite(add_favorite_request)
Add Favorite
Add a new favorite. Friend groups are named `group_0` through `group_3`. Avatar and World groups are named `avatars1` to `avatar4` and `worlds1` to `worlds4`. You cannot add people whom you are not friends with to your friends list. Destroying a friendship removes the person as favorite on both sides.
Add a new favorite. Friend groups are named `group_0` through `group_3`. Avatar and World groups are named `avatars1` to `avatars4` and `worlds1` to `worlds4`. You cannot add people whom you are not friends with to your friends list. Destroying a friendship removes the person as favorite on both sides.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**inline_object8** | Option<[**InlineObject8**](InlineObject8.md)> | | |
**add_favorite_request** | Option<[**AddFavoriteRequest**](AddFavoriteRequest.md)> | | |
### Return type
@ -236,7 +236,7 @@ Name | Type | Description | Required | Notes
## update_favorite_group
> update_favorite_group(favorite_group_type, favorite_group_name, user_id, inline_object9)
> update_favorite_group(favorite_group_type, favorite_group_name, user_id, update_favorite_group_request)
Update Favorite Group
Update information about a specific favorite group.
@ -249,7 +249,7 @@ Name | Type | Description | Required | Notes
**favorite_group_type** | **String** | The type of group to fetch, must be a valid FavoriteType. | [required] |
**favorite_group_name** | **String** | | [required] |
**user_id** | **String** | | [required] |
**inline_object9** | Option<[**InlineObject9**](InlineObject9.md)> | | |
**update_favorite_group_request** | Option<[**UpdateFavoriteGroupRequest**](UpdateFavoriteGroupRequest.md)> | | |
### Return type

2
docs/FileData.md
View File

@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**category** | **String** | | [readonly]
**category** | **String** | | [readonly][default to Category_Queued]
**file_name** | **String** | |
**md5** | **String** | |
**size_in_bytes** | **i32** | |

2
docs/InlineResponse2004.md → docs/FileUploadUrl.md
View File

@ -1,4 +1,4 @@
# InlineResponse2004
# FileUploadUrl
## Properties

14
docs/InlineResponse2003.md → docs/FileVersionUploadStatus.md
View File

@ -1,15 +1,15 @@
# InlineResponse2003
# FileVersionUploadStatus
## 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]
**upload_id** | **String** | |
**file_name** | **String** | |
**next_part_number** | **f32** | |
**max_parts** | **f32** | |
**parts** | [**Vec<serde_json::Value>**](serde_json::Value.md) | |
**etags** | [**Vec<serde_json::Value>**](serde_json::Value.md) | Unknown |
[[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/FilesApi.md
View File

@ -19,7 +19,7 @@ Method | HTTP request | Description
## create_file
> crate::models::File create_file(inline_object3)
> crate::models::File create_file(create_file_request)
Create File
Creates a new File object
@ -29,7 +29,7 @@ Creates a new File object
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**inline_object3** | Option<[**InlineObject3**](InlineObject3.md)> | | |
**create_file_request** | Option<[**CreateFileRequest**](CreateFileRequest.md)> | | |
### Return type
@ -49,7 +49,7 @@ Name | Type | Description | Required | Notes
## create_file_version
> crate::models::File create_file_version(file_id, inline_object4)
> crate::models::File create_file_version(file_id, create_file_version_request)
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.
@ -60,7 +60,7 @@ Creates a new FileVersion. Once a Version has been created, proceed to the `/fil
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** | | [required] |
**inline_object4** | Option<[**InlineObject4**](InlineObject4.md)> | | |
**create_file_version_request** | Option<[**CreateFileVersionRequest**](CreateFileVersionRequest.md)> | | |
### Return type
@ -172,7 +172,7 @@ Name | Type | Description | Required | Notes
## finish_file_data_upload
> crate::models::File finish_file_data_upload(file_id, version_id, file_type, inline_object5)
> crate::models::File finish_file_data_upload(file_id, version_id, file_type, finish_file_data_upload_request)
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.
@ -185,7 +185,7 @@ Name | Type | Description | Required | Notes
**file_id** | **String** | | [required] |
**version_id** | **i32** | | [required] |
**file_type** | **String** | | [required] |
**inline_object5** | Option<[**InlineObject5**](InlineObject5.md)> | | |
**finish_file_data_upload_request** | Option<[**FinishFileDataUploadRequest**](FinishFileDataUploadRequest.md)> | Please see documentation on ETag's: [https://teppen.io/2018/06/23/aws_s3_etags/](https://teppen.io/2018/06/23/aws_s3_etags/) ETag's should NOT be present when uploading a `signature`. | |
### Return type
@ -235,7 +235,7 @@ Name | Type | Description | Required | Notes
## get_file_data_upload_status
> crate::models::InlineResponse2003 get_file_data_upload_status(file_id, version_id, file_type)
> crate::models::FileVersionUploadStatus 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.
@ -251,7 +251,7 @@ Name | Type | Description | Required | Notes
### Return type
[**crate::models::InlineResponse2003**](inline_response_200_3.md)
[**crate::models::FileVersionUploadStatus**](FileVersionUploadStatus.md)
### Authorization
@ -300,7 +300,7 @@ Name | Type | Description | Required | Notes
## start_file_data_upload
> crate::models::InlineResponse2004 start_file_data_upload(file_id, version_id, file_type, part_number)
> crate::models::FileUploadUrl 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.
@ -317,7 +317,7 @@ Name | Type | Description | Required | Notes
### Return type
[**crate::models::InlineResponse2004**](inline_response_200_4.md)
[**crate::models::FileUploadUrl**](FileUploadURL.md)
### Authorization

2
docs/InlineObject5.md → docs/FinishFileDataUploadRequest.md
View File

@ -1,4 +1,4 @@
# InlineObject5
# FinishFileDataUploadRequest
## Properties

12
docs/InlineObject13.md
View File

@ -1,12 +0,0 @@
# InlineObject13
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**moderated** | Option<**String**> | | [optional]
**_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)

11
docs/InlineResponse2006.md
View File

@ -1,11 +0,0 @@
# InlineResponse2006
## 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/InlineResponse400.md
View File

@ -1,11 +0,0 @@
# InlineResponse400
## 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)

4
docs/InviteApi.md
View File

@ -90,7 +90,7 @@ Sends an invite to a user. Returns the Notification of type `invite` that was se
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**invite_request** | Option<[**InviteRequest**](InviteRequest.md)> | Instance ID when inviting a user. | |
**invite_request** | Option<[**InviteRequest**](InviteRequest.md)> | Slot number of the Invite Message to use when inviting a user. | |
### Return type
@ -175,7 +175,7 @@ Name | Type | Description | Required | Notes
> crate::models::Notification respond_invite(notification_id, invite_response)
Respond Invite
Sends a world invite to a user.
Respond to an invite request by sending a world invite to the requesting user. `:notificationId` is the ID of the requesting notification.
### Parameters

2
docs/LimitedUser.md
View File

@ -19,6 +19,8 @@ Name | Type | Description | Notes
**tags** | **Vec<String>** | <- Always empty. |
**user_icon** | **String** | |
**username** | **String** | |
**location** | Option<**String**> | | [optional]
**friend_key** | 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)

2
docs/InlineObject12.md → docs/ModerateUserRequest.md
View File

@ -1,4 +1,4 @@
# InlineObject12
# ModerateUserRequest
## Properties

4
docs/NotificationsApi.md
View File

@ -8,7 +8,7 @@ Method | HTTP request | Description
[**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
[**mark_notification_as_read**](NotificationsApi.md#mark_notification_as_read) | **PUT** /auth/user/notifications/{notificationId}/see | Mark Notification As Read
@ -137,7 +137,7 @@ Name | Type | Description | Required | Notes
## mark_notification_as_read
> crate::models::Notification mark_notification_as_read(notification_id)
Mark As Read
Mark Notification As Read
Mark a notification as seen.

2
docs/Permission.md
View File

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

4
docs/PermissionsApi.md
View File

@ -4,7 +4,7 @@ All URIs are relative to *https://api.vrchat.cloud/api/1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_assigned_permissions**](PermissionsApi.md#get_assigned_permissions) | **GET** /auth/permissions | Get Assigned Permission
[**get_assigned_permissions**](PermissionsApi.md#get_assigned_permissions) | **GET** /auth/permissions | Get Assigned Permissions
[**get_permission**](PermissionsApi.md#get_permission) | **GET** /permissions/{permissionId} | Get Permission
@ -12,7 +12,7 @@ Method | HTTP request | Description
## get_assigned_permissions
> Vec<crate::models::Permission> get_assigned_permissions()
Get Assigned Permission
Get Assigned Permissions
Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.

10
docs/PlayermoderationApi.md
View File

@ -133,7 +133,7 @@ Name | Type | Description | Required | Notes
## moderate_user
> crate::models::PlayerModeration moderate_user(inline_object12)
> crate::models::PlayerModeration moderate_user(moderate_user_request)
Moderate User
Moderate a user, e.g. unmute them or show their avatar.
@ -143,7 +143,7 @@ Moderate a user, e.g. unmute them or show their avatar.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**inline_object12** | Option<[**InlineObject12**](InlineObject12.md)> | | |
**moderate_user_request** | Option<[**ModerateUserRequest**](ModerateUserRequest.md)> | | |
### Return type
@ -163,17 +163,17 @@ Name | Type | Description | Required | Notes
## unmoderate_user
> crate::models::Success unmoderate_user(inline_object13)
> crate::models::Success unmoderate_user(moderate_user_request)
Unmoderate User
Removes a player moderation previously added through `moderateUser`. E.g if you previuosly have shown their avatar, but now want to reset it to default.
Removes a player moderation previously added through `moderateUser`. E.g if you previously have shown their avatar, but now want to reset it to default.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**inline_object13** | Option<[**InlineObject13**](InlineObject13.md)> | | |
**moderate_user_request** | Option<[**ModerateUserRequest**](ModerateUserRequest.md)> | | |
### Return type

12
docs/SystemApi.md
View File

@ -5,10 +5,10 @@ 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_css**](SystemApi.md#get_css) | **GET** /css/app.js | Download Frontend CSS
[**get_css**](SystemApi.md#get_css) | **GET** /css/app.js | Download CSS
[**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_java_script**](SystemApi.md#get_java_script) | **GET** /js/app.js | Download Frontend JavaScript
[**get_java_script**](SystemApi.md#get_java_script) | **GET** /js/app.js | Download JavaScript
[**get_system_time**](SystemApi.md#get_system_time) | **GET** /time | Current System Time
@ -43,7 +43,7 @@ No authorization required
## get_css
> String get_css(variant, branch)
Download Frontend CSS
Download CSS
Fetches the CSS code to the frontend React website.
@ -100,7 +100,7 @@ No authorization required
## get_health
> crate::models::InlineResponse2002 get_health()
> crate::models::ApiHealth get_health()
Check API Health
~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
@ -111,7 +111,7 @@ This endpoint does not need any parameter.
### Return type
[**crate::models::InlineResponse2002**](inline_response_200_2.md)
[**crate::models::ApiHealth**](APIHealth.md)
### Authorization
@ -128,7 +128,7 @@ No authorization required
## get_java_script
> String get_java_script(variant, branch)
Download Frontend JavaScript
Download JavaScript
Fetches the JavaScript code to the frontend React website.

2
docs/InlineObject.md → docs/TwoFactorAuthCode.md
View File

@ -1,4 +1,4 @@
# InlineObject
# TwoFactorAuthCode
## Properties

2
docs/InlineObject11.md → docs/UpdateAvatarRequest.md
View File

@ -1,4 +1,4 @@
# InlineObject11
# UpdateAvatarRequest
## Properties

2
docs/InlineObject9.md → docs/UpdateFavoriteGroupRequest.md
View File

@ -1,4 +1,4 @@
# InlineObject9
# UpdateFavoriteGroupRequest
## Properties

2
docs/InlineObject2.md → docs/UpdateUserRequest.md
View File

@ -1,4 +1,4 @@
# InlineObject2
# UpdateUserRequest
## Properties

5
docs/InlineObject7.md → docs/UpdateWorldRequest.md
View File

@ -1,4 +1,4 @@
# InlineObject7
# UpdateWorldRequest
## Properties
@ -8,9 +8,8 @@ Name | Type | Description | Notes
**asset_version** | Option<**String**> | | [optional]
**author_id** | Option<**String**> | | [optional]
**author_name** | Option<**String**> | | [optional]
**capacity** | Option<**i32**> | | [optional][default to 16]
**capacity** | Option<**i32**> | | [optional]
**description** | Option<**String**> | | [optional]
**id** | Option<**String**> | | [optional]
**image_url** | Option<**String**> | | [optional]
**name** | Option<**String**> | | [optional]
**platform** | Option<**String**> | This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. | [optional]

4
docs/UsersApi.md
View File

@ -106,7 +106,7 @@ Name | Type | Description | Required | Notes
## update_user
> crate::models::CurrentUser update_user(user_id, inline_object2)
> crate::models::CurrentUser update_user(user_id, update_user_request)
Update User Info
Update a users information such as the email and birthday.
@ -117,7 +117,7 @@ Update a users information such as the email and birthday.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**inline_object2** | Option<[**InlineObject2**](InlineObject2.md)> | | |
**update_user_request** | Option<[**UpdateUserRequest**](UpdateUserRequest.md)> | | |
### Return type

2
docs/InlineResponse2001.md → docs/Verify2FaResult.md
View File

@ -1,4 +1,4 @@
# InlineResponse2001
# Verify2FaResult
## Properties

2
docs/InlineResponse200.md → docs/VerifyAuthTokenResult.md
View File

@ -1,4 +1,4 @@
# InlineResponse200
# VerifyAuthTokenResult
## Properties

4
docs/InlineResponse2005.md → docs/WorldMetadata.md
View File

@ -1,11 +1,11 @@
# InlineResponse2005
# WorldMetadata
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | |
**metadata** | [**serde_json::Value**](.md) | | [readonly]
**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)

4
docs/InlineObject1.md → docs/WorldPublishStatus.md
View File

@ -1,10 +1,10 @@
# InlineObject1
# WorldPublishStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **String** | |
**can_pubilsh** | **bool** | | [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)

16
docs/WorldsApi.md
View File

@ -22,7 +22,7 @@ Method | HTTP request | Description
## create_world
> crate::models::World create_world(inline_object6)
> crate::models::World create_world(create_world_request)
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.
@ -32,7 +32,7 @@ Create a new world. This endpoint requires `assetUrl` to be a valid File object
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**inline_object6** | Option<[**InlineObject6**](InlineObject6.md)> | | |
**create_world_request** | Option<[**CreateWorldRequest**](CreateWorldRequest.md)> | | |
### Return type
@ -268,7 +268,7 @@ Name | Type | Description | Required | Notes
## get_world_metadata
> crate::models::InlineResponse2005 get_world_metadata(world_id)
> crate::models::WorldMetadata get_world_metadata(world_id)
Get World Metadata
Return a worlds custom metadata. This is currently believed to be unused. Metadata can be set with `updateWorld` and can be any arbitrary object.
@ -282,7 +282,7 @@ Name | Type | Description | Required | Notes
### Return type
[**crate::models::InlineResponse2005**](inline_response_200_5.md)
[**crate::models::WorldMetadata**](WorldMetadata.md)
### Authorization
@ -298,7 +298,7 @@ Name | Type | Description | Required | Notes
## get_world_publish_status
> crate::models::InlineResponse2006 get_world_publish_status(world_id)
> crate::models::WorldPublishStatus get_world_publish_status(world_id)
Get World Publish Status
Returns a worlds publish status.
@ -312,7 +312,7 @@ Name | Type | Description | Required | Notes
### Return type
[**crate::models::InlineResponse2006**](inline_response_200_6.md)
[**crate::models::WorldPublishStatus**](WorldPublishStatus.md)
### Authorization
@ -431,7 +431,7 @@ Name | Type | Description | Required | Notes
## update_world
> crate::models::World update_world(world_id, inline_object7)
> crate::models::World update_world(world_id, update_world_request)
Update World
Update information about a specific World.
@ -442,7 +442,7 @@ Update information about a specific World.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
**inline_object7** | Option<[**InlineObject7**](InlineObject7.md)> | | |
**update_world_request** | Option<[**UpdateWorldRequest**](UpdateWorldRequest.md)> | | |
### Return type