Skip to content

Commit 06b44f5

Browse files
VRCCatVRCCat
committed
Upgrade Python SDK to spec 1.17.0
1 parent c1b4560 commit 06b44f5

File tree

155 files changed

+665
-165
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

155 files changed

+665
-165
lines changed

‎.openapi-generator/FILES‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ docs/FinishFileDataUploadRequest.md
4444
docs/FriendStatus.md
4545
docs/FriendsApi.md
4646
docs/Group.md
47+
docs/GroupAccessType.md
4748
docs/GroupAnnouncement.md
4849
docs/GroupAuditLogEntry.md
4950
docs/GroupGallery.md
@@ -206,6 +207,7 @@ vrchatapi/models/file_version_upload_status.py
206207
vrchatapi/models/finish_file_data_upload_request.py
207208
vrchatapi/models/friend_status.py
208209
vrchatapi/models/group.py
210+
vrchatapi/models/group_access_type.py
209211
vrchatapi/models/group_announcement.py
210212
vrchatapi/models/group_audit_log_entry.py
211213
vrchatapi/models/group_gallery.py

‎docs/FriendsApi.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,7 @@ Name | Type | Description | Notes
156156
| Status code | Description | Response headers |
157157
|-------------|-------------|------------------|
158158
**200** | Returns a single Notifcation object. | - |
159+
**400** | Bad request error response when sending a friend request | - |
159160
**401** | Error response due to missing auth cookie. | - |
160161
**404** | Error response when trying to send a friend request to a user which doesn't exist. | - |
161162

‎docs/GroupAccessType.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# GroupAccessType
2+
3+
Group access type when the instance type is \"group\"
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
9+
[[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+
11+

‎docs/GroupsApi.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -652,8 +652,9 @@ void (empty response body)
652652
| Status code | Description | Response headers |
653653
|-------------|-------------|------------------|
654654
**200** | OK | - |
655-
**400** | User <displayName> is already invited | - |
655+
**400** | Bad request error response when creating a group invite. | - |
656656
**401** | Error response due to missing auth cookie. | - |
657+
**403** | Forbidden error response when creating a group invite. | - |
657658
**404** | Error response when trying to perform operations on a non-existing group. | - |
658659

659660
[[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)
@@ -1980,6 +1981,7 @@ Name | Type | Description | Notes
19801981
| Status code | Description | Response headers |
19811982
|-------------|-------------|------------------|
19821983
**200** | Returns a list of GroupMember objects. | - |
1984+
**400** | Bad request error response when responding to a group join request | - |
19831985
**403** | Error response when trying to perform operations on a group you are not member of. | - |
19841986
**404** | Error response when trying to perform operations on a non-existing group. | - |
19851987

‎docs/Instance.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
1515
**location** | **str** | 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. |
1616
**n_users** | **int** | |
1717
**name** | **str** | |
18-
**owner_id** | **str** | 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]
18+
**owner_id** | **str** | A groupId if the instance type is \"group\", null if instance type is public, or a userId otherwise | [optional]
1919
**permanent** | **bool** | | [default to False]
2020
**photon_region** | [**Region**](Region.md) | |
2121
**platforms** | [**InstancePlatforms**](InstancePlatforms.md) | |
@@ -31,11 +31,16 @@ Name | Type | Description | Notes
3131
**queue_enabled** | **bool** | |
3232
**queue_size** | **int** | |
3333
**recommended_capacity** | **int** | |
34-
**role_restricted** | **bool** | |
34+
**role_restricted** | **bool** | | [optional]
3535
**strict** | **bool** | |
3636
**user_count** | **int** | |
3737
**world** | [**World**](World.md) | |
3838
**users** | [**list[LimitedUser]**](LimitedUser.md) | The users field is present on instances created by the requesting user. | [optional]
39+
**group_access_type** | [**GroupAccessType**](GroupAccessType.md) | | [optional]
40+
**has_capacity_for_you** | **bool** | | [optional]
41+
**nonce** | **str** | | [optional]
42+
**closed_at** | **datetime** | | [optional]
43+
**hard_close** | **bool** | | [optional]
3944

4045
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
4146

‎docs/InstancesApi.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,93 @@ All URIs are relative to *https://api.vrchat.cloud/api/1*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7+
[**close_instance**](InstancesApi.md#close_instance) | **DELETE** /instances/{worldId}:{instanceId} | Close Instance
78
[**get_instance**](InstancesApi.md#get_instance) | **GET** /instances/{worldId}:{instanceId} | Get Instance
89
[**get_instance_by_short_name**](InstancesApi.md#get_instance_by_short_name) | **GET** /instances/s/{shortName} | Get Instance By Short Name
910
[**get_short_name**](InstancesApi.md#get_short_name) | **GET** /instances/{worldId}:{instanceId}/shortName | Get Instance Short Name
1011
[**send_self_invite**](InstancesApi.md#send_self_invite) | **POST** /instances/{worldId}:{instanceId}/invite | Send Self Invite
1112

1213

14+
# **close_instance**
15+
> Instance close_instance(world_id, instance_id, hard_close=hard_close)
16+
17+
Close Instance
18+
19+
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.
20+
21+
### Example
22+
23+
* Api Key Authentication (authCookie):
24+
```python
25+
from __future__ import print_function
26+
import time
27+
import vrchatapi
28+
from vrchatapi.rest import ApiException
29+
from pprint import pprint
30+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
31+
# See configuration.py for a list of all supported configuration parameters.
32+
configuration = vrchatapi.Configuration(
33+
host = "https://api.vrchat.cloud/api/1"
34+
)
35+
36+
# The client must configure the authentication and authorization parameters
37+
# in accordance with the API server security policy.
38+
# Examples for each auth method are provided below, use the example that
39+
# satisfies your auth use case.
40+
41+
# Configure API key authorization: authCookie
42+
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
43+
44+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
45+
# configuration.api_key_prefix['authCookie'] = 'Bearer'
46+
47+
# Enter a context with an instance of the API client
48+
with vrchatapi.ApiClient(configuration) as api_client:
49+
# Create an instance of the API class
50+
api_instance = vrchatapi.InstancesApi(api_client)
51+
world_id = 'world_id_example' # str | Must be a valid world ID.
52+
instance_id = 'instance_id_example' # str | Must be a valid instance ID.
53+
hard_close = True # bool | Whether to hard close the instance. Defaults to false. (optional)
54+
55+
try:
56+
# Close Instance
57+
api_response = api_instance.close_instance(world_id, instance_id, hard_close=hard_close)
58+
pprint(api_response)
59+
except ApiException as e:
60+
print("Exception when calling InstancesApi->close_instance: %s\n" % e)
61+
```
62+
63+
### Parameters
64+
65+
Name | Type | Description | Notes
66+
------------- | ------------- | ------------- | -------------
67+
**world_id** | **str**| Must be a valid world ID. |
68+
**instance_id** | **str**| Must be a valid instance ID. |
69+
**hard_close** | **bool**| Whether to hard close the instance. Defaults to false. | [optional]
70+
71+
### Return type
72+
73+
[**Instance**](Instance.md)
74+
75+
### Authorization
76+
77+
[authCookie](../README.md#authCookie)
78+
79+
### HTTP request headers
80+
81+
- **Content-Type**: Not defined
82+
- **Accept**: application/json
83+
84+
### HTTP response details
85+
| Status code | Description | Response headers |
86+
|-------------|-------------|------------------|
87+
**200** | Returns a single Instance object. | - |
88+
**401** | Error response due to missing auth cookie. | - |
89+
**403** | Error response due to not being allowed to close an instance | - |
90+
**404** | Error response due to non existant instance | - |
91+
92+
[[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)
93+
1394
# **get_instance**
1495
> Instance get_instance(world_id, instance_id)
1596

‎setup.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383
8484
Join the [Discord server](https://discord.gg/Ge2APMhPfD) to get in touch with us.
8585
86-
The version of the OpenAPI document: 1.16.8
86+
The version of the OpenAPI document: 1.17.0
8787
Contact: vrchatapi.lpv0t@aries.fyi
8888
Generated by: https://openapi-generator.tech
8989
"""
@@ -92,7 +92,7 @@
9292
from setuptools import setup, find_packages # noqa: H301
9393

9494
NAME = "vrchatapi"
95-
VERSION = "1.16.8"
95+
VERSION = "1.17.0"
9696
# To install the library, run the following
9797
#
9898
# python setup.py install

‎vrchatapi/__init__.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
VRChat API Documentation
77
88
9-
The version of the OpenAPI document: 1.16.8
9+
The version of the OpenAPI document: 1.17.0
1010
Contact: vrchatapi.lpv0t@aries.fyi
1111
Generated by: https://openapi-generator.tech
1212
"""
@@ -82,6 +82,7 @@
8282
from vrchatapi.models.finish_file_data_upload_request import FinishFileDataUploadRequest
8383
from vrchatapi.models.friend_status import FriendStatus
8484
from vrchatapi.models.group import Group
85+
from vrchatapi.models.group_access_type import GroupAccessType
8586
from vrchatapi.models.group_announcement import GroupAnnouncement
8687
from vrchatapi.models.group_audit_log_entry import GroupAuditLogEntry
8788
from vrchatapi.models.group_gallery import GroupGallery

‎vrchatapi/api/authentication_api.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
VRChat API Documentation
55
66
7-
The version of the OpenAPI document: 1.16.8
7+
The version of the OpenAPI document: 1.17.0
88
Contact: vrchatapi.lpv0t@aries.fyi
99
Generated by: https://openapi-generator.tech
1010
"""

‎vrchatapi/api/avatars_api.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
VRChat API Documentation
55
66
7-
The version of the OpenAPI document: 1.16.8
7+
The version of the OpenAPI document: 1.17.0
88
Contact: vrchatapi.lpv0t@aries.fyi
99
Generated by: https://openapi-generator.tech
1010
"""

0 commit comments

Comments
 (0)