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

Browse Source
This commit is contained in:
VRCCat
2024-04-15 22:18:47 +00:00
parent 0bac2026bb
commit fd93366a00
11 changed files with 165 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/GroupAccessType.md Normal file
View File

@@ -0,0 +1,10 @@
# GroupAccessType
## 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)

9
docs/Instance.md
View File

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
**location** | **String** | InstanceID can be \"offline\" on User profiles if you are not friends with that user and \"private\" if you are friends and user is in private instance. |
**n_users** | **i32** | |
**name** | **String** | |
**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]
**owner_id** | Option<**String**> | A groupId if the instance type is \"group\", null if instance type is public, or a userId otherwise | [optional]
**permanent** | **bool** | | [default to false]
**photon_region** | [**crate::models::Region**](Region.md) | |
**platforms** | [**crate::models::InstancePlatforms**](InstancePlatforms.md) | |
@@ -30,11 +30,16 @@ Name | Type | Description | Notes
**queue_enabled** | **bool** | |
**queue_size** | **i32** | |
**recommended_capacity** | **i32** | |
**role_restricted** | **bool** | |
**role_restricted** | Option<**bool**> | | [optional]
**strict** | **bool** | |
**user_count** | **i32** | |
**world** | [**crate::models::World**](World.md) | |
**users** | Option<[**Vec<crate::models::LimitedUser>**](LimitedUser.md)> | The users field is present on instances created by the requesting user. | [optional]
**group_access_type** | Option<[**crate::models::GroupAccessType**](GroupAccessType.md)> | | [optional]
**has_capacity_for_you** | Option<**bool**> | | [optional]
**nonce** | Option<**String**> | | [optional]
**closed_at** | Option<**String**> | | [optional]
**hard_close** | Option<**bool**> | | [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/InstancesApi.md
View File

@@ -4,6 +4,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
[**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
@@ -11,6 +12,38 @@ Method | HTTP request | Description
## close_instance
> crate::models::Instance close_instance(world_id, instance_id, hard_close)
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.
### Parameters
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. | |
### Return type
[**crate::models::Instance**](Instance.md)
### Authorization
[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_instance
> crate::models::Instance get_instance(world_id, instance_id)