ExilProductions/VRChatBackendDocs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add subdir

Browse Source
This commit is contained in:
ExilProductions
2026-02-15 17:39:26 +01:00
parent a4b3cb0164
commit aa707d1deb
262 changed files with 12189 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

403
Apis/CalendarApi.md Normal file
View File

@@ -0,0 +1,403 @@
# CalendarApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**createGroupCalendarEvent**](CalendarApi.md#createGroupCalendarEvent) | **POST** /calendar/{groupId}/event | Create a calendar event |
| [**deleteGroupCalendarEvent**](CalendarApi.md#deleteGroupCalendarEvent) | **DELETE** /calendar/{groupId}/{calendarId} | Delete a calendar event |
| [**discoverCalendarEvents**](CalendarApi.md#discoverCalendarEvents) | **GET** /calendar/discover | Discover calendar events |
| [**followGroupCalendarEvent**](CalendarApi.md#followGroupCalendarEvent) | **POST** /calendar/{groupId}/{calendarId}/follow | Follow a calendar event |
| [**getCalendarEvents**](CalendarApi.md#getCalendarEvents) | **GET** /calendar | List calendar events |
| [**getFeaturedCalendarEvents**](CalendarApi.md#getFeaturedCalendarEvents) | **GET** /calendar/featured | List featured calendar events |
| [**getFollowedCalendarEvents**](CalendarApi.md#getFollowedCalendarEvents) | **GET** /calendar/following | List followed calendar events |
| [**getGroupCalendarEvent**](CalendarApi.md#getGroupCalendarEvent) | **GET** /calendar/{groupId}/{calendarId} | Get a calendar event |
| [**getGroupCalendarEventICS**](CalendarApi.md#getGroupCalendarEventICS) | **GET** /calendar/{groupId}/{calendarId}.ics | Download calendar event as ICS |
| [**getGroupCalendarEvents**](CalendarApi.md#getGroupCalendarEvents) | **GET** /calendar/{groupId} | List a group's calendar events |
| [**getGroupNextCalendarEvent**](CalendarApi.md#getGroupNextCalendarEvent) | **GET** /calendar/{groupId}/next | Get next calendar event |
| [**searchCalendarEvents**](CalendarApi.md#searchCalendarEvents) | **GET** /calendar/search | Search for calendar events |
| [**updateGroupCalendarEvent**](CalendarApi.md#updateGroupCalendarEvent) | **PUT** /calendar/{groupId}/{calendarId}/event | Update a calendar event |
<a name="createGroupCalendarEvent"></a>
# **createGroupCalendarEvent**
> CalendarEvent createGroupCalendarEvent(groupId, CreateCalendarEventRequest)
Create a calendar event
Creates an event for a group on the calendar
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **CreateCalendarEventRequest** | [**CreateCalendarEventRequest**](../Models/CreateCalendarEventRequest.md)| | |
### Return type
[**CalendarEvent**](../Models/CalendarEvent.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="deleteGroupCalendarEvent"></a>
# **deleteGroupCalendarEvent**
> Success deleteGroupCalendarEvent(groupId, calendarId)
Delete a calendar event
Delete a group calendar event
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **calendarId** | **String**| Must be a valid calendar ID. | [default to null] |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="discoverCalendarEvents"></a>
# **discoverCalendarEvents**
> CalendarEventDiscovery discoverCalendarEvents(scope, categories, tags, featuredResults, nonFeaturedResults, personalizedResults, minimumInterestCount, minimumRemainingMinutes, upcomingOffsetMinutes, n, nextCursor)
Discover calendar events
Get a list of calendar events Initially, call without a &#x60;nextCursor&#x60; parameter For every successive call, use the &#x60;nextCursor&#x60; property returned in the previous call &amp; the &#x60;number&#x60; of entries desired for this call The &#x60;nextCursor&#x60; internally keeps track of the &#x60;offset&#x60; of the results, the initial request parameters, and accounts for discrepancies that might arise from time elapsed between calls
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **scope** | **String**| Scope for calendar event discovery. | [optional] [default to upcoming] [enum: all, live, upcoming] |
| **categories** | **String**| Filter for calendar event discovery. | [optional] [default to null] |
| **tags** | **String**| Filter for calendar event discovery. | [optional] [default to null] |
| **featuredResults** | **String**| Filter for calendar event discovery. | [optional] [default to include] [enum: exclude, include, skip] |
| **nonFeaturedResults** | **String**| Filter for calendar event discovery. | [optional] [default to include] [enum: exclude, include, skip] |
| **personalizedResults** | **String**| Filter for calendar event discovery. | [optional] [default to include] [enum: exclude, include, skip] |
| **minimumInterestCount** | **Integer**| Filter for calendar event discovery. | [optional] [default to null] |
| **minimumRemainingMinutes** | **Integer**| Filter for calendar event discovery. | [optional] [default to null] |
| **upcomingOffsetMinutes** | **Integer**| Filter for calendar event discovery. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **nextCursor** | **String**| Cursor returned from previous calendar discovery queries (see nextCursor property of the schema CalendarEventDiscovery). | [optional] [default to null] |
### Return type
[**CalendarEventDiscovery**](../Models/CalendarEventDiscovery.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="followGroupCalendarEvent"></a>
# **followGroupCalendarEvent**
> CalendarEvent followGroupCalendarEvent(groupId, calendarId, FollowCalendarEventRequest)
Follow a calendar event
Follow or unfollow an event on a group&#39;s calendar
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **calendarId** | **String**| Must be a valid calendar ID. | [default to null] |
| **FollowCalendarEventRequest** | [**FollowCalendarEventRequest**](../Models/FollowCalendarEventRequest.md)| | |
### Return type
[**CalendarEvent**](../Models/CalendarEvent.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="getCalendarEvents"></a>
# **getCalendarEvents**
> PaginatedCalendarEventList getCalendarEvents(date, n, offset)
List calendar events
Get a list of a user&#39;s calendar events for the month in ?date
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **date** | **Date**| The month to search in. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**PaginatedCalendarEventList**](../Models/PaginatedCalendarEventList.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFeaturedCalendarEvents"></a>
# **getFeaturedCalendarEvents**
> PaginatedCalendarEventList getFeaturedCalendarEvents(date, n, offset)
List featured calendar events
Get a list of a featured calendar events for the month in ?date
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **date** | **Date**| The month to search in. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**PaginatedCalendarEventList**](../Models/PaginatedCalendarEventList.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFollowedCalendarEvents"></a>
# **getFollowedCalendarEvents**
> PaginatedCalendarEventList getFollowedCalendarEvents(date, n, offset)
List followed calendar events
Get a list of a followed calendar events for the month in ?date
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **date** | **Date**| The month to search in. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**PaginatedCalendarEventList**](../Models/PaginatedCalendarEventList.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupCalendarEvent"></a>
# **getGroupCalendarEvent**
> CalendarEvent getGroupCalendarEvent(groupId, calendarId)
Get a calendar event
Get a group calendar event
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **calendarId** | **String**| Must be a valid calendar ID. | [default to null] |
### Return type
[**CalendarEvent**](../Models/CalendarEvent.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupCalendarEventICS"></a>
# **getGroupCalendarEventICS**
> File getGroupCalendarEventICS(groupId, calendarId)
Download calendar event as ICS
Returns the specified calendar in iCalendar (ICS) format.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **calendarId** | **String**| Must be a valid calendar ID. | [default to null] |
### Return type
**File**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/calendar, application/json
<a name="getGroupCalendarEvents"></a>
# **getGroupCalendarEvents**
> PaginatedCalendarEventList getGroupCalendarEvents(groupId, date, n, offset)
List a group&#39;s calendar events
Get a list of a group&#39;s calendar events
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **date** | **Date**| The month to search in. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**PaginatedCalendarEventList**](../Models/PaginatedCalendarEventList.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupNextCalendarEvent"></a>
# **getGroupNextCalendarEvent**
> CalendarEvent getGroupNextCalendarEvent(groupId)
Get next calendar event
Get the closest future calendar event scheduled for a group
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
### Return type
[**CalendarEvent**](../Models/CalendarEvent.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="searchCalendarEvents"></a>
# **searchCalendarEvents**
> PaginatedCalendarEventList searchCalendarEvents(searchTerm, utcOffset, n, offset, isInternalVariant)
Search for calendar events
Get a list of calendar events by search terms
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **searchTerm** | **String**| Search term for calendar events. | [default to null] |
| **utcOffset** | **Integer**| The offset from UTC in hours of the client or authenticated user. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **isInternalVariant** | **Boolean**| Not quite sure what this actually does (exists on the website but doesn&#39;t seem to be used) | [optional] [default to null] |
### Return type
[**PaginatedCalendarEventList**](../Models/PaginatedCalendarEventList.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="updateGroupCalendarEvent"></a>
# **updateGroupCalendarEvent**
> CalendarEvent updateGroupCalendarEvent(groupId, calendarId, UpdateCalendarEventRequest)
Update a calendar event
Updates an event for a group on the calendar
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **calendarId** | **String**| Must be a valid calendar ID. | [default to null] |
| **UpdateCalendarEventRequest** | [**UpdateCalendarEventRequest**](../Models/UpdateCalendarEventRequest.md)| | |
### Return type
[**CalendarEvent**](../Models/CalendarEvent.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json