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

Upgrade Rust SDK to spec 1.3.0

Browse Source
This commit is contained in:
Foorack
2021-09-12 13:28:50 +02:00
parent 0bb65d838b
commit 760d14e93c
120 changed files with 864 additions and 379 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Avatar.md
View File

@@ -6,7 +6,7 @@ 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** | | [readonly]
**author_id** | **String** | |
**author_name** | **String** | | [readonly]
**created_at** | **String** | | [readonly]
**description** | **String** | |

4
docs/AvatarsApi.md
View File

@@ -106,7 +106,7 @@ Name | Type | Description | Required | Notes
## get_favorited_avatars
> get_favorited_avatars(featured, sort, n, order, offset, search, tag, notag, release_status, max_unity_version, min_unity_version, platform, user_id)
> Vec<crate::models::Avatar> get_favorited_avatars(featured, sort, n, order, offset, search, tag, notag, release_status, max_unity_version, min_unity_version, platform, user_id)
List Favorited Avatars
Search and list favorited avatars by query filters.
@@ -132,7 +132,7 @@ Name | Type | Description | Required | Notes
### Return type
(empty response body)
[**Vec<crate::models::Avatar>**](Avatar.md)
### Authorization

4
docs/CurrentUser.md
View File

@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [readonly]
**id** | **String** | |
**username** | **String** | |
**display_name** | **String** | |
**user_icon** | **String** | |
@@ -41,7 +41,7 @@ Name | Type | Description | Notes
**tags** | **Vec<String>** | |
**developer_type** | [**crate::models::DeveloperType**](DeveloperType.md) | |
**last_login** | **String** | |
**last_platform** | [**crate::models::Platform**](Platform.md) | |
**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`. |
**allow_avatar_copying** | **bool** | |
**status** | [**crate::models::UserStatus**](UserStatus.md) | |
**date_joined** | [**String**](string.md) | | [readonly]

2
docs/Favorite.md
View File

@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [readonly]
**id** | **String** | |
**_type** | [**crate::models::FavoriteType**](FavoriteType.md) | |
**favorite_id** | **String** | MUST be either AvatarID, UserID or WorldID. |
**tags** | **Vec<String>** | |

4
docs/FavoriteGroup.md
View File

@@ -4,8 +4,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [readonly]
**owner_id** | **String** | | [readonly]
**id** | **String** | |
**owner_id** | **String** | |
**owner_display_name** | **String** | |
**name** | **String** | |
**display_name** | **String** | |

8
docs/FavoritesApi.md
View File

@@ -47,7 +47,7 @@ Name | Type | Description | Required | Notes
## clear_favorite_group
> crate::models::Error clear_favorite_group(favorite_group_type, favorite_group_name, user_id)
> crate::models::Success clear_favorite_group(favorite_group_type, favorite_group_name, user_id)
Clear Favorite Group
Clear ALL contents of a specific favorite group.
@@ -63,7 +63,7 @@ Name | Type | Description | Required | Notes
### Return type
[**crate::models::Error**](Error.md)
[**crate::models::Success**](Success.md)
### Authorization
@@ -206,7 +206,7 @@ Name | Type | Description | Required | Notes
## remove_favorite
> crate::models::Error remove_favorite(favorite_id)
> crate::models::Success remove_favorite(favorite_id)
Remove Favorite
Remove a favorite from your favorites list.
@@ -220,7 +220,7 @@ Name | Type | Description | Required | Notes
### Return type
[**crate::models::Error**](Error.md)
[**crate::models::Success**](Success.md)
### Authorization

4
docs/File.md
View File

@@ -4,9 +4,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [readonly]
**id** | **String** | |
**name** | **String** | |
**owner_id** | **String** | | [readonly]
**owner_id** | **String** | |
**mime_type** | [**crate::models::MimeType**](MIMEType.md) | |
**extension** | **String** | |
**tags** | **Vec<String>** | |

8
docs/FilesApi.md
View File

@@ -235,7 +235,7 @@ Name | Type | Description | Required | Notes
## get_file_data_upload_status
> crate::models::InlineResponse2004 get_file_data_upload_status(file_id, version_id, file_type)
> crate::models::InlineResponse2003 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::InlineResponse2004**](inline_response_200_4.md)
[**crate::models::InlineResponse2003**](inline_response_200_3.md)
### Authorization
@@ -300,7 +300,7 @@ Name | Type | Description | Required | Notes
## start_file_data_upload
> crate::models::InlineResponse2005 start_file_data_upload(file_id, version_id, file_type, part_number)
> crate::models::InlineResponse2004 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::InlineResponse2005**](inline_response_200_5.md)
[**crate::models::InlineResponse2004**](inline_response_200_4.md)
### Authorization

6
docs/InlineResponse2007.md → docs/FriendStatus.md
View File

@@ -1,10 +1,12 @@
# InlineResponse2007
# FriendStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**can_pubilsh** | **bool** | | [readonly][default to true]
**is_friend** | **bool** | | [default to false]
**outgoing_request** | **bool** | | [default to false]
**incoming_request** | **bool** | | [default to false]
[[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/FriendsApi.md
View File

@@ -74,7 +74,7 @@ Name | Type | Description | Required | Notes
## get_friend_status
> crate::models::InlineResponse2003 get_friend_status(user_id)
> crate::models::FriendStatus get_friend_status(user_id)
Check Friend Status
Retrieve if the user is currently a friend with a given user, if they have an outgoing friend request, and if they have an incoming friend request. The proper way to receive and accept friend request is by checking if the user has an incoming `Notification` of type `friendRequest`, and then accepting that notification.
@@ -88,7 +88,7 @@ Name | Type | Description | Required | Notes
### Return type
[**crate::models::InlineResponse2003**](inline_response_200_3.md)
[**crate::models::FriendStatus**](FriendStatus.md)
### Authorization

2
docs/InlineObject12.md
View File

@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**moderated** | **String** | | [readonly]
**moderated** | **String** | |
**_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/InlineObject13.md
View File

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

4
docs/InlineObject6.md
View File

@@ -6,14 +6,14 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_url** | **String** | |
**asset_version** | Option<**String**> | | [optional]
**author_id** | Option<**String**> | | [optional][readonly]
**author_id** | Option<**String**> | | [optional]
**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]
**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]
**unity_package_url** | Option<**String**> | | [optional]

4
docs/InlineObject7.md
View File

@@ -6,14 +6,14 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_url** | Option<**String**> | | [optional]
**asset_version** | Option<**String**> | | [optional]
**author_id** | Option<**String**> | | [optional][readonly]
**author_id** | Option<**String**> | | [optional]
**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]
**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]
**unity_package_url** | Option<**String**> | | [optional]

9
docs/InlineResponse2003.md
View File

@@ -4,9 +4,12 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**is_friend** | **bool** | | [default to false]
**outgoing_request** | **bool** | | [default to false]
**incoming_request** | **bool** | | [default to false]
**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]
[[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/InlineResponse2004.md
View File

@@ -4,12 +4,7 @@
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]
**url** | **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)

3
docs/InlineResponse2005.md
View File

@@ -4,7 +4,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**url** | **String** | |
**id** | **String** | |
**metadata** | [**serde_json::Value**](.md) | | [readonly]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

3
docs/InlineResponse2006.md
View File

@@ -4,8 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | |
**metadata** | [**serde_json::Value**](.md) | | [readonly]
**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)

2
docs/InlineResponse403.md → docs/InlineResponse400.md
View File

@@ -1,4 +1,4 @@
# InlineResponse403
# InlineResponse400
## Properties

2
docs/Instance.md
View File

@@ -15,7 +15,7 @@ Name | Type | Description | Notes
**n_users** | **f32** | |
**name** | **String** | |
**nonce** | Option<**String**> | | [optional]
**owner_id** | **String** | | [readonly]
**owner_id** | **String** | |
**permanent** | **bool** | | [default to false]
**photon_region** | **String** | |
**platforms** | [**crate::models::InstancePlatforms**](Instance_platforms.md) | |

228
docs/InviteApi.md Normal file
View File

@@ -0,0 +1,228 @@
# \InviteApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_invite_message**](InviteApi.md#get_invite_message) | **GET** /message/{userId}/message/{messageId} | Get Invite Messages
[**get_invite_messages**](InviteApi.md#get_invite_messages) | **GET** /message/{userId}/message | List Invite Messages
[**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}/message/{messageId} | Reset Invite Message
[**respond_invite**](InviteApi.md#respond_invite) | **POST** /invite/{notificationId}/response | Respond Invite
[**update_invite_message**](InviteApi.md#update_invite_message) | **PUT** /message/{userId}/message/{messageId} | Update Invite Message
## get_invite_message
> crate::models::InviteMessage get_invite_message(user_id, message_id)
Get Invite Messages
Returns a single Invite Message. This returns the exact same information but less than `getInviteMessages`. Admin Credentials are required to view messages of other users!
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**message_id** | **i32** | | [required] |
### Return type
[**crate::models::InviteMessage**](InviteMessage.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_invite_messages
> Vec<crate::models::InviteMessage> get_invite_messages(user_id)
List Invite Messages
Returns a list of all that users Invite Messages. Admin Credentials are required to view messages of other users!
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
### Return type
[**Vec<crate::models::InviteMessage>**](InviteMessage.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)
## invite_user
> crate::models::Notification invite_user(user_id)
Invite User
Sends an invite to a user. Returns the Notification of type `invite` that was sent.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
### Return type
[**crate::models::Notification**](Notification.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)
## request_invite
> crate::models::Notification request_invite(user_id)
Request Invite
Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
### Return type
[**crate::models::Notification**](Notification.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)
## reset_invite_message
> Vec<crate::models::InviteMessage> reset_invite_message(user_id, message_id)
Reset Invite Message
Resets a single Invite Message back to it's original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users! Resetting a message respects the rate-limit, but resetting it does not set the rate-limit to 60 like when editing it. It is possible to edit it right after resetting it. Trying to edit a message before the cooldown timer expires results in a 429 Too Fast Error.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**message_id** | **i32** | | [required] |
### Return type
[**Vec<crate::models::InviteMessage>**](InviteMessage.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)
## respond_invite
> crate::models::Notification respond_invite(notification_id)
Respond Invite
Sends a world invite to a user.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**notification_id** | **String** | | [required] |
### Return type
[**crate::models::Notification**](Notification.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_invite_message
> Vec<crate::models::InviteMessage> update_invite_message(user_id, message_id)
Update Invite Message
Updates a single Invite Message and then returns a list of all of them. Admin Credentials are required to update messages of other users! Updating a message automatically sets the cooldown timer to 60 minutes. Trying to edit a message before the cooldown timer expires results in a 429 Too Fast Error.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**message_id** | **i32** | | [required] |
### Return type
[**Vec<crate::models::InviteMessage>**](InviteMessage.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)

17
docs/InviteMessage.md Normal file
View File

@@ -0,0 +1,17 @@
# InviteMessage
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | |
**slot** | **i32** | |
**message** | **String** | |
**message_type** | [**crate::models::InviteMessageType**](InviteMessageType.md) | |
**updated_at** | **String** | |
**remaining_cooldown_minutes** | **i32** | Changes to 60 when updated, although probably server-side configurable. | [default to 0]
**can_be_updated** | **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)

2
docs/Platform.md → docs/InviteMessageType.md
View File

@@ -1,4 +1,4 @@
# Platform
# InviteMessageType
## Properties

2
docs/LimitedUnityPackage.md
View File

@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**platform** | [**crate::models::Platform**](Platform.md) | |
**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`. |
**unity_version** | **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)

5
docs/LimitedUser.md
View File

@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [readonly]
**id** | **String** | |
**username** | **String** | |
**display_name** | **String** | |
**bio** | Option<**String**> | | [optional]
@@ -15,10 +15,9 @@ Name | Type | Description | Notes
**current_avatar_thumbnail_image_url** | **String** | |
**fallback_avatar** | **String** | |
**developer_type** | [**crate::models::DeveloperType**](DeveloperType.md) | |
**last_platform** | [**crate::models::Platform**](Platform.md) | |
**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`. |
**status** | [**crate::models::UserStatus**](UserStatus.md) | |
**is_friend** | **bool** | |
**location** | **String** | |
**tags** | **Vec<String>** | <- Always empty. |
[[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/Notification.md
View File

@@ -5,13 +5,13 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | |
**sender_user_id** | **String** | | [readonly]
**sender_user_id** | **String** | |
**sender_username** | **String** | |
**_type** | [**crate::models::NotificationType**](NotificationType.md) | |
**message** | **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 {}]
**seen** | **bool** | | [default to false]
**created_at** | **String** | | [readonly]
**created_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/Permission.md
View File

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

4
docs/PlayerModeration.md
View File

@@ -6,9 +6,9 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | |
**_type** | [**crate::models::PlayerModerationType**](PlayerModerationType.md) | |
**source_user_id** | **String** | | [readonly]
**source_user_id** | **String** | |
**source_display_name** | **String** | |
**target_user_id** | **String** | | [readonly]
**target_user_id** | **String** | |
**target_display_name** | **String** | |
**created** | **String** | |

8
docs/PlayermoderationApi.md
View File

@@ -42,7 +42,7 @@ This endpoint does not need any parameter.
## delete_player_moderation
> crate::models::Error delete_player_moderation(player_moderation_id)
> crate::models::Success delete_player_moderation(player_moderation_id)
Delete Player Moderation
Deletes a specific player moderation based on it's `pmod_` ID. The website uses `unmoderateUser` instead. You can delete the same player moderation multiple times successfully.
@@ -56,7 +56,7 @@ Name | Type | Description | Required | Notes
### Return type
[**crate::models::Error**](Error.md)
[**crate::models::Success**](Success.md)
### Authorization
@@ -163,7 +163,7 @@ Name | Type | Description | Required | Notes
## unmoderate_user
> crate::models::Error unmoderate_user(inline_object13)
> crate::models::Success 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.
@@ -177,7 +177,7 @@ Name | Type | Description | Required | Notes
### Return type
[**crate::models::Error**](Error.md)
[**crate::models::Success**](Success.md)
### Authorization

2
docs/Response.md
View File

@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**message** | **String** | |
**message** | Option<**String**> | | [optional]
**status_code** | **f32** | |
[[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/UnityPackage.md
View File

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
**unity_version** | **String** | | [default to 5.3.4p1]
**unity_sort_number** | Option<**f32**> | | [optional]
**asset_version** | **f32** | |
**platform** | [**crate::models::Platform**](Platform.md) | |
**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`. |
**created_at** | 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)

4
docs/User.md
View File

@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [readonly]
**id** | **String** | |
**username** | **String** | |
**display_name** | **String** | |
**user_icon** | **String** | |
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
**tags** | **Vec<String>** | |
**developer_type** | [**crate::models::DeveloperType**](DeveloperType.md) | |
**last_login** | **String** | |
**last_platform** | [**crate::models::Platform**](Platform.md) | |
**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`. |
**allow_avatar_copying** | **bool** | |
**status** | [**crate::models::UserStatus**](UserStatus.md) | |
**date_joined** | [**String**](string.md) | | [readonly]

34
docs/UsersApi.md
View File

@@ -6,7 +6,6 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**get_user**](UsersApi.md#get_user) | **GET** /users/{userId} | Get User by ID
[**get_user_by_name**](UsersApi.md#get_user_by_name) | **GET** /users/{username}/name | Get User by Username
[**search_active_users**](UsersApi.md#search_active_users) | **GET** /users/active | Search Active Users
[**search_users**](UsersApi.md#search_users) | **GET** /users | Search All Users
[**update_user**](UsersApi.md#update_user) | **PUT** /users/{userId} | Update User Info
@@ -72,39 +71,6 @@ 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)
## search_active_users
> Vec<crate::models::LimitedUser> search_active_users(search, developer_type, offset, n)
Search Active Users
Search and list any Active users by text query. **Has been locked down and now always respond with \"Invalid Admin Credentials\".**
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**search** | **String** | Username to search for | [required] |
**developer_type** | Option<**String**> | Active user by developer type, none for normal users and internal for moderators | |
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. | |
**n** | Option<**i32**> | The number of objects to return. | |[default to 60]
### Return type
[**Vec<crate::models::LimitedUser>**](LimitedUser.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)
## search_users
> Vec<crate::models::LimitedUser> search_users(search, developer_type, n, offset)

2
docs/World.md
View File

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_url** | **String** | |
**asset_url_object** | [**serde_json::Value**](.md) | |
**author_id** | **String** | | [readonly]
**author_id** | **String** | |
**author_name** | **String** | | [readonly]
**capacity** | **f32** | | [readonly]
**created_at** | **String** | | [readonly]

8
docs/WorldsApi.md
View File

@@ -268,7 +268,7 @@ Name | Type | Description | Required | Notes
## get_world_metadata
> crate::models::InlineResponse2006 get_world_metadata(world_id)
> crate::models::InlineResponse2005 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::InlineResponse2006**](inline_response_200_6.md)
[**crate::models::InlineResponse2005**](inline_response_200_5.md)
### Authorization
@@ -298,7 +298,7 @@ Name | Type | Description | Required | Notes
## get_world_publish_status
> crate::models::InlineResponse2007 get_world_publish_status(world_id)
> crate::models::InlineResponse2006 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::InlineResponse2007**](inline_response_200_7.md)
[**crate::models::InlineResponse2006**](inline_response_200_6.md)
### Authorization