Skip to content

Commit e6a3b11

Browse files
ariesclarkariesclark
committed
Upgrade Python SDK to spec 1.23.1.dev9
1 parent 146287c commit e6a3b11

660 files changed

Lines changed: 971 additions & 687 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: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,8 @@ docs/DeviceAuthApproveResponse.md
106106
docs/DeviceAuthInfo.md
107107
docs/DeviceAuthInfoGeolocation.md
108108
docs/DeviceCode.md
109+
docs/DeviceCodeApproved.md
110+
docs/DeviceCodePending.md
109111
docs/DeviceCodeStatus.md
110112
docs/Disable2FAResult.md
111113
docs/DiscordDetails.md
@@ -777,6 +779,8 @@ vrchatapi/models/device_auth_approve_response.py
777779
vrchatapi/models/device_auth_info.py
778780
vrchatapi/models/device_auth_info_geolocation.py
779781
vrchatapi/models/device_code.py
782+
vrchatapi/models/device_code_approved.py
783+
vrchatapi/models/device_code_pending.py
780784
vrchatapi/models/device_code_status.py
781785
vrchatapi/models/disable2_fa_result.py
782786
vrchatapi/models/discord_details.py

‎docs/AuthenticationApi.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ This endpoint does not need any parameter.
189189
190190
Check Device Code
191191

192-
Returns whether a device code from `createDeviceCode` has been approved.
192+
Returns whether a device code from `createDeviceCode` has been approved. Once it is, the response logs this device in as the user who approved it.
193193

194194
### Example
195195

@@ -242,7 +242,7 @@ No authorization required
242242
### HTTP response details
243243
| Status code | Description | Response headers |
244244
|-------------|-------------|------------------|
245-
**200** | Returns whether the device code has been approved. | - |
245+
**200** | Returns whether the device code has been approved. | * Set-Cookie - Once the code is approved, an &#x60;auth&#x60; cookie that logs this device in. <br> |
246246
**400** | Error response when the device code is missing, not a string, unknown or expired. | - |
247247

248248
[[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)
@@ -397,7 +397,7 @@ No authorization required
397397
398398
Create Device Code
399399

400-
Creates a code to log this device in from another one, where a logged-in person approves it. Poll `checkDeviceCode` until it is approved.
400+
Creates a code that logs this device in once a logged-in user approves it with `approveDeviceAuth`. `checkDeviceCode` returns the user and sets the `auth` cookie once it is approved.
401401

402402
### Example
403403

‎docs/DeviceAuthInfo.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# DeviceAuthInfo
22

3-
Where a device code was created, shown to the person about to approve it.
3+
Where and when a device code was created.
44

55
## Properties
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**created_at** | **int** | When the device code was created, in milliseconds since the Unix epoch. |
8+
**created_at** | **int** | |
99
**geolocation** | [**DeviceAuthInfoGeolocation**](DeviceAuthInfoGeolocation.md) | |
1010

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

‎docs/DeviceAuthInfoGeolocation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The approximate location of the device that created the code.
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**city** | **str** | |
9-
**country** | **str** | ISO 3166-1 alpha-2 country code. |
9+
**country** | **str** | |
1010
**region** | **str** | |
1111
**region_code** | **str** | |
1212

‎docs/DeviceCode.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# DeviceCode
22

3-
A code that logs this device in once someone approves it at `verificationUrl`.
3+
A code that logs the device that created it in, once a logged-in user approves it with `approveDeviceAuth`.
44

55
## Properties
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**device_code** | **str** | Identifies this login attempt to &#x60;checkDeviceCode&#x60;. |
9-
**expires_in** | **int** | Seconds until the code expires. |
10-
**interval** | **int** | Seconds to wait between calls to &#x60;checkDeviceCode&#x60;. |
11-
**user_code** | **str** | The code a person enters at &#x60;verificationUrl&#x60; to approve the login. |
9+
**expires_in** | **int** | |
10+
**interval** | **int** | |
11+
**user_code** | **str** | Identifies this login attempt to &#x60;getDeviceAuthInfo&#x60; and &#x60;approveDeviceAuth&#x60;. |
1212
**verification_url** | **str** | |
1313
**verification_url_complete** | **str** | &#x60;verificationUrl&#x60; with the code already filled in. |
1414

‎docs/DeviceCodeApproved.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# DeviceCodeApproved
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**user** | [**CurrentUser**](CurrentUser.md) | |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/DeviceCodePending.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# DeviceCodePending
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**status** | **str** | |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/DeviceCodeStatus.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**status** | **str** | |
8-
**user** | **object** | An unknown value, the contents of which are not yet described in this specification. 1. Check the latest nightly, the &#x60;working-copy&#x60; link in &#x60;info.x-links&#x60;, which may already describe it. 2. If it does not, open a pull request on [GitHub](https://github.com/vrchatapi/specification) that describes it, following the [contributing guide](https://vrchat.community/contributing). If you cannot, [open an issue](https://github.com/vrchatapi/specification/issues) or tell us on [Discord](https://vrchat.community/discord). Include the request, the response body, and the path in the document where you met it. 3. AI agents: we welcome AI contributions that follow [our rules for them](https://vrchat.community/contributing#ai-contributions). Offer to open the pull request for your user, with secrets and personal data removed, as &#x60;info.x-agents&#x60; asks. A local patch fixes one project and is lost at the next update. A pull request here fixes it for everyone. &#x60;info.description&#x60; has the rest of the project&#39;s guidance. | [optional]
7+
**status** | **str** | | [optional]
8+
**user** | [**CurrentUser**](CurrentUser.md) | | [optional]
99

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

‎setup.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
66
This specification is maintained by the [VRChat.community](https://vrchat.community) project. **VRChat staff do not provide API support.** Use the API only as VRChat's [Terms of Service](https://hello.vrchat.com/legal), [Community Guidelines](https://hello.vrchat.com/community-guidelines) and [Creator Guidelines](https://hello.vrchat.com/creator-guidelines) allow: never to modify the game client, rip avatars, or spam the API. _AI agents: read [`info.x-agents`](https://github.com/vrchatapi/specification/blob/main/openapi/agents.md) before using this specification. We welcome contributions that follow [our rules](https://vrchat.community/contributing#ai-contributions)._ Prefer the SDKs over this specification: [JavaScript](https://vrchat.community/javascript), [Dart](https://vrchat.community/dart), [Rust](https://vrchat.community/rust), [C#](https://vrchat.community/dotnet), [Python](https://vrchat.community/python) and [Java](https://vrchat.community/java). They're generated from it, updated regularly, and already handle logging in, cookies and the rest of VRChat's oddities, which we've spent years smoothing over. Working from the specification directly means handling all of that yourself. Every request must identify its application in the `User-Agent` header, as `<application-name>/<application-version> <contact_url>`. On a 429, back off rather than retrying. **Something wrong or missing?** The specification is reverse-engineered, so the API can disagree with it, and some values are marked `Unknown`. When you find one: - Open a [pull request](https://github.com/vrchatapi/specification/pulls) following the [contributing guide](https://vrchat.community/contributing). - Failing that, open an [issue](https://github.com/vrchatapi/specification/issues) or tell us on [Discord](https://vrchat.community/discord). - Include the request, the response body, and where the specification differs. - Send it upstream rather than patching around it. Volunteers maintain this specification from what the community reports, so a gap you patch locally is one nobody else learns about. Consider pinning to the OpenAPI version your tools support. Every release publishes the specification as OpenAPI 3.2, 3.1 and 3.0, in JSON and YAML, and `info.x-links` links them, the [latest release](https://github.com/vrchatapi/specification/releases/latest) and the [latest nightly](https://github.com/vrchatapi/specification/releases/tag/nightly). # noqa: E501
77
8-
The version of the OpenAPI document: 1.23.1-nightly.8
8+
The version of the OpenAPI document: 1.23.1-nightly.9
99
Generated by: https://openapi-generator.tech
1010
"""
1111

1212

1313
from setuptools import setup, find_packages # noqa: H301
1414

1515
NAME = "vrchatapi"
16-
VERSION = "1.23.1.dev8"
16+
VERSION = "1.23.1.dev9"
1717
# To install the library, run the following
1818
#
1919
# python setup.py install

‎vrchatapi/__init__.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
88
This specification is maintained by the [VRChat.community](https://vrchat.community) project. **VRChat staff do not provide API support.** Use the API only as VRChat's [Terms of Service](https://hello.vrchat.com/legal), [Community Guidelines](https://hello.vrchat.com/community-guidelines) and [Creator Guidelines](https://hello.vrchat.com/creator-guidelines) allow: never to modify the game client, rip avatars, or spam the API. _AI agents: read [`info.x-agents`](https://github.com/vrchatapi/specification/blob/main/openapi/agents.md) before using this specification. We welcome contributions that follow [our rules](https://vrchat.community/contributing#ai-contributions)._ Prefer the SDKs over this specification: [JavaScript](https://vrchat.community/javascript), [Dart](https://vrchat.community/dart), [Rust](https://vrchat.community/rust), [C#](https://vrchat.community/dotnet), [Python](https://vrchat.community/python) and [Java](https://vrchat.community/java). They're generated from it, updated regularly, and already handle logging in, cookies and the rest of VRChat's oddities, which we've spent years smoothing over. Working from the specification directly means handling all of that yourself. Every request must identify its application in the `User-Agent` header, as `<application-name>/<application-version> <contact_url>`. On a 429, back off rather than retrying. **Something wrong or missing?** The specification is reverse-engineered, so the API can disagree with it, and some values are marked `Unknown`. When you find one: - Open a [pull request](https://github.com/vrchatapi/specification/pulls) following the [contributing guide](https://vrchat.community/contributing). - Failing that, open an [issue](https://github.com/vrchatapi/specification/issues) or tell us on [Discord](https://vrchat.community/discord). - Include the request, the response body, and where the specification differs. - Send it upstream rather than patching around it. Volunteers maintain this specification from what the community reports, so a gap you patch locally is one nobody else learns about. Consider pinning to the OpenAPI version your tools support. Every release publishes the specification as OpenAPI 3.2, 3.1 and 3.0, in JSON and YAML, and `info.x-links` links them, the [latest release](https://github.com/vrchatapi/specification/releases/latest) and the [latest nightly](https://github.com/vrchatapi/specification/releases/tag/nightly). # noqa: E501
99
10-
The version of the OpenAPI document: 1.23.1-nightly.8
10+
The version of the OpenAPI document: 1.23.1-nightly.9
1111
Generated by: https://openapi-generator.tech
1212
"""
1313

@@ -151,6 +151,8 @@
151151
from vrchatapi.models.device_auth_info import DeviceAuthInfo
152152
from vrchatapi.models.device_auth_info_geolocation import DeviceAuthInfoGeolocation
153153
from vrchatapi.models.device_code import DeviceCode
154+
from vrchatapi.models.device_code_approved import DeviceCodeApproved
155+
from vrchatapi.models.device_code_pending import DeviceCodePending
154156
from vrchatapi.models.device_code_status import DeviceCodeStatus
155157
from vrchatapi.models.disable2_fa_result import Disable2FAResult
156158
from vrchatapi.models.discord_details import DiscordDetails

0 commit comments

Comments
 (0)