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

Set OpenAPI version back to 6.2.1 and fix GitLab CI

Browse Source
This commit is contained in:
Foorack / Max Faxälv
2022-12-05 00:43:30 +01:00
parent 934f89850d
commit a4cf1025e0
98 changed files with 4975 additions and 169 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/AddGroupGalleryImageRequest.md Normal file
View File

@ -0,0 +1,11 @@
# AddGroupGalleryImageRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**file_id** | **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)

6
docs/ApiConfig.md
View File

@ -7,7 +7,7 @@ Name | Type | Description | Notes
**voice_enable_degradation** | **bool** | Unknown, probably voice optimization testing | [default to false]
**voice_enable_receiver_limiting** | **bool** | Unknown, probably voice optimization testing | [default to true]
**address** | **String** | VRChat's office address |
**announcements** | [**Vec<crate::models::PublicAnnouncement>**](Public_Announcement.md) | Public Announcements |
**announcements** | [**Vec<crate::models::ApiConfigAnnouncement>**](APIConfigAnnouncement.md) | Public Announcements |
**api_key** | **String** | apiKey to be used for all other requests |
**app_name** | **String** | Game name | [default to VrChat]
**build_version_tag** | **String** | Build tag of the API server |
@ -43,9 +43,9 @@ Name | Type | Description | Notes
**disable_udon** | **bool** | Toggles if Udon should be universally disabled in-game. | [default to false]
**disable_upgrade_account** | **bool** | Toggles if account upgrading \"linking with Steam/Oculus\" should be disabled. | [default to false]
**download_link_windows** | **String** | Download link for game on the Oculus Rift website. |
**download_urls** | [**crate::models::DownloadUrlList**](DownloadURLList.md) | |
**download_urls** | [**crate::models::ApiConfigDownloadUrlList**](APIConfigDownloadURLList.md) | |
**dynamic_world_rows** | [**Vec<crate::models::DynamicContentRow>**](DynamicContentRow.md) | Array of DynamicWorldRow objects, used by the game to display the list of world rows |
**events** | [**crate::models::ApiEventConfig**](APIEventConfig.md) | |
**events** | [**crate::models::ApiConfigEvents**](APIConfigEvents.md) | |
**gear_demo_room_id** | **String** | Unknown |
**home_world_id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
**homepage_redirect_target** | **String** | Redirect target if you try to open the base API domain in your browser | [default to https://hello.vrchat.com]

2
docs/PublicAnnouncement.md → docs/ApiConfigAnnouncement.md
View File

@ -1,4 +1,4 @@
# PublicAnnouncement
# ApiConfigAnnouncement
## Properties

2
docs/DownloadUrlList.md → docs/ApiConfigDownloadUrlList.md
View File

@ -1,4 +1,4 @@
# DownloadUrlList
# ApiConfigDownloadUrlList
## Properties

2
docs/ApiEventConfig.md → docs/ApiConfigEvents.md
View File

@ -1,4 +1,4 @@
# ApiEventConfig
# ApiConfigEvents
## Properties

2
docs/AuthenticationApi.md
View File

@ -59,7 +59,7 @@ Deletes the account with given ID. Normal users only have permission to delete t
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**user_id** | **String** | Must be a valid user ID. | [required] |
### Return type

24
docs/AvatarsApi.md
View File

@ -58,7 +58,7 @@ Delete an avatar. Notice an avatar is never fully \"deleted\", only its ReleaseS
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**avatar_id** | **String** | | [required] |
**avatar_id** | **String** | Must be a valid avatar ID. | [required] |
### Return type
@ -88,7 +88,7 @@ Get information about a specific Avatar.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**avatar_id** | **String** | | [required] |
**avatar_id** | **String** | Must be a valid avatar ID. | [required] |
### Return type
@ -119,14 +119,14 @@ Search and list favorited avatars by query filters.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**featured** | Option<**bool**> | Filters on featured results. | |
**sort** | Option<**String**> | | |[default to popularity]
**sort** | Option<[**SortOption**](.md)> | The sort order of the results. | |
**n** | Option<**i32**> | The number of objects to return. | |[default to 60]
**order** | Option<**String**> | | |[default to descending]
**order** | Option<[**OrderOption**](.md)> | Result ordering | |
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. | |
**search** | Option<**String**> | Filters by world name. | |
**tag** | Option<**String**> | Tags to include (comma-separated). Any of the tags needs to be present. | |
**notag** | Option<**String**> | Tags to exclude (comma-separated). | |
**release_status** | Option<**String**> | Filter by ReleaseStatus. | |[default to public]
**release_status** | Option<[**ReleaseStatus**](.md)> | Filter by ReleaseStatus. | |
**max_unity_version** | Option<**String**> | The maximum Unity version supported by the asset. | |
**min_unity_version** | Option<**String**> | The minimum Unity version supported by the asset. | |
**platform** | Option<**String**> | The platform the asset supports. | |
@ -160,7 +160,7 @@ Get the current avatar for the user. This will return an error for any other use
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**user_id** | **String** | Must be a valid user ID. | [required] |
### Return type
@ -191,15 +191,15 @@ Search and list avatars by query filters. You can only search your own or featur
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**featured** | Option<**bool**> | Filters on featured results. | |
**sort** | Option<**String**> | | |[default to popularity]
**sort** | Option<[**SortOption**](.md)> | The sort order of the results. | |
**user** | Option<**String**> | Set to `me` for searching own avatars. | |
**user_id** | Option<**String**> | Filter by UserID. | |
**n** | Option<**i32**> | The number of objects to return. | |[default to 60]
**order** | Option<**String**> | | |[default to descending]
**order** | Option<[**OrderOption**](.md)> | Result ordering | |
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. | |
**tag** | Option<**String**> | Tags to include (comma-separated). Any of the tags needs to be present. | |
**notag** | Option<**String**> | Tags to exclude (comma-separated). | |
**release_status** | Option<**String**> | Filter by ReleaseStatus. | |[default to public]
**release_status** | Option<[**ReleaseStatus**](.md)> | Filter by ReleaseStatus. | |
**max_unity_version** | Option<**String**> | The maximum Unity version supported by the asset. | |
**min_unity_version** | Option<**String**> | The minimum Unity version supported by the asset. | |
**platform** | Option<**String**> | The platform the asset supports. | |
@ -232,7 +232,7 @@ Switches into that avatar.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**avatar_id** | **String** | | [required] |
**avatar_id** | **String** | Must be a valid avatar ID. | [required] |
### Return type
@ -262,7 +262,7 @@ Switches into that avatar as your fallback avatar.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**avatar_id** | **String** | | [required] |
**avatar_id** | **String** | Must be a valid avatar ID. | [required] |
### Return type
@ -292,7 +292,7 @@ Update information about a specific avatar.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**avatar_id** | **String** | | [required] |
**avatar_id** | **String** | Must be a valid avatar ID. | [required] |
**update_avatar_request** | Option<[**UpdateAvatarRequest**](UpdateAvatarRequest.md)> | | |
### Return type

11
docs/BanGroupMemberRequest.md Normal file
View File

@ -0,0 +1,11 @@
# BanGroupMemberRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
docs/CreateGroupAnnouncementRequest.md Normal file
View File

@ -0,0 +1,14 @@
# CreateGroupAnnouncementRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **String** | Announcement title |
**text** | Option<**String**> | Announcement text | [optional]
**image_id** | Option<**String**> | | [optional]
**send_notification** | Option<**bool**> | Send notification to group members. | [optional][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)

17
docs/CreateGroupGalleryRequest.md Normal file
View File

@ -0,0 +1,17 @@
# CreateGroupGalleryRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Name of the gallery. |
**description** | Option<**String**> | Description of the gallery. | [optional]
**members_only** | Option<**bool**> | Whether the gallery is members only. | [optional][default to false]
**role_ids_to_view** | Option<**Vec<String>**> | | [optional]
**role_ids_to_submit** | Option<**Vec<String>**> | | [optional]
**role_ids_to_auto_approve** | Option<**Vec<String>**> | | [optional]
**role_ids_to_manage** | 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)

12
docs/CreateGroupInviteRequest.md Normal file
View File

@ -0,0 +1,12 @@
# CreateGroupInviteRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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. |
**confirm_override_block** | Option<**bool**> | | [optional][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)

18
docs/CreateGroupRequest.md Normal file
View File

@ -0,0 +1,18 @@
# CreateGroupRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | |
**short_code** | **String** | |
**description** | Option<**String**> | | [optional]
**join_state** | Option<[**crate::models::GroupJoinState**](GroupJoinState.md)> | | [optional]
**icon_id** | Option<**String**> | | [optional]
**banner_id** | Option<**String**> | | [optional]
**privacy** | Option<[**crate::models::GroupPrivacy**](GroupPrivacy.md)> | | [optional]
**role_template** | [**crate::models::GroupRoleTemplate**](GroupRoleTemplate.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)

15
docs/CreateGroupRoleRequest.md Normal file
View File

@ -0,0 +1,15 @@
# CreateGroupRoleRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**String**> | | [optional]
**name** | Option<**String**> | | [optional]
**description** | Option<**String**> | | [optional]
**is_self_assignable** | Option<**bool**> | | [optional][default to false]
**permissions** | 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)

4
docs/EconomyApi.md
View File

@ -51,7 +51,7 @@ Get a single License Group by given ID.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**license_group_id** | **String** | | [required] |
**license_group_id** | **String** | Must be a valid license group ID. | [required] |
### Return type
@ -81,7 +81,7 @@ Get a single Steam transactions by ID. This returns the exact same information a
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**transaction_id** | **String** | | [required] |
**transaction_id** | **String** | Must be a valid transaction ID. | [required] |
### Return type

16
docs/FavoritesApi.md
View File

@ -58,8 +58,8 @@ Clear ALL contents of a specific favorite group.
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] |
**favorite_group_name** | **String** | The name of the group to fetch, must be a name of a FavoriteGroup. | [required] |
**user_id** | **String** | Must be a valid user ID. | [required] |
### Return type
@ -89,7 +89,7 @@ Return information about a specific Favorite.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**favorite_id** | **String** | | [required] |
**favorite_id** | **String** | Must be a valid favorite ID. | [required] |
### Return type
@ -120,8 +120,8 @@ Fetch information about a specific favorite group.
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] |
**favorite_group_name** | **String** | The name of the group to fetch, must be a name of a FavoriteGroup. | [required] |
**user_id** | **String** | Must be a valid user ID. | [required] |
### Return type
@ -216,7 +216,7 @@ Remove a favorite from your favorites list.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**favorite_id** | **String** | | [required] |
**favorite_id** | **String** | Must be a valid favorite ID. | [required] |
### Return type
@ -247,8 +247,8 @@ Update information about a specific favorite group.
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] |
**favorite_group_name** | **String** | The name of the group to fetch, must be a name of a FavoriteGroup. | [required] |
**user_id** | **String** | Must be a valid user ID. | [required] |
**update_favorite_group_request** | Option<[**UpdateFavoriteGroupRequest**](UpdateFavoriteGroupRequest.md)> | | |
### Return type

34
docs/FilesApi.md
View File

@ -59,7 +59,7 @@ Creates a new FileVersion. Once a Version has been created, proceed to the `/fil
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** | | [required] |
**file_id** | **String** | Must be a valid file ID. | [required] |
**create_file_version_request** | Option<[**CreateFileVersionRequest**](CreateFileVersionRequest.md)> | | |
### Return type
@ -90,7 +90,7 @@ Deletes a File object.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** | | [required] |
**file_id** | **String** | Must be a valid file ID. | [required] |
### Return type
@ -120,8 +120,8 @@ Delete a specific version of a file. You can only delete the latest version.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** | | [required] |
**version_id** | **i32** | | [required] |
**file_id** | **String** | Must be a valid file ID. | [required] |
**version_id** | **i32** | Version ID of the asset. | [required] |
### Return type
@ -151,8 +151,8 @@ Downloads the file with the provided version number. **Version Note:** Version
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** | | [required] |
**version_id** | **i32** | | [required] |
**file_id** | **String** | Must be a valid file ID. | [required] |
**version_id** | **i32** | Version ID of the asset. | [required] |
### Return type
@ -182,9 +182,9 @@ Finish an upload of a FileData. This will mark it as \"complete\". After uploadi
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** | | [required] |
**version_id** | **i32** | | [required] |
**file_type** | **String** | | [required] |
**file_id** | **String** | Must be a valid file ID. | [required] |
**version_id** | **i32** | Version ID of the asset. | [required] |
**file_type** | **String** | Type of file. | [required] |
**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
@ -215,7 +215,7 @@ Shows general information about the \"File\" object. Each File can have several
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** | | [required] |
**file_id** | **String** | Must be a valid file ID. | [required] |
### Return type
@ -245,9 +245,9 @@ Retrieves the upload status for file upload. Can currently only be accessed when
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** | | [required] |
**version_id** | **i32** | | [required] |
**file_type** | **String** | | [required] |
**file_id** | **String** | Must be a valid file ID. | [required] |
**version_id** | **i32** | Version ID of the asset. | [required] |
**file_type** | **String** | Type of file. | [required] |
### Return type
@ -310,10 +310,10 @@ Starts an upload of a specific FilePart. This endpoint will return an AWS URL wh
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** | | [required] |
**version_id** | **i32** | | [required] |
**file_type** | **String** | | [required] |
**part_number** | Option<**i32**> | | |
**file_id** | **String** | Must be a valid file ID. | [required] |
**version_id** | **i32** | Version ID of the asset. | [required] |
**file_type** | **String** | Type of file. | [required] |
**part_number** | Option<**i32**> | The part number to start uploading. If not provided, the first part will be started. | |
### Return type

8
docs/FriendsApi.md
View File

@ -24,7 +24,7 @@ Deletes an outgoing pending friend request to another user. To delete an incomin
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**user_id** | **String** | Must be a valid user ID. | [required] |
### Return type
@ -54,7 +54,7 @@ Send a friend request to another user.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**user_id** | **String** | Must be a valid user ID. | [required] |
### Return type
@ -84,7 +84,7 @@ Retrieve if the user is currently a friend with a given user, if they have an ou
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**user_id** | **String** | Must be a valid user ID. | [required] |
### Return type
@ -146,7 +146,7 @@ Unfriend a user by ID.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**user_id** | **String** | Must be a valid user ID. | [required] |
### Return type

35
docs/Group.md Normal file
View File

@ -0,0 +1,35 @@
# Group
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**String**> | | [optional]
**name** | Option<**String**> | | [optional]
**short_code** | Option<**String**> | | [optional]
**discriminator** | Option<**String**> | | [optional]
**description** | Option<**String**> | | [optional]
**icon_url** | Option<**String**> | | [optional]
**banner_url** | Option<**String**> | | [optional]
**privacy** | Option<[**crate::models::GroupPrivacy**](GroupPrivacy.md)> | | [optional]
**owner_id** | 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]
**rules** | Option<**String**> | | [optional]
**links** | Option<**Vec<String>**> | | [optional]
**languages** | Option<**Vec<String>**> | | [optional]
**icon_id** | Option<**String**> | | [optional]
**banner_id** | Option<**String**> | | [optional]
**member_count** | Option<**i32**> | | [optional]
**member_count_synced_at** | Option<**String**> | | [optional]
**is_verified** | Option<**bool**> | | [optional][default to false]
**join_state** | Option<[**crate::models::GroupJoinState**](GroupJoinState.md)> | | [optional]
**tags** | Option<**Vec<String>**> | | [optional]
**galleries** | Option<[**Vec<crate::models::GroupGallery>**](GroupGallery.md)> | | [optional]
**created_at** | Option<**String**> | | [optional]
**online_member_count** | Option<**i32**> | | [optional]
**membership_status** | Option<[**crate::models::GroupMemberStatus**](GroupMemberStatus.md)> | | [optional]
**my_member** | Option<[**crate::models::GroupMyMember**](GroupMyMember.md)> | | [optional]
**roles** | Option<[**Vec<crate::models::GroupRole>**](GroupRole.md)> | Only returned if ?includeRoles=true is specified. | [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)

19
docs/GroupAnnouncement.md Normal file
View File

@ -0,0 +1,19 @@
# GroupAnnouncement
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**String**> | | [optional]
**group_id** | Option<**String**> | | [optional]
**author_id** | 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]
**title** | Option<**String**> | | [optional]
**text** | Option<**String**> | | [optional]
**image_id** | Option<**String**> | | [optional]
**image_url** | Option<**String**> | | [optional]
**created_at** | Option<**String**> | | [optional]
**updated_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)

19
docs/GroupAuditLogEntry.md Normal file
View File

@ -0,0 +1,19 @@
# GroupAuditLogEntry
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**String**> | | [optional]
**created_at** | Option<**String**> | | [optional]
**group_id** | Option<**String**> | | [optional]
**actor_id** | 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]
**actor_displayname** | Option<**String**> | | [optional]
**target_id** | Option<**String**> | Typically GroupID or GroupRoleID, but could be other types of IDs. | [optional]
**event_type** | Option<**String**> | The type of event that occurred. This is a string that is prefixed with the type of object that the event occurred on. For example, a group role update event would be prefixed with `group.role`. | [optional][default to group.update]
**description** | Option<**String**> | A human-readable description of the event. | [optional]
**data** | Option<[**serde_json::Value**](.md)> | The data associated with the event. The format of this data is dependent on the event type. | [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)

20
docs/GroupGallery.md Normal file
View File

@ -0,0 +1,20 @@
# GroupGallery
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**String**> | | [optional]
**name** | Option<**String**> | Name of the gallery. | [optional]
**description** | Option<**String**> | Description of the gallery. | [optional]
**members_only** | Option<**bool**> | Whether the gallery is members only. | [optional][default to false]
**role_ids_to_view** | Option<**Vec<String>**> | | [optional]
**role_ids_to_submit** | Option<**Vec<String>**> | | [optional]
**role_ids_to_auto_approve** | Option<**Vec<String>**> | | [optional]
**role_ids_to_manage** | Option<**Vec<String>**> | | [optional]
**created_at** | Option<**String**> | | [optional]
**updated_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)

20
docs/GroupGalleryImage.md Normal file
View File

@ -0,0 +1,20 @@
# GroupGalleryImage
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**String**> | | [optional]
**group_id** | Option<**String**> | | [optional]
**gallery_id** | Option<**String**> | | [optional]
**file_id** | Option<**String**> | | [optional]
**image_url** | Option<**String**> | | [optional]
**created_at** | Option<**String**> | | [optional]
**submitted_by_user_id** | 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]
**approved** | Option<**bool**> | | [optional][default to false]
**approved_by_user_id** | 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]
**approved_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)

10
docs/GroupJoinState.md Normal file
View File

@ -0,0 +1,10 @@
# GroupJoinState
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
docs/GroupLimitedMember.md Normal file
View File

@ -0,0 +1,14 @@
# GroupLimitedMember
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**String**> | | [optional]
**group_id** | Option<**String**> | | [optional]
**user_id** | 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]
**is_representing** | Option<**bool**> | | [optional][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)

23
docs/GroupMember.md Normal file
View File

@ -0,0 +1,23 @@
# GroupMember
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**String**> | | [optional]
**group_id** | Option<**String**> | | [optional]
**user_id** | 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]
**is_representing** | Option<**bool**> | Whether the user is representing the group. This makes the group show up above the name tag in-game. | [optional][default to false]
**user** | Option<[**crate::models::GroupMemberLimitedUser**](GroupMemberLimitedUser.md)> | | [optional]
**role_ids** | Option<**Vec<String>**> | | [optional]
**joined_at** | Option<**String**> | | [optional]
**membership_status** | Option<**String**> | | [optional]
**visibility** | Option<**String**> | | [optional]
**is_subscribed_to_announcements** | Option<**bool**> | | [optional][default to false]
**created_at** | Option<**String**> | Only visible via the /groups/:groupId/members endpoint, **not** when fetching a specific user. | [optional]
**banned_at** | Option<**String**> | Only visible via the /groups/:groupId/members endpoint, **not** when fetching a specific user. | [optional]
**manager_notes** | Option<**String**> | Only visible via the /groups/:groupId/members endpoint, **not** when fetching a specific user. | [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)

14
docs/GroupMemberLimitedUser.md Normal file
View File

@ -0,0 +1,14 @@
# GroupMemberLimitedUser
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | 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]
**display_name** | Option<**String**> | | [optional]
**thumbnail_url** | Option<**String**> | | [optional]
**icon_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)

10
docs/GroupMemberStatus.md Normal file
View File

@ -0,0 +1,10 @@
# GroupMemberStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

23
docs/GroupMyMember.md Normal file
View File

@ -0,0 +1,23 @@
# GroupMyMember
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**String**> | | [optional]
**group_id** | Option<**String**> | | [optional]
**user_id** | 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]
**role_ids** | Option<**Vec<String>**> | | [optional]
**manager_notes** | Option<**String**> | | [optional]
**membership_status** | Option<**String**> | | [optional]
**is_subscribed_to_announcements** | Option<**bool**> | | [optional][default to true]
**visibility** | Option<**String**> | | [optional]
**is_representing** | Option<**bool**> | | [optional][default to false]
**joined_at** | Option<**String**> | | [optional]
**banned_at** | Option<**String**> | | [optional]
**has2_fa** | Option<**bool**> | | [optional][default to false]
**permissions** | 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)

15
docs/GroupPermission.md Normal file
View File

@ -0,0 +1,15 @@
# GroupPermission
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | Option<**String**> | The name of the permission. | [optional]
**display_name** | Option<**String**> | The display name of the permission. | [optional]
**help** | Option<**String**> | Human-readable description of the permission. | [optional]
**is_management_permission** | Option<**bool**> | Whether this permission is a \"management\" permission. | [optional][default to false]
**allowed_to_add** | Option<**bool**> | Whether the user is allowed to add this permission to a role. | [optional][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)

10
docs/GroupPrivacy.md Normal file
View File

@ -0,0 +1,10 @@
# GroupPrivacy
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

22
docs/GroupRole.md Normal file
View File

@ -0,0 +1,22 @@
# GroupRole
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**String**> | | [optional]
**group_id** | Option<**String**> | | [optional]
**name** | Option<**String**> | | [optional]
**description** | Option<**String**> | | [optional]
**is_self_assignable** | Option<**bool**> | | [optional][default to false]
**permissions** | Option<**Vec<String>**> | | [optional]
**is_management_role** | Option<**bool**> | | [optional][default to false]
**requires_two_factor** | Option<**bool**> | | [optional][default to false]
**requires_purchase** | Option<**bool**> | | [optional][default to false]
**order** | Option<**i32**> | | [optional]
**created_at** | Option<**String**> | | [optional]
**updated_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)

10
docs/GroupRoleTemplate.md Normal file
View File

@ -0,0 +1,10 @@
# GroupRoleTemplate
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/GroupUserVisibility.md Normal file
View File

@ -0,0 +1,10 @@
# GroupUserVisibility
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

1165
docs/GroupsApi.md Normal file
View File

File diff suppressed because it is too large Load Diff

14
docs/InstancesApi.md
View File

@ -23,8 +23,8 @@ Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.i
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
**instance_id** | **String** | | [required] |
**world_id** | **String** | Must be a valid world ID. | [required] |
**instance_id** | **String** | Must be a valid instance ID. | [required] |
### Return type
@ -54,7 +54,7 @@ Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.i
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**short_name** | **String** | | [required] |
**short_name** | **String** | Must be a valid instance short name. | [required] |
### Return type
@ -84,8 +84,8 @@ Returns an instance short name.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
**instance_id** | **String** | | [required] |
**world_id** | **String** | Must be a valid world ID. | [required] |
**instance_id** | **String** | Must be a valid instance ID. | [required] |
### Return type
@ -115,8 +115,8 @@ Sends an invite to the instance to yourself.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
**instance_id** | **String** | | [required] |
**world_id** | **String** | Must be a valid world ID. | [required] |
**instance_id** | **String** | Must be a valid instance ID. | [required] |
### Return type

32
docs/InviteApi.md
View File

@ -27,9 +27,9 @@ Returns a single Invite Message. This returns the exact same information but les
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**message_type** | **String** | | [required] |
**slot** | **i32** | | [required] |
**user_id** | **String** | Must be a valid user ID. | [required] |
**message_type** | [**InviteMessageType**](.md) | The type of message to fetch, must be a valid InviteMessageType. | [required] |
**slot** | **i32** | The message slot to fetch of a given message type. | [required] |
### Return type
@ -59,8 +59,8 @@ Returns a list of all the users Invite Messages. Admin Credentials are required
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**message_type** | **String** | | [required] |
**user_id** | **String** | Must be a valid user ID. | [required] |
**message_type** | [**InviteMessageType**](.md) | The type of message to fetch, must be a valid InviteMessageType. | [required] |
### Return type
@ -90,8 +90,8 @@ Sends self an invite to an instance
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
**instance_id** | **String** | | [required] |
**world_id** | **String** | Must be a valid world ID. | [required] |
**instance_id** | **String** | Must be a valid instance ID. | [required] |
### Return type
@ -121,7 +121,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] |
**user_id** | **String** | Must be a valid user ID. | [required] |
**invite_request** | Option<[**InviteRequest**](InviteRequest.md)> | Slot number of the Invite Message to use when inviting a user. | |
### Return type
@ -152,7 +152,7 @@ Requests an invite from a user. Returns the Notification of type `requestInvite`
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**user_id** | **String** | Must be a valid user ID. | [required] |
**request_invite_request** | Option<[**RequestInviteRequest**](RequestInviteRequest.md)> | Slot number of the Request Message to use when request an invite. | |
### Return type
@ -183,9 +183,9 @@ Resets a single Invite Message back to its original message, and then returns a
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**message_type** | **String** | | [required] |
**slot** | **i32** | | [required] |
**user_id** | **String** | Must be a valid user ID. | [required] |
**message_type** | [**InviteMessageType**](.md) | The type of message to fetch, must be a valid InviteMessageType. | [required] |
**slot** | **i32** | The message slot to fetch of a given message type. | [required] |
### Return type
@ -215,7 +215,7 @@ Respond to an invite request by sending a world invite to the requesting user. `
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**notification_id** | **String** | | [required] |
**notification_id** | **String** | Must be a valid notification ID. | [required] |
**invite_response** | Option<[**InviteResponse**](InviteResponse.md)> | Slot number of the Response Message to use when responding to a user. | |
### Return type
@ -246,9 +246,9 @@ Updates a single Invite Message and then returns a list of all of them. Admin Cr
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**message_type** | **String** | | [required] |
**slot** | **i32** | | [required] |
**user_id** | **String** | Must be a valid user ID. | [required] |
**message_type** | [**InviteMessageType**](.md) | The type of message to fetch, must be a valid InviteMessageType. | [required] |
**slot** | **i32** | The message slot to fetch of a given message type. | [required] |
**update_invite_message_request** | Option<[**UpdateInviteMessageRequest**](UpdateInviteMessageRequest.md)> | Message of what to set the invite message to. | |
### Return type

5
docs/Notification.md
View File

@ -5,10 +5,11 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created_at** | **String** | |
**details** | **String** | **NOTICE:** This is not a JSON object, this is a json **encoded** object, meaning you have to json-de-encode to get the NotificationDetail object depending on the NotificationType. | [default to {}]
**details** | **String** | **NOTICE:** This is not a JSON object when received from the REST API, but it is when received from the Websocket API. When received from the REST API, this is a json **encoded** object, meaning you have to json-de-encode to get the NotificationDetail object depending on the NotificationType. | [default to {}]
**id** | **String** | |
**message** | **String** | |
**seen** | **bool** | | [default to false]
**seen** | Option<**bool**> | Not included in notification objects received from the Websocket API | [optional][default to false]
**receiver_user_id** | 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]
**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]
**r#type** | [**crate::models::NotificationType**](NotificationType.md) | |

6
docs/NotificationsApi.md
View File

@ -24,7 +24,7 @@ Accept a friend request by notification `frq_` ID. Friend requests can be found
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**notification_id** | **String** | | [required] |
**notification_id** | **String** | Must be a valid notification ID. | [required] |
### Return type
@ -81,7 +81,7 @@ Delete a notification.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**notification_id** | **String** | | [required] |
**notification_id** | **String** | Must be a valid notification ID. | [required] |
### Return type
@ -146,7 +146,7 @@ Mark a notification as seen.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**notification_id** | **String** | | [required] |
**notification_id** | **String** | Must be a valid notification ID. | [required] |
### Return type

10
docs/OrderOption.md Normal file
View File

@ -0,0 +1,10 @@
# OrderOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
docs/PaginatedGroupAuditLogEntryList.md Normal file
View File

@ -0,0 +1,13 @@
# PaginatedGroupAuditLogEntryList
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**results** | Option<[**Vec<crate::models::GroupAuditLogEntry>**](GroupAuditLogEntry.md)> | | [optional]
**total_count** | Option<**i32**> | The total number of results that the query would return if there were no pagination. | [optional]
**has_next** | Option<**bool**> | Whether there are more results after this page. | [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/PermissionsApi.md
View File

@ -48,7 +48,7 @@ Returns a single permission. This endpoint is pretty useless, as it returns the
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**permission_id** | **String** | | [required] |
**permission_id** | **String** | Must be a valid permission ID. | [required] |
### Return type

4
docs/PlayermoderationApi.md
View File

@ -52,7 +52,7 @@ Deletes a specific player moderation based on it's `pmod_` ID. The website uses
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**player_moderation_id** | **String** | | [required] |
**player_moderation_id** | **String** | Must be a valid `pmod_` ID. | [required] |
### Return type
@ -82,7 +82,7 @@ Returns a single Player Moderation. This returns the exact same amount of inform
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**player_moderation_id** | **String** | | [required] |
**player_moderation_id** | **String** | Must be a valid `pmod_` ID. | [required] |
### Return type

11
docs/RespondGroupJoinRequest.md Normal file
View File

@ -0,0 +1,11 @@
# RespondGroupJoinRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**action** | 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)

10
docs/SortOption.md Normal file
View File

@ -0,0 +1,10 @@
# SortOption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[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/UpdateGroupGalleryRequest.md Normal file
View File

@ -0,0 +1,17 @@
# UpdateGroupGalleryRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | Option<**String**> | Name of the gallery. | [optional]
**description** | Option<**String**> | Description of the gallery. | [optional]
**members_only** | Option<**bool**> | Whether the gallery is members only. | [optional][default to false]
**role_ids_to_view** | Option<**Vec<String>**> | | [optional]
**role_ids_to_submit** | Option<**Vec<String>**> | | [optional]
**role_ids_to_auto_approve** | Option<**Vec<String>**> | | [optional]
**role_ids_to_manage** | 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)

13
docs/UpdateGroupMemberRequest.md Normal file
View File

@ -0,0 +1,13 @@
# UpdateGroupMemberRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**visibility** | Option<[**crate::models::GroupUserVisibility**](GroupUserVisibility.md)> | | [optional]
**is_subscribed_to_announcements** | Option<**bool**> | | [optional]
**manager_notes** | 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)

20
docs/UpdateGroupRequest.md Normal file
View File

@ -0,0 +1,20 @@
# UpdateGroupRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | Option<**String**> | | [optional]
**short_code** | Option<**String**> | | [optional]
**description** | Option<**String**> | | [optional]
**join_state** | Option<[**crate::models::GroupJoinState**](GroupJoinState.md)> | | [optional]
**icon_id** | Option<**String**> | | [optional]
**banner_id** | Option<**String**> | | [optional]
**languages** | Option<**Vec<String>**> | 3 letter language code | [optional]
**links** | Option<**Vec<String>**> | | [optional]
**rules** | Option<**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)

15
docs/UpdateGroupRoleRequest.md Normal file
View File

@ -0,0 +1,15 @@
# UpdateGroupRoleRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | Option<**String**> | | [optional]
**description** | Option<**String**> | | [optional]
**is_self_assignable** | Option<**bool**> | | [optional][default to false]
**permissions** | Option<**Vec<String>**> | | [optional]
**order** | Option<**i32**> | | [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)

68
docs/UsersApi.md
View File

@ -6,6 +6,8 @@ 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
[**get_user_group_requests**](UsersApi.md#get_user_group_requests) | **GET** /users/{userId}/groups/requested | Get User Group Requests
[**get_user_groups**](UsersApi.md#get_user_groups) | **GET** /users/{userId}/groups | Get User Groups
[**search_users**](UsersApi.md#search_users) | **GET** /users | Search All Users
[**update_user**](UsersApi.md#update_user) | **PUT** /users/{userId} | Update User Info
@ -23,7 +25,7 @@ Get public user information about a specific user using their ID.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**user_id** | **String** | Must be a valid user ID. | [required] |
### Return type
@ -53,7 +55,7 @@ Get User by Username
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**username** | **String** | | [required] |
**username** | **String** | Username of the user | [required] |
### Return type
@ -71,6 +73,66 @@ Name | Type | Description | Required | Notes
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_user_group_requests
> Vec<crate::models::Group> get_user_group_requests(user_id)
Get User Group Requests
Returns a list of Groups the user has requested to be invited into.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | Must be a valid user ID. | [required] |
### Return type
[**Vec<crate::models::Group>**](Group.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_user_groups
> Vec<crate::models::Group> get_user_groups(user_id)
Get User Groups
Get user's public groups
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | Must be a valid user ID. | [required] |
### Return type
[**Vec<crate::models::Group>**](Group.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)
@ -116,7 +178,7 @@ Update a users information such as the email and birthday.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**user_id** | **String** | Must be a valid user ID. | [required] |
**update_user_request** | Option<[**UpdateUserRequest**](UpdateUserRequest.md)> | | |
### Return type

42
docs/WorldsApi.md
View File

@ -62,7 +62,7 @@ Delete a world. Notice a world is never fully \"deleted\", only its ReleaseStatu
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
**world_id** | **String** | Must be a valid world ID. | [required] |
### Return type
@ -93,14 +93,14 @@ Search and list currently Active worlds by query filters.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**featured** | Option<**bool**> | Filters on featured results. | |
**sort** | Option<**String**> | | |[default to popularity]
**sort** | Option<[**SortOption**](.md)> | The sort order of the results. | |
**n** | Option<**i32**> | The number of objects to return. | |[default to 60]
**order** | Option<**String**> | | |[default to descending]
**order** | Option<[**OrderOption**](.md)> | Result ordering | |
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. | |
**search** | Option<**String**> | Filters by world name. | |
**tag** | Option<**String**> | Tags to include (comma-separated). Any of the tags needs to be present. | |
**notag** | Option<**String**> | Tags to exclude (comma-separated). | |
**release_status** | Option<**String**> | Filter by ReleaseStatus. | |[default to public]
**release_status** | Option<[**ReleaseStatus**](.md)> | Filter by ReleaseStatus. | |
**max_unity_version** | Option<**String**> | The maximum Unity version supported by the asset. | |
**min_unity_version** | Option<**String**> | The minimum Unity version supported by the asset. | |
**platform** | Option<**String**> | The platform the asset supports. | |
@ -134,14 +134,14 @@ Search and list favorited worlds by query filters.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**featured** | Option<**bool**> | Filters on featured results. | |
**sort** | Option<**String**> | | |[default to popularity]
**sort** | Option<[**SortOption**](.md)> | The sort order of the results. | |
**n** | Option<**i32**> | The number of objects to return. | |[default to 60]
**order** | Option<**String**> | | |[default to descending]
**order** | Option<[**OrderOption**](.md)> | Result ordering | |
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. | |
**search** | Option<**String**> | Filters by world name. | |
**tag** | Option<**String**> | Tags to include (comma-separated). Any of the tags needs to be present. | |
**notag** | Option<**String**> | Tags to exclude (comma-separated). | |
**release_status** | Option<**String**> | Filter by ReleaseStatus. | |[default to public]
**release_status** | Option<[**ReleaseStatus**](.md)> | Filter by ReleaseStatus. | |
**max_unity_version** | Option<**String**> | The maximum Unity version supported by the asset. | |
**min_unity_version** | Option<**String**> | The minimum Unity version supported by the asset. | |
**platform** | Option<**String**> | The platform the asset supports. | |
@ -176,14 +176,14 @@ Search and list recently visited worlds by query filters.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**featured** | Option<**bool**> | Filters on featured results. | |
**sort** | Option<**String**> | | |[default to popularity]
**sort** | Option<[**SortOption**](.md)> | The sort order of the results. | |
**n** | Option<**i32**> | The number of objects to return. | |[default to 60]
**order** | Option<**String**> | | |[default to descending]
**order** | Option<[**OrderOption**](.md)> | Result ordering | |
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. | |
**search** | Option<**String**> | Filters by world name. | |
**tag** | Option<**String**> | Tags to include (comma-separated). Any of the tags needs to be present. | |
**notag** | Option<**String**> | Tags to exclude (comma-separated). | |
**release_status** | Option<**String**> | Filter by ReleaseStatus. | |[default to public]
**release_status** | Option<[**ReleaseStatus**](.md)> | Filter by ReleaseStatus. | |
**max_unity_version** | Option<**String**> | The maximum Unity version supported by the asset. | |
**min_unity_version** | Option<**String**> | The minimum Unity version supported by the asset. | |
**platform** | Option<**String**> | The platform the asset supports. | |
@ -217,7 +217,7 @@ Get information about a specific World. Works unauthenticated but when so will a
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
**world_id** | **String** | Must be a valid world ID. | [required] |
### Return type
@ -247,8 +247,8 @@ Returns a worlds instance.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
**instance_id** | **String** | | [required] |
**world_id** | **String** | Must be a valid world ID. | [required] |
**instance_id** | **String** | Must be a valid instance ID. | [required] |
### Return type
@ -278,7 +278,7 @@ Return a worlds custom metadata. This is currently believed to be unused. Metada
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
**world_id** | **String** | Must be a valid world ID. | [required] |
### Return type
@ -308,7 +308,7 @@ Returns a worlds publish status.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
**world_id** | **String** | Must be a valid world ID. | [required] |
### Return type
@ -338,7 +338,7 @@ Publish a world. You can only publish one world per week.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
**world_id** | **String** | Must be a valid world ID. | [required] |
### Return type
@ -369,16 +369,16 @@ Search and list any worlds by query filters.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**featured** | Option<**bool**> | Filters on featured results. | |
**sort** | Option<**String**> | | |[default to popularity]
**sort** | Option<[**SortOption**](.md)> | The sort order of the results. | |
**user** | Option<**String**> | Set to `me` for searching own worlds. | |
**user_id** | Option<**String**> | Filter by UserID. | |
**n** | Option<**i32**> | The number of objects to return. | |[default to 60]
**order** | Option<**String**> | | |[default to descending]
**order** | Option<[**OrderOption**](.md)> | Result ordering | |
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. | |
**search** | Option<**String**> | Filters by world name. | |
**tag** | Option<**String**> | Tags to include (comma-separated). Any of the tags needs to be present. | |
**notag** | Option<**String**> | Tags to exclude (comma-separated). | |
**release_status** | Option<**String**> | Filter by ReleaseStatus. | |[default to public]
**release_status** | Option<[**ReleaseStatus**](.md)> | Filter by ReleaseStatus. | |
**max_unity_version** | Option<**String**> | The maximum Unity version supported by the asset. | |
**min_unity_version** | Option<**String**> | The minimum Unity version supported by the asset. | |
**platform** | Option<**String**> | The platform the asset supports. | |
@ -411,7 +411,7 @@ Unpublish a world.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
**world_id** | **String** | Must be a valid world ID. | [required] |
### Return type
@ -441,7 +441,7 @@ Update information about a specific World.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**world_id** | **String** | | [required] |
**world_id** | **String** | Must be a valid world ID. | [required] |
**update_world_request** | Option<[**UpdateWorldRequest**](UpdateWorldRequest.md)> | | |
### Return type