Upgrade Python SDK to spec 1.17.3

vrchatapi · Apr 29, 2024 · e2aa4c6 · e2aa4c6
1 parent 1d362a3
commit e2aa4c6
Show file tree

Hide file tree

Showing 169 changed files with 1,900 additions and 167 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -21,6 +21,7 @@ docs/CreateGroupInviteRequest.md
 docs/CreateGroupPostRequest.md
 docs/CreateGroupRequest.md
 docs/CreateGroupRoleRequest.md
+docs/CreateInstanceRequest.md
 docs/CreateWorldRequest.md
 docs/CurrentUser.md
 docs/CurrentUserPresence.md
@@ -93,6 +94,11 @@ docs/LimitedWorld.md
 docs/MIMEType.md
 docs/ModerateUserRequest.md
 docs/Notification.md
+docs/NotificationDetailInvite.md
+docs/NotificationDetailInviteResponse.md
+docs/NotificationDetailRequestInvite.md
+docs/NotificationDetailRequestInviteResponse.md
+docs/NotificationDetailVoteToKick.md
 docs/NotificationType.md
 docs/NotificationsApi.md
 docs/OrderOption.md
@@ -192,6 +198,7 @@ vrchatapi/models/create_group_invite_request.py
 vrchatapi/models/create_group_post_request.py
 vrchatapi/models/create_group_request.py
 vrchatapi/models/create_group_role_request.py
+vrchatapi/models/create_instance_request.py
 vrchatapi/models/create_world_request.py
 vrchatapi/models/current_user.py
 vrchatapi/models/current_user_presence.py
@@ -257,6 +264,11 @@ vrchatapi/models/limited_world.py
 vrchatapi/models/mime_type.py
 vrchatapi/models/moderate_user_request.py
 vrchatapi/models/notification.py
+vrchatapi/models/notification_detail_invite.py
+vrchatapi/models/notification_detail_invite_response.py
+vrchatapi/models/notification_detail_request_invite.py
+vrchatapi/models/notification_detail_request_invite_response.py
+vrchatapi/models/notification_detail_vote_to_kick.py
 vrchatapi/models/notification_type.py
 vrchatapi/models/order_option.py
 vrchatapi/models/paginated_group_audit_log_entry_list.py

diff --git a/docs/CreateInstanceRequest.md b/docs/CreateInstanceRequest.md
@@ -0,0 +1,18 @@
+# CreateInstanceRequest
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**world_id** | **str** | WorldID be \&quot;offline\&quot; on User profiles if you are not friends with that user. | 
+**type** | [**InstanceType**](InstanceType.md) |  | 
+**region** | [**Region**](Region.md) |  | 
+**owner_id** | **str** | A groupId if the instance type is \&quot;group\&quot;, null if instance type is public, or a userId otherwise | [optional] 
+**role_ids** | **list[str]** | Group roleIds that are allowed to join if the type is \&quot;group\&quot; and groupAccessType is \&quot;member\&quot; | [optional] 
+**group_access_type** | [**GroupAccessType**](GroupAccessType.md) |  | [optional] 
+**queue_enabled** | **bool** |  | [optional] [default to False]
+**closed_at** | **datetime** | The time after which users won&#39;t be allowed to join the instance | [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)
+
+
diff --git a/docs/GroupsApi.md b/docs/GroupsApi.md
@@ -44,6 +44,7 @@ Method | HTTP request | Description
 [**update_group**](GroupsApi.md#update_group) | **PUT** /groups/{groupId} | Update Group
 [**update_group_gallery**](GroupsApi.md#update_group_gallery) | **PUT** /groups/{groupId}/galleries/{groupGalleryId} | Update Group Gallery
 [**update_group_member**](GroupsApi.md#update_group_member) | **PUT** /groups/{groupId}/members/{userId} | Update Group Member
+[**update_group_post**](GroupsApi.md#update_group_post) | **PUT** /groups/{groupId}/posts/{notificationId} | Edits a Group post
 [**update_group_role**](GroupsApi.md#update_group_role) | **PUT** /groups/{groupId}/roles/{groupRoleId} | Update Group Role
 
 
@@ -3139,6 +3140,85 @@ 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)
 
+# **update_group_post**
+> GroupPost update_group_post(group_id, notification_id, create_group_post_request)
+
+Edits a Group post
+
+Edits a Group post
+
+### Example
+
+* Api Key Authentication (authCookie):
+```python
+from __future__ import print_function
+import time
+import vrchatapi
+from vrchatapi.rest import ApiException
+from pprint import pprint
+# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vrchatapi.Configuration(
+    host = "https://api.vrchat.cloud/api/1"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: authCookie
+configuration.api_key['authCookie'] = 'YOUR_API_KEY'
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['authCookie'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with vrchatapi.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vrchatapi.GroupsApi(api_client)
+    group_id = 'grp_00000000-0000-0000-0000-000000000000' # str | Must be a valid group ID.
+notification_id = 'notification_id_example' # str | Must be a valid notification ID.
+create_group_post_request = vrchatapi.CreateGroupPostRequest() # CreateGroupPostRequest | 
+
+    try:
+        # Edits a Group post
+        api_response = api_instance.update_group_post(group_id, notification_id, create_group_post_request)
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling GroupsApi->update_group_post: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_id** | **str**| Must be a valid group ID. | 
+ **notification_id** | **str**| Must be a valid notification ID. | 
+ **create_group_post_request** | [**CreateGroupPostRequest**](CreateGroupPostRequest.md)|  | 
+
+### Return type
+
+[**GroupPost**](GroupPost.md)
+
+### Authorization
+
+[authCookie](../README.md#authCookie)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Returns a GroupPost object. |  -  |
+**401** | Error response due to missing auth cookie. |  -  |
+**404** | Response after deleting a group post. |  -  |
+
+[[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)
+
 # **update_group_role**
 > list[GroupRole] update_group_role(group_id, group_role_id, update_group_role_request=update_group_role_request)
 

diff --git a/docs/InstancesApi.md b/docs/InstancesApi.md
@@ -5,18 +5,19 @@ All URIs are relative to *https://api.vrchat.cloud/api/1*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**close_instance**](InstancesApi.md#close_instance) | **DELETE** /instances/{worldId}:{instanceId} | Close Instance
+[**create_instance**](InstancesApi.md#create_instance) | **POST** /instances | Create Instance
 [**get_instance**](InstancesApi.md#get_instance) | **GET** /instances/{worldId}:{instanceId} | Get Instance
 [**get_instance_by_short_name**](InstancesApi.md#get_instance_by_short_name) | **GET** /instances/s/{shortName} | Get Instance By Short Name
 [**get_short_name**](InstancesApi.md#get_short_name) | **GET** /instances/{worldId}:{instanceId}/shortName | Get Instance Short Name
 [**send_self_invite**](InstancesApi.md#send_self_invite) | **POST** /instances/{worldId}:{instanceId}/invite | Send Self Invite
 
 
 # **close_instance**
-> Instance close_instance(world_id, instance_id, hard_close=hard_close)
+> Instance close_instance(world_id, instance_id, hard_close=hard_close, closed_at=closed_at)
 
 Close Instance
 
-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.
+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.
 
 ### Example
 
@@ -51,10 +52,11 @@ with vrchatapi.ApiClient(configuration) as api_client:
     world_id = 'world_id_example' # str | Must be a valid world ID.
 instance_id = 'instance_id_example' # str | Must be a valid instance ID.
 hard_close = True # bool | Whether to hard close the instance. Defaults to false. (optional)
+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)
 
     try:
         # Close Instance
-        api_response = api_instance.close_instance(world_id, instance_id, hard_close=hard_close)
+        api_response = api_instance.close_instance(world_id, instance_id, hard_close=hard_close, closed_at=closed_at)
         pprint(api_response)
     except ApiException as e:
         print("Exception when calling InstancesApi->close_instance: %s\n" % e)
@@ -67,6 +69,7 @@ Name | Type | Description  | Notes
  **world_id** | **str**| Must be a valid world ID. | 
  **instance_id** | **str**| Must be a valid instance ID. | 
  **hard_close** | **bool**| Whether to hard close the instance. Defaults to false. | [optional] 
+ **closed_at** | **datetime**| The time after which users won&#39;t be allowed to join the instances. If omitted, the instance will be closed immediately. | [optional] 
 
 ### Return type
 
@@ -91,6 +94,80 @@ 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)
 
+# **create_instance**
+> Instance create_instance(create_instance_request)
+
+Create Instance
+
+Create an instance
+
+### Example
+
+* Api Key Authentication (authCookie):
+```python
+from __future__ import print_function
+import time
+import vrchatapi
+from vrchatapi.rest import ApiException
+from pprint import pprint
+# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vrchatapi.Configuration(
+    host = "https://api.vrchat.cloud/api/1"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: authCookie
+configuration.api_key['authCookie'] = 'YOUR_API_KEY'
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['authCookie'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with vrchatapi.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vrchatapi.InstancesApi(api_client)
+    create_instance_request = vrchatapi.CreateInstanceRequest() # CreateInstanceRequest | 
+
+    try:
+        # Create Instance
+        api_response = api_instance.create_instance(create_instance_request)
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling InstancesApi->create_instance: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_instance_request** | [**CreateInstanceRequest**](CreateInstanceRequest.md)|  | 
+
+### Return type
+
+[**Instance**](Instance.md)
+
+### Authorization
+
+[authCookie](../README.md#authCookie)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Returns a single Instance object. |  -  |
+**401** | Error response due to missing auth cookie. |  -  |
+
+[[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)
+
 # **get_instance**
 > Instance get_instance(world_id, instance_id)
 

diff --git a/docs/NotificationDetailInvite.md b/docs/NotificationDetailInvite.md
@@ -0,0 +1,13 @@
+# NotificationDetailInvite
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**invite_message** | **str** |  | [optional] 
+**world_id** | **str** | WorldID be \&quot;offline\&quot; on User profiles if you are not friends with that user. | 
+**world_name** | **str** |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/NotificationDetailInviteResponse.md b/docs/NotificationDetailInviteResponse.md
@@ -0,0 +1,12 @@
+# NotificationDetailInviteResponse
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**in_response_to** | **str** |  | 
+**response_message** | **str** |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/NotificationDetailRequestInvite.md b/docs/NotificationDetailRequestInvite.md
@@ -0,0 +1,12 @@
+# NotificationDetailRequestInvite
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**platform** | **str** | TODO: Does this still exist? | [optional] 
+**request_message** | **str** | Used when using InviteMessage Slot. | [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)
+
+
diff --git a/docs/NotificationDetailRequestInviteResponse.md b/docs/NotificationDetailRequestInviteResponse.md
@@ -0,0 +1,12 @@
+# NotificationDetailRequestInviteResponse
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**in_response_to** | **str** |  | 
+**request_message** | **str** | Used when using InviteMessage Slot. | [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)
+
+
diff --git a/docs/NotificationDetailVoteToKick.md b/docs/NotificationDetailVoteToKick.md
@@ -0,0 +1,12 @@
+# NotificationDetailVoteToKick
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**initiator_user_id** | **str** | A users unique ID, usually in the form of &#x60;usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469&#x60;. Legacy players can have old IDs in the form of &#x60;8JoV9XEdpo&#x60;. The ID can never be changed. | 
+**user_to_kick_id** | **str** | A users unique ID, usually in the form of &#x60;usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469&#x60;. Legacy players can have old IDs in the form of &#x60;8JoV9XEdpo&#x60;. The ID can never be changed. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/UsersApi.md b/docs/UsersApi.md
@@ -236,7 +236,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)
 
 # **get_user_groups**
-> list[Group] get_user_groups(user_id)
+> list[LimitedGroup] get_user_groups(user_id)
 
 Get User Groups
 
@@ -290,7 +290,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**list[Group]**](Group.md)
+[**list[LimitedGroup]**](LimitedGroup.md)
 
 ### Authorization
 
@@ -304,7 +304,7 @@ Name | Type | Description  | Notes
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-**200** | Returns a list of Group objects. |  -  |
+**200** | Returns a list of LimitedGroup objects. |  -  |
 **401** | Error response due to missing auth cookie. |  -  |
 
 [[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)

diff --git a/setup.py b/setup.py
@@ -83,7 +83,7 @@
 
 Join the [Discord server](https://discord.gg/Ge2APMhPfD) to get in touch with us.
 
-    The version of the OpenAPI document: 1.17.2
+    The version of the OpenAPI document: 1.17.3
     Contact: vrchatapi.lpv0t@aries.fyi
     Generated by: https://openapi-generator.tech
 """
@@ -92,7 +92,7 @@
 from setuptools import setup, find_packages  # noqa: H301
 
 NAME = "vrchatapi"
-VERSION = "1.17.2"
+VERSION = "1.17.3"
 # To install the library, run the following
 #
 # python setup.py install