Skip to content

Commit 2e7b077

Browse files
committed
Upgrade Python SDK to spec
1 parent b34aa7a commit 2e7b077

12,081 files changed

Lines changed: 476057 additions & 121 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: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ docs/Tag.md
8383
docs/UnityPackage.md
8484
docs/UnityPackageID.md
8585
docs/User.md
86+
docs/UserExists.md
8687
docs/UserState.md
8788
docs/UserStatus.md
8889
docs/UsersApi.md
@@ -187,6 +188,7 @@ vrchatapi/model/tag.py
187188
vrchatapi/model/unity_package.py
188189
vrchatapi/model/unity_package_id.py
189190
vrchatapi/model/user.py
191+
vrchatapi/model/user_exists.py
190192
vrchatapi/model/user_state.py
191193
vrchatapi/model/user_status.py
192194
vrchatapi/model/world.py

β€Ždocs/AuthenticationApi.mdβ€Ž

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

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7+
[**check_user_exists**](AuthenticationApi.md#check_user_exists) | **GET** /auth/exists | Check User Exists
78
[**delete_user**](AuthenticationApi.md#delete_user) | **PUT** /user/{userId}/delete | Delete User
89
[**get_current_user**](AuthenticationApi.md#get_current_user) | **GET** /auth/user | Login and/or Get Current User Info
910
[**logout**](AuthenticationApi.md#logout) | **PUT** /logout | Logout
@@ -12,6 +13,91 @@ Method | HTTP request | Description
1213
[**verify_recovery_code**](AuthenticationApi.md#verify_recovery_code) | **POST** /auth/twofactorauth/otp/verify | Verify 2FA code with Recovery code
1314

1415

16+
# **check_user_exists**
17+
> UserExists check_user_exists()
18+
19+
Check User Exists
20+
21+
Checks if a user by a given `username`, `displayName` or `email` exist. This is used during registration to check if a username has already been taken, during change of displayName to check if a displayName is available, and during change of email to check if the email is already used. In the later two cases the `excludeUserId` is used to exclude oneself, otherwise the result would always be true. It is **REQUIRED** to include **AT LEAST** `username`, `displayName` **or** `email` query parameter. Although they can be combined - in addition with `excludeUserId` (generally to exclude yourself) - to further fine-tune the search.
22+
23+
### Example
24+
25+
* Api Key Authentication (apiKeyCookie):
26+
```python
27+
import time
28+
import vrchatapi
29+
from vrchatapi.api import authentication_api
30+
from vrchatapi.model.error import Error
31+
from vrchatapi.model.user_exists import UserExists
32+
from pprint import pprint
33+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
34+
# See configuration.py for a list of all supported configuration parameters.
35+
configuration = vrchatapi.Configuration(
36+
host = "https://api.vrchat.cloud/api/1"
37+
)
38+
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'
49+
50+
# Enter a context with an instance of the API client
51+
with vrchatapi.ApiClient(configuration) as api_client:
52+
# Create an instance of the API class
53+
api_instance = authentication_api.AuthenticationApi(api_client)
54+
email = "email_example" # str | Filter by email. (optional)
55+
display_name = "displayName_example" # str | Filter by displayName. (optional)
56+
user_id = "userId_example" # str | Filter by UserID. (optional)
57+
exclude_user_id = "excludeUserId_example" # str | Exclude by UserID. (optional)
58+
59+
# example passing only required values which don't have defaults set
60+
# and optional values
61+
try:
62+
# Check User Exists
63+
api_response = api_instance.check_user_exists(email=email, display_name=display_name, user_id=user_id, exclude_user_id=exclude_user_id)
64+
pprint(api_response)
65+
except vrchatapi.ApiException as e:
66+
print("Exception when calling AuthenticationApi->check_user_exists: %s\n" % e)
67+
```
68+
69+
70+
### Parameters
71+
72+
Name | Type | Description | Notes
73+
------------- | ------------- | ------------- | -------------
74+
**email** | **str**| Filter by email. | [optional]
75+
**display_name** | **str**| Filter by displayName. | [optional]
76+
**user_id** | **str**| Filter by UserID. | [optional]
77+
**exclude_user_id** | **str**| Exclude by UserID. | [optional]
78+
79+
### Return type
80+
81+
[**UserExists**](UserExists.md)
82+
83+
### Authorization
84+
85+
[apiKeyCookie](../README.md#apiKeyCookie)
86+
87+
### HTTP request headers
88+
89+
- **Content-Type**: Not defined
90+
- **Accept**: application/json
91+
92+
93+
### HTTP response details
94+
| Status code | Description | Response headers |
95+
|-------------|-------------|------------------|
96+
**200** | Returns a response if a user exists or not. | - |
97+
**400** | Error response when missing at least 1 of the required parameters. | - |
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+
15101
# **delete_user**
16102
> CurrentUser delete_user(user_id)
17103

β€Ždocs/AvatarsApi.mdβ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,7 @@ with vrchatapi.ApiClient(configuration) as api_client:
443443
featured = "featured_example" # str | Filters on featured results. (optional)
444444
sort = "popularity" # str | (optional) if omitted the server will use the default value of "popularity"
445445
user = "me" # str | Set to `me` for searching own avatars. (optional) if omitted the server will use the default value of "me"
446-
user_id = "userId_example" # str | Filter by author UserID (optional)
446+
user_id = "userId_example" # str | Filter by UserID. (optional)
447447
n = 60 # int | The number of objects to return. (optional) if omitted the server will use the default value of 60
448448
order = "descending" # str | (optional) if omitted the server will use the default value of "descending"
449449
offset = 0 # int | A zero-based offset from the default object sorting from where search results start. (optional)
@@ -472,7 +472,7 @@ Name | Type | Description | Notes
472472
**featured** | **str**| Filters on featured results. | [optional]
473473
**sort** | **str**| | [optional] if omitted the server will use the default value of "popularity"
474474
**user** | **str**| Set to `me` for searching own avatars. | [optional] if omitted the server will use the default value of "me"
475-
**user_id** | **str**| Filter by author UserID | [optional]
475+
**user_id** | **str**| Filter by UserID. | [optional]
476476
**n** | **int**| The number of objects to return. | [optional] if omitted the server will use the default value of 60
477477
**order** | **str**| | [optional] if omitted the server will use the default value of "descending"
478478
**offset** | **int**| A zero-based offset from the default object sorting from where search results start. | [optional]

β€Ždocs/User.mdβ€Ž

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ Name | Type | Description | Notes
1414
**status_description** | **str** | |
1515
**current_avatar_image_url** | **str** | |
1616
**current_avatar_thumbnail_image_url** | **str** | |
17-
**fallback_avatar** | [**AvatarID**](AvatarID.md) | |
1817
**state** | [**UserState**](UserState.md) | |
1918
**tags** | [**[Tag]**](Tag.md) | |
2019
**developer_type** | [**DeveloperType**](DeveloperType.md) | |

β€Ždocs/UserExists.mdβ€Ž

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# UserExists
2+
3+
Status object representing if a queried user by username or userId exists or not. This model is primarily used by the `/auth/exists` endpoint, which in turn is used during registration. Please see the documentation on that endpoint for more information on usage.
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**user_exists** | **bool** | Status if a user exist with that username or userId. | defaults to False
9+
**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]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

β€Ždocs/WorldsApi.mdβ€Ž

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -529,6 +529,7 @@ Get information about a specific World.
529529

530530
### Example
531531

532+
* Api Key Authentication (apiKeyCookie):
532533
```python
533534
import time
534535
import vrchatapi
@@ -542,9 +543,19 @@ configuration = vrchatapi.Configuration(
542543
host = "https://api.vrchat.cloud/api/1"
543544
)
544545

546+
# The client must configure the authentication and authorization parameters
547+
# in accordance with the API server security policy.
548+
# Examples for each auth method are provided below, use the example that
549+
# satisfies your auth use case.
550+
551+
# Configure API key authorization: apiKeyCookie
552+
configuration.api_key['apiKeyCookie'] = 'YOUR_API_KEY'
553+
554+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
555+
# configuration.api_key_prefix['apiKeyCookie'] = 'Bearer'
545556

546557
# Enter a context with an instance of the API client
547-
with vrchatapi.ApiClient() as api_client:
558+
with vrchatapi.ApiClient(configuration) as api_client:
548559
# Create an instance of the API class
549560
api_instance = worlds_api.WorldsApi(api_client)
550561
world_id = "worldId_example" # str |
@@ -571,7 +582,7 @@ Name | Type | Description | Notes
571582

572583
### Authorization
573584

574-
No authorization required
585+
[apiKeyCookie](../README.md#apiKeyCookie)
575586

576587
### HTTP request headers
577588

@@ -977,7 +988,7 @@ with vrchatapi.ApiClient(configuration) as api_client:
977988
featured = "featured_example" # str | Filters on featured results. (optional)
978989
sort = "popularity" # str | (optional) if omitted the server will use the default value of "popularity"
979990
user = "me" # str | Set to `me` for searching own worlds. (optional) if omitted the server will use the default value of "me"
980-
user_id = "userId_example" # str | Filter by author UserID (optional)
991+
user_id = "userId_example" # str | Filter by UserID. (optional)
981992
n = 60 # int | The number of objects to return. (optional) if omitted the server will use the default value of 60
982993
order = "descending" # str | (optional) if omitted the server will use the default value of "descending"
983994
offset = 0 # int | A zero-based offset from the default object sorting from where search results start. (optional)
@@ -1007,7 +1018,7 @@ Name | Type | Description | Notes
10071018
**featured** | **str**| Filters on featured results. | [optional]
10081019
**sort** | **str**| | [optional] if omitted the server will use the default value of "popularity"
10091020
**user** | **str**| Set to `me` for searching own worlds. | [optional] if omitted the server will use the default value of "me"
1010-
**user_id** | **str**| Filter by author UserID | [optional]
1021+
**user_id** | **str**| Filter by UserID. | [optional]
10111022
**n** | **int**| The number of objects to return. | [optional] if omitted the server will use the default value of 60
10121023
**order** | **str**| | [optional] if omitted the server will use the default value of "descending"
10131024
**offset** | **int**| A zero-based offset from the default object sorting from where search results start. | [optional]

β€Žnode_modules/.bin/concurrentlyβ€Ž

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€Žnode_modules/.bin/openapi-generator-cliβ€Ž

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€Žnode_modules/.bin/opencollectiveβ€Ž

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€Žnode_modules/.bin/semverβ€Ž

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
Β (0)