Skip to content

Commit 2ca4598

Browse files
FoorackFoorack
committed
Upgrade Python SDK to spec 1.3.0
1 parent 46b20da commit 2ca4598

96 files changed

Lines changed: 727 additions & 107 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.

‎docs/InviteApi.md‎

Lines changed: 258 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**get_invite_message**](InviteApi.md#get_invite_message) | **GET** /message/{userId}/message/{messageId} | Get Invite Messages
88
[**get_invite_messages**](InviteApi.md#get_invite_messages) | **GET** /message/{userId}/message | List Invite Messages
9+
[**invite_user**](InviteApi.md#invite_user) | **POST** /invite/{userId} | Invite User
10+
[**request_invite**](InviteApi.md#request_invite) | **POST** /requestInvite/{userId} | Request Invite
911
[**reset_invite_message**](InviteApi.md#reset_invite_message) | **DELETE** /message/{userId}/message/{messageId} | Reset Invite Message
12+
[**respond_invite**](InviteApi.md#respond_invite) | **POST** /invite/{notificationId}/response | Respond Invite
1013
[**update_invite_message**](InviteApi.md#update_invite_message) | **PUT** /message/{userId}/message/{messageId} | Update Invite Message
1114

1215

@@ -184,6 +187,176 @@ Name | Type | Description | Notes
184187

185188
[[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)
186189

190+
# **invite_user**
191+
> Notification invite_user(user_id)
192+
193+
Invite User
194+
195+
Sends an invite to a user. Returns the Notification of type `invite` that was sent.
196+
197+
### Example
198+
199+
* Api Key Authentication (apiKeyCookie):
200+
* Api Key Authentication (authCookie):
201+
```python
202+
import time
203+
import vrchatapi
204+
from vrchatapi.api import invite_api
205+
from vrchatapi.model.notification import Notification
206+
from vrchatapi.model.inline_response400 import InlineResponse400
207+
from pprint import pprint
208+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
209+
# See configuration.py for a list of all supported configuration parameters.
210+
configuration = vrchatapi.Configuration(
211+
host = "https://api.vrchat.cloud/api/1"
212+
)
213+
214+
# The client must configure the authentication and authorization parameters
215+
# in accordance with the API server security policy.
216+
# Examples for each auth method are provided below, use the example that
217+
# satisfies your auth use case.
218+
219+
# Configure API key authorization: apiKeyCookie
220+
configuration.api_key['apiKeyCookie'] = 'YOUR_API_KEY'
221+
222+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
223+
# configuration.api_key_prefix['apiKeyCookie'] = 'Bearer'
224+
225+
# Configure API key authorization: authCookie
226+
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
227+
228+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
229+
# configuration.api_key_prefix['authCookie'] = 'Bearer'
230+
231+
# Enter a context with an instance of the API client
232+
with vrchatapi.ApiClient(configuration) as api_client:
233+
# Create an instance of the API class
234+
api_instance = invite_api.InviteApi(api_client)
235+
user_id = "userId_example" # str |
236+
237+
# example passing only required values which don't have defaults set
238+
try:
239+
# Invite User
240+
api_response = api_instance.invite_user(user_id)
241+
pprint(api_response)
242+
except vrchatapi.ApiException as e:
243+
print("Exception when calling InviteApi->invite_user: %s\n" % e)
244+
```
245+
246+
247+
### Parameters
248+
249+
Name | Type | Description | Notes
250+
------------- | ------------- | ------------- | -------------
251+
**user_id** | **str**| |
252+
253+
### Return type
254+
255+
[**Notification**](Notification.md)
256+
257+
### Authorization
258+
259+
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
260+
261+
### HTTP request headers
262+
263+
- **Content-Type**: Not defined
264+
- **Accept**: application/json
265+
266+
267+
### HTTP response details
268+
| Status code | Description | Response headers |
269+
|-------------|-------------|------------------|
270+
**200** | Returns a single Notifcation object. | - |
271+
**403** | Error response when trying to invite someome whom you are not friends with. | - |
272+
273+
[[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)
274+
275+
# **request_invite**
276+
> Notification request_invite(user_id)
277+
278+
Request Invite
279+
280+
Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
281+
282+
### Example
283+
284+
* Api Key Authentication (apiKeyCookie):
285+
* Api Key Authentication (authCookie):
286+
```python
287+
import time
288+
import vrchatapi
289+
from vrchatapi.api import invite_api
290+
from vrchatapi.model.notification import Notification
291+
from vrchatapi.model.inline_response400 import InlineResponse400
292+
from pprint import pprint
293+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
294+
# See configuration.py for a list of all supported configuration parameters.
295+
configuration = vrchatapi.Configuration(
296+
host = "https://api.vrchat.cloud/api/1"
297+
)
298+
299+
# The client must configure the authentication and authorization parameters
300+
# in accordance with the API server security policy.
301+
# Examples for each auth method are provided below, use the example that
302+
# satisfies your auth use case.
303+
304+
# Configure API key authorization: apiKeyCookie
305+
configuration.api_key['apiKeyCookie'] = 'YOUR_API_KEY'
306+
307+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
308+
# configuration.api_key_prefix['apiKeyCookie'] = 'Bearer'
309+
310+
# Configure API key authorization: authCookie
311+
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
312+
313+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
314+
# configuration.api_key_prefix['authCookie'] = 'Bearer'
315+
316+
# Enter a context with an instance of the API client
317+
with vrchatapi.ApiClient(configuration) as api_client:
318+
# Create an instance of the API class
319+
api_instance = invite_api.InviteApi(api_client)
320+
user_id = "userId_example" # str |
321+
322+
# example passing only required values which don't have defaults set
323+
try:
324+
# Request Invite
325+
api_response = api_instance.request_invite(user_id)
326+
pprint(api_response)
327+
except vrchatapi.ApiException as e:
328+
print("Exception when calling InviteApi->request_invite: %s\n" % e)
329+
```
330+
331+
332+
### Parameters
333+
334+
Name | Type | Description | Notes
335+
------------- | ------------- | ------------- | -------------
336+
**user_id** | **str**| |
337+
338+
### Return type
339+
340+
[**Notification**](Notification.md)
341+
342+
### Authorization
343+
344+
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
345+
346+
### HTTP request headers
347+
348+
- **Content-Type**: Not defined
349+
- **Accept**: application/json
350+
351+
352+
### HTTP response details
353+
| Status code | Description | Response headers |
354+
|-------------|-------------|------------------|
355+
**200** | Returns a single Notifcation object. | - |
356+
**403** | Error response when trying to invite someome whom you are not friends with. | - |
357+
358+
[[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)
359+
187360
# **reset_invite_message**
188361
> [InviteMessage] reset_invite_message(user_id, message_id)
189362
@@ -273,6 +446,91 @@ Name | Type | Description | Notes
273446

274447
[[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)
275448

449+
# **respond_invite**
450+
> Notification respond_invite(notification_id)
451+
452+
Respond Invite
453+
454+
Sends a world invite to a user.
455+
456+
### Example
457+
458+
* Api Key Authentication (apiKeyCookie):
459+
* Api Key Authentication (authCookie):
460+
```python
461+
import time
462+
import vrchatapi
463+
from vrchatapi.api import invite_api
464+
from vrchatapi.model.notification import Notification
465+
from vrchatapi.model.inline_response400 import InlineResponse400
466+
from pprint import pprint
467+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
468+
# See configuration.py for a list of all supported configuration parameters.
469+
configuration = vrchatapi.Configuration(
470+
host = "https://api.vrchat.cloud/api/1"
471+
)
472+
473+
# The client must configure the authentication and authorization parameters
474+
# in accordance with the API server security policy.
475+
# Examples for each auth method are provided below, use the example that
476+
# satisfies your auth use case.
477+
478+
# Configure API key authorization: apiKeyCookie
479+
configuration.api_key['apiKeyCookie'] = 'YOUR_API_KEY'
480+
481+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
482+
# configuration.api_key_prefix['apiKeyCookie'] = 'Bearer'
483+
484+
# Configure API key authorization: authCookie
485+
configuration.api_key['authCookie'] = 'YOUR_API_KEY'
486+
487+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
488+
# configuration.api_key_prefix['authCookie'] = 'Bearer'
489+
490+
# Enter a context with an instance of the API client
491+
with vrchatapi.ApiClient(configuration) as api_client:
492+
# Create an instance of the API class
493+
api_instance = invite_api.InviteApi(api_client)
494+
notification_id = "notificationId_example" # str |
495+
496+
# example passing only required values which don't have defaults set
497+
try:
498+
# Respond Invite
499+
api_response = api_instance.respond_invite(notification_id)
500+
pprint(api_response)
501+
except vrchatapi.ApiException as e:
502+
print("Exception when calling InviteApi->respond_invite: %s\n" % e)
503+
```
504+
505+
506+
### Parameters
507+
508+
Name | Type | Description | Notes
509+
------------- | ------------- | ------------- | -------------
510+
**notification_id** | **str**| |
511+
512+
### Return type
513+
514+
[**Notification**](Notification.md)
515+
516+
### Authorization
517+
518+
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
519+
520+
### HTTP request headers
521+
522+
- **Content-Type**: Not defined
523+
- **Accept**: application/json
524+
525+
526+
### HTTP response details
527+
| Status code | Description | Response headers |
528+
|-------------|-------------|------------------|
529+
**200** | Returns a single Notifcation object. | - |
530+
**400** | Error response when trying to respond to an invite and something went wrong. | - |
531+
532+
[[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)
533+
276534
# **update_invite_message**
277535
> [InviteMessage] update_invite_message(user_id, message_id)
278536

‎docs/Notification.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**sender_username** | **str** | |
1010
**type** | [**NotificationType**](NotificationType.md) | |
1111
**message** | **str** | |
12-
**created_at** | **datetime** | | [readonly]
12+
**created_at** | **datetime** | |
1313
**details** | **str** | **NOTICE:** This is not a JSON object, this is a json **encoded** object, meaning you have to json-de-encode to get the NotificationDetail object depending on the NotificationType. | defaults to "{}"
1414
**seen** | **bool** | | defaults to False
1515
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

‎docs/NotificationType.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**value** | **str** | | must be one of ["all", "broadcast", "friendRequest", "invite", "message", "RequestInvite", "votetokick", ]
7+
**value** | **str** | | must be one of ["friendRequest", "invite", "inviteResponse", "requestInvite", "requestInviteResponse", "votetokick", ]
88
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
99

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

‎setup.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
6565
Join the [Discord server](https://discord.gg/Ge2APMhPfD) to get in touch with us.
6666
67-
The version of the OpenAPI document: 1.2.2
67+
The version of the OpenAPI document: 1.3.0
6868
Contact: me@ruby.js.org
6969
Generated by: https://openapi-generator.tech
7070
"""
@@ -73,7 +73,7 @@
7373
from setuptools import setup, find_packages # noqa: H301
7474

7575
NAME = "vrchatapi"
76-
VERSION = "1.2.2"
76+
VERSION = "1.3.0"
7777
# To install the library, run the following
7878
#
7979
# python setup.py install

‎vrchatapi/__init__.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.2.2
7+
The version of the OpenAPI document: 1.3.0
88
Contact: me@ruby.js.org
99
Generated by: https://openapi-generator.tech
1010
"""

‎vrchatapi/api/authentication_api.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
VRChat API Documentation
33
44
5-
The version of the OpenAPI document: 1.2.2
5+
The version of the OpenAPI document: 1.3.0
66
Contact: me@ruby.js.org
77
Generated by: https://openapi-generator.tech
88
"""

‎vrchatapi/api/avatars_api.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
VRChat API Documentation
33
44
5-
The version of the OpenAPI document: 1.2.2
5+
The version of the OpenAPI document: 1.3.0
66
Contact: me@ruby.js.org
77
Generated by: https://openapi-generator.tech
88
"""

‎vrchatapi/api/favorites_api.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
VRChat API Documentation
33
44
5-
The version of the OpenAPI document: 1.2.2
5+
The version of the OpenAPI document: 1.3.0
66
Contact: me@ruby.js.org
77
Generated by: https://openapi-generator.tech
88
"""

‎vrchatapi/api/files_api.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
VRChat API Documentation
33
44
5-
The version of the OpenAPI document: 1.2.2
5+
The version of the OpenAPI document: 1.3.0
66
Contact: me@ruby.js.org
77
Generated by: https://openapi-generator.tech
88
"""

‎vrchatapi/api/friends_api.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
VRChat API Documentation
33
44
5-
The version of the OpenAPI document: 1.2.2
5+
The version of the OpenAPI document: 1.3.0
66
Contact: me@ruby.js.org
77
Generated by: https://openapi-generator.tech
88
"""

0 commit comments

Comments
 (0)