Skip to content

Commit 9151a90

Browse files
committed
Upgrade Python SDK to spec 1.12.0
1 parent c34bc5b commit 9151a90

File tree

162 files changed

+1548
-7286
lines changed

Some content is hidden

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

162 files changed

+1548
-7286
lines changed

docs/APIConfig.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ Name | Type | Description | Notes
99
**voice_enable_receiver_limiting** | **bool** | Unknown, probably voice optimization testing | [default to True]
1010
**address** | **str** | VRChat's office address |
1111
**announcements** | [**list[APIConfigAnnouncement]**](APIConfigAnnouncement.md) | Public Announcements |
12-
**api_key** | **str** | apiKey to be used for all other requests |
1312
**app_name** | **str** | Game name | [default to 'VrChat']
1413
**build_version_tag** | **str** | Build tag of the API server |
1514
**client_api_key** | **str** | apiKey to be used for all other requests |

docs/APIConfigDownloadURLList.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Name | Type | Description | Notes
88
**sdk2** | **str** | Download link for legacy SDK2 |
99
**sdk3_avatars** | **str** | Download link for SDK3 for Avatars |
1010
**sdk3_worlds** | **str** | Download link for SDK3 for Worlds |
11+
**vcc** | **str** | Download link for the Creator Companion |
12+
**bootstrap** | **str** | Download link for ??? |
1113

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

docs/AuthenticationApi.md

Lines changed: 11 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ Checks if a user by a given `username`, `displayName` or `email` exist. This is
2323

2424
### Example
2525

26-
* Api Key Authentication (apiKeyCookie):
2726
```python
2827
from __future__ import print_function
2928
import time
@@ -36,19 +35,9 @@ configuration = vrchatapi.Configuration(
3635
host = "https://api.vrchat.cloud/api/1"
3736
)
3837

39-
# The client must configure the authentication and authorization parameters
40-
# in accordance with the API server security policy.
41-
# Examples for each auth method are provided below, use the example that
42-
# satisfies your auth use case.
43-
44-
# Configure API key authorization: apiKeyCookie
45-
configuration.api_key['apiKeyCookie'] = 'YOUR_API_KEY'
46-
47-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
48-
# configuration.api_key_prefix['apiKeyCookie'] = 'Bearer'
4938

5039
# Enter a context with an instance of the API client
51-
with vrchatapi.ApiClient(configuration) as api_client:
40+
with vrchatapi.ApiClient() as api_client:
5241
# Create an instance of the API class
5342
api_instance = vrchatapi.AuthenticationApi(api_client)
5443
email = 'email_example' # str | Filter by email. (optional)
@@ -79,7 +68,7 @@ Name | Type | Description | Notes
7968

8069
### Authorization
8170

82-
[apiKeyCookie](../README.md#apiKeyCookie)
71+
No authorization required
8372

8473
### HTTP request headers
8574

@@ -103,50 +92,6 @@ Deletes the account with given ID. Normal users only have permission to delete t
10392

10493
### Example
10594

106-
* Api Key Authentication (apiKeyCookie):
107-
```python
108-
from __future__ import print_function
109-
import time
110-
import vrchatapi
111-
from vrchatapi.rest import ApiException
112-
from pprint import pprint
113-
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
114-
# See configuration.py for a list of all supported configuration parameters.
115-
configuration = vrchatapi.Configuration(
116-
host = "https://api.vrchat.cloud/api/1"
117-
)
118-
119-
# The client must configure the authentication and authorization parameters
120-
# in accordance with the API server security policy.
121-
# Examples for each auth method are provided below, use the example that
122-
# satisfies your auth use case.
123-
124-
# Configure API key authorization: apiKeyCookie
125-
configuration.api_key['apiKeyCookie'] = 'YOUR_API_KEY'
126-
127-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
128-
# configuration.api_key_prefix['apiKeyCookie'] = 'Bearer'
129-
130-
# Configure API key authorization: authCookie
131-
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
132-
133-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
134-
# configuration.api_key_prefix['authCookie'] = 'Bearer'
135-
136-
# Enter a context with an instance of the API client
137-
with vrchatapi.ApiClient(configuration) as api_client:
138-
# Create an instance of the API class
139-
api_instance = vrchatapi.AuthenticationApi(api_client)
140-
user_id = 'user_id_example' # str | Must be a valid user ID.
141-
142-
try:
143-
# Delete User
144-
api_response = api_instance.delete_user(user_id)
145-
pprint(api_response)
146-
except ApiException as e:
147-
print("Exception when calling AuthenticationApi->delete_user: %s\n" % e)
148-
```
149-
15095
* Api Key Authentication (authCookie):
15196
```python
15297
from __future__ import print_function
@@ -165,12 +110,6 @@ configuration = vrchatapi.Configuration(
165110
# Examples for each auth method are provided below, use the example that
166111
# satisfies your auth use case.
167112

168-
# Configure API key authorization: apiKeyCookie
169-
configuration.api_key['apiKeyCookie'] = 'YOUR_API_KEY'
170-
171-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
172-
# configuration.api_key_prefix['apiKeyCookie'] = 'Bearer'
173-
174113
# Configure API key authorization: authCookie
175114
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
176115

@@ -203,7 +142,7 @@ Name | Type | Description | Notes
203142

204143
### Authorization
205144

206-
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
145+
[authCookie](../README.md#authCookie)
207146

208147
### HTTP request headers
209148

@@ -214,7 +153,7 @@ Name | Type | Description | Notes
214153
| Status code | Description | Response headers |
215154
|-------------|-------------|------------------|
216155
**200** | OK | - |
217-
**401** | Error response due to missing apiKey or auth cookie. | - |
156+
**401** | Error response due to missing auth cookie. | - |
218157

219158
[[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)
220159

@@ -393,8 +332,8 @@ This endpoint does not need any parameter.
393332
### HTTP response details
394333
| Status code | Description | Response headers |
395334
|-------------|-------------|------------------|
396-
**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> |
397-
**401** | Error response due to missing apiKey or auth cookie. | - |
335+
**200** | OK | * Set-Cookie - Successful authentication returns an &#x60;auth&#x60; cookie. <br> |
336+
**401** | Error response due to missing auth cookie. | - |
398337

399338
[[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)
400339

@@ -464,7 +403,7 @@ This endpoint does not need any parameter.
464403
| Status code | Description | Response headers |
465404
|-------------|-------------|------------------|
466405
**200** | OK | * Set-Cookie - Clears the &#x60;auth&#x60; cookie. <br> * \0Set-Cookie - Clears the &#x60;age&#x60; cookie. <br> * \0\0Set-Cookie - Clears the &#x60;tos&#x60; cookie. <br> |
467-
**401** | Error response due to missing apiKey or auth cookie. | - |
406+
**401** | Error response due to missing auth cookie. | - |
468407

469408
[[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)
470409

@@ -538,7 +477,7 @@ Name | Type | Description | Notes
538477
| Status code | Description | Response headers |
539478
|-------------|-------------|------------------|
540479
**200** | OK | * Set-Cookie - Provides a &#x60;twoFactorAuth&#x60; cookie, which can be used to bypasses the 2FA requirement for future logins on the same device. <br> |
541-
**401** | Error response due to missing apiKey or auth cookie. | - |
480+
**401** | Error response due to missing auth cookie. | - |
542481

543482
[[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)
544483

@@ -612,7 +551,7 @@ Name | Type | Description | Notes
612551
| Status code | Description | Response headers |
613552
|-------------|-------------|------------------|
614553
**200** | OK | * Set-Cookie - Provides a &#x60;twoFactorAuth&#x60; cookie, which can be used to bypasses the 2FA requirement for future logins on the same device. <br> |
615-
**401** | Error response due to missing apiKey or auth cookie. | - |
554+
**401** | Error response due to missing auth cookie. | - |
616555

617556
[[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)
618557

@@ -682,7 +621,7 @@ This endpoint does not need any parameter.
682621
| Status code | Description | Response headers |
683622
|-------------|-------------|------------------|
684623
**200** | Returns wether a provided auth token is valid or not. | - |
685-
**401** | Error response due to missing apiKey or auth cookie. | - |
624+
**401** | Error response due to missing auth cookie. | - |
686625

687626
[[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)
688627

@@ -756,7 +695,7 @@ Name | Type | Description | Notes
756695
| Status code | Description | Response headers |
757696
|-------------|-------------|------------------|
758697
**200** | OK | * Set-Cookie - Provides a &#x60;twoFactorAuth&#x60; cookie, which can be used to bypasses the 2FA requirement for future logins on the same device. <br> |
759-
**401** | Error response due to missing apiKey or auth cookie. | - |
698+
**401** | Error response due to missing auth cookie. | - |
760699

761700
[[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)
762701

0 commit comments

Comments
 (0)