Merge remote-tracking branch 'origin/master' into release

Author: dynabic-billing-team

CHANGELOG.md

@@ -1,3 +1,11 @@
+## [23.12.0] - Aspose Words Cloud for Dart 23.12 Release Notes
+
+- 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.
+
+
 ## [23.11.0] - Aspose Words Cloud for Dart 23.11 Release Notes
 
 - Support of required properties in models.

README.md

@@ -27,7 +27,7 @@ Add this dependency to your *pubspec.yaml*:
 
 ```yaml
 dependencies:
-  aspose_words_cloud: 23.11.0
+  aspose_words_cloud: 23.12.0
 ```
 
 ## Getting Started

analysis_options.yaml

@@ -1,3 +1,5 @@
 analyzer:
   exclude:
-    - test/**
+    - test/**
+    - lib/src/models/*.dart
+    - lib/src/requests/*.dart

lib/aspose_words_cloud.dart

@@ -210,6 +210,8 @@ export 'src/models/png_save_options_data.dart';
 export 'src/models/preferred_width.dart';
 export 'src/models/protection_data_response.dart';
 export 'src/models/protection_data.dart';
+export 'src/models/protection_request_base.dart';
+export 'src/models/protection_request_v2.dart';
 export 'src/models/protection_request.dart';
 export 'src/models/ps_save_options_data.dart';
 export 'src/models/public_key_response.dart';
@@ -291,6 +293,9 @@ export 'src/models/tiff_save_options_data.dart';
 export 'src/models/time_zone_info_data.dart';
 export 'src/models/txt_save_options_base_data.dart';
 export 'src/models/user_information.dart';
+export 'src/models/watermark_data_base.dart';
+export 'src/models/watermark_data_image.dart';
+export 'src/models/watermark_data_text.dart';
 export 'src/models/watermark_text.dart';
 export 'src/models/word_ml_save_options_data.dart';
 export 'src/models/words_api_error_response.dart';
@@ -368,6 +373,8 @@ export 'src/requests/delete_macros_online_request.dart';
 export 'src/requests/delete_macros_request.dart';
 export 'src/requests/delete_office_math_object_online_request.dart';
 export 'src/requests/delete_office_math_object_request.dart';
+export 'src/requests/delete_office_math_objects_online_request.dart';
+export 'src/requests/delete_office_math_objects_request.dart';
 export 'src/requests/delete_paragraph_list_format_online_request.dart';
 export 'src/requests/delete_paragraph_list_format_request.dart';
 export 'src/requests/delete_paragraph_online_request.dart';
@@ -549,6 +556,8 @@ export 'src/requests/insert_table_row_online_request.dart';
 export 'src/requests/insert_table_row_request.dart';
 export 'src/requests/insert_watermark_image_online_request.dart';
 export 'src/requests/insert_watermark_image_request.dart';
+export 'src/requests/insert_watermark_online_request.dart';
+export 'src/requests/insert_watermark_request.dart';
 export 'src/requests/insert_watermark_text_online_request.dart';
 export 'src/requests/insert_watermark_text_request.dart';
 export 'src/requests/link_header_footers_to_previous_request.dart';
@@ -666,6 +675,7 @@ export 'src/responses/insert_table_cell_online_response.dart';
 export 'src/responses/insert_table_online_response.dart';
 export 'src/responses/insert_table_row_online_response.dart';
 export 'src/responses/insert_watermark_image_online_response.dart';
+export 'src/responses/insert_watermark_online_response.dart';
 export 'src/responses/insert_watermark_text_online_response.dart';
 export 'src/responses/protect_document_online_response.dart';
 export 'src/responses/reject_all_revisions_online_response.dart';

lib/src/api_client.dart

@@ -503,7 +503,7 @@ class ApiClient {
 
     var httpRequest = http.Request(requestData.method, Uri.parse(requestData.url));
     httpRequest.headers['x-aspose-client'] = 'dart sdk';
-    httpRequest.headers['x-aspose-client-version'] = '23.11';
+    httpRequest.headers['x-aspose-client-version'] = '23.12';
     httpRequest.headers['Authorization'] = await _getAuthToken();
     httpRequest.headers.addAll(requestData.headers);
 

lib/src/models/bookmark_insert.dart

@@ -30,7 +30,21 @@ library aspose_words_cloud;
 import '../../aspose_words_cloud.dart';
 
 /// Represents a bookmark to insert.
-class BookmarkInsert extends BookmarkData {
+class BookmarkInsert implements ModelBase {
+  /// Gets or sets the name of the bookmark.
+  String? _name;
+
+  String? get name => _name;
+  set name(String? val) => _name = val;
+
+
+  /// Gets or sets text, enclosed in the bookmark.
+  String? _text;
+
+  String? get text => _text;
+  set text(String? val) => _text = val;
+
+
   /// Gets or sets the link to start bookmark node.
   NewDocumentPosition? _startRange;
 
@@ -51,7 +65,6 @@ class BookmarkInsert extends BookmarkData {
       throw ApiException(400, 'Failed to deserialize BookmarkInsert data model.');
     }
 
-    super.deserialize(json);
     if (json.containsKey('Name')) {
       name = json['Name'] as String;
     } else {
@@ -80,7 +93,14 @@ class BookmarkInsert extends BookmarkData {
   @override
   Map<String, dynamic> serialize() {
     var _result = <String, dynamic>{};
-    _result.addAll(super.serialize());
+    if (name != null) {
+      _result['Name'] = name!;
+    }
+
+    if (text != null) {
+      _result['Text'] = text!;
+    }
+
     if (startRange != null) {
       _result['StartRange'] = startRange!.serialize();
     }
@@ -97,7 +117,22 @@ class BookmarkInsert extends BookmarkData {
 
   @override
   void validate() {
-    super.validate();
+    if (name == null)
+    {
+        throw new ApiException(400, 'Property Name in BookmarkInsert is required.');
+    }
+    if (text == null)
+    {
+        throw new ApiException(400, 'Property Text in BookmarkInsert is required.');
+    }
+    if (startRange == null)
+    {
+        throw new ApiException(400, 'Property StartRange in BookmarkInsert is required.');
+    }
+    if (endRange == null)
+    {
+        throw new ApiException(400, 'Property EndRange in BookmarkInsert is required.');
+    }
 
     startRange?.validate();
 

lib/src/models/compare_data.dart

@@ -48,7 +48,9 @@ class CompareData implements ModelBase {
   /// Gets or sets the path to document to compare at the server.
   String? _comparingWithDocument;
 
+  @Deprecated('This field is deprecated and used only for backward compatibility. Please use FileReference instead.')
   String? get comparingWithDocument => _comparingWithDocument;
+  @Deprecated('This field is deprecated and used only for backward compatibility. Please use FileReference instead.')
   set comparingWithDocument(String? val) => _comparingWithDocument = val;
 
 
@@ -59,6 +61,13 @@ class CompareData implements ModelBase {
   set dateTime(DateTime? val) => _dateTime = val;
 
 
+  /// Gets or sets the file reference.
+  FileReference? _fileReference;
+
+  FileReference? get fileReference => _fileReference;
+  set fileReference(FileReference? val) => _fileReference = val;
+
+
   /// Gets or sets the result document format.
   String? _resultDocumentFormat;
 
@@ -96,6 +105,12 @@ class CompareData implements ModelBase {
       dateTime = null;
     }
 
+    if (json.containsKey('FileReference')) {
+      throw ApiException(400, 'File content is not supported for deserialization.');
+    } else {
+      fileReference = null;
+    }
+
     if (json.containsKey('ResultDocumentFormat')) {
       resultDocumentFormat = json['ResultDocumentFormat'] as String;
     } else {
@@ -122,6 +137,10 @@ class CompareData implements ModelBase {
       _result['DateTime'] = dateTime!.toIso8601String();
     }
 
+    if (fileReference != null) {
+      _result['FileReference'] = fileReference!.serialize();
+    }
+
     if (resultDocumentFormat != null) {
       _result['ResultDocumentFormat'] = resultDocumentFormat!;
     }
@@ -130,6 +149,12 @@ class CompareData implements ModelBase {
 
   @override
   void getFilesContent(List<FileReference> resultFilesContent) {
+    if (fileReference != null)
+    {
+        fileReference!.getFilesContent(resultFilesContent);
+    }
+
+
   }
 
   @override
@@ -138,16 +163,20 @@ class CompareData implements ModelBase {
     {
         throw new ApiException(400, 'Property Author in CompareData is required.');
     }
-    if (comparingWithDocument == null)
+    if (fileReference == null)
     {
-        throw new ApiException(400, 'Property ComparingWithDocument in CompareData is required.');
+        throw new ApiException(400, 'Property FileReference in CompareData is required.');
     }
 
     compareOptions?.validate();
 
 
 
 
+
+    fileReference?.validate();
+
+
   }
 }
 

lib/src/models/model_base.dart

@@ -206,6 +206,7 @@ abstract class ModelBase {
     'ProtectionData, _': () => ProtectionData(),
     'ProtectionDataResponse, _': () => ProtectionDataResponse(),
     'ProtectionRequest, _': () => ProtectionRequest(),
+    'ProtectionRequestV2, _': () => ProtectionRequestV2(),
     'PsSaveOptionsData, _': () => PsSaveOptionsData(),
     'PublicKeyResponse, _': () => PublicKeyResponse(),
     'RangeDocument, _': () => RangeDocument(),
@@ -281,6 +282,8 @@ abstract class ModelBase {
     'TiffSaveOptionsData, _': () => TiffSaveOptionsData(),
     'TimeZoneInfoData, _': () => TimeZoneInfoData(),
     'UserInformation, _': () => UserInformation(),
+    'WatermarkDataImage, _': () => WatermarkDataImage(),
+    'WatermarkDataText, _': () => WatermarkDataText(),
     'WatermarkText, _': () => WatermarkText(),
     'WordMLSaveOptionsData, _': () => WordMLSaveOptionsData(),
     'WordsApiErrorResponse, _': () => WordsApiErrorResponse(),

lib/src/models/protection_data.dart

@@ -32,10 +32,10 @@ import '../../aspose_words_cloud.dart';
 /// Container for the data about protection of the document.
 class ProtectionData implements ModelBase {
   /// Gets or sets type of the protection.
-  String? _protectionType;
+  ProtectionData_ProtectionTypeEnum? _protectionType;
 
-  String? get protectionType => _protectionType;
-  set protectionType(String? val) => _protectionType = val;
+  ProtectionData_ProtectionTypeEnum? get protectionType => _protectionType;
+  set protectionType(ProtectionData_ProtectionTypeEnum? val) => _protectionType = val;
 
 
   @override
@@ -45,7 +45,14 @@ class ProtectionData implements ModelBase {
     }
 
     if (json.containsKey('ProtectionType')) {
-      protectionType = json['ProtectionType'] as String;
+      switch (json['ProtectionType'] as String) {
+        case 'AllowOnlyRevisions': protectionType = ProtectionData_ProtectionTypeEnum.allowOnlyRevisions; break;
+        case 'AllowOnlyComments': protectionType = ProtectionData_ProtectionTypeEnum.allowOnlyComments; break;
+        case 'AllowOnlyFormFields': protectionType = ProtectionData_ProtectionTypeEnum.allowOnlyFormFields; break;
+        case 'ReadOnly': protectionType = ProtectionData_ProtectionTypeEnum.readOnly; break;
+        case 'NoProtection': protectionType = ProtectionData_ProtectionTypeEnum.noProtection; break;
+        default: protectionType = null; break;
+      }
     } else {
       protectionType = null;
     }
@@ -55,7 +62,14 @@ class ProtectionData implements ModelBase {
   Map<String, dynamic> serialize() {
     var _result = <String, dynamic>{};
     if (protectionType != null) {
-      _result['ProtectionType'] = protectionType!;
+      switch (protectionType!) {
+        case ProtectionData_ProtectionTypeEnum.allowOnlyRevisions: _result['ProtectionType'] = 'AllowOnlyRevisions'; break;
+        case ProtectionData_ProtectionTypeEnum.allowOnlyComments: _result['ProtectionType'] = 'AllowOnlyComments'; break;
+        case ProtectionData_ProtectionTypeEnum.allowOnlyFormFields: _result['ProtectionType'] = 'AllowOnlyFormFields'; break;
+        case ProtectionData_ProtectionTypeEnum.readOnly: _result['ProtectionType'] = 'ReadOnly'; break;
+        case ProtectionData_ProtectionTypeEnum.noProtection: _result['ProtectionType'] = 'NoProtection'; break;
+        default: break;
+      }
     }
     return _result;
   }
@@ -66,7 +80,20 @@ class ProtectionData implements ModelBase {
 
   @override
   void validate() {
+    if (protectionType == null)
+    {
+        throw new ApiException(400, 'Property ProtectionType in ProtectionData is required.');
+    }
   }
 }
 
+/// Gets or sets type of the protection.
+enum ProtectionData_ProtectionTypeEnum
+{ 
+  allowOnlyRevisions,
+  allowOnlyComments,
+  allowOnlyFormFields,
+  readOnly,
+  noProtection
+}
 

lib/src/models/protection_request.dart

@@ -30,7 +30,8 @@ library aspose_words_cloud;
 import '../../aspose_words_cloud.dart';
 
 /// Request on changing of protection.
-class ProtectionRequest implements ModelBase {
+@Deprecated('ProtectionRequest is deprecated and remains for backwards compatibility only.')
+class ProtectionRequest extends ProtectionRequestBase {
   /// Gets or sets the new password.
   String? _newPassword;
 
@@ -58,6 +59,7 @@ class ProtectionRequest implements ModelBase {
       throw ApiException(400, 'Failed to deserialize ProtectionRequest data model.');
     }
 
+    super.deserialize(json);
     if (json.containsKey('NewPassword')) {
       newPassword = json['NewPassword'] as String;
     } else {
@@ -80,6 +82,7 @@ class ProtectionRequest implements ModelBase {
   @override
   Map<String, dynamic> serialize() {
     var _result = <String, dynamic>{};
+    _result.addAll(super.serialize());
     if (newPassword != null) {
       _result['NewPassword'] = newPassword!;
     }
@@ -100,6 +103,7 @@ class ProtectionRequest implements ModelBase {
 
   @override
   void validate() {
+    super.validate();
     if (password == null)
     {
         throw new ApiException(400, 'Property Password in ProtectionRequest is required.');