Skip to content

Commit 5f9f321

Browse files
committed
Upgrade Python SDK to spec 1.18.1
1 parent b4e3649 commit 5f9f321

File tree

173 files changed

+1182
-732
lines changed

Some content is hidden

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

173 files changed

+1182
-732
lines changed

docs/APIConfig.md

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,28 +10,41 @@ Name | Type | Description | Notes
1010
**address** | **str** | VRChat's office address |
1111
**announcements** | [**list[APIConfigAnnouncement]**](APIConfigAnnouncement.md) | Public Announcements |
1212
**app_name** | **str** | Game name | [default to 'VrChat']
13+
**available_language_codes** | **list[str]** | List of supported Languages |
14+
**available_languages** | **list[str]** | List of supported Languages |
1315
**build_version_tag** | **str** | Build tag of the API server |
1416
**client_api_key** | **str** | apiKey to be used for all other requests |
1517
**client_bps_ceiling** | **int** | Unknown | [default to 18432]
1618
**client_disconnect_timeout** | **int** | Unknown | [default to 30000]
19+
**client_net_dispatch_thread** | **bool** | Unknown | [optional] [default to False]
20+
**client_net_in_thread** | **bool** | Unknown | [optional] [default to False]
21+
**client_net_in_thread2** | **bool** | Unknown | [optional] [default to False]
22+
**client_net_in_thread_mobile** | **bool** | Unknown | [optional] [default to False]
23+
**client_net_in_thread_mobile2** | **bool** | Unknown | [optional] [default to False]
24+
**client_net_out_thread** | **bool** | Unknown | [optional] [default to False]
25+
**client_net_out_thread2** | **bool** | Unknown | [optional] [default to False]
26+
**client_net_out_thread_mobile** | **bool** | Unknown | [optional] [default to False]
27+
**client_net_out_thread_mobile2** | **bool** | Unknown | [optional] [default to False]
28+
**client_qr** | **int** | Unknown | [optional] [default to 1]
1729
**client_reserved_player_bps** | **int** | Unknown | [default to 7168]
1830
**client_sent_count_allowance** | **int** | Unknown | [default to 15]
1931
**contact_email** | **str** | VRChat's contact email |
2032
**copyright_email** | **str** | VRChat's copyright-issues-related email |
33+
**current_privacy_version** | **int** | Current version number of the Privacy Agreement | [optional] [default to 1]
2134
**current_tos_version** | **int** | Current version number of the Terms of Service |
2235
**default_avatar** | **str** | |
2336
**deployment_group** | [**DeploymentGroup**](DeploymentGroup.md) | |
24-
**dev_app_version_standalone** | **str** | Version number for game development build |
25-
**dev_download_link_windows** | **str** | Developer Download link |
37+
**dev_language_codes** | **list[str]** | Unknown | [optional]
2638
**dev_sdk_url** | **str** | Link to download the development SDK, use downloadUrls instead |
2739
**dev_sdk_version** | **str** | Version of the development SDK |
28-
**dev_server_version_standalone** | **str** | Version number for server development build |
2940
**dis_countdown** | **datetime** | Unknown, \"dis\" maybe for disconnect? |
41+
**disable_av_pro_in_proton** | **bool** | Unknown | [optional] [default to False]
3042
**disable_avatar_copying** | **bool** | Toggles if copying avatars should be disabled | [default to False]
3143
**disable_avatar_gating** | **bool** | Toggles if avatar gating should be disabled. Avatar gating restricts uploading of avatars to people with the `system_avatar_access` Tag or `admin_avatar_access` Tag | [default to False]
3244
**disable_community_labs** | **bool** | Toggles if the Community Labs should be disabled | [default to False]
3345
**disable_community_labs_promotion** | **bool** | Toggles if promotion out of Community Labs should be disabled | [default to False]
3446
**disable_email** | **bool** | Unknown | [default to False]
47+
**disable_captcha** | **bool** | Unknown | [optional] [default to True]
3548
**disable_event_stream** | **bool** | Toggles if Analytics should be disabled. | [default to False]
3649
**disable_feedback_gating** | **bool** | Toggles if feedback gating should be disabled. Feedback gating restricts submission of feedback (reporting a World or User) to people with the `system_feedback_access` Tag. | [default to False]
3750
**disable_frontend_builds** | **bool** | Unknown, probably toggles compilation of frontend web builds? So internal flag? | [default to False]
@@ -45,26 +58,23 @@ Name | Type | Description | Notes
4558
**download_link_windows** | **str** | Download link for game on the Oculus Rift website. |
4659
**download_urls** | [**APIConfigDownloadURLList**](APIConfigDownloadURLList.md) | |
4760
**dynamic_world_rows** | [**list[DynamicContentRow]**](DynamicContentRow.md) | Array of DynamicWorldRow objects, used by the game to display the list of world rows |
61+
**economy_pause_end** | **str** | Unknown | [optional]
62+
**economy_pause_start** | **str** | Unknown | [optional]
63+
**economy_state** | **int** | Unknown | [optional] [default to 1]
4864
**events** | [**APIConfigEvents**](APIConfigEvents.md) | |
49-
**gear_demo_room_id** | **str** | Unknown |
5065
**home_world_id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
5166
**homepage_redirect_target** | **str** | Redirect target if you try to open the base API domain in your browser | [default to 'https://hello.vrchat.com']
5267
**hub_world_id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
68+
**image_host_url_list** | **list[str]** | A list of explicitly allowed origins that worlds can request images from via the Udon's [VRCImageDownloader#DownloadImage](https://creators.vrchat.com/worlds/udon/image-loading/#downloadimage). |
5369
**jobs_email** | **str** | VRChat's job application email |
54-
**message_of_the_day** | **str** | MOTD |
5570
**moderation_email** | **str** | VRChat's moderation related email |
56-
**moderation_query_period** | **int** | Unknown |
5771
**not_allowed_to_select_avatar_in_private_world_message** | **str** | Used in-game to notify a user they aren't allowed to select avatars in private worlds |
58-
**plugin** | **str** | Extra [plugin](https://doc.photonengine.com/en-us/server/current/plugins/manual) to run in each instance |
59-
**release_app_version_standalone** | **str** | Version number for game release build |
60-
**release_sdk_url** | **str** | Link to download the release SDK |
61-
**release_sdk_version** | **str** | Version of the release SDK |
62-
**release_server_version_standalone** | **str** | Version number for server release build |
6372
**sdk_developer_faq_url** | **str** | Link to the developer FAQ |
6473
**sdk_discord_url** | **str** | Link to the official VRChat Discord |
6574
**sdk_not_allowed_to_publish_message** | **str** | Used in the SDK to notify a user they aren't allowed to upload avatars/worlds yet |
6675
**sdk_unity_version** | **str** | Unity version supported by the SDK |
6776
**server_name** | **str** | Server name of the API server currently responding |
77+
**string_host_url_list** | **list[str]** | A list of explicitly allowed origins that worlds can request strings from via the Udon's [VRCStringDownloader.LoadUrl](https://creators.vrchat.com/worlds/udon/string-loading/#ivrcstringdownload). |
6878
**support_email** | **str** | VRChat's support email |
6979
**time_out_world_id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
7080
**tutorial_world_id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
@@ -75,15 +85,10 @@ Name | Type | Description | Notes
7585
**upload_analysis_percent** | **int** | Unknown |
7686
**url_list** | **list[str]** | List of allowed URLs that bypass the \"Allow untrusted URL's\" setting in-game |
7787
**use_reliable_udp_for_voice** | **bool** | Unknown | [default to False]
78-
**user_update_period** | **int** | Unknown |
79-
**user_verification_delay** | **int** | Unknown |
80-
**user_verification_retry** | **int** | Unknown |
81-
**user_verification_timeout** | **int** | Unknown |
8288
**vive_windows_url** | **str** | Download link for game on the Steam website. |
8389
**white_listed_asset_urls** | **list[str]** | List of allowed URLs that are allowed to host avatar assets |
84-
**world_update_period** | **int** | Unknown |
85-
**player_url_resolver_hash** | **str** | Currently used youtube-dl.exe hash in SHA-256-delimited format |
8690
**player_url_resolver_version** | **str** | Currently used youtube-dl.exe version |
91+
**player_url_resolver_sha1** | **str** | Currently used youtube-dl.exe hash in SHA1-delimited format |
8792

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

docs/AuthenticationApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Method | HTTP request | Description
1515

1616

1717
# **check_user_exists**
18-
> UserExists check_user_exists(email=email, display_name=display_name, user_id=user_id, exclude_user_id=exclude_user_id)
18+
> UserExists check_user_exists(email=email, display_name=display_name, username=username, exclude_user_id=exclude_user_id)
1919
2020
Check User Exists
2121

@@ -42,12 +42,12 @@ with vrchatapi.ApiClient() as api_client:
4242
api_instance = vrchatapi.AuthenticationApi(api_client)
4343
email = 'email_example' # str | Filter by email. (optional)
4444
display_name = 'display_name_example' # str | Filter by displayName. (optional)
45-
user_id = 'user_id_example' # str | Filter by UserID. (optional)
45+
username = 'username_example' # str | Filter by Username. (optional)
4646
exclude_user_id = 'exclude_user_id_example' # str | Exclude by UserID. (optional)
4747

4848
try:
4949
# Check User Exists
50-
api_response = api_instance.check_user_exists(email=email, display_name=display_name, user_id=user_id, exclude_user_id=exclude_user_id)
50+
api_response = api_instance.check_user_exists(email=email, display_name=display_name, username=username, exclude_user_id=exclude_user_id)
5151
pprint(api_response)
5252
except ApiException as e:
5353
print("Exception when calling AuthenticationApi->check_user_exists: %s\n" % e)
@@ -59,7 +59,7 @@ Name | Type | Description | Notes
5959
------------- | ------------- | ------------- | -------------
6060
**email** | **str**| Filter by email. | [optional]
6161
**display_name** | **str**| Filter by displayName. | [optional]
62-
**user_id** | **str**| Filter by UserID. | [optional]
62+
**username** | **str**| Filter by Username. | [optional]
6363
**exclude_user_id** | **str**| Exclude by UserID. | [optional]
6464

6565
### Return type

docs/FileData.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**category** | **str** | | [default to 'queued']
99
**file_name** | **str** | |
10-
**md5** | **str** | |
10+
**md5** | **str** | | [optional]
1111
**size_in_bytes** | **int** | |
1212
**status** | [**FileStatus**](FileStatus.md) | |
1313
**upload_id** | **str** | | [default to '']

docs/FilesApi.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ Name | Type | Description | Notes
165165
[[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)
166166

167167
# **delete_file**
168-
> Success delete_file(file_id)
168+
> File delete_file(file_id)
169169
170170
Delete File
171171

@@ -219,7 +219,7 @@ Name | Type | Description | Notes
219219

220220
### Return type
221221

222-
[**Success**](Success.md)
222+
[**File**](File.md)
223223

224224
### Authorization
225225

@@ -233,7 +233,7 @@ Name | Type | Description | Notes
233233
### HTTP response details
234234
| Status code | Description | Response headers |
235235
|-------------|-------------|------------------|
236-
**200** | Successful response after deleting a File. | - |
236+
**200** | Returns a single File object. | - |
237237
**404** | Error response when trying to delete a non-existent file. | - |
238238

239239
[[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)
@@ -311,7 +311,7 @@ Name | Type | Description | Notes
311311
|-------------|-------------|------------------|
312312
**200** | Returns a single File object. | - |
313313
**400** | Error response when trying to delete the initial version of a file. Delete the main File object instead. | - |
314-
**500** | Error response when trying to delete any version of a file that is not hte last one. | - |
314+
**500** | Error response when trying to delete any version of a file that is not the last one. | - |
315315

316316
[[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)
317317

@@ -380,12 +380,13 @@ void (empty response body)
380380
### HTTP request headers
381381

382382
- **Content-Type**: Not defined
383-
- **Accept**: Not defined
383+
- **Accept**: application/json
384384

385385
### HTTP response details
386386
| Status code | Description | Response headers |
387387
|-------------|-------------|------------------|
388388
**200** | Raw file | - |
389+
**404** | Error response when trying to show information about a non-existent file. | - |
389390

390391
[[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)
391392

docs/Group.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,11 @@ Name | Type | Description | Notes
2323
**is_verified** | **bool** | | [optional] [default to False]
2424
**join_state** | [**GroupJoinState**](GroupJoinState.md) | | [optional]
2525
**tags** | **list[str]** | | [optional]
26+
**transfer_target_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. | [optional]
2627
**galleries** | [**list[GroupGallery]**](GroupGallery.md) | | [optional]
2728
**created_at** | **datetime** | | [optional]
29+
**updated_at** | **datetime** | | [optional]
30+
**last_post_created_at** | **datetime** | | [optional]
2831
**online_member_count** | **int** | | [optional]
2932
**membership_status** | [**GroupMemberStatus**](GroupMemberStatus.md) | | [optional]
3033
**my_member** | [**GroupMyMember**](GroupMyMember.md) | | [optional]

docs/GroupMyMember.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ Name | Type | Description | Notes
88
**group_id** | **str** | | [optional]
99
**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. | [optional]
1010
**role_ids** | **list[str]** | | [optional]
11+
**accepted_by_display_name** | **str** | | [optional]
12+
**accepted_by_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. | [optional]
13+
**created_at** | **datetime** | | [optional]
1114
**manager_notes** | **str** | | [optional]
1215
**membership_status** | **str** | | [optional]
1316
**is_subscribed_to_announcements** | **bool** | | [optional] [default to True]
@@ -16,6 +19,9 @@ Name | Type | Description | Notes
1619
**joined_at** | **datetime** | | [optional]
1720
**banned_at** | **str** | | [optional]
1821
**has2_fa** | **bool** | | [optional] [default to False]
22+
**has_joined_from_purchase** | **bool** | | [optional] [default to False]
23+
**last_post_read_at** | **datetime** | | [optional]
24+
**m_role_ids** | **list[str]** | | [optional]
1925
**permissions** | **list[str]** | | [optional]
2026

2127
[[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/GroupsApi.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1665,6 +1665,7 @@ Name | Type | Description | Notes
16651665
|-------------|-------------|------------------|
16661666
**200** | Returns a list of GroupMember objects. | - |
16671667
**401** | Error response due to missing auth cookie. | - |
1668+
**403** | Error response due to missing permissions. | - |
16681669
**404** | Error response when trying to perform operations on a non-existing group. | - |
16691670

16701671
[[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)
@@ -1980,6 +1981,7 @@ Name | Type | Description | Notes
19801981
|-------------|-------------|------------------|
19811982
**200** | Returns a list of GroupMember objects. | - |
19821983
**401** | Error response due to missing auth cookie. | - |
1984+
**403** | Error response when trying to perform operations on a group you are not member of. | - |
19831985
**404** | Error response when trying to perform operations on a non-existing group. | - |
19841986

19851987
[[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/Permission.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**id** | **str** | |
9+
**owner_display_name** | **str** | |
910
**name** | **str** | |
1011
**owner_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. |
1112
**data** | **object** | | [optional]

docs/TransactionAgreement.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# TransactionAgreement
22

3-
3+
Represents a single Transaction, which is likely between VRChat and Steam.
44

55
## Properties
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**agreement_id** | **str** | |
99
**item_id** | **float** | |
10+
**agreement** | **str** | |
1011
**status** | **str** | This is NOT TransactionStatus, but whatever Steam return. |
1112
**period** | **str** | |
1213
**frequency** | **float** | |

docs/UserSubscription.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
1515
**tier** | **float** | |
1616
**active** | **bool** | | [default to True]
1717
**status** | [**TransactionStatus**](TransactionStatus.md) | |
18+
**starts** | **datetime** | | [optional]
1819
**expires** | **datetime** | |
1920
**created_at** | **datetime** | |
2021
**updated_at** | **datetime** | |

0 commit comments

Comments
 (0)