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

Update to latest spec

Browse Source
This commit is contained in:
Foorack
2021-08-22 13:40:49 +02:00
parent 3c700cba19
commit c9b7f51e10
90 changed files with 340 additions and 283 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/AvatarsApi.md
View File

@@ -16,7 +16,7 @@ Method | HTTP request | Description
## create_avatar
> crate::models::Avatar create_avatar(inline_object9)
> crate::models::Avatar create_avatar(inline_object10)
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 +26,7 @@ Create an avatar. It's possible to optionally specify a ID if you want a custom
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**inline_object9** | Option<[**InlineObject9**](InlineObject9.md)> | | |
**inline_object10** | Option<[**InlineObject10**](InlineObject10.md)> | | |
### Return type
@@ -220,7 +220,7 @@ Name | Type | Description | Required | Notes
## update_avatar
> crate::models::Avatar update_avatar(avatar_id, inline_object10)
> crate::models::Avatar update_avatar(avatar_id, inline_object11)
Update Avatar
Update information about a specific avatar.
@@ -231,7 +231,7 @@ Update information about a specific avatar.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**avatar_id** | **String** | | [required] |
**inline_object10** | Option<[**InlineObject10**](InlineObject10.md)> | | |
**inline_object11** | Option<[**InlineObject11**](InlineObject11.md)> | | |
### Return type

8
docs/FavoritesApi.md
View File

@@ -17,7 +17,7 @@ Method | HTTP request | Description
## add_favorite
> crate::models::Favorite add_favorite(inline_object7)
> crate::models::Favorite add_favorite(inline_object8)
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.
@@ -27,7 +27,7 @@ Add a new favorite. Friend groups are named `group_0` through `group_3`. Avatar
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**inline_object7** | Option<[**InlineObject7**](InlineObject7.md)> | | |
**inline_object8** | Option<[**InlineObject8**](InlineObject8.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_object8)
> update_favorite_group(favorite_group_type, favorite_group_name, user_id, inline_object9)
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_object8** | Option<[**InlineObject8**](InlineObject8.md)> | | |
**inline_object9** | Option<[**InlineObject9**](InlineObject9.md)> | | |
### Return type

9
docs/FilesApi.md
View File

@@ -49,7 +49,7 @@ Name | Type | Description | Required | Notes
## create_file_version
> crate::models::File create_file_version(file_id)
> crate::models::File create_file_version(file_id, inline_object4)
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,6 +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)> | | |
### Return type
@@ -71,7 +72,7 @@ Name | Type | Description | Required | Notes
### HTTP request headers
- **Content-Type**: Not defined
- **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)
@@ -171,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_object4)
> crate::models::File finish_file_data_upload(file_id, version_id, file_type, inline_object5)
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.
@@ -184,7 +185,7 @@ Name | Type | Description | Required | Notes
**file_id** | **String** | | [required] |
**version_id** | **i32** | | [required] |
**file_type** | **String** | | [required] |
**inline_object4** | Option<[**InlineObject4**](InlineObject4.md)> | | |
**inline_object5** | Option<[**InlineObject5**](InlineObject5.md)> | | |
### Return type

4
docs/InlineObject10.md
View File

@@ -6,10 +6,10 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_url** | Option<**String**> | | [optional]
**id** | Option<**String**> | | [optional]
**name** | Option<**String**> | | [optional]
**name** | **String** | |
**description** | Option<**String**> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional]
**image_url** | Option<**String**> | | [optional]
**image_url** | **String** | |
**release_status** | Option<[**crate::models::ReleaseStatus**](ReleaseStatus.md)> | | [optional]
**version** | Option<**f32**> | | [optional][default to 1]
**unity_package_url** | Option<**String**> | | [optional]

11
docs/InlineObject11.md
View File

@@ -4,8 +4,15 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**moderated** | **String** | | [readonly]
**_type** | [**crate::models::PlayerModerationType**](PlayerModerationType.md) | |
**asset_url** | Option<**String**> | | [optional]
**id** | Option<**String**> | | [optional]
**name** | Option<**String**> | | [optional]
**description** | Option<**String**> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional]
**image_url** | Option<**String**> | | [optional]
**release_status** | Option<[**crate::models::ReleaseStatus**](ReleaseStatus.md)> | | [optional]
**version** | Option<**f32**> | | [optional][default to 1]
**unity_package_url** | 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
View File

@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**moderated** | Option<**String**> | | [optional][readonly]
**moderated** | **String** | | [readonly]
**_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)

12
docs/InlineObject13.md Normal file
View File

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

7
docs/InlineObject4.md
View File

@@ -4,9 +4,10 @@
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 0]
**max_parts** | **String** | Always a zero in string form, despite how many parts uploaded. | [default to 0]
**signature_md5** | **String** | |
**signature_size_in_bytes** | **f32** | |
**file_md5** | Option<**String**> | | [optional]
**file_size_in_bytes** | Option<**f32**> | | [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/InlineObject5.md
View File

@@ -4,20 +4,9 @@
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]
**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 0]
**max_parts** | **String** | Always a zero in string form, despite how many parts uploaded. | [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)

6
docs/InlineObject6.md
View File

@@ -4,15 +4,15 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_url** | Option<**String**> | | [optional]
**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** | Option<**String**> | | [optional]
**name** | 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]

17
docs/InlineObject7.md
View File

@@ -4,9 +4,20 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_type** | [**crate::models::FavoriteType**](FavoriteType.md) | |
**favorite_id** | **String** | Must be either AvatarID, WorldID or UserID. |
**tags** | **Vec<String>** | Tags indicate which group this favorite belongs to. Adding multiple groups makes it show up in all. Removing it from one in that case removes it from all. |
**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)

6
docs/InlineObject8.md
View File

@@ -4,9 +4,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**display_name** | Option<**String**> | | [optional]
**visibility** | Option<[**crate::models::FavoriteGroupVisibility**](FavoriteGroupVisibility.md)> | | [optional]
**tags** | Option<**Vec<String>**> | Tags on FavoriteGroups are believed to do nothing. | [optional]
**_type** | [**crate::models::FavoriteType**](FavoriteType.md) | |
**favorite_id** | **String** | Must be either AvatarID, WorldID or UserID. |
**tags** | **Vec<String>** | Tags indicate which group this favorite belongs to. Adding multiple groups makes it show up in all. Removing it from one in that case removes it from all. |
[[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/InlineObject9.md
View File

@@ -4,15 +4,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_url** | Option<**String**> | | [optional]
**id** | Option<**String**> | | [optional]
**name** | **String** | |
**description** | Option<**String**> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional]
**image_url** | **String** | |
**release_status** | Option<[**crate::models::ReleaseStatus**](ReleaseStatus.md)> | | [optional]
**version** | Option<**f32**> | | [optional][default to 1]
**unity_package_url** | Option<**String**> | | [optional]
**display_name** | Option<**String**> | | [optional]
**visibility** | Option<[**crate::models::FavoriteGroupVisibility**](FavoriteGroupVisibility.md)> | | [optional]
**tags** | Option<**Vec<String>**> | Tags on FavoriteGroups are believed to do nothing. | [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)

8
docs/PlayermoderationApi.md
View File

@@ -133,7 +133,7 @@ Name | Type | Description | Required | Notes
## moderate_user
> crate::models::PlayerModeration moderate_user(inline_object11)
> crate::models::PlayerModeration moderate_user(inline_object12)
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_object11** | Option<[**InlineObject11**](InlineObject11.md)> | | |
**inline_object12** | Option<[**InlineObject12**](InlineObject12.md)> | | |
### Return type
@@ -163,7 +163,7 @@ Name | Type | Description | Required | Notes
## unmoderate_user
> crate::models::Error unmoderate_user(inline_object12)
> crate::models::Error unmoderate_user(inline_object13)
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.
@@ -173,7 +173,7 @@ Removes a player moderation previously added through `moderateUser`. E.g if you
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**inline_object12** | Option<[**InlineObject12**](InlineObject12.md)> | | |
**inline_object13** | Option<[**InlineObject13**](InlineObject13.md)> | | |
### Return type

8
docs/WorldsApi.md
View File

@@ -22,7 +22,7 @@ Method | HTTP request | Description
## create_world
> crate::models::World create_world(inline_object5)
> crate::models::World create_world(inline_object6)
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_object5** | Option<[**InlineObject5**](InlineObject5.md)> | | |
**inline_object6** | Option<[**InlineObject6**](InlineObject6.md)> | | |
### Return type
@@ -431,7 +431,7 @@ Name | Type | Description | Required | Notes
## update_world
> crate::models::World update_world(world_id, inline_object6)
> crate::models::World update_world(world_id, inline_object7)
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_object6** | Option<[**InlineObject6**](InlineObject6.md)> | | |
**inline_object7** | Option<[**InlineObject7**](InlineObject7.md)> | | |
### Return type