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

Generate Rust SDK with openapi generator 6.2.1

Browse Source
This commit is contained in:
Foorack / Max Faxälv
2022-12-04 20:34:03 +01:00
parent 531287545e
commit 71c93272ac
78 changed files with 194 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/AddFavoriteRequest.md
View File

@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_type** | [**crate::models::FavoriteType**](FavoriteType.md) | |
**r#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. |

2
docs/Avatar.md
View File

@@ -15,7 +15,7 @@ Name | Type | Description | Notes
**image_url** | **String** | |
**name** | **String** | |
**release_status** | [**crate::models::ReleaseStatus**](ReleaseStatus.md) | |
**tags** | **Vec<String>** | |
**tags** | **Vec<String>** | |
**thumbnail_image_url** | **String** | |
**unity_package_url** | **String** | |
**unity_package_url_object** | [**crate::models::AvatarUnityPackageUrlObject**](Avatar_unityPackageUrlObject.md) | |

2
docs/CreateAvatarRequest.md
View File

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**id** | Option<**String**> | | [optional]
**name** | **String** | |
**description** | Option<**String**> | | [optional]
**tags** | Option<**Vec<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]

2
docs/CreateFileRequest.md
View File

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
**name** | **String** | |
**mime_type** | [**crate::models::MimeType**](MIMEType.md) | |
**extension** | **String** | |
**tags** | Option<**Vec<String>**> | | [optional]
**tags** | 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)

2
docs/CreateWorldRequest.md
View File

@@ -15,7 +15,7 @@ Name | Type | Description | Notes
**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]
**release_status** | Option<[**crate::models::ReleaseStatus**](ReleaseStatus.md)> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional]
**unity_package_url** | Option<**String**> | | [optional]
**unity_version** | Option<**String**> | | [optional][default to 5.3.4p1]

2
docs/CurrentUser.md
View File

@@ -36,7 +36,7 @@ Name | Type | Description | Notes
**oculus_id** | **String** | |
**offline_friends** | Option<**Vec<String>**> | | [optional]
**online_friends** | Option<**Vec<String>**> | | [optional]
**past_display_names** | [**Vec<crate::models::PastDisplayName>**](PastDisplayName.md) | |
**past_display_names** | [**Vec<crate::models::PastDisplayName>**](PastDisplayName.md) | |
**profile_pic_override** | **String** | |
**state** | [**crate::models::UserState**](UserState.md) | |
**status** | [**crate::models::UserStatus**](UserStatus.md) | |

2
docs/DynamicContentRow.md
View File

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**sort_order** | **String** | |
**sort_ownership** | **String** | |
**tag** | Option<**String**> | Tag to filter content for this row. | [optional]
**_type** | Option<**String**> | Type is not present if it is a world. | [optional]
**r#type** | Option<**String**> | Type is not present if it is a world. | [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/Favorite.md
View File

@@ -6,8 +6,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**favorite_id** | **String** | MUST be either AvatarID, UserID or WorldID. |
**id** | **String** | |
**tags** | **Vec<String>** | |
**_type** | [**crate::models::FavoriteType**](FavoriteType.md) | |
**tags** | **Vec<String>** | |
**r#type** | [**crate::models::FavoriteType**](FavoriteType.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/FavoriteGroup.md
View File

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
**name** | **String** | |
**owner_display_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. |
**tags** | **Vec<String>** | |
**_type** | [**crate::models::FavoriteType**](FavoriteType.md) | |
**tags** | **Vec<String>** | |
**r#type** | [**crate::models::FavoriteType**](FavoriteType.md) | |
**visibility** | [**crate::models::FavoriteGroupVisibility**](FavoriteGroupVisibility.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/FavoritesApi.md
View File

@@ -173,7 +173,7 @@ Name | Type | Description | Required | Notes
## get_favorites
> Vec<crate::models::Favorite> get_favorites(n, offset, _type, tag)
> Vec<crate::models::Favorite> get_favorites(n, offset, r#type, tag)
List Favorites
Returns a list of favorites.
@@ -185,7 +185,7 @@ Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**n** | Option<**i32**> | The number of objects to return. | |[default to 60]
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. | |
**_type** | Option<**String**> | The type of favorites to return, FavoriteType. | |
**r#type** | Option<**String**> | The type of favorites to return, FavoriteType. | |
**tag** | Option<**String**> | Tags to include (comma-separated). Any of the tags needs to be present. | |
### Return type

4
docs/File.md
View File

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
**mime_type** | [**crate::models::MimeType**](MIMEType.md) | |
**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. |
**tags** | **Vec<String>** | |
**versions** | [**Vec<crate::models::FileVersion>**](FileVersion.md) | |
**tags** | **Vec<String>** | |
**versions** | [**Vec<crate::models::FileVersion>**](FileVersion.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)

2
docs/FileData.md
View File

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

2
docs/InfoPush.md
View File

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**is_enabled** | **bool** | | [default to true]
**release_status** | [**crate::models::ReleaseStatus**](ReleaseStatus.md) | |
**priority** | **i32** | |
**tags** | **Vec<String>** | |
**tags** | **Vec<String>** | |
**data** | [**crate::models::InfoPushData**](InfoPushData.md) | |
**hash** | **String** | Unknown usage, MD5 |
**created_at** | **String** | |

2
docs/Instance.md
View File

@@ -22,7 +22,7 @@ Name | Type | Description | Notes
**secure_name** | **String** | |
**short_name** | Option<**String**> | | [optional]
**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) | |
**r#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]

4
docs/LimitedWorld.md
View File

@@ -19,9 +19,9 @@ Name | Type | Description | Notes
**popularity** | **i32** | | [default to 0]
**publication_date** | **String** | |
**release_status** | [**crate::models::ReleaseStatus**](ReleaseStatus.md) | |
**tags** | **Vec<String>** | |
**tags** | **Vec<String>** | |
**thumbnail_image_url** | **String** | |
**unity_packages** | [**Vec<crate::models::LimitedUnityPackage>**](LimitedUnityPackage.md) | |
**unity_packages** | [**Vec<crate::models::LimitedUnityPackage>**](LimitedUnityPackage.md) | |
**updated_at** | **String** | |
[[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/ModerateUserRequest.md
View File

@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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) | |
**r#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)

2
docs/Notification.md
View File

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**seen** | **bool** | | [default to false]
**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** | Option<**String**> | -| **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). | [optional]
**_type** | [**crate::models::NotificationType**](NotificationType.md) | |
**r#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)

4
docs/NotificationsApi.md
View File

@@ -101,7 +101,7 @@ Name | Type | Description | Required | Notes
## get_notifications
> Vec<crate::models::Notification> get_notifications(_type, sent, hidden, after, n, offset)
> Vec<crate::models::Notification> get_notifications(r#type, sent, hidden, after, n, offset)
List Notifications
Retrieve all of the current user's notifications.
@@ -111,7 +111,7 @@ Retrieve all of the current user's notifications.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**_type** | Option<**String**> | Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated. | |
**r#type** | Option<**String**> | Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated. | |
**sent** | Option<**bool**> | Return notifications sent by the user. Must be false or omitted. | |
**hidden** | Option<**bool**> | Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`. | |
**after** | Option<**String**> | Only return notifications sent after this Date. Ignored if type is `friendRequest`. | |

2
docs/PlayerModeration.md
View File

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
**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** | 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) | |
**r#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)

4
docs/PlayermoderationApi.md
View File

@@ -102,7 +102,7 @@ Name | Type | Description | Required | Notes
## get_player_moderations
> Vec<crate::models::PlayerModeration> get_player_moderations(_type, target_user_id)
> Vec<crate::models::PlayerModeration> get_player_moderations(r#type, target_user_id)
Search Player Moderations
Returns a list of all player moderations made by **you**. This endpoint does not have pagination, and will return *all* results. Use query parameters to limit your query if needed.
@@ -112,7 +112,7 @@ Returns a list of all player moderations made by **you**. This endpoint does no
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**_type** | Option<**String**> | Must be one of PlayerModerationType, except unblock. Unblocking simply removes a block. | |
**r#type** | Option<**String**> | Must be one of PlayerModerationType, except unblock. Unblocking simply removes a block. | |
**target_user_id** | Option<**String**> | Must be valid UserID. | |
### Return type

2
docs/SentNotification.md
View File

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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** | Option<**String**> | -| **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). | [optional]
**_type** | [**crate::models::NotificationType**](NotificationType.md) | |
**r#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)

2
docs/UpdateAvatarRequest.md
View File

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**id** | Option<**String**> | | [optional]
**name** | Option<**String**> | | [optional]
**description** | Option<**String**> | | [optional]
**tags** | Option<**Vec<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]

2
docs/UpdateUserRequest.md
View File

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
**email** | Option<**String**> | | [optional]
**birthday** | Option<[**String**](string.md)> | | [optional]
**accepted_tos_version** | Option<**f32**> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional]
**status** | Option<[**crate::models::UserStatus**](UserStatus.md)> | | [optional]
**status_description** | Option<**String**> | | [optional]
**bio** | Option<**String**> | | [optional]

2
docs/UpdateWorldRequest.md
View File

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
**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]
**release_status** | Option<[**crate::models::ReleaseStatus**](ReleaseStatus.md)> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional]
**unity_package_url** | Option<**String**> | | [optional]
**unity_version** | Option<**String**> | | [optional][default to 5.3.4p1]

2
docs/User.md
View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
**state** | [**crate::models::UserState**](UserState.md) | |
**status** | [**crate::models::UserStatus**](UserStatus.md) | |
**status_description** | **String** | |
**tags** | **Vec<String>** | |
**tags** | **Vec<String>** | |
**traveling_to_instance** | Option<**String**> | | [optional]
**traveling_to_location** | Option<**String**> | | [optional]
**traveling_to_world** | Option<**String**> | | [optional]

2
docs/World.md
View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
**public_occupants** | Option<**i32**> | Will always be `0` when unauthenticated. | [optional][default to 0]
**publication_date** | **String** | |
**release_status** | [**crate::models::ReleaseStatus**](ReleaseStatus.md) | |
**tags** | **Vec<String>** | |
**tags** | **Vec<String>** | |
**thumbnail_image_url** | **String** | |
**unity_packages** | [**Vec<crate::models::UnityPackage>**](UnityPackage.md) | Empty if unauthenticated. |
**updated_at** | **String** | |