vrchatapi 1.20.7

VRChat API Client for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442

# \CalendarApi

All URIs are relative to *https://api.vrchat.cloud/api/1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_group_calendar_event**](CalendarApi.md#create_group_calendar_event) | **POST** /calendar/{groupId}/event | Create a calendar event
[**delete_group_calendar_event**](CalendarApi.md#delete_group_calendar_event) | **DELETE** /calendar/{groupId}/{calendarId} | Delete a calendar event
[**discover_calendar_events**](CalendarApi.md#discover_calendar_events) | **GET** /calendar/discover | Discover calendar events
[**follow_group_calendar_event**](CalendarApi.md#follow_group_calendar_event) | **POST** /calendar/{groupId}/{calendarId}/follow | Follow a calendar event
[**get_calendar_events**](CalendarApi.md#get_calendar_events) | **GET** /calendar | List calendar events
[**get_featured_calendar_events**](CalendarApi.md#get_featured_calendar_events) | **GET** /calendar/featured | List featured calendar events
[**get_followed_calendar_events**](CalendarApi.md#get_followed_calendar_events) | **GET** /calendar/following | List followed calendar events
[**get_group_calendar_event**](CalendarApi.md#get_group_calendar_event) | **GET** /calendar/{groupId}/{calendarId} | Get a calendar event
[**get_group_calendar_event_ics**](CalendarApi.md#get_group_calendar_event_ics) | **GET** /calendar/{groupId}/{calendarId}.ics | Download calendar event as ICS
[**get_group_calendar_events**](CalendarApi.md#get_group_calendar_events) | **GET** /calendar/{groupId} | List a group's calendar events
[**get_group_next_calendar_event**](CalendarApi.md#get_group_next_calendar_event) | **GET** /calendar/{groupId}/next | Get next calendar event
[**search_calendar_events**](CalendarApi.md#search_calendar_events) | **GET** /calendar/search | Search for calendar events
[**update_group_calendar_event**](CalendarApi.md#update_group_calendar_event) | **PUT** /calendar/{groupId}/{calendarId}/event | Update a calendar event



## create_group_calendar_event

> models::CalendarEvent create_group_calendar_event(group_id, create_calendar_event_request)
Create a calendar event

Creates an event for a group on the calendar

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** | Must be a valid group ID. | [required] |
**create_calendar_event_request** | [**CreateCalendarEventRequest**](CreateCalendarEventRequest.md) |  | [required] |

### Return type

[**models::CalendarEvent**](CalendarEvent.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

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


## delete_group_calendar_event

> models::Success delete_group_calendar_event(group_id, calendar_id)
Delete a calendar event

Delete a group calendar event

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** | Must be a valid group ID. | [required] |
**calendar_id** | **String** | Must be a valid calendar ID. | [required] |

### Return type

[**models::Success**](Success.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

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


## discover_calendar_events

> models::CalendarEventDiscovery discover_calendar_events(scope, categories, tags, featured_results, non_featured_results, personalized_results, minimum_interest_count, minimum_remaining_minutes, upcoming_offset_minutes, n, next_cursor)
Discover calendar events

Get a list of calendar events Initially, call without a `nextCursor` parameter For every successive call, use the `nextCursor` property returned in the previous call & the `number` of entries desired for this call The `nextCursor` internally keeps track of the `offset` of the results, the initial request parameters, and accounts for discrepancies that might arise from time elapsed between calls

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**scope** | Option<[**CalendarEventDiscoveryScope**](.md)> | Scope for calendar event discovery. |  |
**categories** | Option<**String**> | Filter for calendar event discovery. |  |
**tags** | Option<**String**> | Filter for calendar event discovery. |  |
**featured_results** | Option<[**CalendarEventDiscoveryInclusion**](.md)> | Filter for calendar event discovery. |  |
**non_featured_results** | Option<[**CalendarEventDiscoveryInclusion**](.md)> | Filter for calendar event discovery. |  |
**personalized_results** | Option<[**CalendarEventDiscoveryInclusion**](.md)> | Filter for calendar event discovery. |  |
**minimum_interest_count** | Option<**i32**> | Filter for calendar event discovery. |  |
**minimum_remaining_minutes** | Option<**i32**> | Filter for calendar event discovery. |  |
**upcoming_offset_minutes** | Option<**i32**> | Filter for calendar event discovery. |  |
**n** | Option<**i32**> | The number of objects to return. |  |[default to 60]
**next_cursor** | Option<**String**> | Cursor returned from previous calendar discovery queries (see nextCursor property of the schema CalendarEventDiscovery). |  |

### Return type

[**models::CalendarEventDiscovery**](CalendarEventDiscovery.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

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


## follow_group_calendar_event

> models::CalendarEvent follow_group_calendar_event(group_id, calendar_id, follow_calendar_event_request)
Follow a calendar event

Follow or unfollow an event on a group's calendar

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** | Must be a valid group ID. | [required] |
**calendar_id** | **String** | Must be a valid calendar ID. | [required] |
**follow_calendar_event_request** | [**FollowCalendarEventRequest**](FollowCalendarEventRequest.md) |  | [required] |

### Return type

[**models::CalendarEvent**](CalendarEvent.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[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_calendar_events

> models::PaginatedCalendarEventList get_calendar_events(date, n, offset)
List calendar events

Get a list of a user's calendar events for the month in ?date

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**date** | Option<**String**> | The month to search in. |  |
**n** | Option<**i32**> | The number of objects to return. |  |[default to 60]
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. |  |

### Return type

[**models::PaginatedCalendarEventList**](PaginatedCalendarEventList.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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_featured_calendar_events

> models::PaginatedCalendarEventList get_featured_calendar_events(date, n, offset)
List featured calendar events

Get a list of a featured calendar events for the month in ?date

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**date** | Option<**String**> | The month to search in. |  |
**n** | Option<**i32**> | The number of objects to return. |  |[default to 60]
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. |  |

### Return type

[**models::PaginatedCalendarEventList**](PaginatedCalendarEventList.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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_followed_calendar_events

> models::PaginatedCalendarEventList get_followed_calendar_events(date, n, offset)
List followed calendar events

Get a list of a followed calendar events for the month in ?date

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**date** | Option<**String**> | The month to search in. |  |
**n** | Option<**i32**> | The number of objects to return. |  |[default to 60]
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. |  |

### Return type

[**models::PaginatedCalendarEventList**](PaginatedCalendarEventList.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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_group_calendar_event

> models::CalendarEvent get_group_calendar_event(group_id, calendar_id)
Get a calendar event

Get a group calendar event

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** | Must be a valid group ID. | [required] |
**calendar_id** | **String** | Must be a valid calendar ID. | [required] |

### Return type

[**models::CalendarEvent**](CalendarEvent.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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_group_calendar_event_ics

> std::path::PathBuf get_group_calendar_event_ics(group_id, calendar_id)
Download calendar event as ICS

Returns the specified calendar in iCalendar (ICS) format.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** | Must be a valid group ID. | [required] |
**calendar_id** | **String** | Must be a valid calendar ID. | [required] |

### Return type

[**std::path::PathBuf**](std::path::PathBuf.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/calendar, application/json

[[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_group_calendar_events

> models::PaginatedCalendarEventList get_group_calendar_events(group_id, date, n, offset)
List a group's calendar events

Get a list of a group's calendar events

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** | Must be a valid group ID. | [required] |
**date** | Option<**String**> | The month to search in. |  |
**n** | Option<**i32**> | The number of objects to return. |  |[default to 60]
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. |  |

### Return type

[**models::PaginatedCalendarEventList**](PaginatedCalendarEventList.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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_group_next_calendar_event

> models::CalendarEvent get_group_next_calendar_event(group_id)
Get next calendar event

Get the closest future calendar event scheduled for a group

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** | Must be a valid group ID. | [required] |

### Return type

[**models::CalendarEvent**](CalendarEvent.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

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


## search_calendar_events

> models::PaginatedCalendarEventList search_calendar_events(search_term, utc_offset, n, offset, is_internal_variant)
Search for calendar events

Get a list of calendar events by search terms

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**search_term** | **String** | Search term for calendar events. | [required] |
**utc_offset** | Option<**i32**> | The offset from UTC in hours of the client or authenticated user. |  |
**n** | Option<**i32**> | The number of objects to return. |  |[default to 60]
**offset** | Option<**i32**> | A zero-based offset from the default object sorting from where search results start. |  |
**is_internal_variant** | Option<**bool**> | Not quite sure what this actually does (exists on the website but doesn't seem to be used) |  |

### Return type

[**models::PaginatedCalendarEventList**](PaginatedCalendarEventList.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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_calendar_event

> models::CalendarEvent update_group_calendar_event(group_id, calendar_id, update_calendar_event_request)
Update a calendar event

Updates an event for a group on the calendar

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** | Must be a valid group ID. | [required] |
**calendar_id** | **String** | Must be a valid calendar ID. | [required] |
**update_calendar_event_request** | [**UpdateCalendarEventRequest**](UpdateCalendarEventRequest.md) |  | [required] |

### Return type

[**models::CalendarEvent**](CalendarEvent.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

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