Merge branch 'master' into release

Author: YaroslawEkimov

README.md

@@ -13,6 +13,15 @@ This repository contains Aspose.Words Cloud SDK for Java source code. This SDK a
 * Watermarks and protection
 * Full read & write access to Document Object Model, including sections, paragraphs, text, images, tables, headers/footers and many others
 
+## Enhancements in Version 22.10
+
+- Added 'CacheHeaderFooterShapes' property for PdfSaveOptionsData class.
+- FileReference structure has been added that allows to determine how the document will be accessed: from the remote storage, or loaded directly in the request.
+- The 'AppendDocument' and 'AppendDocumentOnline' methods takes a 'FileReference' instead of an 'href' property.
+- Added property 'StartingNumber' for 'PageNumbers' class.
+- Added property 'GlobalCultureName' for 'FieldOptions' class.
+
+
 ## Enhancements in Version 22.9
 
 - CompressDocument method now can handle images.
@@ -242,7 +251,7 @@ Add this dependency to your project's POM:
     <dependency>
         <groupId>com.aspose</groupId>
         <artifactId>aspose-words-cloud</artifactId>
-        <version>22.9.0</version>
+        <version>22.10.0</version>
     </dependency>
 </dependencies>
 ```

pom.xml

@@ -4,7 +4,7 @@
     <artifactId>aspose-words-cloud</artifactId>
     <packaging>jar</packaging>
     <name>AsposeWordsCloud</name>
-    <version>22.9.0</version>
+    <version>22.10.0</version>
     <url>https://www.aspose.cloud/</url>
     <description>Aspose Words Java SDK</description>
     <scm>

src/main/java/com/aspose/words/cloud/ApiClient.java

@@ -27,6 +27,7 @@
 
 package com.aspose.words.cloud;
 
+import com.aspose.words.cloud.model.*;
 import com.aspose.words.cloud.model.requests.*;
 import com.squareup.okhttp.*;
 import com.squareup.okhttp.internal.http.HttpMethod;
@@ -58,7 +59,7 @@ public class ApiClient {
     private String apiVersion = "v4.0";
     private String baseUrl = "https://api.aspose.cloud";
     private String basePath = baseUrl + "/" + apiVersion;
-    private String clientVersion = "22.9";
+    private String clientVersion = "22.10";
     private boolean debugging = false;
     private Map<String, String> defaultHeaderMap = new HashMap<String, String>();
     private String tempFolderPath = null;
@@ -686,27 +687,24 @@ else if (returnType.equals(String.class)) {
      * class and the request Content-Type.
      *
      * @param obj The Java object
-     * @param contentType The request Content-Type
      * @return The serialized request body
      * @throws ApiException If fail to serialize the given object
      */
-    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);
-        } 
-        else if (isJsonMime(contentType)) {
-            String content;
-            if (obj != null) {
-                content = json.serialize(obj);
-            } 
-            else {
-                content = null;
-            }
-            return RequestBody.create(MediaType.parse(contentType), content);
-        } 
+    public RequestBody serialize(Object obj) throws ApiException {
+        if (obj instanceof RequestBody) {
+            return (RequestBody) obj;
+        }
+        else if (obj instanceof byte[]) {
+            return RequestBody.create(MediaType.parse("application/octet-stream"), (byte[]) obj);
+        }
+        else if (obj instanceof ModelIfc) {
+            return RequestBody.create(MediaType.parse("application/json"), json.serialize(obj));
+        }
+        else if (obj instanceof String) {
+            return RequestBody.create(MediaType.parse("text/plain"), (String) obj);
+        }
         else {
-            throw new ApiException("Content type \"" + contentType + "\" is not supported");
+            throw new ApiException("Unsupported object type to serialize.");
         }
     }
 
@@ -812,54 +810,46 @@ public Call buildCall(Request request) {
      * @param method The request method, one of "GET", "HEAD", "OPTIONS", "POST", "PUT", "PATCH" and "DELETE"
      * @param queryParams The query parameters
      * @param collectionQueryParams The collection query parameters
-     * @param body The request body object
      * @param headerParams The header parameters
      * @param formParams The form parameters
+     * @param filesContentParams The file content parameters
      * @param addAuthHeaders The authentications to apply
      * @param progressRequestListener Progress request listener
      * @return The HTTP request 
      * @throws ApiException If fail to serialize the request body object
      * @throws IOException If fail to serialize the request body object
      */
-    public Request buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, Boolean addAuthHeaders, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, IOException {
+    public Request buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Map<String, String> headerParams, Map<String, Object> formParams, List<FileReference> filesContentParams, Boolean addAuthHeaders, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, IOException {
         if (addAuthHeaders) {
             addOAuthAuthentication(headerParams);
         }
 
-        String contentType = (String) headerParams.get("Content-Type");
-        // ensuring a default content type
-        if (contentType == null) {
-            contentType = "application/json";
-        }
+        RequestBody reqBody = null;
+        if (HttpMethod.permitsRequestBody(method)) {
+            String contentType = headerParams.get("Content-Type");
+            int partsCount = formParams.size() + filesContentParams.size();
+            if ("application/x-www-form-urlencoded".equals(contentType)) {
+                reqBody = buildRequestBodyFormEncoding(formParams);
+            }
+            else if (partsCount == 0) {
+                if (!"DELETE".equals(method)) {
+                    reqBody = RequestBody.create(MediaType.parse("none"), "");
+                }
+            }
+            else if (partsCount == 1) {
+                Object part = formParams.values().toArray()[0];
+                if (part != null) {
+                    reqBody = serialize(part);
+                }
+            }
+            else if (partsCount > 1) {
+                String boundary = UUID.randomUUID().toString();
+                reqBody = buildRequestBodyMultipart(formParams, filesContentParams, boundary);
+            }
 
-        RequestBody reqBody;
-        if (!HttpMethod.permitsRequestBody(method)) {
-            reqBody = null;
-        } 
-        else if (body instanceof RequestBody) {
-            reqBody = (RequestBody) body;
-        }
-        else if ("application/x-www-form-urlencoded".equals(contentType)) {
-            reqBody = buildRequestBodyFormEncoding(formParams);
-        } 
-        else if ("multipart/form-data".equals(contentType)) {
-            String boundary = UUID.randomUUID().toString();
-            contentType += "; boundary=" + boundary;
-            headerParams.put("Content-Type", contentType);
-            reqBody = buildRequestBodyMultipart(formParams, boundary);
-        } 
-        else if (body == null) {
-            if ("DELETE".equals(method)) {
-                // allow calling DELETE without sending a request body
-                reqBody = null;
-            } 
-            else {
-                // use an empty request body (for POST, PUT and PATCH)
-                reqBody = RequestBody.create(MediaType.parse(contentType), "");
+            if (reqBody != null && reqBody.contentType() != null && !headerParams.containsKey("Content-Type")) {
+                headerParams.put("Content-Type", reqBody.contentType().toString());
             }
-        } 
-        else {
-            reqBody = serialize(body, contentType);
         }
 
         final String url = buildUrl(path, queryParams, collectionQueryParams);
@@ -967,27 +957,26 @@ public RequestBody buildRequestBodyFormEncoding(Map<String, Object> formParams)
      * which could contain text fields and file fields.
      *
      * @param formParams Form parameters in the form of Map
+     * @param fileParams Form parameters of additional files
+     * @param boundary Boundary string
      * @throws IOException If fail to serialize the request body object
+     * @throws ApiException If fail to serialize the request body object
      * @return RequestBody
      */
-    public RequestBody buildRequestBodyMultipart(Map<String, Object> formParams, String boundary) throws IOException {
+    public RequestBody buildRequestBodyMultipart(Map<String, Object> formParams, List<FileReference> fileParams, String boundary) throws IOException, ApiException {
         MultipartBuilder mpBuilder = new MultipartBuilder(boundary).type(MultipartBuilder.FORM);
         if (formParams.isEmpty()) {
             Headers partHeaders = Headers.of("Content-Disposition", "form-data");
             mpBuilder.addPart(partHeaders, RequestBody.create(MediaType.parse("none"), new byte[] {}));
         }
         else {
             for (Entry<String, Object> param : formParams.entrySet()) {
-                if (param.getValue() instanceof byte[]) {
-                    byte[] file = (byte[]) param.getValue();
-                    Headers partHeaders = Headers.of("Content-Disposition", "form-data; name=\"" + param.getKey() + "\"; filename=\"" + param.getKey() + "\"");
-                    MediaType mediaType = MediaType.parse(guessContentTypeFromFile(file));
-                    mpBuilder.addPart(partHeaders, RequestBody.create(mediaType, file));
-                } 
-                else {
-                    Headers partHeaders = Headers.of("Content-Disposition", "form-data; name=\"" + param.getKey() + "\"");
-                    mpBuilder.addPart(partHeaders, RequestBody.create(null, parameterToString(param.getValue())));
-                }
+                Headers partHeaders = Headers.of("Content-Disposition", "form-data; name=\"" + param.getKey() + "\"");
+                mpBuilder.addPart(partHeaders, serialize(param.getValue()));
+            }
+            for (FileReference param : fileParams) {
+                Headers partHeaders = Headers.of("Content-Disposition", "form-data; name=\"" + param.getReference() + "\"");
+                mpBuilder.addPart(partHeaders, RequestBody.create(MediaType.parse("application/octet-stream"), param.getContent()));
             }
         }
         return mpBuilder.build();
@@ -1078,14 +1067,15 @@ public Request buildBatchRequest(BatchPartRequest[] requests, Boolean displayInt
 
         RequestBody requestBody = builder.build();
         Map<String, String> headers = new HashMap<>();
-        headers.put("Content-Type", requestBody.contentType().toString());
+        Map<String, Object> formData = new HashMap<>();
+        formData.put("Body", requestBody);
 
         String url = "/words/batch";
         if (!displayIntermediateResults) {
             url += "?displayIntermediateResults=false";
         }
 
-        return buildRequest(url, "PUT", new ArrayList<>(), new ArrayList<>(), requestBody, headers, new HashMap<>(), true, null);
+        return buildRequest(url, "PUT", new ArrayList<>(), new ArrayList<>(), headers, formData, new ArrayList<>(), true, null);
     }
 
     /**

src/main/java/com/aspose/words/cloud/model/ApiError.java

@@ -46,7 +46,7 @@
  * Api error.
  */
 @ApiModel(description = "Api error.")
-public class ApiError {
+public class ApiError implements ModelIfc {
     @SerializedName("Code")
     protected String code;
 
@@ -164,6 +164,15 @@ public ApiError() {
         this.message = null;
     }
 
+    /*
+     * Gets files content.
+     *
+     * @param resultFilesContent List<FileReference> instance.
+     */
+    @Override
+    public void getFilesContent(List<FileReference> resultFilesContent) {
+    }
+
     @Override
     public boolean equals(java.lang.Object o) {
         if (this == o) {

src/main/java/com/aspose/words/cloud/model/AvailableFontsResponse.java

@@ -146,6 +146,15 @@ public AvailableFontsResponse() {
         this.systemFonts = null;
     }
 
+    /*
+     * Gets files content.
+     *
+     * @param resultFilesContent List<FileReference> instance.
+     */
+    @Override
+    public void getFilesContent(List<FileReference> resultFilesContent) {
+    }
+
     @Override
     public boolean equals(java.lang.Object o) {
         if (this == o) {

src/main/java/com/aspose/words/cloud/model/BaseEntry.java

@@ -43,33 +43,46 @@
 import io.swagger.annotations.ApiModelProperty;
 
 /**
- * Represents a entry which will be appended to the original resource document.
+ * Represents a base class for document which will be appended to the original resource document.
  */
-@ApiModel(description = "Represents a entry which will be appended to the original resource document.")
-public class BaseEntry {
-    @SerializedName("Href")
-    protected String href;
+@ApiModel(description = "Represents a base class for document which will be appended to the original resource document.")
+public abstract class BaseEntry implements ModelIfc {
+    @SerializedName("FileReference")
+    protected FileReference fileReference;
     /**
-     * Gets or sets the path to entry to append at the server.
-    * @return href
+     * Gets or sets the file reference.
+    * @return fileReference
     **/
-    @ApiModelProperty(value = "Gets or sets the path to entry to append at the server.")
-    public String getHref() {
-        return href;
+    @ApiModelProperty(value = "Gets or sets the file reference.")
+    public FileReference getFileReference() {
+        return fileReference;
     }
 
-    public BaseEntry href(String href) {
-        this.href = href;
+    public BaseEntry fileReference(FileReference fileReference) {
+        this.fileReference = fileReference;
         return this;
     }
 
-    public void setHref(String href) {
-        this.href = href;
+    public void setFileReference(FileReference fileReference) {
+        this.fileReference = fileReference;
     }
 
 
     public BaseEntry() {
-        this.href = null;
+        this.fileReference = null;
+    }
+
+    /*
+     * Gets files content.
+     *
+     * @param resultFilesContent List<FileReference> instance.
+     */
+    @Override
+    public void getFilesContent(List<FileReference> resultFilesContent) {
+        if (this.fileReference != null) {
+            this.fileReference.getFilesContent(resultFilesContent);
+        }
+
     }
 
     @Override
@@ -83,19 +96,19 @@ public boolean equals(java.lang.Object o) {
 
         BaseEntry baseEntry = (BaseEntry) o;
         return
-            Objects.equals(this.href, baseEntry.href);
+            Objects.equals(this.fileReference, baseEntry.fileReference);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(href);
+    return Objects.hash(fileReference);
   }
 
   @Override
   public String toString() {
     StringBuilder sb = new StringBuilder();
     sb.append("class BaseEntry {\n");
-    sb.append("    href: ").append(toIndentedString(getHref())).append("\n");
+    sb.append("    fileReference: ").append(toIndentedString(getFileReference())).append("\n");
     sb.append("}");
     return sb.toString();
   }

src/main/java/com/aspose/words/cloud/model/BaseEntryList.java

@@ -46,11 +46,20 @@
  * Represents a list of entries which will be appended to the original resource entry.
  */
 @ApiModel(description = "Represents a list of entries which will be appended to the original resource entry.")
-public abstract class BaseEntryList {
+public abstract class BaseEntryList implements ModelIfc {
 
     public BaseEntryList() {
     }
 
+    /*
+     * Gets files content.
+     *
+     * @param resultFilesContent List<FileReference> instance.
+     */
+    @Override
+    public void getFilesContent(List<FileReference> resultFilesContent) {
+    }
+
     @Override
     public boolean equals(java.lang.Object o) {
         if (this == o) {