add subdir

2026-02-15 17:39:26 +01:00
parent a4b3cb0164
commit aa707d1deb
262 changed files with 12189 additions and 0 deletions
--- a/Apis/FriendsApi.md
+++ b/Apis/FriendsApi.md
@@ -0,0 +1,179 @@
+# FriendsApi
+
+All URIs are relative to *https://api.vrchat.cloud/api/1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**boop**](FriendsApi.md#boop) | **POST** /users/{userId}/boop | Send Boop |
+| [**deleteFriendRequest**](FriendsApi.md#deleteFriendRequest) | **DELETE** /user/{userId}/friendRequest | Delete Friend Request |
+| [**friend**](FriendsApi.md#friend) | **POST** /user/{userId}/friendRequest | Send Friend Request |
+| [**getFriendStatus**](FriendsApi.md#getFriendStatus) | **GET** /user/{userId}/friendStatus | Check Friend Status |
+| [**getFriends**](FriendsApi.md#getFriends) | **GET** /auth/user/friends | List Friends |
+| [**unfriend**](FriendsApi.md#unfriend) | **DELETE** /auth/user/friends/{userId} | Unfriend |
+
+
+<a name="boop"></a>
+# **boop**
+> Success boop(userId, BoopRequest)
+
+Send Boop
+
+    Send a boop to another user.
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | **String**| Must be a valid user ID. | [default to null] |
+| **BoopRequest** | [**BoopRequest**](../Models/BoopRequest.md)|  | |
+
+### Return type
+
+[**Success**](../Models/Success.md)
+
+### Authorization
+
+[authCookie](../README.md#authCookie)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+<a name="deleteFriendRequest"></a>
+# **deleteFriendRequest**
+> Success deleteFriendRequest(userId)
+
+Delete Friend Request
+
+    Deletes an outgoing pending friend request to another user. To delete an incoming friend request, use the &#x60;deleteNotification&#x60; endpoint instead.
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | **String**| Must be a valid user 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="friend"></a>
+# **friend**
+> Notification friend(userId)
+
+Send Friend Request
+
+    Send a friend request to another user.
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | **String**| Must be a valid user 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="getFriendStatus"></a>
+# **getFriendStatus**
+> FriendStatus getFriendStatus(userId)
+
+Check Friend Status
+
+    Retrieve if the user is currently a friend with a given user, if they have an outgoing friend request, and if they have an incoming friend request. The proper way to receive and accept friend request is by checking if the user has an incoming &#x60;Notification&#x60; of type &#x60;friendRequest&#x60;, and then accepting that notification.
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | **String**| Must be a valid user ID. | [default to null] |
+
+### Return type
+
+[**FriendStatus**](../Models/FriendStatus.md)
+
+### Authorization
+
+[authCookie](../README.md#authCookie)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+<a name="getFriends"></a>
+# **getFriends**
+> List getFriends(offset, n, offline)
+
+List Friends
+
+    List information about friends.
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
+| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
+| **offline** | **Boolean**| Returns *only* offline users if true, returns only online and active users if false | [optional] [default to null] |
+
+### Return type
+
+[**List**](../Models/LimitedUserFriend.md)
+
+### Authorization
+
+[authCookie](../README.md#authCookie)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+<a name="unfriend"></a>
+# **unfriend**
+> Success unfriend(userId)
+
+Unfriend
+
+    Unfriend a user by ID.
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | **String**| Must be a valid user 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
+