Skip to content

Commit d89599b

Browse files
committed
Upgrade Python SDK to spec 1.3.1
1 parent 2ca4598 commit d89599b

105 files changed

Lines changed: 1026 additions & 118 deletions

File tree

Some content is hidden

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

‎.openapi-generator/FILES‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,14 @@ docs/InlineResponse2005.md
5252
docs/InlineResponse2006.md
5353
docs/InlineResponse400.md
5454
docs/Instance.md
55+
docs/InstanceID.md
5556
docs/InstancePlatforms.md
5657
docs/InviteApi.md
5758
docs/InviteMessage.md
5859
docs/InviteMessageID.md
5960
docs/InviteMessageType.md
61+
docs/InviteRequest.md
62+
docs/InviteResponse.md
6063
docs/LimitedUnityPackage.md
6164
docs/LimitedUser.md
6265
docs/LimitedWorld.md
@@ -158,10 +161,13 @@ vrchatapi/model/inline_response2005.py
158161
vrchatapi/model/inline_response2006.py
159162
vrchatapi/model/inline_response400.py
160163
vrchatapi/model/instance.py
164+
vrchatapi/model/instance_id.py
161165
vrchatapi/model/instance_platforms.py
162166
vrchatapi/model/invite_message.py
163167
vrchatapi/model/invite_message_id.py
164168
vrchatapi/model/invite_message_type.py
169+
vrchatapi/model/invite_request.py
170+
vrchatapi/model/invite_response.py
165171
vrchatapi/model/limited_unity_package.py
166172
vrchatapi/model/limited_user.py
167173
vrchatapi/model/limited_world.py

‎docs/AuthenticationApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Name | Type | Description | Notes
102102
103103
Login and/or Get Current User Info
104104

105-
Login and/or Get user data from your VRChat account. If `Authorization` header is present then a new login session will be generated, and a new `auth` cookie is returned. **WARNING: Session Limit:** Each authentication with login credentials counts as a separate session, out of which you have a limited amount. Make sure to save and reuse the `auth` cookie whenever you can, and avoid sending the Authorization header unless strictly neccesary. While the exact number of simultaneous open sessions is secret, expect to **very fast** run into the rate-limit and be temporarily blocked from making new sessions until the old ones expire.
105+
This endpoint does the following two operations: 1) Checks if you are already logged in by looking for a valid `auth` cookie. If you are have a valid auth cookie then no additional auth-related actions are taken. If you are **not** logged in then it will log you in with the `Authorization` header and set the `auth` cookie. The `auth` cookie will only be sent once. 2) If logged in, this function will also return the CurrentUser object containing detailed information about the currently logged in user. **WARNING: Session Limit:** Each authentication with login credentials counts as a separate session, out of which you have a limited amount. Make sure to save and reuse the `auth` cookie if you are often restarting the program. The provided API libraries automatically save cookies during runtime, but does not persist during restart. While it can be fine to use username/password during development, expect in production to very fast run into the rate-limit and be temporarily blocked from making new sessions until older ones expire. The exact number of simultaneous sessions is unknown/undisclosed.
106106

107107
### Example
108108

@@ -180,7 +180,7 @@ This endpoint does not need any parameter.
180180
### HTTP response details
181181
| Status code | Description | Response headers |
182182
|-------------|-------------|------------------|
183-
**200** | OK | * Set-Cookie - Authenticating returns an &#x60;auth&#x60; cookie. <br> * \0Set-Cookie - Authenticating also sets the &#x60;apiKey&#x60; if not already set. <br> |
183+
**200** | OK | * Set-Cookie - Successful authentication returns an &#x60;auth&#x60; cookie. <br> * \0Set-Cookie - This endpoint **always** sets the &#x60;apiKey&#x60; irrespective if it is already set. <br> |
184184
**401** | Error response due to missing apiKey or auth cookie. | - |
185185

186186
[[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/CurrentUser.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ Name | Type | Description | Notes
2626
**friend_group_names** | **[str]** | Always empty array. |
2727
**current_avatar_image_url** | **str** | |
2828
**current_avatar_thumbnail_image_url** | **str** | |
29-
**fallback_avatar** | [**AvatarID**](AvatarID.md) | |
3029
**current_avatar** | [**AvatarID**](AvatarID.md) | |
3130
**current_avatar_asset_url** | **str** | |
3231
**accepted_tos_version** | **float** | |
@@ -46,6 +45,7 @@ Name | Type | Description | Notes
4645
**date_joined** | **date** | | [readonly]
4746
**friend_key** | **str** | |
4847
**is_friend** | **bool** | | defaults to False
48+
**fallback_avatar** | [**AvatarID**](AvatarID.md) | | [optional]
4949
**account_deletion_date** | **date, none_type** | | [optional]
5050
**online_friends** | **[str]** | | [optional]
5151
**active_friends** | **[str]** | | [optional]

‎docs/Instance.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**capacity** | **float** | |
88
**client_number** | **str** | |
9-
**id** | **str** | |
9+
**id** | [**InstanceID**](InstanceID.md) | |
1010
**instance_id** | **str** | |
1111
**location** | **str** | |
1212
**n_users** | **float** | |

‎docs/InstanceID.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# InstanceID
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**value** | **str** | |
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/InviteApi.md‎

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,7 @@ import time
203203
import vrchatapi
204204
from vrchatapi.api import invite_api
205205
from vrchatapi.model.notification import Notification
206+
from vrchatapi.model.invite_request import InviteRequest
206207
from vrchatapi.model.inline_response400 import InlineResponse400
207208
from pprint import pprint
208209
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
@@ -233,6 +234,9 @@ with vrchatapi.ApiClient(configuration) as api_client:
233234
# Create an instance of the API class
234235
api_instance = invite_api.InviteApi(api_client)
235236
user_id = "userId_example" # str |
237+
invite_request = InviteRequest(
238+
instance_id=InstanceID("wrld_ba913a96-fac4-4048-a062-9aa5db092812:123456"),
239+
) # InviteRequest | Instance ID when inviting a user. (optional)
236240

237241
# example passing only required values which don't have defaults set
238242
try:
@@ -241,6 +245,15 @@ with vrchatapi.ApiClient(configuration) as api_client:
241245
pprint(api_response)
242246
except vrchatapi.ApiException as e:
243247
print("Exception when calling InviteApi->invite_user: %s\n" % e)
248+
249+
# example passing only required values which don't have defaults set
250+
# and optional values
251+
try:
252+
# Invite User
253+
api_response = api_instance.invite_user(user_id, invite_request=invite_request)
254+
pprint(api_response)
255+
except vrchatapi.ApiException as e:
256+
print("Exception when calling InviteApi->invite_user: %s\n" % e)
244257
```
245258

246259

@@ -249,6 +262,7 @@ with vrchatapi.ApiClient(configuration) as api_client:
249262
Name | Type | Description | Notes
250263
------------- | ------------- | ------------- | -------------
251264
**user_id** | **str**| |
265+
**invite_request** | [**InviteRequest**](InviteRequest.md)| Instance ID when inviting a user. | [optional]
252266

253267
### Return type
254268

@@ -260,7 +274,7 @@ Name | Type | Description | Notes
260274

261275
### HTTP request headers
262276

263-
- **Content-Type**: Not defined
277+
- **Content-Type**: application/json
264278
- **Accept**: application/json
265279

266280

@@ -463,6 +477,7 @@ import vrchatapi
463477
from vrchatapi.api import invite_api
464478
from vrchatapi.model.notification import Notification
465479
from vrchatapi.model.inline_response400 import InlineResponse400
480+
from vrchatapi.model.invite_response import InviteResponse
466481
from pprint import pprint
467482
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
468483
# See configuration.py for a list of all supported configuration parameters.
@@ -492,6 +507,9 @@ with vrchatapi.ApiClient(configuration) as api_client:
492507
# Create an instance of the API class
493508
api_instance = invite_api.InviteApi(api_client)
494509
notification_id = "notificationId_example" # str |
510+
invite_response = InviteResponse(
511+
response_slot=0,
512+
) # InviteResponse | Instance ID when inviting a user. (optional)
495513

496514
# example passing only required values which don't have defaults set
497515
try:
@@ -500,6 +518,15 @@ with vrchatapi.ApiClient(configuration) as api_client:
500518
pprint(api_response)
501519
except vrchatapi.ApiException as e:
502520
print("Exception when calling InviteApi->respond_invite: %s\n" % e)
521+
522+
# example passing only required values which don't have defaults set
523+
# and optional values
524+
try:
525+
# Respond Invite
526+
api_response = api_instance.respond_invite(notification_id, invite_response=invite_response)
527+
pprint(api_response)
528+
except vrchatapi.ApiException as e:
529+
print("Exception when calling InviteApi->respond_invite: %s\n" % e)
503530
```
504531

505532

@@ -508,6 +535,7 @@ with vrchatapi.ApiClient(configuration) as api_client:
508535
Name | Type | Description | Notes
509536
------------- | ------------- | ------------- | -------------
510537
**notification_id** | **str**| |
538+
**invite_response** | [**InviteResponse**](InviteResponse.md)| Instance ID when inviting a user. | [optional]
511539

512540
### Return type
513541

@@ -519,7 +547,7 @@ Name | Type | Description | Notes
519547

520548
### HTTP request headers
521549

522-
- **Content-Type**: Not defined
550+
- **Content-Type**: application/json
523551
- **Accept**: application/json
524552

525553

‎docs/InviteRequest.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# InviteRequest
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**instance_id** | [**InstanceID**](InstanceID.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/InviteResponse.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# InviteResponse
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**response_slot** | **int** | |
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+

‎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.3.0
67+
The version of the OpenAPI document: 1.3.1
6868
Contact: me@ruby.js.org
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.3.0"
76+
VERSION = "1.3.1"
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.3.0
7+
The version of the OpenAPI document: 1.3.1
88
Contact: me@ruby.js.org
99
Generated by: https://openapi-generator.tech
1010
"""

0 commit comments

Comments
 (0)