update to 6.86.0

Author: gateio

.gitignore

@@ -19,3 +19,4 @@ hs_err_pid*
 target
 .gradle
 build
+*.iml

README.md

@@ -1,7 +1,9 @@
 # gate-api
 
 Gate API v4
+
 - API version: 4.86.0
+- SDK version: 6.86.0
 
 Welcome to Gate.io API
 
@@ -11,39 +13,48 @@ APIv4 provides spot, margin and futures trading operations. There are public API
 
 *Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
 
+## Versioning
 
-## Requirements
+Trying our best to follow the [semantic versioning](https://semver.org/), while enjoying recent features
+provided by programming language and libraries, from 4.15.2, one major versioning difference will be
+introduced:
 
-Building the API client library requires:
-1. Java 1.8+
-2. Maven/Gradle
+If extra code rewrite is required when you upgrade the SDK, such as:
 
-## Installation
+- some outdated programming language version support is dropped
+- API method signature has breaking changes.
 
-To install the API client library to your local Maven repository, simply execute:
+**the MAJOR version will be incremented, but the MINOR and PATCH version are still following REST API's
+instead of resetting to 0**, so that you can recognize it has some breaking changes, but still getting
+the idea of from which REST API version the change is introduced.
 
-```shell
-mvn clean install
-```
+For example, the previous REST API and SDK version are both 4.14.0. But if we decide to introduce
+some breaking changes in SDK along with REST API 4.15.2 upgrade, then the version of next SDK release
+will be 5.15.2(the MAJOR version is incremented to denote breaking changes, but the MINOR and PATCH
+version are identical to REST API's instead of resetting them to 0)
 
-To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
+If MAJOR version is incremented, make sure you read the release note on
+[Releases](https://github.com/gateio/gateapi-java/releases)
+page
 
-```shell
-mvn clean deploy
-```
+## Requirements
 
-Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
+Building the API client library requires:
+1. Java 1.8+
+2. Maven/Gradle
+
+## Installation
 
 ### Maven users
 
 Add this dependency to your project's POM:
 
 ```xml
 <dependency>
-  <groupId>io.gate</groupId>
-  <artifactId>gate-api</artifactId>
-  <version>6.86.0</version>
-  <scope>compile</scope>
+    <groupId>io.gate</groupId>
+    <artifactId>gate-api</artifactId>
+    <version>6.86.0</version>
+    <scope>compile</scope>
 </dependency>
 ```
 
@@ -68,47 +79,62 @@ Then manually install the following JARs:
 * `target/gate-api-6.86.0.jar`
 * `target/lib/*.jar`
 
+To install the API client library to your local Maven repository, simply execute:
+
+```shell
+mvn clean install
+```
+
+To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
+
+```shell
+mvn clean deploy
+```
+
+Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
+
 ## Getting Started
 
 Please follow the [installation](#installation) instruction and execute the following Java code:
 
-```java
 
+```java
 // Import classes:
 import io.gate.gateapi.ApiClient;
 import io.gate.gateapi.ApiException;
 import io.gate.gateapi.Configuration;
+import io.gate.gateapi.GateApiException;
 import io.gate.gateapi.auth.*;
 import io.gate.gateapi.models.*;
 import io.gate.gateapi.api.AccountApi;
 
 public class Example {
-  public static void main(String[] args) {
-    ApiClient defaultClient = Configuration.getDefaultApiClient();
-    defaultClient.setBasePath("https://api.gateio.ws/api/v4");
-    
-    // Configure API key authorization: apiv4
-    ApiKeyAuth apiv4 = (ApiKeyAuth) defaultClient.getAuthentication("apiv4");
-    apiv4.setApiKey("YOUR API KEY");
-    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-    //apiv4.setApiKeyPrefix("Token");
-
-    AccountApi apiInstance = new AccountApi(defaultClient);
-    try {
-      AccountDetail result = apiInstance.getAccountDetail();
-      System.out.println(result);
-    } catch (ApiException e) {
-      System.err.println("Exception when calling AccountApi#getAccountDetail");
-      System.err.println("Status code: " + e.getCode());
-      System.err.println("Reason: " + e.getResponseBody());
-      System.err.println("Response headers: " + e.getResponseHeaders());
-      e.printStackTrace();
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        defaultClient.setBasePath("https://api.gateio.ws/api/v4");
+        
+        // Configure APIv4 authorization: apiv4
+        defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
+
+        AccountApi apiInstance = new AccountApi(defaultClient);
+        try {
+            AccountDetail result = apiInstance.getAccountDetail();
+            System.out.println(result);
+        } catch (GateApiException e) {
+            System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
+            e.printStackTrace();
+        } catch (ApiException e) {
+            System.err.println("Exception when calling AccountApi#getAccountDetail");
+            System.err.println("Status code: " + e.getCode());
+            System.err.println("Response headers: " + e.getResponseHeaders());
+            e.printStackTrace();
+        }
     }
-  }
 }
-
 ```
 
+For a more complete API usage example, refer to the demo application in [example](example) directory
+
 ## Documentation for API Endpoints
 
 All URIs are relative to *https://api.gateio.ws/api/v4*
@@ -662,16 +688,14 @@ Class | Method | HTTP request | Description
 ## Documentation for Authorization
 
 Authentication schemes defined for the API:
-### apiv4
 
-- **Type**: API key
-- **API key parameter name**: SIGN
-- **Location**: HTTP header
+### apiv4
 
+- **Type**: Gate APIv4
 
 ## Recommendation
 
-It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
+It's recommended to create an instance of `ApiClient` per thread in a multi-threaded environment to avoid any potential issues.
 
 ## Author
 

build.gradle

@@ -98,12 +98,12 @@ if(hasProperty('target') && target == 'android') {
 }
 
 dependencies {
-    compile 'io.swagger:swagger-annotations:1.5.24'
     compile "com.google.code.findbugs:jsr305:3.0.2"
-    compile 'com.squareup.okhttp3:okhttp:3.14.7'
-    compile 'com.squareup.okhttp3:logging-interceptor:3.14.7'
-    compile 'com.google.code.gson:gson:2.8.6'
+    compile 'com.squareup.okhttp3:okhttp:4.9.3'
+    compile 'com.squareup.okhttp3:logging-interceptor:4.9.3'
+    compile 'com.google.code.gson:gson:2.10'
     compile 'io.gsonfire:gson-fire:1.8.4'
+    compile 'commons-codec:commons-codec:1.14'
     compile group: 'org.apache.commons', name: 'commons-lang3', version: '3.10'
     testCompile 'junit:junit:4.13'
 }

build.sbt

@@ -9,11 +9,11 @@ lazy val root = (project in file(".")).
     publishArtifact in (Compile, packageDoc) := false,
     resolvers += Resolver.mavenLocal,
     libraryDependencies ++= Seq(
-      "io.swagger" % "swagger-annotations" % "1.5.24",
-      "com.squareup.okhttp3" % "okhttp" % "3.14.7",
-      "com.squareup.okhttp3" % "logging-interceptor" % "3.14.7",
-      "com.google.code.gson" % "gson" % "2.8.6",
+      "com.squareup.okhttp3" % "okhttp" % "4.9.3",
+      "com.squareup.okhttp3" % "logging-interceptor" % "4.9.3",
+      "com.google.code.gson" % "gson" % "2.10",
       "org.apache.commons" % "commons-lang3" % "3.10",
+      "commons-codec" % "commons-codec" % "1.14",
       "io.gsonfire" % "gson-fire" % "1.8.3" % "compile",
       "javax.annotation" % "javax.annotation-api" % "1.3.2" % "compile",
       "com.google.code.findbugs" % "jsr305" % "3.0.2" % "compile",