Skip to content

Commit

Permalink
Upgrade Python SDK to spec 1.18.1
Browse files Browse the repository at this point in the history
  • Loading branch information
VRCCat committed Jul 22, 2024
1 parent b4e3649 commit 5f9f321
Show file tree
Hide file tree
Showing 173 changed files with 1,182 additions and 732 deletions.
39 changes: 22 additions & 17 deletions docs/APIConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,28 +10,41 @@ Name | Type | Description | Notes
**address** | **str** | VRChat's office address |
**announcements** | [**list[APIConfigAnnouncement]**](APIConfigAnnouncement.md) | Public Announcements |
**app_name** | **str** | Game name | [default to 'VrChat']
**available_language_codes** | **list[str]** | List of supported Languages |
**available_languages** | **list[str]** | List of supported Languages |
**build_version_tag** | **str** | Build tag of the API server |
**client_api_key** | **str** | apiKey to be used for all other requests |
**client_bps_ceiling** | **int** | Unknown | [default to 18432]
**client_disconnect_timeout** | **int** | Unknown | [default to 30000]
**client_net_dispatch_thread** | **bool** | Unknown | [optional] [default to False]
**client_net_in_thread** | **bool** | Unknown | [optional] [default to False]
**client_net_in_thread2** | **bool** | Unknown | [optional] [default to False]
**client_net_in_thread_mobile** | **bool** | Unknown | [optional] [default to False]
**client_net_in_thread_mobile2** | **bool** | Unknown | [optional] [default to False]
**client_net_out_thread** | **bool** | Unknown | [optional] [default to False]
**client_net_out_thread2** | **bool** | Unknown | [optional] [default to False]
**client_net_out_thread_mobile** | **bool** | Unknown | [optional] [default to False]
**client_net_out_thread_mobile2** | **bool** | Unknown | [optional] [default to False]
**client_qr** | **int** | Unknown | [optional] [default to 1]
**client_reserved_player_bps** | **int** | Unknown | [default to 7168]
**client_sent_count_allowance** | **int** | Unknown | [default to 15]
**contact_email** | **str** | VRChat's contact email |
**copyright_email** | **str** | VRChat's copyright-issues-related email |
**current_privacy_version** | **int** | Current version number of the Privacy Agreement | [optional] [default to 1]
**current_tos_version** | **int** | Current version number of the Terms of Service |
**default_avatar** | **str** | |
**deployment_group** | [**DeploymentGroup**](DeploymentGroup.md) | |
**dev_app_version_standalone** | **str** | Version number for game development build |
**dev_download_link_windows** | **str** | Developer Download link |
**dev_language_codes** | **list[str]** | Unknown | [optional]
**dev_sdk_url** | **str** | Link to download the development SDK, use downloadUrls instead |
**dev_sdk_version** | **str** | Version of the development SDK |
**dev_server_version_standalone** | **str** | Version number for server development build |
**dis_countdown** | **datetime** | Unknown, \"dis\" maybe for disconnect? |
**disable_av_pro_in_proton** | **bool** | Unknown | [optional] [default to False]
**disable_avatar_copying** | **bool** | Toggles if copying avatars should be disabled | [default to False]
**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]
**disable_community_labs** | **bool** | Toggles if the Community Labs should be disabled | [default to False]
**disable_community_labs_promotion** | **bool** | Toggles if promotion out of Community Labs should be disabled | [default to False]
**disable_email** | **bool** | Unknown | [default to False]
**disable_captcha** | **bool** | Unknown | [optional] [default to True]
**disable_event_stream** | **bool** | Toggles if Analytics should be disabled. | [default to False]
**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]
**disable_frontend_builds** | **bool** | Unknown, probably toggles compilation of frontend web builds? So internal flag? | [default to False]
Expand All @@ -45,26 +58,23 @@ Name | Type | Description | Notes
**download_link_windows** | **str** | Download link for game on the Oculus Rift website. |
**download_urls** | [**APIConfigDownloadURLList**](APIConfigDownloadURLList.md) | |
**dynamic_world_rows** | [**list[DynamicContentRow]**](DynamicContentRow.md) | Array of DynamicWorldRow objects, used by the game to display the list of world rows |
**economy_pause_end** | **str** | Unknown | [optional]
**economy_pause_start** | **str** | Unknown | [optional]
**economy_state** | **int** | Unknown | [optional] [default to 1]
**events** | [**APIConfigEvents**](APIConfigEvents.md) | |
**gear_demo_room_id** | **str** | Unknown |
**home_world_id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
**homepage_redirect_target** | **str** | Redirect target if you try to open the base API domain in your browser | [default to 'https://hello.vrchat.com']
**hub_world_id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
**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). |
**jobs_email** | **str** | VRChat's job application email |
**message_of_the_day** | **str** | MOTD |
**moderation_email** | **str** | VRChat's moderation related email |
**moderation_query_period** | **int** | Unknown |
**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 |
**plugin** | **str** | Extra [plugin](https://doc.photonengine.com/en-us/server/current/plugins/manual) to run in each instance |
**release_app_version_standalone** | **str** | Version number for game release build |
**release_sdk_url** | **str** | Link to download the release SDK |
**release_sdk_version** | **str** | Version of the release SDK |
**release_server_version_standalone** | **str** | Version number for server release build |
**sdk_developer_faq_url** | **str** | Link to the developer FAQ |
**sdk_discord_url** | **str** | Link to the official VRChat Discord |
**sdk_not_allowed_to_publish_message** | **str** | Used in the SDK to notify a user they aren't allowed to upload avatars/worlds yet |
**sdk_unity_version** | **str** | Unity version supported by the SDK |
**server_name** | **str** | Server name of the API server currently responding |
**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). |
**support_email** | **str** | VRChat's support email |
**time_out_world_id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
**tutorial_world_id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
Expand All @@ -75,15 +85,10 @@ Name | Type | Description | Notes
**upload_analysis_percent** | **int** | Unknown |
**url_list** | **list[str]** | List of allowed URLs that bypass the \"Allow untrusted URL's\" setting in-game |
**use_reliable_udp_for_voice** | **bool** | Unknown | [default to False]
**user_update_period** | **int** | Unknown |
**user_verification_delay** | **int** | Unknown |
**user_verification_retry** | **int** | Unknown |
**user_verification_timeout** | **int** | Unknown |
**vive_windows_url** | **str** | Download link for game on the Steam website. |
**white_listed_asset_urls** | **list[str]** | List of allowed URLs that are allowed to host avatar assets |
**world_update_period** | **int** | Unknown |
**player_url_resolver_hash** | **str** | Currently used youtube-dl.exe hash in SHA-256-delimited format |
**player_url_resolver_version** | **str** | Currently used youtube-dl.exe version |
**player_url_resolver_sha1** | **str** | Currently used youtube-dl.exe hash in SHA1-delimited format |

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

Expand Down
8 changes: 4 additions & 4 deletions docs/AuthenticationApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Method | HTTP request | Description


# **check_user_exists**
> UserExists check_user_exists(email=email, display_name=display_name, user_id=user_id, exclude_user_id=exclude_user_id)
> UserExists check_user_exists(email=email, display_name=display_name, username=username, exclude_user_id=exclude_user_id)
Check User Exists

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

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

### Return type
Expand Down
2 changes: 1 addition & 1 deletion docs/FileData.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**category** | **str** | | [default to 'queued']
**file_name** | **str** | |
**md5** | **str** | |
**md5** | **str** | | [optional]
**size_in_bytes** | **int** | |
**status** | [**FileStatus**](FileStatus.md) | |
**upload_id** | **str** | | [default to '']
Expand Down
11 changes: 6 additions & 5 deletions docs/FilesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ Name | Type | Description | Notes
[[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)

# **delete_file**
> Success delete_file(file_id)
> File delete_file(file_id)
Delete File

Expand Down Expand Up @@ -219,7 +219,7 @@ Name | Type | Description | Notes

### Return type

[**Success**](Success.md)
[**File**](File.md)

### Authorization

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

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

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

Expand Down Expand Up @@ -380,12 +380,13 @@ void (empty response body)
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Raw file | - |
**404** | Error response when trying to show information about a non-existent file. | - |

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

Expand Down
3 changes: 3 additions & 0 deletions docs/Group.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,11 @@ Name | Type | Description | Notes
**is_verified** | **bool** | | [optional] [default to False]
**join_state** | [**GroupJoinState**](GroupJoinState.md) | | [optional]
**tags** | **list[str]** | | [optional]
**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]
**galleries** | [**list[GroupGallery]**](GroupGallery.md) | | [optional]
**created_at** | **datetime** | | [optional]
**updated_at** | **datetime** | | [optional]
**last_post_created_at** | **datetime** | | [optional]
**online_member_count** | **int** | | [optional]
**membership_status** | [**GroupMemberStatus**](GroupMemberStatus.md) | | [optional]
**my_member** | [**GroupMyMember**](GroupMyMember.md) | | [optional]
Expand Down
6 changes: 6 additions & 0 deletions docs/GroupMyMember.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ Name | Type | Description | Notes
**group_id** | **str** | | [optional]
**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]
**role_ids** | **list[str]** | | [optional]
**accepted_by_display_name** | **str** | | [optional]
**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]
**created_at** | **datetime** | | [optional]
**manager_notes** | **str** | | [optional]
**membership_status** | **str** | | [optional]
**is_subscribed_to_announcements** | **bool** | | [optional] [default to True]
Expand All @@ -16,6 +19,9 @@ Name | Type | Description | Notes
**joined_at** | **datetime** | | [optional]
**banned_at** | **str** | | [optional]
**has2_fa** | **bool** | | [optional] [default to False]
**has_joined_from_purchase** | **bool** | | [optional] [default to False]
**last_post_read_at** | **datetime** | | [optional]
**m_role_ids** | **list[str]** | | [optional]
**permissions** | **list[str]** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
2 changes: 2 additions & 0 deletions docs/GroupsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -1665,6 +1665,7 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | Returns a list of GroupMember objects. | - |
**401** | Error response due to missing auth cookie. | - |
**403** | Error response due to missing permissions. | - |
**404** | Error response when trying to perform operations on a non-existing group. | - |

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

[[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)
Expand Down
1 change: 1 addition & 0 deletions docs/Permission.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | |
**owner_display_name** | **str** | |
**name** | **str** | |
**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. |
**data** | **object** | | [optional]
Expand Down
3 changes: 2 additions & 1 deletion docs/TransactionAgreement.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# TransactionAgreement


Represents a single Transaction, which is likely between VRChat and Steam.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**agreement_id** | **str** | |
**item_id** | **float** | |
**agreement** | **str** | |
**status** | **str** | This is NOT TransactionStatus, but whatever Steam return. |
**period** | **str** | |
**frequency** | **float** | |
Expand Down
1 change: 1 addition & 0 deletions docs/UserSubscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Name | Type | Description | Notes
**tier** | **float** | |
**active** | **bool** | | [default to True]
**status** | [**TransactionStatus**](TransactionStatus.md) | |
**starts** | **datetime** | | [optional]
**expires** | **datetime** | |
**created_at** | **datetime** | |
**updated_at** | **datetime** | |
Expand Down
6 changes: 4 additions & 2 deletions docs/WorldsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -814,7 +814,7 @@ void (empty response body)
[[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)

# **search_worlds**
> list[LimitedWorld] search_worlds(featured=featured, sort=sort, user=user, user_id=user_id, n=n, order=order, offset=offset, search=search, tag=tag, notag=notag, release_status=release_status, max_unity_version=max_unity_version, min_unity_version=min_unity_version, platform=platform)
> list[LimitedWorld] search_worlds(featured=featured, sort=sort, user=user, user_id=user_id, n=n, order=order, offset=offset, search=search, tag=tag, notag=notag, release_status=release_status, max_unity_version=max_unity_version, min_unity_version=min_unity_version, platform=platform, fuzzy=fuzzy)
Search All Worlds

Expand Down Expand Up @@ -864,10 +864,11 @@ release_status = vrchatapi.ReleaseStatus() # ReleaseStatus | Filter by ReleaseSt
max_unity_version = 'max_unity_version_example' # str | The maximum Unity version supported by the asset. (optional)
min_unity_version = 'min_unity_version_example' # str | The minimum Unity version supported by the asset. (optional)
platform = 'platform_example' # str | The platform the asset supports. (optional)
fuzzy = True # bool | (optional)

try:
# Search All Worlds
api_response = api_instance.search_worlds(featured=featured, sort=sort, user=user, user_id=user_id, n=n, order=order, offset=offset, search=search, tag=tag, notag=notag, release_status=release_status, max_unity_version=max_unity_version, min_unity_version=min_unity_version, platform=platform)
api_response = api_instance.search_worlds(featured=featured, sort=sort, user=user, user_id=user_id, n=n, order=order, offset=offset, search=search, tag=tag, notag=notag, release_status=release_status, max_unity_version=max_unity_version, min_unity_version=min_unity_version, platform=platform, fuzzy=fuzzy)
pprint(api_response)
except ApiException as e:
print("Exception when calling WorldsApi->search_worlds: %s\n" % e)
Expand All @@ -891,6 +892,7 @@ Name | Type | Description | Notes
**max_unity_version** | **str**| The maximum Unity version supported by the asset. | [optional]
**min_unity_version** | **str**| The minimum Unity version supported by the asset. | [optional]
**platform** | **str**| The platform the asset supports. | [optional]
**fuzzy** | **bool**| | [optional]

### Return type

Expand Down
Loading

0 comments on commit 5f9f321

Please sign in to comment.