Skip to content

Commit

Permalink
Upgrade Java SDK to spec 1.18.1
Browse files Browse the repository at this point in the history
  • Loading branch information
VRCCat committed Jul 22, 2024
1 parent b97a868 commit 8c50a3f
Show file tree
Hide file tree
Showing 185 changed files with 1,411 additions and 829 deletions.
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ apply plugin: 'java'
apply plugin: 'com.diffplug.spotless'

group = 'io.github.vrchatapi'
version = '1.18.0'
version = '1.18.1'

buildscript {
repositories {
Expand Down
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
settings(
organization := "io.github.vrchatapi",
name := "vrchatapi",
version := "1.18.0",
version := "1.18.1",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
javacOptions in compile ++= Seq("-Xlint:deprecation"),
Expand Down
39 changes: 22 additions & 17 deletions docs/APIConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,28 +13,41 @@
|**address** | **String** | VRChat's office address | |
|**announcements** | [**Set<APIConfigAnnouncement>**](APIConfigAnnouncement.md) | Public Announcements | |
|**appName** | **String** | Game name | |
|**availableLanguageCodes** | **List<String>** | List of supported Languages | |
|**availableLanguages** | **List<String>** | List of supported Languages | |
|**buildVersionTag** | **String** | Build tag of the API server | |
|**clientApiKey** | **String** | apiKey to be used for all other requests | |
|**clientBPSCeiling** | **Integer** | Unknown | |
|**clientDisconnectTimeout** | **Integer** | Unknown | |
|**clientNetDispatchThread** | **Boolean** | Unknown | [optional] |
|**clientNetInThread** | **Boolean** | Unknown | [optional] |
|**clientNetInThread2** | **Boolean** | Unknown | [optional] |
|**clientNetInThreadMobile** | **Boolean** | Unknown | [optional] |
|**clientNetInThreadMobile2** | **Boolean** | Unknown | [optional] |
|**clientNetOutThread** | **Boolean** | Unknown | [optional] |
|**clientNetOutThread2** | **Boolean** | Unknown | [optional] |
|**clientNetOutThreadMobile** | **Boolean** | Unknown | [optional] |
|**clientNetOutThreadMobile2** | **Boolean** | Unknown | [optional] |
|**clientQR** | **Integer** | Unknown | [optional] |
|**clientReservedPlayerBPS** | **Integer** | Unknown | |
|**clientSentCountAllowance** | **Integer** | Unknown | |
|**contactEmail** | **String** | VRChat's contact email | |
|**copyrightEmail** | **String** | VRChat's copyright-issues-related email | |
|**currentPrivacyVersion** | **Integer** | Current version number of the Privacy Agreement | [optional] |
|**currentTOSVersion** | **Integer** | Current version number of the Terms of Service | |
|**defaultAvatar** | **String** | | |
|**deploymentGroup** | **DeploymentGroup** | | |
|**devAppVersionStandalone** | **String** | Version number for game development build | |
|**devDownloadLinkWindows** | **String** | Developer Download link | |
|**devLanguageCodes** | **List<String>** | Unknown | [optional] |
|**devSdkUrl** | **String** | Link to download the development SDK, use downloadUrls instead | |
|**devSdkVersion** | **String** | Version of the development SDK | |
|**devServerVersionStandalone** | **String** | Version number for server development build | |
|**disCountdown** | **OffsetDateTime** | Unknown, \"dis\" maybe for disconnect? | |
|**disableAVProInProton** | **Boolean** | Unknown | [optional] |
|**disableAvatarCopying** | **Boolean** | Toggles if copying avatars should be disabled | |
|**disableAvatarGating** | **Boolean** | Toggles if avatar gating should be disabled. Avatar gating restricts uploading of avatars to people with the `system_avatar_access` Tag or `admin_avatar_access` Tag | |
|**disableCommunityLabs** | **Boolean** | Toggles if the Community Labs should be disabled | |
|**disableCommunityLabsPromotion** | **Boolean** | Toggles if promotion out of Community Labs should be disabled | |
|**disableEmail** | **Boolean** | Unknown | |
|**disableCaptcha** | **Boolean** | Unknown | [optional] |
|**disableEventStream** | **Boolean** | Toggles if Analytics should be disabled. | |
|**disableFeedbackGating** | **Boolean** | Toggles if feedback gating should be disabled. Feedback gating restricts submission of feedback (reporting a World or User) to people with the `system_feedback_access` Tag. | |
|**disableFrontendBuilds** | **Boolean** | Unknown, probably toggles compilation of frontend web builds? So internal flag? | |
Expand All @@ -48,26 +61,23 @@
|**downloadLinkWindows** | **String** | Download link for game on the Oculus Rift website. | |
|**downloadUrls** | [**APIConfigDownloadURLList**](APIConfigDownloadURLList.md) | | |
|**dynamicWorldRows** | [**Set<DynamicContentRow>**](DynamicContentRow.md) | Array of DynamicWorldRow objects, used by the game to display the list of world rows | |
|**economyPauseEnd** | **String** | Unknown | [optional] |
|**economyPauseStart** | **String** | Unknown | [optional] |
|**economyState** | **Integer** | Unknown | [optional] |
|**events** | [**APIConfigEvents**](APIConfigEvents.md) | | |
|**gearDemoRoomId** | **String** | Unknown | |
|**homeWorldId** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | |
|**homepageRedirectTarget** | **String** | Redirect target if you try to open the base API domain in your browser | |
|**hubWorldId** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | |
|**imageHostUrlList** | **List<String>** | A list of explicitly allowed origins that worlds can request images from via the Udon's [VRCImageDownloader#DownloadImage](https://creators.vrchat.com/worlds/udon/image-loading/#downloadimage). | |
|**jobsEmail** | **String** | VRChat's job application email | |
|**messageOfTheDay** | **String** | MOTD | |
|**moderationEmail** | **String** | VRChat's moderation related email | |
|**moderationQueryPeriod** | **Integer** | Unknown | |
|**notAllowedToSelectAvatarInPrivateWorldMessage** | **String** | Used in-game to notify a user they aren't allowed to select avatars in private worlds | |
|**plugin** | **String** | Extra [plugin](https://doc.photonengine.com/en-us/server/current/plugins/manual) to run in each instance | |
|**releaseAppVersionStandalone** | **String** | Version number for game release build | |
|**releaseSdkUrl** | **String** | Link to download the release SDK | |
|**releaseSdkVersion** | **String** | Version of the release SDK | |
|**releaseServerVersionStandalone** | **String** | Version number for server release build | |
|**sdkDeveloperFaqUrl** | **String** | Link to the developer FAQ | |
|**sdkDiscordUrl** | **String** | Link to the official VRChat Discord | |
|**sdkNotAllowedToPublishMessage** | **String** | Used in the SDK to notify a user they aren't allowed to upload avatars/worlds yet | |
|**sdkUnityVersion** | **String** | Unity version supported by the SDK | |
|**serverName** | **String** | Server name of the API server currently responding | |
|**stringHostUrlList** | **List<String>** | A list of explicitly allowed origins that worlds can request strings from via the Udon's [VRCStringDownloader.LoadUrl](https://creators.vrchat.com/worlds/udon/string-loading/#ivrcstringdownload). | |
|**supportEmail** | **String** | VRChat's support email | |
|**timeOutWorldId** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | |
|**tutorialWorldId** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | |
Expand All @@ -78,15 +88,10 @@
|**uploadAnalysisPercent** | **Integer** | Unknown | |
|**urlList** | **List<String>** | List of allowed URLs that bypass the \"Allow untrusted URL's\" setting in-game | |
|**useReliableUdpForVoice** | **Boolean** | Unknown | |
|**userUpdatePeriod** | **Integer** | Unknown | |
|**userVerificationDelay** | **Integer** | Unknown | |
|**userVerificationRetry** | **Integer** | Unknown | |
|**userVerificationTimeout** | **Integer** | Unknown | |
|**viveWindowsUrl** | **String** | Download link for game on the Steam website. | |
|**whiteListedAssetUrls** | **List<String>** | List of allowed URLs that are allowed to host avatar assets | |
|**worldUpdatePeriod** | **Integer** | Unknown | |
|**playerUrlResolverHash** | **String** | Currently used youtube-dl.exe hash in SHA-256-delimited format | |
|**playerUrlResolverVersion** | **String** | Currently used youtube-dl.exe version | |
|**playerUrlResolverSha1** | **String** | Currently used youtube-dl.exe hash in SHA1-delimited format | |



8 changes: 4 additions & 4 deletions docs/AuthenticationApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ All URIs are relative to *https://vrchat.com/api/1*

<a name="checkUserExists"></a>
# **checkUserExists**
> UserExists checkUserExists(email, displayName, userId, excludeUserId)
> UserExists checkUserExists(email, displayName, username, excludeUserId)
Check User Exists

Expand All @@ -39,10 +39,10 @@ public class Example {
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 username = "username_example"; // String | Filter by Username.
String excludeUserId = "excludeUserId_example"; // String | Exclude by UserID.
try {
UserExists result = apiInstance.checkUserExists(email, displayName, userId, excludeUserId);
UserExists result = apiInstance.checkUserExists(email, displayName, username, excludeUserId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AuthenticationApi#checkUserExists");
Expand All @@ -61,7 +61,7 @@ public class Example {
|------------- | ------------- | ------------- | -------------|
| **email** | **String**| Filter by email. | [optional] |
| **displayName** | **String**| Filter by displayName. | [optional] |
| **userId** | **String**| Filter by UserID. | [optional] |
| **username** | **String**| Filter by Username. | [optional] |
| **excludeUserId** | **String**| Exclude by UserID. | [optional] |

### Return type
Expand Down
2 changes: 1 addition & 1 deletion docs/FileData.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
|------------ | ------------- | ------------- | -------------|
|**category** | [**CategoryEnum**](#CategoryEnum) | | |
|**fileName** | **String** | | |
|**md5** | **String** | | |
|**md5** | **String** | | [optional] |
|**sizeInBytes** | **Integer** | | |
|**status** | **FileStatus** | | |
|**uploadId** | **String** | | |
Expand Down
13 changes: 7 additions & 6 deletions docs/FilesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ public class Example {

<a name="deleteFile"></a>
# **deleteFile**
> Success deleteFile(fileId)
> ModelFile deleteFile(fileId)
Delete File

Expand Down Expand Up @@ -188,7 +188,7 @@ public class Example {
FilesApi apiInstance = new FilesApi(defaultClient);
String fileId = "file_00000000-0000-0000-0000-000000000000"; // String | Must be a valid file ID.
try {
Success result = apiInstance.deleteFile(fileId);
ModelFile result = apiInstance.deleteFile(fileId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FilesApi#deleteFile");
Expand All @@ -209,7 +209,7 @@ public class Example {

### Return type

[**Success**](Success.md)
[**ModelFile**](ModelFile.md)

### Authorization

Expand All @@ -223,7 +223,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful response after deleting a File. | - |
| **200** | Returns a single File object. | - |
| **404** | Error response when trying to delete a non-existent file. | - |

<a name="deleteFileVersion"></a>
Expand Down Expand Up @@ -297,7 +297,7 @@ public class Example {
|-------------|-------------|------------------|
| **200** | Returns a single File object. | - |
| **400** | Error response when trying to delete the initial version of a file. Delete the main File object instead. | - |
| **500** | Error response when trying to delete any version of a file that is not hte last one. | - |
| **500** | Error response when trying to delete any version of a file that is not the last one. | - |

<a name="downloadFileVersion"></a>
# **downloadFileVersion**
Expand Down Expand Up @@ -362,12 +362,13 @@ null (empty response body)
### HTTP request headers

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

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Raw file | - |
| **404** | Error response when trying to show information about a non-existent file. | - |

<a name="finishFileDataUpload"></a>
# **finishFileDataUpload**
Expand Down
3 changes: 3 additions & 0 deletions docs/Group.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,11 @@
|**isVerified** | **Boolean** | | [optional] |
|**joinState** | **GroupJoinState** | | [optional] |
|**tags** | **List&lt;String&gt;** | | [optional] |
|**transferTargetId** | **String** | A users unique ID, usually in the form of &#x60;usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469&#x60;. Legacy players can have old IDs in the form of &#x60;8JoV9XEdpo&#x60;. The ID can never be changed. | [optional] |
|**galleries** | [**List&lt;GroupGallery&gt;**](GroupGallery.md) | | [optional] |
|**createdAt** | **OffsetDateTime** | | [optional] |
|**updatedAt** | **OffsetDateTime** | | [optional] |
|**lastPostCreatedAt** | **OffsetDateTime** | | [optional] |
|**onlineMemberCount** | **Integer** | | [optional] |
|**membershipStatus** | **GroupMemberStatus** | | [optional] |
|**myMember** | [**GroupMyMember**](GroupMyMember.md) | | [optional] |
Expand Down
6 changes: 6 additions & 0 deletions docs/GroupMyMember.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
|**groupId** | **String** | | [optional] |
|**userId** | **String** | A users unique ID, usually in the form of &#x60;usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469&#x60;. Legacy players can have old IDs in the form of &#x60;8JoV9XEdpo&#x60;. The ID can never be changed. | [optional] |
|**roleIds** | **List&lt;String&gt;** | | [optional] |
|**acceptedByDisplayName** | **String** | | [optional] |
|**acceptedById** | **String** | A users unique ID, usually in the form of &#x60;usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469&#x60;. Legacy players can have old IDs in the form of &#x60;8JoV9XEdpo&#x60;. The ID can never be changed. | [optional] |
|**createdAt** | **OffsetDateTime** | | [optional] |
|**managerNotes** | **String** | | [optional] |
|**membershipStatus** | **String** | | [optional] |
|**isSubscribedToAnnouncements** | **Boolean** | | [optional] |
Expand All @@ -19,6 +22,9 @@
|**joinedAt** | **OffsetDateTime** | | [optional] |
|**bannedAt** | **String** | | [optional] |
|**has2FA** | **Boolean** | | [optional] |
|**hasJoinedFromPurchase** | **Boolean** | | [optional] |
|**lastPostReadAt** | **OffsetDateTime** | | [optional] |
|**mRoleIds** | **List&lt;String&gt;** | | [optional] |
|**permissions** | **List&lt;String&gt;** | | [optional] |


Expand Down
2 changes: 2 additions & 0 deletions docs/GroupsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -1583,6 +1583,7 @@ public class Example {
|-------------|-------------|------------------|
| **200** | Returns a list of GroupMember objects. | - |
| **401** | Error response due to missing auth cookie. | - |
| **403** | Error response due to missing permissions. | - |
| **404** | Error response when trying to perform operations on a non-existing group. | - |

<a name="getGroupGalleryImages"></a>
Expand Down Expand Up @@ -1882,6 +1883,7 @@ public class Example {
|-------------|-------------|------------------|
| **200** | Returns a list of GroupMember objects. | - |
| **401** | Error response due to missing auth cookie. | - |
| **403** | Error response when trying to perform operations on a group you are not member of. | - |
| **404** | Error response when trying to perform operations on a non-existing group. | - |

<a name="getGroupMembers"></a>
Expand Down
1 change: 1 addition & 0 deletions docs/Permission.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**id** | **String** | | |
|**ownerDisplayName** | **String** | | |
|**name** | **String** | | |
|**ownerId** | **String** | A users unique ID, usually in the form of &#x60;usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469&#x60;. Legacy players can have old IDs in the form of &#x60;8JoV9XEdpo&#x60;. The ID can never be changed. | |
|**data** | **Object** | | [optional] |
Expand Down
3 changes: 2 additions & 1 deletion docs/TransactionAgreement.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@

# TransactionAgreement


Represents a single Transaction, which is likely between VRChat and Steam.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**agreementId** | **String** | | |
|**itemId** | **BigDecimal** | | |
|**agreement** | **String** | | |
|**status** | **String** | This is NOT TransactionStatus, but whatever Steam return. | |
|**period** | **String** | | |
|**frequency** | **BigDecimal** | | |
Expand Down
1 change: 1 addition & 0 deletions docs/UserSubscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
|**tier** | **BigDecimal** | | |
|**active** | **Boolean** | | |
|**status** | **TransactionStatus** | | |
|**starts** | **OffsetDateTime** | | [optional] |
|**expires** | **OffsetDateTime** | | |
|**createdAt** | **OffsetDateTime** | | |
|**updatedAt** | **OffsetDateTime** | | |
Expand Down
6 changes: 4 additions & 2 deletions docs/WorldsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -783,7 +783,7 @@ null (empty response body)

<a name="searchWorlds"></a>
# **searchWorlds**
> List&lt;LimitedWorld&gt; searchWorlds(featured, sort, user, userId, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform)
> List&lt;LimitedWorld&gt; searchWorlds(featured, sort, user, userId, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, fuzzy)
Search All Worlds

Expand Down Expand Up @@ -825,8 +825,9 @@ public class Example {
String maxUnityVersion = "maxUnityVersion_example"; // String | The maximum Unity version supported by the asset.
String minUnityVersion = "minUnityVersion_example"; // String | The minimum Unity version supported by the asset.
String platform = "platform_example"; // String | The platform the asset supports.
Boolean fuzzy = true; // Boolean |
try {
List<LimitedWorld> result = apiInstance.searchWorlds(featured, sort, user, userId, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform);
List<LimitedWorld> result = apiInstance.searchWorlds(featured, sort, user, userId, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, fuzzy);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WorldsApi#searchWorlds");
Expand Down Expand Up @@ -857,6 +858,7 @@ public class Example {
| **maxUnityVersion** | **String**| The maximum Unity version supported by the asset. | [optional] |
| **minUnityVersion** | **String**| The minimum Unity version supported by the asset. | [optional] |
| **platform** | **String**| The platform the asset supports. | [optional] |
| **fuzzy** | **Boolean**| | [optional] |

### Return type

Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<artifactId>vrchatapi</artifactId>
<packaging>jar</packaging>
<name>vrchatapi</name>
<version>1.18.0</version>
<version>1.18.1</version>
<url>https://github.com/openapitools/openapi-generator</url>
<description>OpenAPI Java</description>
<scm>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/io/github/vrchatapi/ApiCallback.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* VRChat API Documentation
*
* The version of the OpenAPI document: 1.18.0
* The version of the OpenAPI document: 1.18.1
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/io/github/vrchatapi/ApiClient.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* VRChat API Documentation
*
* The version of the OpenAPI document: 1.18.0
* The version of the OpenAPI document: 1.18.1
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/io/github/vrchatapi/ApiException.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* VRChat API Documentation
*
* The version of the OpenAPI document: 1.18.0
* The version of the OpenAPI document: 1.18.1
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/io/github/vrchatapi/ApiResponse.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* VRChat API Documentation
*
* The version of the OpenAPI document: 1.18.0
* The version of the OpenAPI document: 1.18.1
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
Loading

0 comments on commit 8c50a3f

Please sign in to comment.