Skip to content

Commit b9c5ba5

Browse files
VRCCatVRCCat
committed
Upgrade Python SDK to spec 1.7.3
1 parent a16784c commit b9c5ba5

File tree

131 files changed

+1248
-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.

131 files changed

+1248
-171
lines changed

‎.openapi-generator/FILES‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ docs/InviteApi.md
5151
docs/InviteMessage.md
5252
docs/InviteMessageID.md
5353
docs/InviteMessageType.md
54+
docs/InviteMyselfToRequest.md
5455
docs/InviteRequest.md
5556
docs/InviteResponse.md
5657
docs/License.md
@@ -79,6 +80,7 @@ docs/Region.md
7980
docs/ReleaseStatus.md
8081
docs/RequestInviteRequest.md
8182
docs/Response.md
83+
docs/SentNotification.md
8284
docs/Subscription.md
8385
docs/SubscriptionPeriod.md
8486
docs/Success.md
@@ -182,6 +184,7 @@ vrchatapi/model/instance_type.py
182184
vrchatapi/model/invite_message.py
183185
vrchatapi/model/invite_message_id.py
184186
vrchatapi/model/invite_message_type.py
187+
vrchatapi/model/invite_myself_to_request.py
185188
vrchatapi/model/invite_request.py
186189
vrchatapi/model/invite_response.py
187190
vrchatapi/model/license.py
@@ -207,6 +210,7 @@ vrchatapi/model/region.py
207210
vrchatapi/model/release_status.py
208211
vrchatapi/model/request_invite_request.py
209212
vrchatapi/model/response.py
213+
vrchatapi/model/sent_notification.py
210214
vrchatapi/model/subscription.py
211215
vrchatapi/model/subscription_period.py
212216
vrchatapi/model/success.py

‎docs/APIConfig.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ Name | Type | Description | Notes
5858
**vive_windows_url** | **str** | Download link for game on the Steam website. |
5959
**white_listed_asset_urls** | **[str]** | List of allowed URLs that are allowed to host avatar assets |
6060
**world_update_period** | **int** | Unknown |
61-
**youtubedl_hash** | **str** | Currently used youtube-dl.exe hash in SHA-256-delimited format |
62-
**youtubedl_version** | **str** | Currently used youtube-dl.exe version |
61+
**player_url_resolver_hash** | **str** | Currently used youtube-dl.exe hash in SHA-256-delimited format |
62+
**player_url_resolver_version** | **str** | Currently used youtube-dl.exe version |
6363
**voice_enable_degradation** | **bool** | Unknown, probably voice optimization testing | defaults to False
6464
**voice_enable_receiver_limiting** | **bool** | Unknown, probably voice optimization testing | defaults to True
6565
**app_name** | **str** | Game name | defaults to "VrChat"

‎docs/InstancesApi.md‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.vrchat.cloud/api/1*
55
Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**get_instance**](InstancesApi.md#get_instance) | **GET** /instances/{worldId}:{instanceId} | Get Instance
8+
[**get_instance_by_short_name**](InstancesApi.md#get_instance_by_short_name) | **GET** /instances/s/{shortName} | Get Instance By Short Name
89
[**get_short_name**](InstancesApi.md#get_short_name) | **GET** /instances/{worldId}:{instanceId}/shortName | Get Instance Short Name
910
[**send_self_invite**](InstancesApi.md#send_self_invite) | **POST** /instances/{worldId}:{instanceId}/invite | Send Self Invite
1011

@@ -98,6 +99,94 @@ Name | Type | Description | Notes
9899

99100
[[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)
100101

102+
# **get_instance_by_short_name**
103+
> Instance get_instance_by_short_name(short_name)
104+
105+
Get Instance By Short Name
106+
107+
Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances.
108+
109+
### Example
110+
111+
* Api Key Authentication (apiKeyCookie):
112+
* Api Key Authentication (authCookie):
113+
114+
```python
115+
import time
116+
import vrchatapi
117+
from vrchatapi.api import instances_api
118+
from vrchatapi.model.error import Error
119+
from vrchatapi.model.instance import Instance
120+
from pprint import pprint
121+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
122+
# See configuration.py for a list of all supported configuration parameters.
123+
configuration = vrchatapi.Configuration(
124+
host = "https://api.vrchat.cloud/api/1"
125+
)
126+
127+
# The client must configure the authentication and authorization parameters
128+
# in accordance with the API server security policy.
129+
# Examples for each auth method are provided below, use the example that
130+
# satisfies your auth use case.
131+
132+
# Configure API key authorization: apiKeyCookie
133+
configuration.api_key['apiKeyCookie'] = 'YOUR_API_KEY'
134+
135+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
136+
# configuration.api_key_prefix['apiKeyCookie'] = 'Bearer'
137+
138+
# Configure API key authorization: authCookie
139+
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
140+
141+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
142+
# configuration.api_key_prefix['authCookie'] = 'Bearer'
143+
144+
# Enter a context with an instance of the API client
145+
with vrchatapi.ApiClient(configuration) as api_client:
146+
# Create an instance of the API class
147+
api_instance = instances_api.InstancesApi(api_client)
148+
short_name = "shortName_example" # str |
149+
150+
# example passing only required values which don't have defaults set
151+
try:
152+
# Get Instance By Short Name
153+
api_response = api_instance.get_instance_by_short_name(short_name)
154+
pprint(api_response)
155+
except vrchatapi.ApiException as e:
156+
print("Exception when calling InstancesApi->get_instance_by_short_name: %s\n" % e)
157+
```
158+
159+
160+
### Parameters
161+
162+
Name | Type | Description | Notes
163+
------------- | ------------- | ------------- | -------------
164+
**short_name** | **str**| |
165+
166+
### Return type
167+
168+
[**Instance**](Instance.md)
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**: application/json
178+
179+
180+
### HTTP response details
181+
182+
| Status code | Description | Response headers |
183+
|-------------|-------------|------------------|
184+
**200** | Returns a single Instance object. | - |
185+
**401** | Error response due to missing apiKey or auth cookie. | - |
186+
**404** | Error response due to non existant instance | - |
187+
188+
[[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)
189+
101190
# **get_short_name**
102191
> str get_short_name(world_id, instance_id)
103192

‎docs/InviteApi.md‎

Lines changed: 109 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**get_invite_message**](InviteApi.md#get_invite_message) | **GET** /message/{userId}/{messageType}/{slot} | Get Invite Message
88
[**get_invite_messages**](InviteApi.md#get_invite_messages) | **GET** /message/{userId}/{messageType} | List Invite Messages
9+
[**invite_myself_to**](InviteApi.md#invite_myself_to) | **POST** /invite/myself/to/{worldId}:{instanceId} | Invite Myself To Instance
910
[**invite_user**](InviteApi.md#invite_user) | **POST** /invite/{userId} | Invite User
1011
[**request_invite**](InviteApi.md#request_invite) | **POST** /requestInvite/{userId} | Request Invite
1112
[**reset_invite_message**](InviteApi.md#reset_invite_message) | **DELETE** /message/{userId}/{messageType}/{slot} | Reset Invite Message
@@ -196,8 +197,112 @@ Name | Type | Description | Notes
196197

197198
[[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)
198199

200+
# **invite_myself_to**
201+
> SentNotification invite_myself_to(world_id, instance_id)
202+
203+
Invite Myself To Instance
204+
205+
Sends self an invite to an instance
206+
207+
### Example
208+
209+
* Api Key Authentication (apiKeyCookie):
210+
* Api Key Authentication (authCookie):
211+
212+
```python
213+
import time
214+
import vrchatapi
215+
from vrchatapi.api import invite_api
216+
from vrchatapi.model.sent_notification import SentNotification
217+
from vrchatapi.model.invite_myself_to_request import InviteMyselfToRequest
218+
from vrchatapi.model.error import Error
219+
from pprint import pprint
220+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
221+
# See configuration.py for a list of all supported configuration parameters.
222+
configuration = vrchatapi.Configuration(
223+
host = "https://api.vrchat.cloud/api/1"
224+
)
225+
226+
# The client must configure the authentication and authorization parameters
227+
# in accordance with the API server security policy.
228+
# Examples for each auth method are provided below, use the example that
229+
# satisfies your auth use case.
230+
231+
# Configure API key authorization: apiKeyCookie
232+
configuration.api_key['apiKeyCookie'] = 'YOUR_API_KEY'
233+
234+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
235+
# configuration.api_key_prefix['apiKeyCookie'] = 'Bearer'
236+
237+
# Configure API key authorization: authCookie
238+
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
239+
240+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
241+
# configuration.api_key_prefix['authCookie'] = 'Bearer'
242+
243+
# Enter a context with an instance of the API client
244+
with vrchatapi.ApiClient(configuration) as api_client:
245+
# Create an instance of the API class
246+
api_instance = invite_api.InviteApi(api_client)
247+
world_id = "worldId_example" # str |
248+
instance_id = "instanceId_example" # str |
249+
invite_myself_to_request = InviteMyselfToRequest(
250+
short_name="short_name_example",
251+
) # InviteMyselfToRequest | (optional)
252+
253+
# example passing only required values which don't have defaults set
254+
try:
255+
# Invite Myself To Instance
256+
api_response = api_instance.invite_myself_to(world_id, instance_id)
257+
pprint(api_response)
258+
except vrchatapi.ApiException as e:
259+
print("Exception when calling InviteApi->invite_myself_to: %s\n" % e)
260+
261+
# example passing only required values which don't have defaults set
262+
# and optional values
263+
try:
264+
# Invite Myself To Instance
265+
api_response = api_instance.invite_myself_to(world_id, instance_id, invite_myself_to_request=invite_myself_to_request)
266+
pprint(api_response)
267+
except vrchatapi.ApiException as e:
268+
print("Exception when calling InviteApi->invite_myself_to: %s\n" % e)
269+
```
270+
271+
272+
### Parameters
273+
274+
Name | Type | Description | Notes
275+
------------- | ------------- | ------------- | -------------
276+
**world_id** | **str**| |
277+
**instance_id** | **str**| |
278+
**invite_myself_to_request** | [**InviteMyselfToRequest**](InviteMyselfToRequest.md)| | [optional]
279+
280+
### Return type
281+
282+
[**SentNotification**](SentNotification.md)
283+
284+
### Authorization
285+
286+
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
287+
288+
### HTTP request headers
289+
290+
- **Content-Type**: application/json
291+
- **Accept**: application/json
292+
293+
294+
### HTTP response details
295+
296+
| Status code | Description | Response headers |
297+
|-------------|-------------|------------------|
298+
**200** | Returns a single SentNotifcation object. | - |
299+
**401** | Error response due to missing apiKey or auth cookie. | - |
300+
**404** | Error response due to non existant instance | - |
301+
302+
[[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)
303+
199304
# **invite_user**
200-
> Notification invite_user(user_id)
305+
> SentNotification invite_user(user_id)
201306
202307
Invite User
203308

@@ -212,7 +317,7 @@ Sends an invite to a user. Returns the Notification of type `invite` that was se
212317
import time
213318
import vrchatapi
214319
from vrchatapi.api import invite_api
215-
from vrchatapi.model.notification import Notification
320+
from vrchatapi.model.sent_notification import SentNotification
216321
from vrchatapi.model.invite_request import InviteRequest
217322
from vrchatapi.model.error import Error
218323
from pprint import pprint
@@ -277,7 +382,7 @@ Name | Type | Description | Notes
277382

278383
### Return type
279384

280-
[**Notification**](Notification.md)
385+
[**SentNotification**](SentNotification.md)
281386

282387
### Authorization
283388

@@ -293,7 +398,7 @@ Name | Type | Description | Notes
293398

294399
| Status code | Description | Response headers |
295400
|-------------|-------------|------------------|
296-
**200** | Returns a single Notifcation object. | - |
401+
**200** | Returns a single SentNotifcation object. | - |
297402
**403** | Error response when trying to invite someome whom you are not friends with. | - |
298403

299404
[[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)

‎docs/InviteMyselfToRequest.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# InviteMyselfToRequest
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**short_name** | **str** | Short Name of the Instance; can be retrieved from the Get Instance Short Name endpoint. |
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/SentNotification.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# SentNotification
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**created_at** | **datetime** | |
8+
**id** | **str** | |
9+
**message** | **str** | |
10+
**reciever_user_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. |
11+
**sender_user_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. |
12+
**sender_username** | **str** | |
13+
**type** | [**NotificationType**](NotificationType.md) | |
14+
**details** | **str** | **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. | defaults to "{}"
15+
**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]
16+
17+
[[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+
19+

‎docs/User.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@ Name | Type | Description | Notes
1212
**developer_type** | [**DeveloperType**](DeveloperType.md) | |
1313
**display_name** | **str** | A users visual display name. This is what shows up in-game, and can different from their `username`. Changing display name is restricted to a cooldown period. |
1414
**friend_key** | **str** | |
15+
**friend_request_status** | **str** | |
1516
**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. |
1617
**is_friend** | **bool** | Either their `friendKey`, or empty string if you are not friends. Unknown usage. |
18+
**last_activity** | **str** | Either a date-time or empty string. |
1719
**last_login** | **str** | Either a date-time or empty string. |
1820
**last_platform** | **str** | This can be `standalonewindows` or `android`, but can also pretty much be any random Unity verison such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. |
1921
**profile_pic_override** | **str** | |
@@ -26,6 +28,10 @@ Name | Type | Description | Notes
2628
**allow_avatar_copying** | **bool** | | defaults to True
2729
**instance_id** | [**InstanceID**](InstanceID.md) | | [optional]
2830
**location** | [**WorldID**](WorldID.md) | | [optional]
31+
**note** | **str** | | [optional]
32+
**traveling_to_instance** | **str** | | [optional]
33+
**traveling_to_location** | **str** | | [optional]
34+
**traveling_to_world** | **str** | | [optional]
2935
**world_id** | [**WorldID**](WorldID.md) | | [optional]
3036
**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]
3137

‎docs/World.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**asset_url** | **str** | Empty if unauthenticated. |
8-
**asset_url_object** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | |
98
**author_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. |
109
**author_name** | **str** | |
1110
**capacity** | **int** | |
@@ -16,12 +15,10 @@ Name | Type | Description | Notes
1615
**labs_publication_date** | **str** | |
1716
**name** | **str** | |
1817
**namespace** | **str** | |
19-
**plugin_url_object** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | |
2018
**publication_date** | **str** | |
2119
**release_status** | [**ReleaseStatus**](ReleaseStatus.md) | |
2220
**tags** | [**[Tag]**](Tag.md) | |
2321
**thumbnail_image_url** | **str** | |
24-
**unity_package_url_object** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | |
2522
**unity_packages** | [**[UnityPackage]**](UnityPackage.md) | Empty if unauthenticated. |
2623
**updated_at** | **datetime** | |
2724
**featured** | **bool** | | defaults to False

‎setup.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
6565
Join the [Discord server](https://discord.gg/Ge2APMhPfD) to get in touch with us.
6666
67-
The version of the OpenAPI document: 1.7.2
67+
The version of the OpenAPI document: 1.7.3
6868
Contact: me@ariesclark.com
6969
Generated by: https://openapi-generator.tech
7070
"""
@@ -73,7 +73,7 @@
7373
from setuptools import setup, find_packages # noqa: H301
7474

7575
NAME = "vrchatapi"
76-
VERSION = "1.7.2"
76+
VERSION = "1.7.3"
7777
# To install the library, run the following
7878
#
7979
# python setup.py install

‎vrchatapi/__init__.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.7.2
7+
The version of the OpenAPI document: 1.7.3
88
Contact: me@ariesclark.com
99
Generated by: https://openapi-generator.tech
1010
"""

0 commit comments

Comments
 (0)