Skip to content

Commit 9d21bf8

Browse files
committed
Upgrade Python SDK to spec 1.23.1.dev6
1 parent 32b9a94 commit 9d21bf8

649 files changed

Lines changed: 1773 additions & 658 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: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ docs/AgreementRequest.md
3434
docs/AgreementStatus.md
3535
docs/AuthenticationApi.md
3636
docs/Avatar.md
37+
docs/AvatarList.md
3738
docs/AvatarModeration.md
3839
docs/AvatarModerationCreated.md
3940
docs/AvatarModerationType.md
@@ -317,6 +318,7 @@ docs/InfoPushWorldCategoryData.md
317318
docs/Instance.md
318319
docs/InstanceCategory.md
319320
docs/InstanceContentSettings.md
321+
docs/InstanceCount.md
320322
docs/InstanceDiscovery.md
321323
docs/InstanceDiscoveryBoost.md
322324
docs/InstanceDiscoveryMode.md
@@ -475,6 +477,7 @@ docs/RewardRedemptionData.md
475477
docs/RewardRedemptionRequest.md
476478
docs/RewardRedemptionResult.md
477479
docs/RouteNotImplemented.md
480+
docs/SearchAvatarsMarketplace.md
478481
docs/SearchWorldsUser.md
479482
docs/SellerEligibility.md
480483
docs/SentNotification.md
@@ -695,6 +698,7 @@ vrchatapi/models/api_config_offline_analysis.py
695698
vrchatapi/models/api_config_profile_defaults.py
696699
vrchatapi/models/api_health.py
697700
vrchatapi/models/avatar.py
701+
vrchatapi/models/avatar_list.py
698702
vrchatapi/models/avatar_moderation.py
699703
vrchatapi/models/avatar_moderation_created.py
700704
vrchatapi/models/avatar_moderation_type.py
@@ -971,6 +975,7 @@ vrchatapi/models/info_push_world_category_data.py
971975
vrchatapi/models/instance.py
972976
vrchatapi/models/instance_category.py
973977
vrchatapi/models/instance_content_settings.py
978+
vrchatapi/models/instance_count.py
974979
vrchatapi/models/instance_discovery.py
975980
vrchatapi/models/instance_discovery_boost.py
976981
vrchatapi/models/instance_discovery_mode.py
@@ -1120,6 +1125,7 @@ vrchatapi/models/reward_redemption_data.py
11201125
vrchatapi/models/reward_redemption_request.py
11211126
vrchatapi/models/reward_redemption_result.py
11221127
vrchatapi/models/route_not_implemented.py
1128+
vrchatapi/models/search_avatars_marketplace.py
11231129
vrchatapi/models/search_worlds_user.py
11241130
vrchatapi/models/seller_eligibility.py
11251131
vrchatapi/models/sent_notification.py

‎docs/AvatarList.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# AvatarList
2+
3+
A page of avatar search results.
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**has_next** | **bool** | |
9+
**results** | [**list[Avatar]**](Avatar.md) | |
10+
**total_count** | **int** | |
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+
14+

‎docs/AvatarsApi.md‎

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -785,11 +785,11 @@ Name | Type | Description | Notes
785785
[[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)
786786

787787
# **search_avatars**
788-
> list[Avatar] search_avatars(featured=featured, sort=sort, user=user, user_id=user_id, n=n, order=order, offset=offset, tag=tag, notag=notag, release_status=release_status, max_unity_version=max_unity_version, min_unity_version=min_unity_version, platform=platform, is_internal_variant=is_internal_variant)
788+
> object search_avatars(featured=featured, sort=sort, user=user, user_id=user_id, n=n, order=order, offset=offset, tag=tag, notag=notag, release_status=release_status, max_unity_version=max_unity_version, min_unity_version=min_unity_version, platform=platform, is_internal_variant=is_internal_variant, marketplace=marketplace, search=search, metadata=metadata, min_price=min_price, max_price=max_price, performance_at_least=performance_at_least, min_asset_version=min_asset_version, max_asset_version=max_asset_version)
789789
790790
Search Avatars
791791

792-
Search and list avatars by query filters. You can only search your own or featured avatars. It is not possible as a normal user to search other peoples avatars.
792+
Search and list avatars by query filters. Without `marketplace`, you can only search your own or featured avatars.
793793

794794
### Example
795795

@@ -835,10 +835,18 @@ max_unity_version = 'max_unity_version_example' # str | The maximum Unity versio
835835
min_unity_version = 'min_unity_version_example' # str | The minimum Unity version supported by the asset. (optional)
836836
platform = 'platform_example' # str | The platform the asset supports. (optional)
837837
is_internal_variant = false # bool | Not quite sure what this actually does (exists on the website but doesn't seem to be used) (optional)
838+
marketplace = vrchatapi.SearchAvatarsMarketplace() # SearchAvatarsMarketplace | Search avatars listed in the marketplace. (optional)
839+
search = 'search_example' # str | Text to search for. Requires `marketplace`. (optional)
840+
metadata = True # bool | Wrap the results in an AvatarList. (optional)
841+
min_price = 56 # int | (optional)
842+
max_price = 56 # int | (optional)
843+
performance_at_least = 56 # int | (optional)
844+
min_asset_version = 56 # int | (optional)
845+
max_asset_version = 56 # int | (optional)
838846

839847
try:
840848
# Search Avatars
841-
api_response = api_instance.search_avatars(featured=featured, sort=sort, user=user, user_id=user_id, n=n, order=order, offset=offset, tag=tag, notag=notag, release_status=release_status, max_unity_version=max_unity_version, min_unity_version=min_unity_version, platform=platform, is_internal_variant=is_internal_variant)
849+
api_response = api_instance.search_avatars(featured=featured, sort=sort, user=user, user_id=user_id, n=n, order=order, offset=offset, tag=tag, notag=notag, release_status=release_status, max_unity_version=max_unity_version, min_unity_version=min_unity_version, platform=platform, is_internal_variant=is_internal_variant, marketplace=marketplace, search=search, metadata=metadata, min_price=min_price, max_price=max_price, performance_at_least=performance_at_least, min_asset_version=min_asset_version, max_asset_version=max_asset_version)
842850
pprint(api_response)
843851
except ApiException as e:
844852
print("Exception when calling AvatarsApi->search_avatars: %s\n" % e)
@@ -862,10 +870,18 @@ Name | Type | Description | Notes
862870
**min_unity_version** | **str**| The minimum Unity version supported by the asset. | [optional]
863871
**platform** | **str**| The platform the asset supports. | [optional]
864872
**is_internal_variant** | **bool**| Not quite sure what this actually does (exists on the website but doesn't seem to be used) | [optional]
873+
**marketplace** | [**SearchAvatarsMarketplace**](.md)| Search avatars listed in the marketplace. | [optional]
874+
**search** | **str**| Text to search for. Requires `marketplace`. | [optional]
875+
**metadata** | **bool**| Wrap the results in an AvatarList. | [optional]
876+
**min_price** | **int**| | [optional]
877+
**max_price** | **int**| | [optional]
878+
**performance_at_least** | **int**| | [optional]
879+
**min_asset_version** | **int**| | [optional]
880+
**max_asset_version** | **int**| | [optional]
865881

866882
### Return type
867883

868-
[**list[Avatar]**](Avatar.md)
884+
**object**
869885

870886
### Authorization
871887

@@ -879,7 +895,7 @@ Name | Type | Description | Notes
879895
### HTTP response details
880896
| Status code | Description | Response headers |
881897
|-------------|-------------|------------------|
882-
**200** | | - |
898+
**200** | Returns a list of Avatar objects, wrapped in a paginated object when `metadata` is `true`. | - |
883899
**400** | The request failed validation. VRChat validates the request before it looks up the resource, so this response is returned even when the ID in the path does not exist. The message names the offending field or parameter. | - |
884900
**401** | Error response due to missing auth cookie. | - |
885901

‎docs/EconomyApi.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Method | HTTP request | Description
1919
[**get_economy_payout_status**](EconomyApi.md#get_economy_payout_status) | **GET** /user/{userId}/economy/payouts/status | Get Economy Payout Status
2020
[**get_economy_payouts**](EconomyApi.md#get_economy_payouts) | **GET** /user/{userId}/economy/payouts/list | Get Economy Payouts
2121
[**get_economy_status**](EconomyApi.md#get_economy_status) | **GET** /economy/status | Get Economy Status
22+
[**get_economy_subscriptions**](EconomyApi.md#get_economy_subscriptions) | **GET** /economy/subscriptions | List Economy Subscriptions
2223
[**get_license_group**](EconomyApi.md#get_license_group) | **GET** /licenseGroups/{licenseGroupId} | Get License Group
2324
[**get_product_listing**](EconomyApi.md#get_product_listing) | **GET** /listing/{productId} | Get Product Listing
2425
[**get_product_listing_alternate**](EconomyApi.md#get_product_listing_alternate) | **GET** /products/{productId} | Get Product Listing (alternate)
@@ -1155,6 +1156,86 @@ This endpoint does not need any parameter.
11551156

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

1159+
# **get_economy_subscriptions**
1160+
> list[object] get_economy_subscriptions(subscriber_id, n=n, offset=offset)
1161+
1162+
List Economy Subscriptions
1163+
1164+
List a subscriber's economy subscriptions.
1165+
1166+
### Example
1167+
1168+
* Api Key Authentication (authCookie):
1169+
```python
1170+
from __future__ import print_function
1171+
import time
1172+
import vrchatapi
1173+
from vrchatapi.rest import ApiException
1174+
from pprint import pprint
1175+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
1176+
# See configuration.py for a list of all supported configuration parameters.
1177+
configuration = vrchatapi.Configuration(
1178+
host = "https://api.vrchat.cloud/api/1"
1179+
)
1180+
1181+
# The client must configure the authentication and authorization parameters
1182+
# in accordance with the API server security policy.
1183+
# Examples for each auth method are provided below, use the example that
1184+
# satisfies your auth use case.
1185+
1186+
# Configure API key authorization: authCookie
1187+
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
1188+
1189+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1190+
# configuration.api_key_prefix['authCookie'] = 'Bearer'
1191+
1192+
# Enter a context with an instance of the API client
1193+
with vrchatapi.ApiClient(configuration) as api_client:
1194+
# Create an instance of the API class
1195+
api_instance = vrchatapi.EconomyApi(api_client)
1196+
subscriber_id = 'subscriber_id_example' # str |
1197+
n = 60 # int | The number of objects to return. (optional) (default to 60)
1198+
offset = 56 # int | A zero-based offset from the default object sorting from where search results start. (optional)
1199+
1200+
try:
1201+
# List Economy Subscriptions
1202+
api_response = api_instance.get_economy_subscriptions(subscriber_id, n=n, offset=offset)
1203+
pprint(api_response)
1204+
except ApiException as e:
1205+
print("Exception when calling EconomyApi->get_economy_subscriptions: %s\n" % e)
1206+
```
1207+
1208+
### Parameters
1209+
1210+
Name | Type | Description | Notes
1211+
------------- | ------------- | ------------- | -------------
1212+
**subscriber_id** | **str**| |
1213+
**n** | **int**| The number of objects to return. | [optional] [default to 60]
1214+
**offset** | **int**| A zero-based offset from the default object sorting from where search results start. | [optional]
1215+
1216+
### Return type
1217+
1218+
**list[object]**
1219+
1220+
### Authorization
1221+
1222+
[authCookie](../README.md#authCookie)
1223+
1224+
### HTTP request headers
1225+
1226+
- **Content-Type**: Not defined
1227+
- **Accept**: application/json
1228+
1229+
### HTTP response details
1230+
| Status code | Description | Response headers |
1231+
|-------------|-------------|------------------|
1232+
**200** | | - |
1233+
**400** | The request failed validation. VRChat validates the request before it looks up the resource, so this response is returned even when the ID in the path does not exist. The message names the offending field or parameter. | - |
1234+
**401** | Error response due to missing auth cookie. | - |
1235+
**403** | Error response when requesting another user's economy subscriptions. | - |
1236+
1237+
[[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)
1238+
11581239
# **get_license_group**
11591240
> LicenseGroup get_license_group(license_group_id)
11601241

‎docs/InstanceCount.md‎

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

‎docs/InstancesApi.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Method | HTTP request | Description
1111
[**get_instance**](InstancesApi.md#get_instance) | **GET** /instances/{worldId}:{instanceId} | Get Instance
1212
[**get_instance_by_short_name**](InstancesApi.md#get_instance_by_short_name) | **GET** /instances/s/{shortName} | Get Instance By Short Name
1313
[**get_instance_categories**](InstancesApi.md#get_instance_categories) | **GET** /instanceCategories | List Instance Categories
14+
[**get_instance_count**](InstancesApi.md#get_instance_count) | **GET** /instances/count | Get Instance Count
1415
[**get_instance_vibes**](InstancesApi.md#get_instance_vibes) | **GET** /instanceVibes | List Instance Vibes
1516
[**get_recent_locations**](InstancesApi.md#get_recent_locations) | **GET** /instances/recent | List Recent Locations
1617
[**get_short_name**](InstancesApi.md#get_short_name) | **GET** /instances/{worldId}:{instanceId}/shortName | Get Instance Short Name
@@ -577,6 +578,76 @@ This endpoint does not need any parameter.
577578

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

581+
# **get_instance_count**
582+
> InstanceCount get_instance_count()
583+
584+
Get Instance Count
585+
586+
Returns instance and event counts as of `asOf`.
587+
588+
### Example
589+
590+
* Api Key Authentication (authCookie):
591+
```python
592+
from __future__ import print_function
593+
import time
594+
import vrchatapi
595+
from vrchatapi.rest import ApiException
596+
from pprint import pprint
597+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
598+
# See configuration.py for a list of all supported configuration parameters.
599+
configuration = vrchatapi.Configuration(
600+
host = "https://api.vrchat.cloud/api/1"
601+
)
602+
603+
# The client must configure the authentication and authorization parameters
604+
# in accordance with the API server security policy.
605+
# Examples for each auth method are provided below, use the example that
606+
# satisfies your auth use case.
607+
608+
# Configure API key authorization: authCookie
609+
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
610+
611+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
612+
# configuration.api_key_prefix['authCookie'] = 'Bearer'
613+
614+
# Enter a context with an instance of the API client
615+
with vrchatapi.ApiClient(configuration) as api_client:
616+
# Create an instance of the API class
617+
api_instance = vrchatapi.InstancesApi(api_client)
618+
619+
try:
620+
# Get Instance Count
621+
api_response = api_instance.get_instance_count()
622+
pprint(api_response)
623+
except ApiException as e:
624+
print("Exception when calling InstancesApi->get_instance_count: %s\n" % e)
625+
```
626+
627+
### Parameters
628+
This endpoint does not need any parameter.
629+
630+
### Return type
631+
632+
[**InstanceCount**](InstanceCount.md)
633+
634+
### Authorization
635+
636+
[authCookie](../README.md#authCookie)
637+
638+
### HTTP request headers
639+
640+
- **Content-Type**: Not defined
641+
- **Accept**: application/json
642+
643+
### HTTP response details
644+
| Status code | Description | Response headers |
645+
|-------------|-------------|------------------|
646+
**200** | Returns a single InstanceCount object. | - |
647+
**401** | Error response due to missing auth cookie. | - |
648+
649+
[[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)
650+
580651
# **get_instance_vibes**
581652
> list[InstanceVibe] get_instance_vibes()
582653

‎docs/SearchAvatarsMarketplace.md‎

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

‎docs/UpdateInstanceRequest.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**calendar_entry_id** | **str** | |
7+
**calendar_entry_id** | **str** | | [optional]
8+
**display_name** | **str** | | [optional]
89

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

‎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.5
8+
The version of the OpenAPI document: 1.23.1-nightly.6
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.dev5"
16+
VERSION = "1.23.1.dev6"
1717
# To install the library, run the following
1818
#
1919
# python setup.py install

0 commit comments

Comments
 (0)