SDK regenerated by CI server [ci skip]

Author: dynabic-billing-team

README.md

@@ -17,6 +17,8 @@ This repository contains Aspose.Words Cloud SDK for Java source code. This SDK a
 
 - Properties Name, Text, StartRange, EndRange marked as required for InsertBookmark operation.
 - Implemented DeleteOfficeMathObjects operation to delete all office math objects from document.
+- Parameter ProtectionRequest was removed from the UnprotectDocument operation. Now removing protection from a document does not require a password.
+- Model ProtectionRequest marked as deprecated, please use ProtectionRequestV2 instead for perform ProtectDocument operation. To change the password or protection type of protected document, the old password is no required.
 
 
 ## Enhancements in Version 23.11

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

@@ -582,6 +582,7 @@ public static class ModelAdapterFactory implements TypeAdapterFactory {
                 put("ProtectionData, _", com.aspose.words.cloud.model.ProtectionData.class);
                 put("ProtectionDataResponse, _", com.aspose.words.cloud.model.ProtectionDataResponse.class);
                 put("ProtectionRequest, _", com.aspose.words.cloud.model.ProtectionRequest.class);
+                put("ProtectionRequestV2, _", com.aspose.words.cloud.model.ProtectionRequestV2.class);
                 put("PsSaveOptionsData, _", com.aspose.words.cloud.model.PsSaveOptionsData.class);
                 put("PublicKeyResponse, _", com.aspose.words.cloud.model.PublicKeyResponse.class);
                 put("RangeDocument, _", com.aspose.words.cloud.model.RangeDocument.class);

src/main/java/com/aspose/words/cloud/api/WordsApi.java

@@ -18686,7 +18686,7 @@ private com.squareup.okhttp.Call protectDocumentValidateBeforeCall(ProtectDocume
     }
 
     /**
-     * Adds protection to the document.
+     * Changes the document protection. The previous protection will be overwritten if it exist.
      * @param request Request object
      * @return ProtectionDataResponse
      * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -18708,7 +18708,7 @@ public ProtectionDataResponse protectDocument(ProtectDocumentRequest request) th
     }
 
     /**
-     * Adds protection to the document.
+     * Changes the document protection. The previous protection will be overwritten if it exist.
      * @param request Request object
      * @return ApiResponse< ProtectionDataResponse >;
      * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -18720,7 +18720,7 @@ private ApiResponse< ProtectionDataResponse > protectDocumentWithHttpInfo(Protec
     }
 
     /**
-     * Adds protection to the document. (asynchronously)
+     * Changes the document protection. The previous protection will be overwritten if it exist. (asynchronously)
      * @param request Request object
      * @param callback The callback to be executed when the API call finishes
      * @return The request call
@@ -18759,7 +18759,7 @@ private com.squareup.okhttp.Call protectDocumentOnlineValidateBeforeCall(Protect
     }
 
     /**
-     * Adds protection to the document.
+     * Changes the document protection. The previous protection will be overwritten if it exist.
      * @param request Request object
      * @return ProtectDocumentOnlineResponse
      * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -18781,7 +18781,7 @@ public ProtectDocumentOnlineResponse protectDocumentOnline(ProtectDocumentOnline
     }
 
     /**
-     * Adds protection to the document.
+     * Changes the document protection. The previous protection will be overwritten if it exist.
      * @param request Request object
      * @return ApiResponse< ProtectDocumentOnlineResponse >;
      * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -18793,7 +18793,7 @@ private ApiResponse< ProtectDocumentOnlineResponse > protectDocumentOnlineWithHt
     }
 
     /**
-     * Adds protection to the document. (asynchronously)
+     * Changes the document protection. The previous protection will be overwritten if it exist. (asynchronously)
      * @param request Request object
      * @param callback The callback to be executed when the API call finishes
      * @return The request call

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

@@ -48,23 +48,72 @@
  */
 @ApiModel(description = "Container for the data about protection of the document.")
 public class ProtectionData implements ModelIfc {
+    /**
+     * Gets or sets type of the protection.
+     */
+    @JsonAdapter(ProtectionTypeEnum.Adapter.class)
+    public enum ProtectionTypeEnum {
+        ALLOWONLYREVISIONS("AllowOnlyRevisions"),
+        ALLOWONLYCOMMENTS("AllowOnlyComments"),
+        ALLOWONLYFORMFIELDS("AllowOnlyFormFields"),
+        READONLY("ReadOnly"),
+        NOPROTECTION("NoProtection");
+
+        private String value;
+
+        ProtectionTypeEnum(String value) {
+            this.value = value;
+        }
+
+        public String getValue() {
+            return value;
+        }
+
+        @Override
+        public String toString() {
+            return String.valueOf(value);
+        }
+
+        public static ProtectionTypeEnum fromValue(String text) {
+            for (ProtectionTypeEnum b : ProtectionTypeEnum.values()) {
+                if (String.valueOf(b.value).equals(text)) {
+                    return b;
+                }
+            }
+            return null;
+        }
+
+        public static class Adapter extends TypeAdapter< ProtectionTypeEnum > {
+            @Override
+            public void write(final JsonWriter jsonWriter, final ProtectionTypeEnum enumeration) throws IOException {
+                jsonWriter.value(enumeration.getValue());
+            }
+
+            @Override
+            public ProtectionTypeEnum read(final JsonReader jsonReader) throws IOException {
+                String value = jsonReader.nextString();
+                return ProtectionTypeEnum.fromValue(String.valueOf(value));
+            }
+        }
+    }
+
     @SerializedName("ProtectionType")
-    protected String protectionType;
+    protected ProtectionTypeEnum protectionType;
     /**
      * Gets or sets type of the protection.
     * @return protectionType
     **/
     @ApiModelProperty(value = "Gets or sets type of the protection.")
-    public String getProtectionType() {
+    public ProtectionTypeEnum getProtectionType() {
         return protectionType;
     }
 
-    public ProtectionData protectionType(String protectionType) {
+    public ProtectionData protectionType(ProtectionTypeEnum protectionType) {
         this.protectionType = protectionType;
         return this;
     }
 
-    public void setProtectionType(String protectionType) {
+    public void setProtectionType(ProtectionTypeEnum protectionType) {
         this.protectionType = protectionType;
     }
 
@@ -89,6 +138,9 @@ public void getFilesContent(List<FileReference> resultFilesContent) {
      */
     @Override
     public void validate() throws ApiException {
+        if (this.protectionType == null) {
+            throw new ApiException(400, "Property ProtectionType in ProtectionData is required.");
+        }
     }
 
     @Override

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

@@ -45,9 +45,11 @@
 
 /**
  * Request on changing of protection.
+ * @deprecated ProtectionRequest is deprecated and remains for backwards compatibility only.
  */
 @ApiModel(description = "Request on changing of protection.")
-public class ProtectionRequest implements ModelIfc {
+@Deprecated
+public class ProtectionRequest extends ProtectionRequestBase {
     @SerializedName("NewPassword")
     protected String newPassword;
 
@@ -114,6 +116,7 @@ public void setProtectionType(String protectionType) {
 
 
     public ProtectionRequest() {
+        super();
         this.newPassword = null;
         this.password = null;
         this.protectionType = null;
@@ -135,6 +138,7 @@ public void getFilesContent(List<FileReference> resultFilesContent) {
      */
     @Override
     public void validate() throws ApiException {
+        super.validate();
         if (this.password == null) {
             throw new ApiException(400, "Property Password in ProtectionRequest is required.");
         }
@@ -153,12 +157,13 @@ public boolean equals(java.lang.Object o) {
         return
             Objects.equals(this.newPassword, protectionRequest.newPassword) &&
             Objects.equals(this.password, protectionRequest.password) &&
-            Objects.equals(this.protectionType, protectionRequest.protectionType);
+            Objects.equals(this.protectionType, protectionRequest.protectionType) &&
+            super.equals(o);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(newPassword, password, protectionType);
+    return Objects.hash(newPassword, password, protectionType, super.hashCode());
   }
 
   @Override

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

@@ -0,0 +1,108 @@
+/*
+ * --------------------------------------------------------------------------------
+ * <copyright company="Aspose" file="ProtectionRequestBase.java">
+ *   Copyright (c) 2023 Aspose.Words for Cloud
+ * </copyright>
+ * <summary>
+ *   Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ * 
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ * 
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ * </summary>
+ * --------------------------------------------------------------------------------
+ */
+
+package com.aspose.words.cloud.model;
+
+import java.util.Objects;
+import java.util.Arrays;
+import java.util.ArrayList;
+import java.util.List;
+import java.io.IOException;
+import org.threeten.bp.OffsetDateTime;
+import com.aspose.words.cloud.ApiException;
+import com.aspose.words.cloud.model.*;
+import com.google.gson.TypeAdapter;
+import com.google.gson.annotations.JsonAdapter;
+import com.google.gson.annotations.SerializedName;
+import com.google.gson.stream.JsonReader;
+import com.google.gson.stream.JsonWriter;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+
+/**
+ * Request on changing of protection.
+ */
+@ApiModel(description = "Request on changing of protection.")
+public abstract class ProtectionRequestBase implements ModelIfc {
+
+    public ProtectionRequestBase() {
+    }
+
+    /*
+     * Gets files content.
+     *
+     * @param resultFilesContent List<FileReference> instance.
+     */
+    @Override
+    public void getFilesContent(List<FileReference> resultFilesContent) {
+    }
+
+    /*
+     * Validate required properties.
+     *
+     * @throws ApiException If fails to validate required properties.
+     */
+    @Override
+    public void validate() throws ApiException {
+    }
+
+    @Override
+    public boolean equals(java.lang.Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+
+        return true;
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash();
+  }
+
+  @Override
+  public String toString() {
+    StringBuilder sb = new StringBuilder();
+    sb.append("class ProtectionRequestBase {\n");
+    sb.append("}");
+    return sb.toString();
+  }
+
+  /**
+   * Convert the given object to string with each line indented by 4 spaces
+   * (except the first line).
+   */
+  private String toIndentedString(java.lang.Object o) {
+    if (o == null) {
+      return "null";
+    }
+    return o.toString().replace("\n", "\n    ");
+  }
+}