Merge branch 'main' of https://github.com/vrchatapi/vrchatapi-java

Author: Foorack

.openapi-generator/FILES

@@ -1,4 +1,3 @@
-.gitignore
 api/openapi.yaml
 build.gradle
 build.sbt
@@ -53,6 +52,8 @@ docs/InstancePlatforms.md
 docs/InviteApi.md
 docs/InviteMessage.md
 docs/InviteMessageType.md
+docs/InviteRequest.md
+docs/InviteResponse.md
 docs/LimitedUnityPackage.md
 docs/LimitedUser.md
 docs/LimitedWorld.md
@@ -72,6 +73,7 @@ docs/Success.md
 docs/SystemApi.md
 docs/UnityPackage.md
 docs/User.md
+docs/UserExists.md
 docs/UserState.md
 docs/UserStatus.md
 docs/UsersApi.md
@@ -160,6 +162,8 @@ src/main/java/io/github/vrchatapi/model/Instance.java
 src/main/java/io/github/vrchatapi/model/InstancePlatforms.java
 src/main/java/io/github/vrchatapi/model/InviteMessage.java
 src/main/java/io/github/vrchatapi/model/InviteMessageType.java
+src/main/java/io/github/vrchatapi/model/InviteRequest.java
+src/main/java/io/github/vrchatapi/model/InviteResponse.java
 src/main/java/io/github/vrchatapi/model/LimitedUnityPackage.java
 src/main/java/io/github/vrchatapi/model/LimitedUser.java
 src/main/java/io/github/vrchatapi/model/LimitedWorld.java
@@ -175,6 +179,7 @@ src/main/java/io/github/vrchatapi/model/Response.java
 src/main/java/io/github/vrchatapi/model/Success.java
 src/main/java/io/github/vrchatapi/model/UnityPackage.java
 src/main/java/io/github/vrchatapi/model/User.java
+src/main/java/io/github/vrchatapi/model/UserExists.java
 src/main/java/io/github/vrchatapi/model/UserState.java
 src/main/java/io/github/vrchatapi/model/UserStatus.java
 src/main/java/io/github/vrchatapi/model/World.java

build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'eclipse'
 apply plugin: 'java'
 
 group = 'io.github.vrchatapi'
-version = '1.3.0'
+version = '1.3.3'
 
 buildscript {
     repositories {

build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "io.github.vrchatapi",
     name := "vrchatapi",
-    version := "1.3.0",
+    version := "1.3.3",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/AuthenticationApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://api.vrchat.cloud/api/1*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**checkUserExists**](AuthenticationApi.md#checkUserExists) | **GET** /auth/exists | Check User Exists
 [**deleteUser**](AuthenticationApi.md#deleteUser) | **PUT** /user/{userId}/delete | Delete User
 [**getCurrentUser**](AuthenticationApi.md#getCurrentUser) | **GET** /auth/user | Login and/or Get Current User Info
 [**logout**](AuthenticationApi.md#logout) | **PUT** /logout | Logout
@@ -12,6 +13,82 @@ Method | HTTP request | Description
 [**verifyRecoveryCode**](AuthenticationApi.md#verifyRecoveryCode) | **POST** /auth/twofactorauth/otp/verify | Verify 2FA code with Recovery code
 
 
+<a name="checkUserExists"></a>
+# **checkUserExists**
+> UserExists checkUserExists(email, displayName, userId, excludeUserId)
+
+Check User Exists
+
+Checks if a user by a given &#x60;username&#x60;, &#x60;displayName&#x60; or &#x60;email&#x60; exist. This is used during registration to check if a username has already been taken, during change of displayName to check if a displayName is available, and during change of email to check if the email is already used. In the later two cases the &#x60;excludeUserId&#x60; is used to exclude oneself, otherwise the result would always be true.  It is **REQUIRED** to include **AT LEAST** &#x60;username&#x60;, &#x60;displayName&#x60; **or** &#x60;email&#x60; query parameter. Although they can be combined - in addition with &#x60;excludeUserId&#x60; (generally to exclude yourself) - to further fine-tune the search.
+
+### Example
+```java
+// Import classes:
+import io.github.vrchatapi.ApiClient;
+import io.github.vrchatapi.ApiException;
+import io.github.vrchatapi.Configuration;
+import io.github.vrchatapi.auth.*;
+import io.github.vrchatapi.models.*;
+import io.github.vrchatapi.api.AuthenticationApi;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = Configuration.getDefaultApiClient();
+    defaultClient.setBasePath("https://api.vrchat.cloud/api/1");
+    
+    // Configure API key authorization: apiKeyCookie
+    ApiKeyAuth apiKeyCookie = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyCookie");
+    apiKeyCookie.setApiKey("YOUR API KEY");
+    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+    //apiKeyCookie.setApiKeyPrefix("Token");
+
+    AuthenticationApi apiInstance = new AuthenticationApi(defaultClient);
+    String email = "email_example"; // String | Filter by email.
+    String displayName = "displayName_example"; // String | Filter by displayName.
+    String userId = "userId_example"; // String | Filter by UserID.
+    String excludeUserId = "excludeUserId_example"; // String | Exclude by UserID.
+    try {
+      UserExists result = apiInstance.checkUserExists(email, displayName, userId, excludeUserId);
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling AuthenticationApi#checkUserExists");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email** | **String**| Filter by email. | [optional]
+ **displayName** | **String**| Filter by displayName. | [optional]
+ **userId** | **String**| Filter by UserID. | [optional]
+ **excludeUserId** | **String**| Exclude by UserID. | [optional]
+
+### Return type
+
+[**UserExists**](UserExists.md)
+
+### Authorization
+
+[apiKeyCookie](../README.md#apiKeyCookie)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Returns a response if a user exists or not. |  -  |
+**400** | Error response when missing at least 1 of the required parameters. |  -  |
+
 <a name="deleteUser"></a>
 # **deleteUser**
 > CurrentUser deleteUser(userId)
@@ -94,7 +171,7 @@ Name | Type | Description  | Notes
 
 Login and/or Get Current User Info
 
-Login and/or Get user data from your VRChat account.  If &#x60;Authorization&#x60; header is present then a new login session will be generated, and a new &#x60;auth&#x60; cookie is returned.  **WARNING: Session Limit:** Each authentication with login credentials counts as a separate session, out of which you have a limited amount. Make sure to save and reuse the &#x60;auth&#x60; cookie whenever you can, and avoid sending the Authorization header unless strictly neccesary. While the exact number of simultaneous open sessions is secret, expect to **very fast** run into the rate-limit and be temporarily blocked from making new sessions until the old ones expire.
+This endpoint does the following two operations:   1) Checks if you are already logged in by looking for a valid &#x60;auth&#x60; cookie. If you are have a valid auth cookie then no additional auth-related actions are taken. If you are **not** logged in then it will log you in with the &#x60;Authorization&#x60; header and set the &#x60;auth&#x60; cookie. The &#x60;auth&#x60; cookie will only be sent once.   2) If logged in, this function will also return the CurrentUser object containing detailed information about the currently logged in user.  **WARNING: Session Limit:** Each authentication with login credentials counts as a separate session, out of which you have a limited amount. Make sure to save and reuse the &#x60;auth&#x60; cookie if you are often restarting the program. The provided API libraries automatically save cookies during runtime, but does not persist during restart. While it can be fine to use username/password during development, expect in production to very fast run into the rate-limit and be temporarily blocked from making new sessions until older ones expire. The exact number of simultaneous sessions is unknown/undisclosed.
 
 ### Example
 ```java
@@ -162,7 +239,7 @@ This endpoint does not need any parameter.
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-**200** | OK |  * Set-Cookie - Authenticating returns an &#x60;auth&#x60; cookie. <br>  * \0Set-Cookie - Authenticating also sets the &#x60;apiKey&#x60; if not already set. <br>  |
+**200** | OK |  * Set-Cookie - Successful authentication returns an &#x60;auth&#x60; cookie. <br>  * \0Set-Cookie - This endpoint **always** sets the &#x60;apiKey&#x60; irrespective if it is already set. <br>  |
 **401** | Error response due to missing apiKey or auth cookie. |  -  |
 
 <a name="logout"></a>

docs/AvatarsApi.md

@@ -383,7 +383,7 @@ public class Example {
     String featured = "featured_example"; // String | Filters on featured results.
     String sort = "popularity"; // String | 
     String user = "user_example"; // String | Set to `me` for searching own avatars.
-    String userId = "userId_example"; // String | Filter by author UserID
+    String userId = "userId_example"; // String | Filter by UserID.
     Integer n = 60; // Integer | The number of objects to return.
     String order = "descending"; // String | 
     Integer offset = 56; // Integer | A zero-based offset from the default object sorting from where search results start.
@@ -414,7 +414,7 @@ Name | Type | Description  | Notes
  **featured** | **String**| Filters on featured results. | [optional]
  **sort** | **String**|  | [optional] [default to popularity] [enum: popularity, heat, trust, shuffle, random, favorites, reportScore, reportCount, publicationDate, labsPublicationDate, created, _created_at, updated, _updated_at, order, relevance, magic, name]
  **user** | **String**| Set to `me` for searching own avatars. | [optional] [enum: me]
- **userId** | **String**| Filter by author UserID | [optional]
+ **userId** | **String**| Filter by UserID. | [optional]
  **n** | **Integer**| The number of objects to return. | [optional] [default to 60]
  **order** | **String**|  | [optional] [default to descending] [enum: ascending, descending]
  **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional]

docs/CurrentUser.md

@@ -29,7 +29,7 @@ Name | Type | Description | Notes
 **friendGroupNames** | **List<String>** | Always empty array. | 
 **currentAvatarImageUrl** | **String** |  | 
 **currentAvatarThumbnailImageUrl** | **String** |  | 
-**fallbackAvatar** | **String** |  | 
+**fallbackAvatar** | **String** |  |  [optional]
 **currentAvatar** | **String** |  | 
 **currentAvatarAssetUrl** | **String** |  | 
 **accountDeletionDate** | **LocalDate** |  |  [optional]

docs/InviteApi.md

@@ -171,7 +171,7 @@ Name | Type | Description  | Notes
 
 <a name="inviteUser"></a>
 # **inviteUser**
-> Notification inviteUser(userId)
+> Notification inviteUser(userId, inviteRequest)
 
 Invite User
 
@@ -206,8 +206,9 @@ public class Example {
 
     InviteApi apiInstance = new InviteApi(defaultClient);
     String userId = "userId_example"; // String | 
+    InviteRequest inviteRequest = new InviteRequest(); // InviteRequest | Instance ID when inviting a user.
     try {
-      Notification result = apiInstance.inviteUser(userId);
+      Notification result = apiInstance.inviteUser(userId, inviteRequest);
       System.out.println(result);
     } catch (ApiException e) {
       System.err.println("Exception when calling InviteApi#inviteUser");
@@ -225,6 +226,7 @@ public class Example {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **userId** | **String**|  |
+ **inviteRequest** | [**InviteRequest**](InviteRequest.md)| Instance ID when inviting a user. | [optional]
 
 ### Return type
 
@@ -236,7 +238,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 ### HTTP response details
@@ -403,7 +405,7 @@ Name | Type | Description  | Notes
 
 <a name="respondInvite"></a>
 # **respondInvite**
-> Notification respondInvite(notificationId)
+> Notification respondInvite(notificationId, inviteResponse)
 
 Respond Invite
 
@@ -438,8 +440,9 @@ public class Example {
 
     InviteApi apiInstance = new InviteApi(defaultClient);
     String notificationId = "notificationId_example"; // String | 
+    InviteResponse inviteResponse = new InviteResponse(); // InviteResponse | Instance ID when inviting a user.
     try {
-      Notification result = apiInstance.respondInvite(notificationId);
+      Notification result = apiInstance.respondInvite(notificationId, inviteResponse);
       System.out.println(result);
     } catch (ApiException e) {
       System.err.println("Exception when calling InviteApi#respondInvite");
@@ -457,6 +460,7 @@ public class Example {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **notificationId** | **String**|  |
+ **inviteResponse** | [**InviteResponse**](InviteResponse.md)| Instance ID when inviting a user. | [optional]
 
 ### Return type
 
@@ -468,7 +472,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 ### HTTP response details

docs/InviteRequest.md

@@ -0,0 +1,13 @@
+
+
+# InviteRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**instanceId** | **String** |  | 
+
+
+

docs/InviteResponse.md

@@ -0,0 +1,13 @@
+
+
+# InviteResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**responseSlot** | **Integer** |  | 
+
+
+

docs/User.md

@@ -17,7 +17,6 @@ Name | Type | Description | Notes
 **statusDescription** | **String** |  | 
 **currentAvatarImageUrl** | **String** |  | 
 **currentAvatarThumbnailImageUrl** | **String** |  | 
-**fallbackAvatar** | **String** |  | 
 **state** | **UserState** |  | 
 **tags** | **List<String>** |  | 
 **developerType** | **DeveloperType** |  |