Latest changes for templates and configs

Author: Ivan Kamkin

codegen/Templates/csharp/README.mustache

@@ -8,6 +8,11 @@
 - API version: {{appVersion}}
 - SDK version: {{packageVersion}}
 
+## SDK and API Version Compatibility:
+
+- SDK Version 25.1 and Later: Starting from SDK version 25.1, all subsequent versions are compatible with API Version v4.0.
+- SDK Version 24.12 and Earlier: These versions are compatible with API Version v3.0.
+
 ## Demo applications
 
 [Scan QR](https://products.aspose.app/barcode/scanqr) | [Generate Barcode](https://products.aspose.app/barcode/generate) | [Recognize Barcode](https://products.aspose.app/barcode/recognize)

codegen/Templates/csharp/api.mustache

@@ -66,6 +66,7 @@ namespace {{packageName}}.Api
         /// </summary>
         {{#allParams}}/// <param name="{{paramName}}">{{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param>
         {{/allParams}}
+        /// <param name="cancellationToken"></param>
         /// <returns>
         /// A task that represents the asynchronous operation. {{#returnType}}Task result type is  <see cref="{{returnType}}" /> {{/returnType}}
         /// </returns>

codegen/Templates/dart/README.mustache

@@ -5,6 +5,11 @@
 - API version: {{appVersion}}
 - SDK version: {{pubVersion}}
 
+## SDK and API Version Compatibility:
+
+- SDK Version 4.25.1 and Later: Starting from SDK version 25.1, all subsequent versions are compatible with API Version v4.0.
+- SDK Version 1.24.12 and Earlier: These versions are compatible with API Version v3.0.
+
 {{pubDescription}}
 
 ## Demo applications

codegen/Templates/dart/api_client.mustache

@@ -118,7 +118,7 @@ class ApiClient {
   }
 
   /// Invoke HTTP request
-  /// We don't use a Map<String, String> for queryParams.
+  /// We don't use a `Map<String, String>` for queryParams.
   /// If collectionFormat is 'multi' a key might appear multiple times.
   Future<Http.Response> invokeAPI(String path,
                              String method,

codegen/Templates/dart/enum.mustache

@@ -11,7 +11,7 @@ class {{classname}} {
       {{#description}}
   /// {{description}}
       {{/description}}
-  // ignore: non_constant_identifier_names
+  // ignore: non_constant_identifier_names{{^description}}, public_member_api_docs{{/description}}
   static final {{classname}} {{.}} = {{classname}}._internal("{{.}}");
     {{/values}}
   {{/allowableValues}}

codegen/Templates/go/README.mustache

@@ -7,6 +7,11 @@
 - API version: {{appVersion}}
 - SDK version: {{packageVersion}}
 
+## SDK and API Version Compatibility:
+
+- SDK Version 4.2501.0 and Later: Starting from SDK version 25.1, all subsequent versions are compatible with API Version v4.0.
+- SDK Version 1.2412.0 and Earlier: These versions are compatible with API Version v3.0.
+
 ## Demo applications
 
 [Scan QR](https://products.aspose.app/barcode/scanqr) | [Generate Barcode](https://products.aspose.app/barcode/generate) | [Recognize Barcode](https://products.aspose.app/barcode/recognize)

codegen/Templates/java/ApiClient.mustache

@@ -1,19 +1,19 @@
 package {{invokerPackage}};
 
 import com.aspose.barcode.cloud.model.ApiErrorResponse;
-import com.squareup.okhttp.Call;
-import com.squareup.okhttp.Callback;
-import com.squareup.okhttp.FormEncodingBuilder;
-import com.squareup.okhttp.Headers;
-import com.squareup.okhttp.MediaType;
-import com.squareup.okhttp.MultipartBuilder;
-import com.squareup.okhttp.OkHttpClient;
-import com.squareup.okhttp.Request;
-import com.squareup.okhttp.RequestBody;
-import com.squareup.okhttp.Response;
-import com.squareup.okhttp.internal.http.HttpMethod;
-import com.squareup.okhttp.logging.HttpLoggingInterceptor;
-import com.squareup.okhttp.logging.HttpLoggingInterceptor.Level;
+import okhttp3.Call;
+import okhttp3.Callback;
+import okhttp3.FormBody;
+import okhttp3.Headers;
+import okhttp3.MediaType;
+import okhttp3.MultipartBody;
+import okhttp3.OkHttpClient;
+import okhttp3.Request;
+import okhttp3.RequestBody;
+import okhttp3.Response;
+import okhttp3.internal.http.HttpMethod;
+import okhttp3.logging.HttpLoggingInterceptor;
+import okhttp3.logging.HttpLoggingInterceptor.Level;
 import okio.BufferedSink;
 import okio.Okio;
 {{#joda}}
@@ -65,7 +65,7 @@ public class ApiClient {
     private boolean debugging = false;
     private final Map<String, String> defaultHeaderMap = new HashMap<>();
     private String tempFolderPath = null;
-    private final OkHttpClient httpClient;
+    private OkHttpClient httpClient;
     private final JSON json;
     private HttpLoggingInterceptor loggingInterceptor;
     private String accessToken;
@@ -98,13 +98,11 @@ public class ApiClient {
         }
     }
 
-    protected ApiClient() {
-        httpClient = new OkHttpClient();
-
-        {{#useGzipFeature}}
-        // Enable gzip request compression
-        httpClient.interceptors().add(new GzipRequestInterceptor());
-        {{/useGzipFeature}}
+    /** Constructor for ApiClient with readTimeout */
+    protected ApiClient(long readTimeoutMillis) {
+        httpClient = new  OkHttpClient.Builder()
+                        .readTimeout(readTimeoutMillis, TimeUnit.MILLISECONDS)
+                        .build();
 
         json = new JSON();
 
@@ -116,6 +114,9 @@ public class ApiClient {
         setReadTimeout(60_000);
     }
 
+    protected ApiClient() {
+        this(60_000);
+    }
     /**
      * Get base path.
      *
@@ -230,27 +231,18 @@ public class ApiClient {
      * @return Timeout in milliseconds
      */
     public int getConnectTimeout() {
-        return httpClient.getConnectTimeout();
+        return httpClient.connectTimeoutMillis();
     }
 
-    /**
-     * Sets the connect timeout (in milliseconds).
-     * A value of 0 means no timeout, otherwise values must be between 1 and
-     * {@link Integer#MAX_VALUE}.
-     *
-     * @param connectionTimeout connection timeout in milliseconds
-     */
-    public void setConnectTimeout(int connectionTimeout) {
-        httpClient.setConnectTimeout(connectionTimeout, TimeUnit.MILLISECONDS);
-    }
+
 
     /**
      * Get read timeout (in milliseconds).
      *
      * @return Timeout in milliseconds
      */
     public int getReadTimeout() {
-        return httpClient.getReadTimeout();
+        return httpClient.readTimeoutMillis();
     }
 
     /**
@@ -261,7 +253,7 @@ public class ApiClient {
      * @param readTimeout read timeout in milliseconds
      */
     public void setReadTimeout(int readTimeout) {
-        httpClient.setReadTimeout(readTimeout, TimeUnit.MILLISECONDS);
+        httpClient = new OkHttpClient.Builder().readTimeout(readTimeout, TimeUnit.MILLISECONDS).build();
     }
 
     /**
@@ -270,19 +262,10 @@ public class ApiClient {
      * @return Timeout in milliseconds
      */
     public int getWriteTimeout() {
-        return httpClient.getWriteTimeout();
+        return httpClient.writeTimeoutMillis();
     }
 
-    /**
-     * Sets the write timeout (in milliseconds).
-     * A value of 0 means no timeout, otherwise values must be between 1 and
-     * {@link Integer#MAX_VALUE}.
-     *
-     * @param writeTimeout connection timeout in milliseconds
-     */
-    public void setWriteTimeout(int writeTimeout) {
-        httpClient.setWriteTimeout(writeTimeout, TimeUnit.MILLISECONDS);
-    }
+
 
     /**
      * Format the given parameter object into string.
@@ -293,13 +276,15 @@ public class ApiClient {
     public String parameterToString(Object param) {
         if (param == null) {
             return "";
-        } else if (param instanceof Date {{#joda}}|| param instanceof DateTime || param instanceof LocalDate{{/joda}}{{#jsr310}}|| param instanceof OffsetDateTime || param instanceof LocalDate{{/jsr310}}) {
-            //Serialize to json string and remove the " enclosing characters
+        } else if (param instanceof Date
+                || param instanceof OffsetDateTime
+                || param instanceof LocalDate) {
+            // Serialize to json string and remove the " enclosing characters
             String jsonStr = json.serialize(param);
             return jsonStr.substring(1, jsonStr.length() - 1);
         } else if (param instanceof Collection) {
             StringBuilder b = new StringBuilder();
-            for (Object o : (Collection)param) {
+            for (Object o : (Collection<Object>) param) {
                 if (b.length() > 0) {
                     b.append(",");
                 }
@@ -371,7 +356,7 @@ public class ApiClient {
             delimiter = escapeString("|");
         }
 
-        StringBuilder sb = new StringBuilder() ;
+        StringBuilder sb = new StringBuilder();
         for (Object item : value) {
             sb.append(delimiter);
             sb.append(escapeString(parameterToString(item)));
@@ -539,18 +524,18 @@ public class ApiClient {
     public RequestBody serialize(Object obj, String contentType) throws ApiException {
         if (obj instanceof byte[]) {
             // Binary (byte array) body parameter support.
-            return RequestBody.create(MediaType.parse(contentType), (byte[]) obj);
+           return RequestBody.create((byte[]) obj,MediaType.parse(contentType));
         } else if (obj instanceof File) {
             // File body parameter support.
-            return RequestBody.create(MediaType.parse(contentType), (File) obj);
+            return RequestBody.create((File) obj, MediaType.parse(contentType));
         } else if (isJsonMime(contentType)) {
             String content;
             if (obj != null) {
                 content = json.serialize(obj);
             } else {
                 content = null;
             }
-            return RequestBody.create(MediaType.parse(contentType), content);
+            return RequestBody.create(content, MediaType.parse(contentType));
         } else {
             throw new ApiException("Content type \"" + contentType + "\" is not supported");
         }
@@ -672,24 +657,26 @@ public class ApiClient {
      * @param callback ApiCallback
      */
     public <T> void executeAsync(Call call, final Type returnType, final ApiCallback<T> callback) {
-        call.enqueue(new Callback() {
-            @Override
-            public void onFailure(Request request, IOException e) {
-                callback.onFailure(new ApiException(e), 0, null);
-            }
+        call.enqueue(
+                new okhttp3.Callback() {
+                    @Override
+                    public void onFailure(Call call, IOException e) {
+                        callback.onFailure(new ApiException(e), 0, null);
+                    }
 
             @Override
-            public void onResponse(Response response) {
-                T result;
-                try {
-                    result = handleResponse(response, returnType);
-                } catch (ApiException e) {
-                    callback.onFailure(e, response.code(), response.headers().toMultimap());
-                    return;
-                }
-                callback.onSuccess(result, response.code(), response.headers().toMultimap());
-            }
-        });
+                    public void onResponse(Call call, Response response) {
+                        T result;
+                        try {
+                            result = handleResponse(response, returnType);
+                        } catch (ApiException e) {
+                            callback.onFailure(e, response.code(), response.headers().toMultimap());
+                            return;
+                        }
+                        callback.onSuccess(
+                                result, response.code(), response.headers().toMultimap());
+                    }
+                });
     }
 
     /**
@@ -708,7 +695,7 @@ public class ApiClient {
                 if (response.body() != null) {
                     try {
                         response.body().close();
-                    } catch (IOException e) {
+                    } catch (Exception e) {
                         throw new ApiException(response.message(), e, response.code(), response.headers().toMultimap());
                     }
                 }
@@ -788,7 +775,7 @@ public class ApiClient {
                 reqBody = null;
             } else {
                 // use an empty request body (for POST, PUT and PATCH)
-                reqBody = RequestBody.create(MediaType.parse(contentType), "");
+                reqBody = RequestBody.create( "", MediaType.parse(contentType));
             }
         } else {
             reqBody = serialize(body, contentType);
@@ -880,14 +867,14 @@ public class ApiClient {
      * @return RequestBody
      */
     public RequestBody buildRequestBodyMultipart(Map<String, Object> formParams) {
-        MultipartBuilder mpBuilder = new MultipartBuilder().type(MultipartBuilder.FORM);
+        MultipartBody.Builder mpBuilder = new MultipartBody.Builder().setType(MultipartBody.FORM);
         for (Entry<String, Object> param : formParams.entrySet()) {
             Object paramValue = param.getValue();
             if (paramValue instanceof File) {
                 File file = (File) paramValue;
                 Headers partHeaders = Headers.of("Content-Disposition", "form-data; name=\"" + param.getKey() + "\"; filename=\"" + file.getName() + "\"");
                 MediaType mediaType = MediaType.parse(guessContentTypeFromFile(file));
-                mpBuilder.addPart(partHeaders, RequestBody.create(mediaType, file));
+                mpBuilder.addPart(partHeaders, RequestBody.create(file, mediaType));
             } else if (paramValue instanceof Collection) {
                 Collection<Object> collection = (Collection<Object>) paramValue;
                 for (Object item : collection) {
@@ -896,7 +883,7 @@ public class ApiClient {
                                     "Content-Disposition",
                                     "form-data; name=\"" + param.getKey() + "\"");
                     mpBuilder.addPart(
-                            partHeaders, RequestBody.create(null, parameterToString(item)));
+                            partHeaders, RequestBody.create(parameterToString(item), null));
                 }
             } else {
                 Headers partHeaders = Headers.of("Content-Disposition", "form-data; name=\"" + param.getKey() + "\"");
@@ -929,7 +916,7 @@ public class ApiClient {
     public void requestToken() throws ApiException {
         try {
             RequestBody requestBody =
-                    new FormEncodingBuilder()
+                    new FormBody.Builder()
                             .addEncoded("grant_type", "client_credentials")
                             .addEncoded("client_id", clientId)
                             .addEncoded("client_secret", clientSecret)

codegen/Templates/java/README.mustache

@@ -7,6 +7,11 @@
 - API version: {{appVersion}}
 - SDK version: {{artifactVersion}}
 
+## SDK and API Version Compatibility:
+
+- SDK Version 25.1 and Later: Starting from SDK version 25.1, all subsequent versions are compatible with API Version v4.0.
+- SDK Version 24.12 and Earlier: These versions are compatible with API Version v3.0.
+
 ## Demo applications
 
 [Scan QR](https://products.aspose.app/barcode/scanqr) | [Generate Barcode](https://products.aspose.app/barcode/generate) | [Recognize Barcode](https://products.aspose.app/barcode/recognize)