Skip to content

Commit 1d362a3

Browse files
committed
Upgrade Python SDK to spec 1.17.2
1 parent 89e697b commit 1d362a3

File tree

160 files changed

+1763
-185
lines changed

Some content is hidden

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

160 files changed

+1763
-185
lines changed

.openapi-generator/FILES

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ docs/CreateFileVersionRequest.md
1818
docs/CreateGroupAnnouncementRequest.md
1919
docs/CreateGroupGalleryRequest.md
2020
docs/CreateGroupInviteRequest.md
21+
docs/CreateGroupPostRequest.md
2122
docs/CreateGroupRequest.md
2223
docs/CreateGroupRoleRequest.md
2324
docs/CreateWorldRequest.md
@@ -58,6 +59,8 @@ docs/GroupMemberLimitedUser.md
5859
docs/GroupMemberStatus.md
5960
docs/GroupMyMember.md
6061
docs/GroupPermission.md
62+
docs/GroupPost.md
63+
docs/GroupPostVisibility.md
6164
docs/GroupPrivacy.md
6265
docs/GroupRole.md
6366
docs/GroupRoleTemplate.md
@@ -186,6 +189,7 @@ vrchatapi/models/create_file_version_request.py
186189
vrchatapi/models/create_group_announcement_request.py
187190
vrchatapi/models/create_group_gallery_request.py
188191
vrchatapi/models/create_group_invite_request.py
192+
vrchatapi/models/create_group_post_request.py
189193
vrchatapi/models/create_group_request.py
190194
vrchatapi/models/create_group_role_request.py
191195
vrchatapi/models/create_world_request.py
@@ -222,6 +226,8 @@ vrchatapi/models/group_member_limited_user.py
222226
vrchatapi/models/group_member_status.py
223227
vrchatapi/models/group_my_member.py
224228
vrchatapi/models/group_permission.py
229+
vrchatapi/models/group_post.py
230+
vrchatapi/models/group_post_visibility.py
225231
vrchatapi/models/group_privacy.py
226232
vrchatapi/models/group_role.py
227233
vrchatapi/models/group_role_template.py

docs/CreateGroupPostRequest.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# CreateGroupPostRequest
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**title** | **str** | Post title |
8+
**text** | **str** | Post text |
9+
**image_id** | **str** | | [optional]
10+
**send_notification** | **bool** | Send notification to group members. | [default to False]
11+
**role_ids** | **list[str]** | | [optional]
12+
**visibility** | [**GroupPostVisibility**](GroupPostVisibility.md) | |
13+
14+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15+
16+

docs/GroupPost.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# GroupPost
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **str** | | [optional]
8+
**group_id** | **str** | | [optional]
9+
**author_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]
10+
**editor_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]
11+
**visibility** | [**GroupPostVisibility**](GroupPostVisibility.md) | | [optional]
12+
**role_id** | **list[str]** | | [optional]
13+
**title** | **str** | | [optional]
14+
**text** | **str** | | [optional]
15+
**image_id** | **str** | | [optional]
16+
**image_url** | **str** | | [optional]
17+
**created_at** | **datetime** | | [optional]
18+
**updated_at** | **datetime** | | [optional]
19+
20+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
21+
22+

docs/GroupPostVisibility.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# GroupPostVisibility
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/GroupsApi.md

Lines changed: 237 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**add_group_gallery_image**](GroupsApi.md#add_group_gallery_image) | **POST** /groups/{groupId}/galleries/{groupGalleryId}/images | Add Group Gallery Image
88
[**add_group_member_role**](GroupsApi.md#add_group_member_role) | **PUT** /groups/{groupId}/members/{userId}/roles/{groupRoleId} | Add Role to GroupMember
9+
[**add_group_post**](GroupsApi.md#add_group_post) | **POST** /groups/{groupId}/posts | Create a post in a Group
910
[**ban_group_member**](GroupsApi.md#ban_group_member) | **POST** /groups/{groupId}/bans | Ban Group Member
1011
[**cancel_group_request**](GroupsApi.md#cancel_group_request) | **DELETE** /groups/{groupId}/requests | Cancel Group Join Request
1112
[**create_group**](GroupsApi.md#create_group) | **POST** /groups | Create Group
@@ -18,6 +19,7 @@ Method | HTTP request | Description
1819
[**delete_group_gallery**](GroupsApi.md#delete_group_gallery) | **DELETE** /groups/{groupId}/galleries/{groupGalleryId} | Delete Group Gallery
1920
[**delete_group_gallery_image**](GroupsApi.md#delete_group_gallery_image) | **DELETE** /groups/{groupId}/galleries/{groupGalleryId}/images/{groupGalleryImageId} | Delete Group Gallery Image
2021
[**delete_group_invite**](GroupsApi.md#delete_group_invite) | **DELETE** /groups/{groupId}/invites/{userId} | Delete User Invite
22+
[**delete_group_post**](GroupsApi.md#delete_group_post) | **DELETE** /groups/{groupId}/posts/{notificationId} | Delete a Group post
2123
[**delete_group_role**](GroupsApi.md#delete_group_role) | **DELETE** /groups/{groupId}/roles/{groupRoleId} | Delete Group Role
2224
[**get_group**](GroupsApi.md#get_group) | **GET** /groups/{groupId} | Get Group by ID
2325
[**get_group_announcements**](GroupsApi.md#get_group_announcements) | **GET** /groups/{groupId}/announcement | Get Group Announcement
@@ -29,6 +31,7 @@ Method | HTTP request | Description
2931
[**get_group_member**](GroupsApi.md#get_group_member) | **GET** /groups/{groupId}/members/{userId} | Get Group Member
3032
[**get_group_members**](GroupsApi.md#get_group_members) | **GET** /groups/{groupId}/members | List Group Members
3133
[**get_group_permissions**](GroupsApi.md#get_group_permissions) | **GET** /groups/{groupId}/permissions | List Group Permissions
34+
[**get_group_post**](GroupsApi.md#get_group_post) | **GET** /groups/{groupId}/posts | Get posts from a Group
3235
[**get_group_requests**](GroupsApi.md#get_group_requests) | **GET** /groups/{groupId}/requests | Get Group Join Requests
3336
[**get_group_roles**](GroupsApi.md#get_group_roles) | **GET** /groups/{groupId}/roles | Get Group Roles
3437
[**join_group**](GroupsApi.md#join_group) | **POST** /groups/{groupId}/join | Join Group
@@ -202,6 +205,82 @@ Name | Type | Description | Notes
202205

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

208+
# **add_group_post**
209+
> GroupPost add_group_post(group_id, create_group_post_request)
210+
211+
Create a post in a Group
212+
213+
Create a post in a Group.
214+
215+
### Example
216+
217+
* Api Key Authentication (authCookie):
218+
```python
219+
from __future__ import print_function
220+
import time
221+
import vrchatapi
222+
from vrchatapi.rest import ApiException
223+
from pprint import pprint
224+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
225+
# See configuration.py for a list of all supported configuration parameters.
226+
configuration = vrchatapi.Configuration(
227+
host = "https://api.vrchat.cloud/api/1"
228+
)
229+
230+
# The client must configure the authentication and authorization parameters
231+
# in accordance with the API server security policy.
232+
# Examples for each auth method are provided below, use the example that
233+
# satisfies your auth use case.
234+
235+
# Configure API key authorization: authCookie
236+
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
237+
238+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
239+
# configuration.api_key_prefix['authCookie'] = 'Bearer'
240+
241+
# Enter a context with an instance of the API client
242+
with vrchatapi.ApiClient(configuration) as api_client:
243+
# Create an instance of the API class
244+
api_instance = vrchatapi.GroupsApi(api_client)
245+
group_id = 'grp_00000000-0000-0000-0000-000000000000' # str | Must be a valid group ID.
246+
create_group_post_request = vrchatapi.CreateGroupPostRequest() # CreateGroupPostRequest |
247+
248+
try:
249+
# Create a post in a Group
250+
api_response = api_instance.add_group_post(group_id, create_group_post_request)
251+
pprint(api_response)
252+
except ApiException as e:
253+
print("Exception when calling GroupsApi->add_group_post: %s\n" % e)
254+
```
255+
256+
### Parameters
257+
258+
Name | Type | Description | Notes
259+
------------- | ------------- | ------------- | -------------
260+
**group_id** | **str**| Must be a valid group ID. |
261+
**create_group_post_request** | [**CreateGroupPostRequest**](CreateGroupPostRequest.md)| |
262+
263+
### Return type
264+
265+
[**GroupPost**](GroupPost.md)
266+
267+
### Authorization
268+
269+
[authCookie](../README.md#authCookie)
270+
271+
### HTTP request headers
272+
273+
- **Content-Type**: application/json
274+
- **Accept**: application/json
275+
276+
### HTTP response details
277+
| Status code | Description | Response headers |
278+
|-------------|-------------|------------------|
279+
**200** | Returns a GroupPost object. | - |
280+
**401** | Error response due to missing auth cookie. | - |
281+
282+
[[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)
283+
205284
# **ban_group_member**
206285
> GroupMember ban_group_member(group_id, ban_group_member_request)
207286
@@ -1116,7 +1195,85 @@ void (empty response body)
11161195
| Status code | Description | Response headers |
11171196
|-------------|-------------|------------------|
11181197
**200** | OK | - |
1198+
**400** | Bad request error response when deleting a group invite | - |
1199+
**401** | Error response due to missing auth cookie. | - |
1200+
1201+
[[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)
1202+
1203+
# **delete_group_post**
1204+
> Success delete_group_post(group_id, notification_id)
1205+
1206+
Delete a Group post
1207+
1208+
Delete a Group post
1209+
1210+
### Example
1211+
1212+
* Api Key Authentication (authCookie):
1213+
```python
1214+
from __future__ import print_function
1215+
import time
1216+
import vrchatapi
1217+
from vrchatapi.rest import ApiException
1218+
from pprint import pprint
1219+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
1220+
# See configuration.py for a list of all supported configuration parameters.
1221+
configuration = vrchatapi.Configuration(
1222+
host = "https://api.vrchat.cloud/api/1"
1223+
)
1224+
1225+
# The client must configure the authentication and authorization parameters
1226+
# in accordance with the API server security policy.
1227+
# Examples for each auth method are provided below, use the example that
1228+
# satisfies your auth use case.
1229+
1230+
# Configure API key authorization: authCookie
1231+
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
1232+
1233+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1234+
# configuration.api_key_prefix['authCookie'] = 'Bearer'
1235+
1236+
# Enter a context with an instance of the API client
1237+
with vrchatapi.ApiClient(configuration) as api_client:
1238+
# Create an instance of the API class
1239+
api_instance = vrchatapi.GroupsApi(api_client)
1240+
group_id = 'grp_00000000-0000-0000-0000-000000000000' # str | Must be a valid group ID.
1241+
notification_id = 'notification_id_example' # str | Must be a valid notification ID.
1242+
1243+
try:
1244+
# Delete a Group post
1245+
api_response = api_instance.delete_group_post(group_id, notification_id)
1246+
pprint(api_response)
1247+
except ApiException as e:
1248+
print("Exception when calling GroupsApi->delete_group_post: %s\n" % e)
1249+
```
1250+
1251+
### Parameters
1252+
1253+
Name | Type | Description | Notes
1254+
------------- | ------------- | ------------- | -------------
1255+
**group_id** | **str**| Must be a valid group ID. |
1256+
**notification_id** | **str**| Must be a valid notification ID. |
1257+
1258+
### Return type
1259+
1260+
[**Success**](Success.md)
1261+
1262+
### Authorization
1263+
1264+
[authCookie](../README.md#authCookie)
1265+
1266+
### HTTP request headers
1267+
1268+
- **Content-Type**: Not defined
1269+
- **Accept**: application/json
1270+
1271+
### HTTP response details
1272+
| Status code | Description | Response headers |
1273+
|-------------|-------------|------------------|
1274+
**200** | Response after deleting a group post. | - |
11191275
**401** | Error response due to missing auth cookie. | - |
1276+
**404** | Response after deleting a group post. | - |
11201277

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

@@ -1984,6 +2141,86 @@ Name | Type | Description | Notes
19842141

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

2144+
# **get_group_post**
2145+
> GroupPost get_group_post(group_id, n=n, offset=offset, public_only=public_only)
2146+
2147+
Get posts from a Group
2148+
2149+
Get posts from a Group
2150+
2151+
### Example
2152+
2153+
* Api Key Authentication (authCookie):
2154+
```python
2155+
from __future__ import print_function
2156+
import time
2157+
import vrchatapi
2158+
from vrchatapi.rest import ApiException
2159+
from pprint import pprint
2160+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
2161+
# See configuration.py for a list of all supported configuration parameters.
2162+
configuration = vrchatapi.Configuration(
2163+
host = "https://api.vrchat.cloud/api/1"
2164+
)
2165+
2166+
# The client must configure the authentication and authorization parameters
2167+
# in accordance with the API server security policy.
2168+
# Examples for each auth method are provided below, use the example that
2169+
# satisfies your auth use case.
2170+
2171+
# Configure API key authorization: authCookie
2172+
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
2173+
2174+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
2175+
# configuration.api_key_prefix['authCookie'] = 'Bearer'
2176+
2177+
# Enter a context with an instance of the API client
2178+
with vrchatapi.ApiClient(configuration) as api_client:
2179+
# Create an instance of the API class
2180+
api_instance = vrchatapi.GroupsApi(api_client)
2181+
group_id = 'grp_00000000-0000-0000-0000-000000000000' # str | Must be a valid group ID.
2182+
n = 60 # int | The number of objects to return. (optional) (default to 60)
2183+
offset = 56 # int | A zero-based offset from the default object sorting from where search results start. (optional)
2184+
public_only = True # bool | See public posts only. (optional)
2185+
2186+
try:
2187+
# Get posts from a Group
2188+
api_response = api_instance.get_group_post(group_id, n=n, offset=offset, public_only=public_only)
2189+
pprint(api_response)
2190+
except ApiException as e:
2191+
print("Exception when calling GroupsApi->get_group_post: %s\n" % e)
2192+
```
2193+
2194+
### Parameters
2195+
2196+
Name | Type | Description | Notes
2197+
------------- | ------------- | ------------- | -------------
2198+
**group_id** | **str**| Must be a valid group ID. |
2199+
**n** | **int**| The number of objects to return. | [optional] [default to 60]
2200+
**offset** | **int**| A zero-based offset from the default object sorting from where search results start. | [optional]
2201+
**public_only** | **bool**| See public posts only. | [optional]
2202+
2203+
### Return type
2204+
2205+
[**GroupPost**](GroupPost.md)
2206+
2207+
### Authorization
2208+
2209+
[authCookie](../README.md#authCookie)
2210+
2211+
### HTTP request headers
2212+
2213+
- **Content-Type**: Not defined
2214+
- **Accept**: application/json
2215+
2216+
### HTTP response details
2217+
| Status code | Description | Response headers |
2218+
|-------------|-------------|------------------|
2219+
**200** | Returns a GroupPost object. | - |
2220+
**401** | Error response due to missing auth cookie. | - |
2221+
2222+
[[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)
2223+
19872224
# **get_group_requests**
19882225
> list[GroupMember] get_group_requests(group_id, n=n, offset=offset)
19892226

0 commit comments

Comments
 (0)