Skip to content

Commit 89e697b

Browse files
committed
Upgrade Python SDK to spec 1.17.1
1 parent 06b44f5 commit 89e697b

File tree

155 files changed

+692
-161
lines changed

Some content is hidden

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

155 files changed

+692
-161
lines changed

.openapi-generator/FILES

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ docs/GroupAnnouncement.md
4949
docs/GroupAuditLogEntry.md
5050
docs/GroupGallery.md
5151
docs/GroupGalleryImage.md
52+
docs/GroupInstance.md
5253
docs/GroupJoinRequestAction.md
5354
docs/GroupJoinState.md
5455
docs/GroupLimitedMember.md
@@ -212,6 +213,7 @@ vrchatapi/models/group_announcement.py
212213
vrchatapi/models/group_audit_log_entry.py
213214
vrchatapi/models/group_gallery.py
214215
vrchatapi/models/group_gallery_image.py
216+
vrchatapi/models/group_instance.py
215217
vrchatapi/models/group_join_request_action.py
216218
vrchatapi/models/group_join_state.py
217219
vrchatapi/models/group_limited_member.py

docs/GroupInstance.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# GroupInstance
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**instance_id** | **str** | |
8+
**location** | **str** | InstanceID can be \"offline\" on User profiles if you are not friends with that user and \"private\" if you are friends and user is in private instance. |
9+
**world** | [**World**](World.md) | |
10+
**member_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/GroupsApi.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Method | HTTP request | Description
2424
[**get_group_audit_logs**](GroupsApi.md#get_group_audit_logs) | **GET** /groups/{groupId}/auditLogs | Get Group Audit Logs
2525
[**get_group_bans**](GroupsApi.md#get_group_bans) | **GET** /groups/{groupId}/bans | Get Group Bans
2626
[**get_group_gallery_images**](GroupsApi.md#get_group_gallery_images) | **GET** /groups/{groupId}/galleries/{groupGalleryId} | Get Group Gallery Images
27+
[**get_group_instances**](GroupsApi.md#get_group_instances) | **GET** /groups/{groupId}/instances | Get Group Instances
2728
[**get_group_invites**](GroupsApi.md#get_group_invites) | **GET** /groups/{groupId}/invites | Get Group Invites Sent
2829
[**get_group_member**](GroupsApi.md#get_group_member) | **GET** /groups/{groupId}/members/{userId} | Get Group Member
2930
[**get_group_members**](GroupsApi.md#get_group_members) | **GET** /groups/{groupId}/members | List Group Members
@@ -273,6 +274,7 @@ Name | Type | Description | Notes
273274
| Status code | Description | Response headers |
274275
|-------------|-------------|------------------|
275276
**200** | Returns a list of GroupMember objects. | - |
277+
**400** | Bad request error response when banning a user | - |
276278
**401** | Error response due to missing auth cookie. | - |
277279
**404** | Error response when trying to perform operations on a non-existing group. | - |
278280

@@ -1592,6 +1594,81 @@ Name | Type | Description | Notes
15921594

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

1597+
# **get_group_instances**
1598+
> list[GroupInstance] get_group_instances(group_id)
1599+
1600+
Get Group Instances
1601+
1602+
Returns a list of group instances
1603+
1604+
### Example
1605+
1606+
* Api Key Authentication (authCookie):
1607+
```python
1608+
from __future__ import print_function
1609+
import time
1610+
import vrchatapi
1611+
from vrchatapi.rest import ApiException
1612+
from pprint import pprint
1613+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
1614+
# See configuration.py for a list of all supported configuration parameters.
1615+
configuration = vrchatapi.Configuration(
1616+
host = "https://api.vrchat.cloud/api/1"
1617+
)
1618+
1619+
# The client must configure the authentication and authorization parameters
1620+
# in accordance with the API server security policy.
1621+
# Examples for each auth method are provided below, use the example that
1622+
# satisfies your auth use case.
1623+
1624+
# Configure API key authorization: authCookie
1625+
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
1626+
1627+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1628+
# configuration.api_key_prefix['authCookie'] = 'Bearer'
1629+
1630+
# Enter a context with an instance of the API client
1631+
with vrchatapi.ApiClient(configuration) as api_client:
1632+
# Create an instance of the API class
1633+
api_instance = vrchatapi.GroupsApi(api_client)
1634+
group_id = 'grp_00000000-0000-0000-0000-000000000000' # str | Must be a valid group ID.
1635+
1636+
try:
1637+
# Get Group Instances
1638+
api_response = api_instance.get_group_instances(group_id)
1639+
pprint(api_response)
1640+
except ApiException as e:
1641+
print("Exception when calling GroupsApi->get_group_instances: %s\n" % e)
1642+
```
1643+
1644+
### Parameters
1645+
1646+
Name | Type | Description | Notes
1647+
------------- | ------------- | ------------- | -------------
1648+
**group_id** | **str**| Must be a valid group ID. |
1649+
1650+
### Return type
1651+
1652+
[**list[GroupInstance]**](GroupInstance.md)
1653+
1654+
### Authorization
1655+
1656+
[authCookie](../README.md#authCookie)
1657+
1658+
### HTTP request headers
1659+
1660+
- **Content-Type**: Not defined
1661+
- **Accept**: application/json
1662+
1663+
### HTTP response details
1664+
| Status code | Description | Response headers |
1665+
|-------------|-------------|------------------|
1666+
**200** | Returns a list of GroupInstance objects. | - |
1667+
**401** | Error response due to missing auth cookie. | - |
1668+
**404** | Error response when trying to perform operations on a non-existing group. | - |
1669+
1670+
[[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)
1671+
15951672
# **get_group_invites**
15961673
> list[GroupMember] get_group_invites(group_id, n=n, offset=offset)
15971674

package-lock.json

Lines changed: 83 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"dependencies": {
3-
"@openapitools/openapi-generator-cli": "^2.13.1"
3+
"@openapitools/openapi-generator-cli": "^2.13.2"
44
}
55
}

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383
8484
Join the [Discord server](https://discord.gg/Ge2APMhPfD) to get in touch with us.
8585
86-
The version of the OpenAPI document: 1.17.0
86+
The version of the OpenAPI document: 1.17.1
8787
Contact: vrchatapi.lpv0t@aries.fyi
8888
Generated by: https://openapi-generator.tech
8989
"""
@@ -92,7 +92,7 @@
9292
from setuptools import setup, find_packages # noqa: H301
9393

9494
NAME = "vrchatapi"
95-
VERSION = "1.17.0"
95+
VERSION = "1.17.1"
9696
# To install the library, run the following
9797
#
9898
# python setup.py install

vrchatapi/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
VRChat API Documentation
77
88
9-
The version of the OpenAPI document: 1.17.0
9+
The version of the OpenAPI document: 1.17.1
1010
Contact: vrchatapi.lpv0t@aries.fyi
1111
Generated by: https://openapi-generator.tech
1212
"""
@@ -87,6 +87,7 @@
8787
from vrchatapi.models.group_audit_log_entry import GroupAuditLogEntry
8888
from vrchatapi.models.group_gallery import GroupGallery
8989
from vrchatapi.models.group_gallery_image import GroupGalleryImage
90+
from vrchatapi.models.group_instance import GroupInstance
9091
from vrchatapi.models.group_join_request_action import GroupJoinRequestAction
9192
from vrchatapi.models.group_join_state import GroupJoinState
9293
from vrchatapi.models.group_limited_member import GroupLimitedMember

vrchatapi/api/authentication_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
VRChat API Documentation
55
66
7-
The version of the OpenAPI document: 1.17.0
7+
The version of the OpenAPI document: 1.17.1
88
Contact: vrchatapi.lpv0t@aries.fyi
99
Generated by: https://openapi-generator.tech
1010
"""

vrchatapi/api/avatars_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
VRChat API Documentation
55
66
7-
The version of the OpenAPI document: 1.17.0
7+
The version of the OpenAPI document: 1.17.1
88
Contact: vrchatapi.lpv0t@aries.fyi
99
Generated by: https://openapi-generator.tech
1010
"""

vrchatapi/api/economy_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
VRChat API Documentation
55
66
7-
The version of the OpenAPI document: 1.17.0
7+
The version of the OpenAPI document: 1.17.1
88
Contact: vrchatapi.lpv0t@aries.fyi
99
Generated by: https://openapi-generator.tech
1010
"""

0 commit comments

Comments
 (0)