add subdir

Apis/NotificationsApi.md

@@ -0,0 +1,373 @@
+# NotificationsApi
+
+All URIs are relative to *https://api.vrchat.cloud/api/1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**acceptFriendRequest**](NotificationsApi.md#acceptFriendRequest) | **PUT** /auth/user/notifications/{notificationId}/accept | Accept Friend Request |
+| [**acknowledgeNotificationV2**](NotificationsApi.md#acknowledgeNotificationV2) | **POST** /notifications/{notificationId}/see | Acknowledge NotificationV2 |
+| [**clearNotifications**](NotificationsApi.md#clearNotifications) | **PUT** /auth/user/notifications/clear | Clear All Notifications |
+| [**deleteAllNotificationV2s**](NotificationsApi.md#deleteAllNotificationV2s) | **DELETE** /notifications | Delete All NotificationV2s |
+| [**deleteNotification**](NotificationsApi.md#deleteNotification) | **PUT** /auth/user/notifications/{notificationId}/hide | Delete Notification |
+| [**deleteNotificationV2**](NotificationsApi.md#deleteNotificationV2) | **DELETE** /notifications/{notificationId} | Delete NotificationV2 |
+| [**getNotification**](NotificationsApi.md#getNotification) | **GET** /auth/user/notifications/{notificationId} | Show notification |
+| [**getNotificationV2**](NotificationsApi.md#getNotificationV2) | **GET** /notifications/{notificationId} | Get NotificationV2 |
+| [**getNotificationV2s**](NotificationsApi.md#getNotificationV2s) | **GET** /notifications | List NotificationV2s |
+| [**getNotifications**](NotificationsApi.md#getNotifications) | **GET** /auth/user/notifications | List Notifications |
+| [**markNotificationAsRead**](NotificationsApi.md#markNotificationAsRead) | **PUT** /auth/user/notifications/{notificationId}/see | Mark Notification As Read |
+| [**replyNotificationV2**](NotificationsApi.md#replyNotificationV2) | **POST** /notifications/{notificationId}/reply | Reply NotificationV2 |
+| [**respondNotificationV2**](NotificationsApi.md#respondNotificationV2) | **POST** /notifications/{notificationId}/respond | Respond NotificationV2 |
+
+
+<a name="acceptFriendRequest"></a>
+# **acceptFriendRequest**
+> Success acceptFriendRequest(notificationId)
+
+Accept Friend Request
+
+    Accept a friend request by notification &#x60;frq_&#x60; ID. Friend requests can be found using the NotificationsAPI &#x60;getNotifications&#x60; by filtering of type &#x60;friendRequest&#x60;.
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **notificationId** | **String**| Must be a valid notification 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="acknowledgeNotificationV2"></a>
+# **acknowledgeNotificationV2**
+> NotificationV2 acknowledgeNotificationV2(notificationId)
+
+Acknowledge NotificationV2
+
+    Acknowledge a specific notification
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
+
+### Return type
+
+[**NotificationV2**](../Models/NotificationV2.md)
+
+### Authorization
+
+[authCookie](../README.md#authCookie)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+<a name="clearNotifications"></a>
+# **clearNotifications**
+> Success clearNotifications()
+
+Clear All Notifications
+
+    Clear **all** notifications.
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Success**](../Models/Success.md)
+
+### Authorization
+
+[authCookie](../README.md#authCookie)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+<a name="deleteAllNotificationV2s"></a>
+# **deleteAllNotificationV2s**
+> Success deleteAllNotificationV2s()
+
+Delete All NotificationV2s
+
+    Delete all of the current user&#39;s notifications.
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Success**](../Models/Success.md)
+
+### Authorization
+
+[authCookie](../README.md#authCookie)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+<a name="deleteNotification"></a>
+# **deleteNotification**
+> Notification deleteNotification(notificationId)
+
+Delete Notification
+
+    Delete a notification.
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
+
+### Return type
+
+[**Notification**](../Models/Notification.md)
+
+### Authorization
+
+[authCookie](../README.md#authCookie)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+<a name="deleteNotificationV2"></a>
+# **deleteNotificationV2**
+> Success deleteNotificationV2(notificationId)
+
+Delete NotificationV2
+
+    Delete a specific notification
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **notificationId** | **String**| Must be a valid notification 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="getNotification"></a>
+# **getNotification**
+> Notification getNotification(notificationId)
+
+Show notification
+
+    Get a notification by notification &#x60;not_&#x60; ID.
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
+
+### Return type
+
+[**Notification**](../Models/Notification.md)
+
+### Authorization
+
+[authCookie](../README.md#authCookie)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+<a name="getNotificationV2"></a>
+# **getNotificationV2**
+> NotificationV2 getNotificationV2(notificationId)
+
+Get NotificationV2
+
+    Get a specific notification. Appears to require admin credentials by default. Expect a 403 Forbidden error response for normal users.
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
+
+### Return type
+
+[**NotificationV2**](../Models/NotificationV2.md)
+
+### Authorization
+
+[authCookie](../README.md#authCookie)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+<a name="getNotificationV2s"></a>
+# **getNotificationV2s**
+> List getNotificationV2s(limit)
+
+List NotificationV2s
+
+    Retrieve all of the current user&#39;s notifications.
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **limit** | **Integer**| The maximum number of entries to get. | [optional] [default to null] |
+
+### Return type
+
+[**List**](../Models/NotificationV2.md)
+
+### Authorization
+
+[authCookie](../README.md#authCookie)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+<a name="getNotifications"></a>
+# **getNotifications**
+> List getNotifications(type, sent, hidden, after, n, offset)
+
+List Notifications
+
+    Retrieve all of the current user&#39;s notifications.
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **type** | **String**| Only send notifications of this type (can use &#x60;all&#x60; for all). This parameter no longer does anything, and is deprecated. | [optional] [default to null] |
+| **sent** | **Boolean**| Return notifications sent by the user. Must be false or omitted. | [optional] [default to null] |
+| **hidden** | **Boolean**| Whether to return hidden or non-hidden notifications. True only allowed on type &#x60;friendRequest&#x60;. | [optional] [default to null] |
+| **after** | **String**| Only return notifications sent after this Date. Ignored if type is &#x60;friendRequest&#x60;. | [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
+
+[**List**](../Models/Notification.md)
+
+### Authorization
+
+[authCookie](../README.md#authCookie)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+<a name="markNotificationAsRead"></a>
+# **markNotificationAsRead**
+> Notification markNotificationAsRead(notificationId)
+
+Mark Notification As Read
+
+    Mark a notification as seen.
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
+
+### Return type
+
+[**Notification**](../Models/Notification.md)
+
+### Authorization
+
+[authCookie](../README.md#authCookie)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+<a name="replyNotificationV2"></a>
+# **replyNotificationV2**
+> NotificationV2 replyNotificationV2(notificationId, body)
+
+Reply NotificationV2
+
+    Reply to a specific notification
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
+| **body** | **Object**|  | |
+
+### Return type
+
+[**NotificationV2**](../Models/NotificationV2.md)
+
+### Authorization
+
+[authCookie](../README.md#authCookie)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+<a name="respondNotificationV2"></a>
+# **respondNotificationV2**
+> NotificationV2 respondNotificationV2(notificationId, RespondNotificationV2Request)
+
+Respond NotificationV2
+
+    Respond to a specific notification
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
+| **RespondNotificationV2Request** | [**RespondNotificationV2Request**](../Models/RespondNotificationV2Request.md)|  | |
+
+### Return type
+
+[**NotificationV2**](../Models/NotificationV2.md)
+
+### Authorization
+
+[authCookie](../README.md#authCookie)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+