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.17.3

Browse Source
This commit is contained in:
VRCCat
2024-04-29 22:01:05 +00:00
parent 7796d47f36
commit 2f90047c38
21 changed files with 459 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/CreateInstanceRequest.md Normal file
View File

@@ -0,0 +1,18 @@
# CreateInstanceRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**world_id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
**r#type** | [**crate::models::InstanceType**](InstanceType.md) | |
**region** | [**crate::models::Region**](Region.md) | |
**owner_id** | Option<**String**> | A groupId if the instance type is \"group\", null if instance type is public, or a userId otherwise | [optional]
**role_ids** | Option<**Vec<String>**> | Group roleIds that are allowed to join if the type is \"group\" and groupAccessType is \"member\" | [optional]
**group_access_type** | Option<[**crate::models::GroupAccessType**](GroupAccessType.md)> | | [optional]
**queue_enabled** | Option<**bool**> | | [optional][default to false]
**closed_at** | Option<**String**> | The time after which users won't be allowed to join the instance | [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)

33
docs/GroupsApi.md
View File

@@ -44,6 +44,7 @@ Method | HTTP request | Description
[**update_group**](GroupsApi.md#update_group) | **PUT** /groups/{groupId} | Update Group
[**update_group_gallery**](GroupsApi.md#update_group_gallery) | **PUT** /groups/{groupId}/galleries/{groupGalleryId} | Update Group Gallery
[**update_group_member**](GroupsApi.md#update_group_member) | **PUT** /groups/{groupId}/members/{userId} | Update Group Member
[**update_group_post**](GroupsApi.md#update_group_post) | **PUT** /groups/{groupId}/posts/{notificationId} | Edits a Group post
[**update_group_role**](GroupsApi.md#update_group_role) | **PUT** /groups/{groupId}/roles/{groupRoleId} | Update Group Role
@@ -1299,6 +1300,38 @@ 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)
## update_group_post
> crate::models::GroupPost update_group_post(group_id, notification_id, create_group_post_request)
Edits a Group post
Edits a Group post
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** | Must be a valid group ID. | [required] |
**notification_id** | **String** | Must be a valid notification ID. | [required] |
**create_group_post_request** | [**CreateGroupPostRequest**](CreateGroupPostRequest.md) | | [required] |
### Return type
[**crate::models::GroupPost**](GroupPost.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## update_group_role
> Vec<crate::models::GroupRole> update_group_role(group_id, group_role_id, update_group_role_request)

36
docs/InstancesApi.md
View File

@@ -5,6 +5,7 @@ All URIs are relative to *https://api.vrchat.cloud/api/1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**close_instance**](InstancesApi.md#close_instance) | **DELETE** /instances/{worldId}:{instanceId} | Close Instance
[**create_instance**](InstancesApi.md#create_instance) | **POST** /instances | Create Instance
[**get_instance**](InstancesApi.md#get_instance) | **GET** /instances/{worldId}:{instanceId} | Get Instance
[**get_instance_by_short_name**](InstancesApi.md#get_instance_by_short_name) | **GET** /instances/s/{shortName} | Get Instance By Short Name
[**get_short_name**](InstancesApi.md#get_short_name) | **GET** /instances/{worldId}:{instanceId}/shortName | Get Instance Short Name
@@ -14,10 +15,10 @@ Method | HTTP request | Description
## close_instance
> crate::models::Instance close_instance(world_id, instance_id, hard_close)
> crate::models::Instance close_instance(world_id, instance_id, hard_close, closed_at)
Close Instance
Close an instance. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-moderate` permission.
Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-moderate` permission.
### Parameters
@@ -27,6 +28,7 @@ Name | Type | Description | Required | Notes
**world_id** | **String** | Must be a valid world ID. | [required] |
**instance_id** | **String** | Must be a valid instance ID. | [required] |
**hard_close** | Option<**bool**> | Whether to hard close the instance. Defaults to false. | |
**closed_at** | Option<**String**> | The time after which users won't be allowed to join the instances. If omitted, the instance will be closed immediately. | |
### Return type
@@ -44,6 +46,36 @@ 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)
## create_instance
> crate::models::Instance create_instance(create_instance_request)
Create Instance
Create an instance
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_instance_request** | [**CreateInstanceRequest**](CreateInstanceRequest.md) | | [required] |
### Return type
[**crate::models::Instance**](Instance.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_instance
> crate::models::Instance get_instance(world_id, instance_id)

13
docs/NotificationDetailInvite.md Normal file
View File

@@ -0,0 +1,13 @@
# NotificationDetailInvite
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**invite_message** | Option<**String**> | | [optional]
**world_id** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
**world_name** | **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)

12
docs/NotificationDetailInviteResponse.md Normal file
View File

@@ -0,0 +1,12 @@
# NotificationDetailInviteResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**in_response_to** | **String** | |
**response_message** | **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)

12
docs/NotificationDetailRequestInvite.md Normal file
View File

@@ -0,0 +1,12 @@
# NotificationDetailRequestInvite
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**platform** | Option<**String**> | TODO: Does this still exist? | [optional]
**request_message** | Option<**String**> | Used when using InviteMessage Slot. | [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/NotificationDetailRequestInviteResponse.md Normal file
View File

@@ -0,0 +1,12 @@
# NotificationDetailRequestInviteResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**in_response_to** | **String** | |
**request_message** | Option<**String**> | Used when using InviteMessage Slot. | [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/NotificationDetailVoteToKick.md Normal file
View File

@@ -0,0 +1,12 @@
# NotificationDetailVoteToKick
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**initiator_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. |
**user_to_kick_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)

4
docs/UsersApi.md
View File

@@ -106,7 +106,7 @@ Name | Type | Description | Required | Notes
## get_user_groups
> Vec<crate::models::Group> get_user_groups(user_id)
> Vec<crate::models::LimitedGroup> get_user_groups(user_id)
Get User Groups
Get user's public groups
@@ -120,7 +120,7 @@ Name | Type | Description | Required | Notes
### Return type
[**Vec<crate::models::Group>**](Group.md)
[**Vec<crate::models::LimitedGroup>**](LimitedGroup.md)
### Authorization