Skip to content

Commit 33e1308

Browse files
VRCCatVRCCat
committed
Upgrade Python SDK to spec 1.5.1
1 parent 6cd7840 commit 33e1308

File tree

106 files changed

+1479
-171
lines changed

Some content is hidden

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

106 files changed

+1479
-171
lines changed

‎.openapi-generator/FILES‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,11 @@ docs/FilesApi.md
3636
docs/FinishFileDataUploadRequest.md
3737
docs/FriendStatus.md
3838
docs/FriendsApi.md
39+
docs/InlineResponse404.md
3940
docs/Instance.md
4041
docs/InstanceID.md
4142
docs/InstancePlatforms.md
43+
docs/InstancesApi.md
4244
docs/InviteApi.md
4345
docs/InviteMessage.md
4446
docs/InviteMessageID.md
@@ -72,6 +74,7 @@ docs/UnityPackage.md
7274
docs/UnityPackageID.md
7375
docs/UpdateAvatarRequest.md
7476
docs/UpdateFavoriteGroupRequest.md
77+
docs/UpdateInviteMessageRequest.md
7578
docs/UpdateUserRequest.md
7679
docs/UpdateWorldRequest.md
7780
docs/User.md
@@ -99,6 +102,7 @@ vrchatapi/api/avatars_api.py
99102
vrchatapi/api/favorites_api.py
100103
vrchatapi/api/files_api.py
101104
vrchatapi/api/friends_api.py
105+
vrchatapi/api/instances_api.py
102106
vrchatapi/api/invite_api.py
103107
vrchatapi/api/notifications_api.py
104108
vrchatapi/api/permissions_api.py
@@ -143,6 +147,7 @@ vrchatapi/model/file_version.py
143147
vrchatapi/model/file_version_upload_status.py
144148
vrchatapi/model/finish_file_data_upload_request.py
145149
vrchatapi/model/friend_status.py
150+
vrchatapi/model/inline_response404.py
146151
vrchatapi/model/instance.py
147152
vrchatapi/model/instance_id.py
148153
vrchatapi/model/instance_platforms.py
@@ -174,6 +179,7 @@ vrchatapi/model/unity_package.py
174179
vrchatapi/model/unity_package_id.py
175180
vrchatapi/model/update_avatar_request.py
176181
vrchatapi/model/update_favorite_group_request.py
182+
vrchatapi/model/update_invite_message_request.py
177183
vrchatapi/model/update_user_request.py
178184
vrchatapi/model/update_world_request.py
179185
vrchatapi/model/user.py

‎docs/InlineResponse404.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# InlineResponse404
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**error** | [**Error**](Error.md) | |
8+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

‎docs/InstancesApi.md‎

Lines changed: 277 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,277 @@
1+
# vrchatapi.InstancesApi
2+
3+
All URIs are relative to *https://api.vrchat.cloud/api/1*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**get_instance**](InstancesApi.md#get_instance) | **GET** /instances/{worldId}:{instanceId} | Get Instance
8+
[**get_short_name**](InstancesApi.md#get_short_name) | **GET** /instances/{worldId}:{instanceId}/shortName | Get Instance Short Name
9+
[**send_self_invite**](InstancesApi.md#send_self_invite) | **POST** /instances/{worldId}:{instanceId}/invite | Send Self Invite
10+
11+
12+
# **get_instance**
13+
> Instance get_instance(world_id, instance_id)
14+
15+
Get Instance
16+
17+
Returns an instance.
18+
19+
### Example
20+
21+
* Api Key Authentication (apiKeyCookie):
22+
* Api Key Authentication (authCookie):
23+
24+
```python
25+
import time
26+
import vrchatapi
27+
from vrchatapi.api import instances_api
28+
from vrchatapi.model.error import Error
29+
from vrchatapi.model.instance import Instance
30+
from pprint import pprint
31+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
32+
# See configuration.py for a list of all supported configuration parameters.
33+
configuration = vrchatapi.Configuration(
34+
host = "https://api.vrchat.cloud/api/1"
35+
)
36+
37+
# The client must configure the authentication and authorization parameters
38+
# in accordance with the API server security policy.
39+
# Examples for each auth method are provided below, use the example that
40+
# satisfies your auth use case.
41+
42+
# Configure API key authorization: apiKeyCookie
43+
configuration.api_key['apiKeyCookie'] = 'YOUR_API_KEY'
44+
45+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
46+
# configuration.api_key_prefix['apiKeyCookie'] = 'Bearer'
47+
48+
# Configure API key authorization: authCookie
49+
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
50+
51+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
52+
# configuration.api_key_prefix['authCookie'] = 'Bearer'
53+
54+
# Enter a context with an instance of the API client
55+
with vrchatapi.ApiClient(configuration) as api_client:
56+
# Create an instance of the API class
57+
api_instance = instances_api.InstancesApi(api_client)
58+
world_id = "worldId_example" # str |
59+
instance_id = "instanceId_example" # str |
60+
61+
# example passing only required values which don't have defaults set
62+
try:
63+
# Get Instance
64+
api_response = api_instance.get_instance(world_id, instance_id)
65+
pprint(api_response)
66+
except vrchatapi.ApiException as e:
67+
print("Exception when calling InstancesApi->get_instance: %s\n" % e)
68+
```
69+
70+
71+
### Parameters
72+
73+
Name | Type | Description | Notes
74+
------------- | ------------- | ------------- | -------------
75+
**world_id** | **str**| |
76+
**instance_id** | **str**| |
77+
78+
### Return type
79+
80+
[**Instance**](Instance.md)
81+
82+
### Authorization
83+
84+
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
85+
86+
### HTTP request headers
87+
88+
- **Content-Type**: Not defined
89+
- **Accept**: application/json
90+
91+
92+
### HTTP response details
93+
94+
| Status code | Description | Response headers |
95+
|-------------|-------------|------------------|
96+
**200** | Returns a single Instance object. | - |
97+
**401** | Error response due to missing apiKey or auth cookie. | - |
98+
99+
[[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)
100+
101+
# **get_short_name**
102+
> str get_short_name(world_id, instance_id)
103+
104+
Get Instance Short Name
105+
106+
Returns an instance short name.
107+
108+
### Example
109+
110+
* Api Key Authentication (apiKeyCookie):
111+
* Api Key Authentication (authCookie):
112+
113+
```python
114+
import time
115+
import vrchatapi
116+
from vrchatapi.api import instances_api
117+
from vrchatapi.model.error import Error
118+
from pprint import pprint
119+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
120+
# See configuration.py for a list of all supported configuration parameters.
121+
configuration = vrchatapi.Configuration(
122+
host = "https://api.vrchat.cloud/api/1"
123+
)
124+
125+
# The client must configure the authentication and authorization parameters
126+
# in accordance with the API server security policy.
127+
# Examples for each auth method are provided below, use the example that
128+
# satisfies your auth use case.
129+
130+
# Configure API key authorization: apiKeyCookie
131+
configuration.api_key['apiKeyCookie'] = 'YOUR_API_KEY'
132+
133+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
134+
# configuration.api_key_prefix['apiKeyCookie'] = 'Bearer'
135+
136+
# Configure API key authorization: authCookie
137+
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
138+
139+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
140+
# configuration.api_key_prefix['authCookie'] = 'Bearer'
141+
142+
# Enter a context with an instance of the API client
143+
with vrchatapi.ApiClient(configuration) as api_client:
144+
# Create an instance of the API class
145+
api_instance = instances_api.InstancesApi(api_client)
146+
world_id = "worldId_example" # str |
147+
instance_id = "instanceId_example" # str |
148+
149+
# example passing only required values which don't have defaults set
150+
try:
151+
# Get Instance Short Name
152+
api_response = api_instance.get_short_name(world_id, instance_id)
153+
pprint(api_response)
154+
except vrchatapi.ApiException as e:
155+
print("Exception when calling InstancesApi->get_short_name: %s\n" % e)
156+
```
157+
158+
159+
### Parameters
160+
161+
Name | Type | Description | Notes
162+
------------- | ------------- | ------------- | -------------
163+
**world_id** | **str**| |
164+
**instance_id** | **str**| |
165+
166+
### Return type
167+
168+
**str**
169+
170+
### Authorization
171+
172+
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
173+
174+
### HTTP request headers
175+
176+
- **Content-Type**: Not defined
177+
- **Accept**: text/plain, application/json
178+
179+
180+
### HTTP response details
181+
182+
| Status code | Description | Response headers |
183+
|-------------|-------------|------------------|
184+
**200** | Returns an instance short name. | - |
185+
**401** | Error response due to missing apiKey or auth cookie. | - |
186+
187+
[[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)
188+
189+
# **send_self_invite**
190+
> Success send_self_invite(world_id, instance_id)
191+
192+
Send Self Invite
193+
194+
Sends an invite to the instance to yourself.
195+
196+
### Example
197+
198+
* Api Key Authentication (apiKeyCookie):
199+
* Api Key Authentication (authCookie):
200+
201+
```python
202+
import time
203+
import vrchatapi
204+
from vrchatapi.api import instances_api
205+
from vrchatapi.model.success import Success
206+
from vrchatapi.model.error import Error
207+
from pprint import pprint
208+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
209+
# See configuration.py for a list of all supported configuration parameters.
210+
configuration = vrchatapi.Configuration(
211+
host = "https://api.vrchat.cloud/api/1"
212+
)
213+
214+
# The client must configure the authentication and authorization parameters
215+
# in accordance with the API server security policy.
216+
# Examples for each auth method are provided below, use the example that
217+
# satisfies your auth use case.
218+
219+
# Configure API key authorization: apiKeyCookie
220+
configuration.api_key['apiKeyCookie'] = 'YOUR_API_KEY'
221+
222+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
223+
# configuration.api_key_prefix['apiKeyCookie'] = 'Bearer'
224+
225+
# Configure API key authorization: authCookie
226+
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
227+
228+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
229+
# configuration.api_key_prefix['authCookie'] = 'Bearer'
230+
231+
# Enter a context with an instance of the API client
232+
with vrchatapi.ApiClient(configuration) as api_client:
233+
# Create an instance of the API class
234+
api_instance = instances_api.InstancesApi(api_client)
235+
world_id = "worldId_example" # str |
236+
instance_id = "instanceId_example" # str |
237+
238+
# example passing only required values which don't have defaults set
239+
try:
240+
# Send Self Invite
241+
api_response = api_instance.send_self_invite(world_id, instance_id)
242+
pprint(api_response)
243+
except vrchatapi.ApiException as e:
244+
print("Exception when calling InstancesApi->send_self_invite: %s\n" % e)
245+
```
246+
247+
248+
### Parameters
249+
250+
Name | Type | Description | Notes
251+
------------- | ------------- | ------------- | -------------
252+
**world_id** | **str**| |
253+
**instance_id** | **str**| |
254+
255+
### Return type
256+
257+
[**Success**](Success.md)
258+
259+
### Authorization
260+
261+
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
262+
263+
### HTTP request headers
264+
265+
- **Content-Type**: Not defined
266+
- **Accept**: application/json
267+
268+
269+
### HTTP response details
270+
271+
| Status code | Description | Response headers |
272+
|-------------|-------------|------------------|
273+
**200** | Success response after sending an invite to yourself to the instance. | - |
274+
**401** | Error response due to missing apiKey or auth cookie. | - |
275+
276+
[[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)
277+

0 commit comments

Comments
 (0)