Merge branch 'master' into release

Author: YaroslawEkimov

README.md

@@ -13,6 +13,14 @@ This repository contains Aspose.Words Cloud SDK for Ruby 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 23.12
+
+- 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.
+- Rename aspose-client header.
+
 ## Enhancements in Version 23.11
 
 - Support of required properties in models.
@@ -297,7 +305,7 @@ To use Aspose Words for Cloud Ruby SDK you need to register an account with [Asp
 To install this package do the following:
 update your Gemfile
 ```ruby
-gem 'aspose_words_cloud', '~> 23.11'
+gem 'aspose_words_cloud', '~> 23.12'
 ```
 or install directly
 ```bash

lib/aspose_words_cloud.rb

@@ -201,6 +201,7 @@
 require_relative 'aspose_words_cloud/models/protection_data'
 require_relative 'aspose_words_cloud/models/protection_data_response'
 require_relative 'aspose_words_cloud/models/protection_request'
+require_relative 'aspose_words_cloud/models/protection_request_v2'
 require_relative 'aspose_words_cloud/models/ps_save_options_data'
 require_relative 'aspose_words_cloud/models/public_key_response'
 require_relative 'aspose_words_cloud/models/range_document'
@@ -276,6 +277,8 @@
 require_relative 'aspose_words_cloud/models/tiff_save_options_data'
 require_relative 'aspose_words_cloud/models/time_zone_info_data'
 require_relative 'aspose_words_cloud/models/user_information'
+require_relative 'aspose_words_cloud/models/watermark_data_image'
+require_relative 'aspose_words_cloud/models/watermark_data_text'
 require_relative 'aspose_words_cloud/models/watermark_text'
 require_relative 'aspose_words_cloud/models/word_ml_save_options_data'
 require_relative 'aspose_words_cloud/models/words_api_error_response'
@@ -354,6 +357,8 @@
 require_relative 'aspose_words_cloud/models/requests/delete_macros_online_request'
 require_relative 'aspose_words_cloud/models/requests/delete_office_math_object_request'
 require_relative 'aspose_words_cloud/models/requests/delete_office_math_object_online_request'
+require_relative 'aspose_words_cloud/models/requests/delete_office_math_objects_request'
+require_relative 'aspose_words_cloud/models/requests/delete_office_math_objects_online_request'
 require_relative 'aspose_words_cloud/models/requests/delete_paragraph_request'
 require_relative 'aspose_words_cloud/models/requests/delete_paragraph_list_format_request'
 require_relative 'aspose_words_cloud/models/requests/delete_paragraph_list_format_online_request'
@@ -533,8 +538,10 @@
 require_relative 'aspose_words_cloud/models/requests/insert_table_online_request'
 require_relative 'aspose_words_cloud/models/requests/insert_table_row_request'
 require_relative 'aspose_words_cloud/models/requests/insert_table_row_online_request'
+require_relative 'aspose_words_cloud/models/requests/insert_watermark_request'
 require_relative 'aspose_words_cloud/models/requests/insert_watermark_image_request'
 require_relative 'aspose_words_cloud/models/requests/insert_watermark_image_online_request'
+require_relative 'aspose_words_cloud/models/requests/insert_watermark_online_request'
 require_relative 'aspose_words_cloud/models/requests/insert_watermark_text_request'
 require_relative 'aspose_words_cloud/models/requests/insert_watermark_text_online_request'
 require_relative 'aspose_words_cloud/models/requests/link_header_footers_to_previous_request'

lib/aspose_words_cloud/api/words_api.rb

@@ -2843,6 +2843,90 @@ def delete_office_math_object_online(request)
         [data, status_code, headers]
     end
 
+    # Removes all office math objects from the document.
+    # @param request DeleteOfficeMathObjectsRequest
+    # @return [nil]
+    def delete_office_math_objects(request)
+        begin
+        data, _status_code, _headers = delete_office_math_objects_with_http_info(request)
+        rescue ApiError => e
+            if e.code == 401
+            request_token
+            data, _status_code, _headers = delete_office_math_objects_with_http_info(request)
+            else
+            raise
+            end
+        end
+        nil
+    end
+
+    # Removes all office math objects from the document.
+    # @param request DeleteOfficeMathObjectsRequest
+    # @return [Array<(nil, Fixnum, Hash)>]
+    # nil, response status code and response headers
+    private def delete_office_math_objects_with_http_info(request)
+        raise ArgumentError, 'Incorrect request type' unless request.is_a? DeleteOfficeMathObjectsRequest
+
+        @api_client.config.logger.debug 'Calling API: WordsApi.delete_office_math_objects ...' if @api_client.config.debugging
+        request_data = request.create_http_request(@api_client)
+
+        data, status_code, headers = @api_client.call_api(
+                                                        request_data[:'method'],
+                                                        request_data[:'path'],
+                                                        header_params: request_data[:'header_params'],
+                                                        query_params: request_data[:'query_params'],
+                                                        body: request_data[:'body'])
+        if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        WordsApi#delete_office_math_objects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+
+        [data, status_code, headers]
+    end
+
+    # Removes all office math objects from the document.
+    # @param request DeleteOfficeMathObjectsOnlineRequest
+    # @return [FILES_COLLECTION]
+    def delete_office_math_objects_online(request)
+        begin
+        data, _status_code, _headers = delete_office_math_objects_online_with_http_info(request)
+        rescue ApiError => e
+            if e.code == 401
+            request_token
+            data, _status_code, _headers = delete_office_math_objects_online_with_http_info(request)
+            else
+            raise
+            end
+        end
+        data
+    end
+
+    # Removes all office math objects from the document.
+    # @param request DeleteOfficeMathObjectsOnlineRequest
+    # @return [Array<(FILES_COLLECTION, Fixnum, Hash)>]
+    # FILES_COLLECTION, response status code and response headers
+    private def delete_office_math_objects_online_with_http_info(request)
+        raise ArgumentError, 'Incorrect request type' unless request.is_a? DeleteOfficeMathObjectsOnlineRequest
+
+        @api_client.config.logger.debug 'Calling API: WordsApi.delete_office_math_objects_online ...' if @api_client.config.debugging
+        request_data = request.create_http_request(@api_client)
+
+        data, status_code, headers = @api_client.call_api(
+                                                        request_data[:'method'],
+                                                        request_data[:'path'],
+                                                        header_params: request_data[:'header_params'],
+                                                        query_params: request_data[:'query_params'],
+                                                        body: request_data[:'body'],
+                                                        return_type: 'FILES_COLLECTION')
+        if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        WordsApi#delete_office_math_objects_online\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+
+        # FILES_COLLECTION #
+        [data, status_code, headers]
+    end
+
     # Removes a paragraph from the document node.
     # @param request DeleteParagraphRequest
     # @return [nil]
@@ -10449,10 +10533,53 @@ def insert_table_row_online(request)
         [mp_data, status_code, headers]
     end
 
+    # Insert a watermark to the document.
+    # @param request InsertWatermarkRequest
+    # @return [DocumentResponse]
+    def insert_watermark(request)
+        begin
+        data, _status_code, _headers = insert_watermark_with_http_info(request)
+        rescue ApiError => e
+            if e.code == 401
+            request_token
+            data, _status_code, _headers = insert_watermark_with_http_info(request)
+            else
+            raise
+            end
+        end
+        data
+    end
+
+    # Insert a watermark to the document.
+    # @param request InsertWatermarkRequest
+    # @return [Array<(DocumentResponse, Fixnum, Hash)>]
+    # DocumentResponse, response status code and response headers
+    private def insert_watermark_with_http_info(request)
+        raise ArgumentError, 'Incorrect request type' unless request.is_a? InsertWatermarkRequest
+
+        @api_client.config.logger.debug 'Calling API: WordsApi.insert_watermark ...' if @api_client.config.debugging
+        request_data = request.create_http_request(@api_client)
+
+        data, status_code, headers = @api_client.call_api(
+                                                        request_data[:'method'],
+                                                        request_data[:'path'],
+                                                        header_params: request_data[:'header_params'],
+                                                        query_params: request_data[:'query_params'],
+                                                        body: request_data[:'body'],
+                                                        return_type: 'DocumentResponse')
+        if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        WordsApi#insert_watermark\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+
+        [data, status_code, headers]
+    end
+
     # Inserts a new watermark image to the document.
     # @param request InsertWatermarkImageRequest
     # @return [DocumentResponse]
     def insert_watermark_image(request)
+        warn "This operation is deprecated and is used for backward compatibility only. Please use InsertWatermark instead."
         begin
         data, _status_code, _headers = insert_watermark_image_with_http_info(request)
         rescue ApiError => e
@@ -10495,6 +10622,7 @@ def insert_watermark_image(request)
     # @param request InsertWatermarkImageOnlineRequest
     # @return [InsertWatermarkImageOnlineResponse]
     def insert_watermark_image_online(request)
+        warn "This operation is deprecated and is used for backward compatibility only. Please use InsertWatermark instead."
         begin
         data, _status_code, _headers = insert_watermark_image_online_with_http_info(request)
         rescue ApiError => e
@@ -10537,10 +10665,57 @@ def insert_watermark_image_online(request)
         [mp_data, status_code, headers]
     end
 
+    # Insert a watermark to the document.
+    # @param request InsertWatermarkOnlineRequest
+    # @return [InsertWatermarkOnlineResponse]
+    def insert_watermark_online(request)
+        begin
+        data, _status_code, _headers = insert_watermark_online_with_http_info(request)
+        rescue ApiError => e
+            if e.code == 401
+            request_token
+            data, _status_code, _headers = insert_watermark_online_with_http_info(request)
+            else
+            raise
+            end
+        end
+        data
+    end
+
+    # Insert a watermark to the document.
+    # @param request InsertWatermarkOnlineRequest
+    # @return [Array<(InsertWatermarkOnlineResponse, Fixnum, Hash)>]
+    # InsertWatermarkOnlineResponse, response status code and response headers
+    private def insert_watermark_online_with_http_info(request)
+        raise ArgumentError, 'Incorrect request type' unless request.is_a? InsertWatermarkOnlineRequest
+
+        @api_client.config.logger.debug 'Calling API: WordsApi.insert_watermark_online ...' if @api_client.config.debugging
+        request_data = request.create_http_request(@api_client)
+
+        data, status_code, headers = @api_client.call_api(
+                                                        request_data[:'method'],
+                                                        request_data[:'path'],
+                                                        header_params: request_data[:'header_params'],
+                                                        query_params: request_data[:'query_params'],
+                                                        body: request_data[:'body'],
+                                                        multipart_response: true,
+                                                        return_type: 'InsertWatermarkOnlineResponse')
+        if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        WordsApi#insert_watermark_online\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+
+        mp_data = InsertWatermarkOnlineResponse.new()
+        mp_data.model = @api_client.deserialize(data['Model'][:data], data['Model'][:headers], 'DocumentResponse')
+        mp_data.document = @api_client.parse_files_collection(data['Document'][:data], data['Document'][:headers])
+        [mp_data, status_code, headers]
+    end
+
     # Inserts a new watermark text to the document.
     # @param request InsertWatermarkTextRequest
     # @return [DocumentResponse]
     def insert_watermark_text(request)
+        warn "This operation is deprecated and is used for backward compatibility only. Please use InsertWatermark instead."
         begin
         data, _status_code, _headers = insert_watermark_text_with_http_info(request)
         rescue ApiError => e
@@ -10583,6 +10758,7 @@ def insert_watermark_text(request)
     # @param request InsertWatermarkTextOnlineRequest
     # @return [InsertWatermarkTextOnlineResponse]
     def insert_watermark_text_online(request)
+        warn "This operation is deprecated and is used for backward compatibility only. Please use InsertWatermark instead."
         begin
         data, _status_code, _headers = insert_watermark_text_online_with_http_info(request)
         rescue ApiError => e
@@ -10874,7 +11050,7 @@ def optimize_document_online(request)
         [data, status_code, headers]
     end
 
-    # Adds protection to the document.
+    # Changes the document protection. The previous protection will be overwritten if it exist.
     # @param request ProtectDocumentRequest
     # @return [ProtectionDataResponse]
     def protect_document(request)
@@ -10891,7 +11067,7 @@ def protect_document(request)
         data
     end
 
-    # Adds protection to the document.
+    # Changes the document protection. The previous protection will be overwritten if it exist.
     # @param request ProtectDocumentRequest
     # @return [Array<(ProtectionDataResponse, Fixnum, Hash)>]
     # ProtectionDataResponse, response status code and response headers
@@ -10916,7 +11092,7 @@ def protect_document(request)
         [data, status_code, headers]
     end
 
-    # Adds protection to the document.
+    # Changes the document protection. The previous protection will be overwritten if it exist.
     # @param request ProtectDocumentOnlineRequest
     # @return [ProtectDocumentOnlineResponse]
     def protect_document_online(request)
@@ -10933,7 +11109,7 @@ def protect_document_online(request)
         data
     end
 
-    # Adds protection to the document.
+    # Changes the document protection. The previous protection will be overwritten if it exist.
     # @param request ProtectDocumentOnlineRequest
     # @return [Array<(ProtectDocumentOnlineResponse, Fixnum, Hash)>]
     # ProtectDocumentOnlineResponse, response status code and response headers

lib/aspose_words_cloud/api_client.rb

@@ -56,7 +56,7 @@ def initialize(config = Configuration.default)
       @default_headers = {
         'Content-Type' => "application/json",
         'x-aspose-client' => "ruby sdk",
-        'x-aspose-version' => AsposeWordsCloud::VERSION.to_s
+        'x-aspose-client-version' => AsposeWordsCloud::VERSION.to_s
       }
     end
 

lib/aspose_words_cloud/models/bookmark_insert.rb

@@ -228,6 +228,10 @@ def collectFilesContent(resultFilesContent)
     end
 
     def validate()
+      raise ArgumentError, 'Property name in BookmarkInsert is required.' if self.name.nil?
+      raise ArgumentError, 'Property text in BookmarkInsert is required.' if self.text.nil?
+      raise ArgumentError, 'Property start_range in BookmarkInsert is required.' if self.start_range.nil?
+      raise ArgumentError, 'Property end_range in BookmarkInsert is required.' if self.end_range.nil?
       unless self.start_range.nil?
           self.start_range.validate
       end