Skip to content

Commit e2aa4c6

Browse files
VRCCatVRCCat
committed
Upgrade Python SDK to spec 1.17.3
1 parent 1d362a3 commit e2aa4c6

File tree

169 files changed

+1900
-167
lines changed

Some content is hidden

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

169 files changed

+1900
-167
lines changed

‎.openapi-generator/FILES‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ docs/CreateGroupInviteRequest.md
2121
docs/CreateGroupPostRequest.md
2222
docs/CreateGroupRequest.md
2323
docs/CreateGroupRoleRequest.md
24+
docs/CreateInstanceRequest.md
2425
docs/CreateWorldRequest.md
2526
docs/CurrentUser.md
2627
docs/CurrentUserPresence.md
@@ -93,6 +94,11 @@ docs/LimitedWorld.md
9394
docs/MIMEType.md
9495
docs/ModerateUserRequest.md
9596
docs/Notification.md
97+
docs/NotificationDetailInvite.md
98+
docs/NotificationDetailInviteResponse.md
99+
docs/NotificationDetailRequestInvite.md
100+
docs/NotificationDetailRequestInviteResponse.md
101+
docs/NotificationDetailVoteToKick.md
96102
docs/NotificationType.md
97103
docs/NotificationsApi.md
98104
docs/OrderOption.md
@@ -192,6 +198,7 @@ vrchatapi/models/create_group_invite_request.py
192198
vrchatapi/models/create_group_post_request.py
193199
vrchatapi/models/create_group_request.py
194200
vrchatapi/models/create_group_role_request.py
201+
vrchatapi/models/create_instance_request.py
195202
vrchatapi/models/create_world_request.py
196203
vrchatapi/models/current_user.py
197204
vrchatapi/models/current_user_presence.py
@@ -257,6 +264,11 @@ vrchatapi/models/limited_world.py
257264
vrchatapi/models/mime_type.py
258265
vrchatapi/models/moderate_user_request.py
259266
vrchatapi/models/notification.py
267+
vrchatapi/models/notification_detail_invite.py
268+
vrchatapi/models/notification_detail_invite_response.py
269+
vrchatapi/models/notification_detail_request_invite.py
270+
vrchatapi/models/notification_detail_request_invite_response.py
271+
vrchatapi/models/notification_detail_vote_to_kick.py
260272
vrchatapi/models/notification_type.py
261273
vrchatapi/models/order_option.py
262274
vrchatapi/models/paginated_group_audit_log_entry_list.py

‎docs/CreateInstanceRequest.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# CreateInstanceRequest
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**world_id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
8+
**type** | [**InstanceType**](InstanceType.md) | |
9+
**region** | [**Region**](Region.md) | |
10+
**owner_id** | **str** | A groupId if the instance type is \"group\", null if instance type is public, or a userId otherwise | [optional]
11+
**role_ids** | **list[str]** | Group roleIds that are allowed to join if the type is \"group\" and groupAccessType is \"member\" | [optional]
12+
**group_access_type** | [**GroupAccessType**](GroupAccessType.md) | | [optional]
13+
**queue_enabled** | **bool** | | [optional] [default to False]
14+
**closed_at** | **datetime** | The time after which users won't be allowed to join the instance | [optional]
15+
16+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
17+
18+

‎docs/GroupsApi.md‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ Method | HTTP request | Description
4444
[**update_group**](GroupsApi.md#update_group) | **PUT** /groups/{groupId} | Update Group
4545
[**update_group_gallery**](GroupsApi.md#update_group_gallery) | **PUT** /groups/{groupId}/galleries/{groupGalleryId} | Update Group Gallery
4646
[**update_group_member**](GroupsApi.md#update_group_member) | **PUT** /groups/{groupId}/members/{userId} | Update Group Member
47+
[**update_group_post**](GroupsApi.md#update_group_post) | **PUT** /groups/{groupId}/posts/{notificationId} | Edits a Group post
4748
[**update_group_role**](GroupsApi.md#update_group_role) | **PUT** /groups/{groupId}/roles/{groupRoleId} | Update Group Role
4849

4950

@@ -3139,6 +3140,85 @@ Name | Type | Description | Notes
31393140

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

3143+
# **update_group_post**
3144+
> GroupPost update_group_post(group_id, notification_id, create_group_post_request)
3145+
3146+
Edits a Group post
3147+
3148+
Edits a Group post
3149+
3150+
### Example
3151+
3152+
* Api Key Authentication (authCookie):
3153+
```python
3154+
from __future__ import print_function
3155+
import time
3156+
import vrchatapi
3157+
from vrchatapi.rest import ApiException
3158+
from pprint import pprint
3159+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
3160+
# See configuration.py for a list of all supported configuration parameters.
3161+
configuration = vrchatapi.Configuration(
3162+
host = "https://api.vrchat.cloud/api/1"
3163+
)
3164+
3165+
# The client must configure the authentication and authorization parameters
3166+
# in accordance with the API server security policy.
3167+
# Examples for each auth method are provided below, use the example that
3168+
# satisfies your auth use case.
3169+
3170+
# Configure API key authorization: authCookie
3171+
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
3172+
3173+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
3174+
# configuration.api_key_prefix['authCookie'] = 'Bearer'
3175+
3176+
# Enter a context with an instance of the API client
3177+
with vrchatapi.ApiClient(configuration) as api_client:
3178+
# Create an instance of the API class
3179+
api_instance = vrchatapi.GroupsApi(api_client)
3180+
group_id = 'grp_00000000-0000-0000-0000-000000000000' # str | Must be a valid group ID.
3181+
notification_id = 'notification_id_example' # str | Must be a valid notification ID.
3182+
create_group_post_request = vrchatapi.CreateGroupPostRequest() # CreateGroupPostRequest |
3183+
3184+
try:
3185+
# Edits a Group post
3186+
api_response = api_instance.update_group_post(group_id, notification_id, create_group_post_request)
3187+
pprint(api_response)
3188+
except ApiException as e:
3189+
print("Exception when calling GroupsApi->update_group_post: %s\n" % e)
3190+
```
3191+
3192+
### Parameters
3193+
3194+
Name | Type | Description | Notes
3195+
------------- | ------------- | ------------- | -------------
3196+
**group_id** | **str**| Must be a valid group ID. |
3197+
**notification_id** | **str**| Must be a valid notification ID. |
3198+
**create_group_post_request** | [**CreateGroupPostRequest**](CreateGroupPostRequest.md)| |
3199+
3200+
### Return type
3201+
3202+
[**GroupPost**](GroupPost.md)
3203+
3204+
### Authorization
3205+
3206+
[authCookie](../README.md#authCookie)
3207+
3208+
### HTTP request headers
3209+
3210+
- **Content-Type**: application/json
3211+
- **Accept**: application/json
3212+
3213+
### HTTP response details
3214+
| Status code | Description | Response headers |
3215+
|-------------|-------------|------------------|
3216+
**200** | Returns a GroupPost object. | - |
3217+
**401** | Error response due to missing auth cookie. | - |
3218+
**404** | Response after deleting a group post. | - |
3219+
3220+
[[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)
3221+
31423222
# **update_group_role**
31433223
> list[GroupRole] update_group_role(group_id, group_role_id, update_group_role_request=update_group_role_request)
31443224

‎docs/InstancesApi.md‎

Lines changed: 80 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,19 @@ All URIs are relative to *https://api.vrchat.cloud/api/1*
55
Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**close_instance**](InstancesApi.md#close_instance) | **DELETE** /instances/{worldId}:{instanceId} | Close Instance
8+
[**create_instance**](InstancesApi.md#create_instance) | **POST** /instances | Create Instance
89
[**get_instance**](InstancesApi.md#get_instance) | **GET** /instances/{worldId}:{instanceId} | Get Instance
910
[**get_instance_by_short_name**](InstancesApi.md#get_instance_by_short_name) | **GET** /instances/s/{shortName} | Get Instance By Short Name
1011
[**get_short_name**](InstancesApi.md#get_short_name) | **GET** /instances/{worldId}:{instanceId}/shortName | Get Instance Short Name
1112
[**send_self_invite**](InstancesApi.md#send_self_invite) | **POST** /instances/{worldId}:{instanceId}/invite | Send Self Invite
1213

1314

1415
# **close_instance**
15-
> Instance close_instance(world_id, instance_id, hard_close=hard_close)
16+
> Instance close_instance(world_id, instance_id, hard_close=hard_close, closed_at=closed_at)
1617
1718
Close Instance
1819

19-
Close an instance. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-moderate` permission.
20+
Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-moderate` permission.
2021

2122
### Example
2223

@@ -51,10 +52,11 @@ with vrchatapi.ApiClient(configuration) as api_client:
5152
world_id = 'world_id_example' # str | Must be a valid world ID.
5253
instance_id = 'instance_id_example' # str | Must be a valid instance ID.
5354
hard_close = True # bool | Whether to hard close the instance. Defaults to false. (optional)
55+
closed_at = '2013-10-20T19:20:30+01:00' # datetime | The time after which users won't be allowed to join the instances. If omitted, the instance will be closed immediately. (optional)
5456

5557
try:
5658
# Close Instance
57-
api_response = api_instance.close_instance(world_id, instance_id, hard_close=hard_close)
59+
api_response = api_instance.close_instance(world_id, instance_id, hard_close=hard_close, closed_at=closed_at)
5860
pprint(api_response)
5961
except ApiException as e:
6062
print("Exception when calling InstancesApi->close_instance: %s\n" % e)
@@ -67,6 +69,7 @@ Name | Type | Description | Notes
6769
**world_id** | **str**| Must be a valid world ID. |
6870
**instance_id** | **str**| Must be a valid instance ID. |
6971
**hard_close** | **bool**| Whether to hard close the instance. Defaults to false. | [optional]
72+
**closed_at** | **datetime**| The time after which users won't be allowed to join the instances. If omitted, the instance will be closed immediately. | [optional]
7073

7174
### Return type
7275

@@ -91,6 +94,80 @@ Name | Type | Description | Notes
9194

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

97+
# **create_instance**
98+
> Instance create_instance(create_instance_request)
99+
100+
Create Instance
101+
102+
Create an instance
103+
104+
### Example
105+
106+
* Api Key Authentication (authCookie):
107+
```python
108+
from __future__ import print_function
109+
import time
110+
import vrchatapi
111+
from vrchatapi.rest import ApiException
112+
from pprint import pprint
113+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
114+
# See configuration.py for a list of all supported configuration parameters.
115+
configuration = vrchatapi.Configuration(
116+
host = "https://api.vrchat.cloud/api/1"
117+
)
118+
119+
# The client must configure the authentication and authorization parameters
120+
# in accordance with the API server security policy.
121+
# Examples for each auth method are provided below, use the example that
122+
# satisfies your auth use case.
123+
124+
# Configure API key authorization: authCookie
125+
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
126+
127+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
128+
# configuration.api_key_prefix['authCookie'] = 'Bearer'
129+
130+
# Enter a context with an instance of the API client
131+
with vrchatapi.ApiClient(configuration) as api_client:
132+
# Create an instance of the API class
133+
api_instance = vrchatapi.InstancesApi(api_client)
134+
create_instance_request = vrchatapi.CreateInstanceRequest() # CreateInstanceRequest |
135+
136+
try:
137+
# Create Instance
138+
api_response = api_instance.create_instance(create_instance_request)
139+
pprint(api_response)
140+
except ApiException as e:
141+
print("Exception when calling InstancesApi->create_instance: %s\n" % e)
142+
```
143+
144+
### Parameters
145+
146+
Name | Type | Description | Notes
147+
------------- | ------------- | ------------- | -------------
148+
**create_instance_request** | [**CreateInstanceRequest**](CreateInstanceRequest.md)| |
149+
150+
### Return type
151+
152+
[**Instance**](Instance.md)
153+
154+
### Authorization
155+
156+
[authCookie](../README.md#authCookie)
157+
158+
### HTTP request headers
159+
160+
- **Content-Type**: application/json
161+
- **Accept**: application/json
162+
163+
### HTTP response details
164+
| Status code | Description | Response headers |
165+
|-------------|-------------|------------------|
166+
**200** | Returns a single Instance object. | - |
167+
**401** | Error response due to missing auth cookie. | - |
168+
169+
[[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)
170+
94171
# **get_instance**
95172
> Instance get_instance(world_id, instance_id)
96173

‎docs/NotificationDetailInvite.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# NotificationDetailInvite
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**invite_message** | **str** | | [optional]
8+
**world_id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. |
9+
**world_name** | **str** | |
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

‎docs/NotificationDetailInviteResponse.md‎

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

‎docs/NotificationDetailRequestInvite.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# NotificationDetailRequestInvite
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**platform** | **str** | TODO: Does this still exist? | [optional]
8+
**request_message** | **str** | Used when using InviteMessage Slot. | [optional]
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

‎docs/NotificationDetailRequestInviteResponse.md‎

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

‎docs/NotificationDetailVoteToKick.md‎

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

‎docs/UsersApi.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ Name | Type | Description | Notes
236236
[[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)
237237

238238
# **get_user_groups**
239-
> list[Group] get_user_groups(user_id)
239+
> list[LimitedGroup] get_user_groups(user_id)
240240
241241
Get User Groups
242242

@@ -290,7 +290,7 @@ Name | Type | Description | Notes
290290

291291
### Return type
292292

293-
[**list[Group]**](Group.md)
293+
[**list[LimitedGroup]**](LimitedGroup.md)
294294

295295
### Authorization
296296

@@ -304,7 +304,7 @@ Name | Type | Description | Notes
304304
### HTTP response details
305305
| Status code | Description | Response headers |
306306
|-------------|-------------|------------------|
307-
**200** | Returns a list of Group objects. | - |
307+
**200** | Returns a list of LimitedGroup objects. | - |
308308
**401** | Error response due to missing auth cookie. | - |
309309

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

0 commit comments

Comments
 (0)