SDK regenerated by CI server [ci skip]

Author: dynabic-billing-team

README.md

@@ -19,7 +19,7 @@ This repository contains Aspose.Words Cloud SDK for Ruby source code. This SDK a
 - 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
 
@@ -305,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

@@ -277,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'
@@ -536,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

@@ -10533,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
@@ -10579,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
@@ -10621,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
@@ -10667,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

lib/aspose_words_cloud/models/compare_data.rb

@@ -41,6 +41,9 @@ class CompareData
     # Gets or sets the date and time to use for revisions.
     attr_accessor :date_time
 
+    # Gets or sets the file reference.
+    attr_accessor :file_reference
+
     # Gets or sets the result document format.
     attr_accessor :result_document_format
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -50,6 +53,7 @@ def self.attribute_map
         :'compare_options' => :'CompareOptions',
         :'comparing_with_document' => :'ComparingWithDocument',
         :'date_time' => :'DateTime',
+        :'file_reference' => :'FileReference',
         :'result_document_format' => :'ResultDocumentFormat'
       }
     end
@@ -61,6 +65,7 @@ def self.swagger_types
         :'compare_options' => :'CompareOptions',
         :'comparing_with_document' => :'String',
         :'date_time' => :'DateTime',
+        :'file_reference' => :'FileReference',
         :'result_document_format' => :'String'
       }
     end
@@ -89,6 +94,10 @@ def initialize(attributes = {})
         self.date_time = attributes[:'DateTime']
       end
 
+      if attributes.key?(:'FileReference')
+        self.file_reference = attributes[:'FileReference']
+      end
+
       if attributes.key?(:'ResultDocumentFormat')
         self.result_document_format = attributes[:'ResultDocumentFormat']
       end
@@ -109,6 +118,7 @@ def ==(other)
           compare_options == other.compare_options &&
           comparing_with_document == other.comparing_with_document &&
           date_time == other.date_time &&
+          file_reference == other.file_reference &&
           result_document_format == other.result_document_format
     end
 
@@ -121,7 +131,7 @@ def eql?(other)
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [author, compare_options, comparing_with_document, date_time, result_document_format].hash
+      [author, compare_options, comparing_with_document, date_time, file_reference, result_document_format].hash
     end
 
     # Builds the object from hash
@@ -235,14 +245,22 @@ def _to_hash(value)
     end
 
     def collectFilesContent(resultFilesContent)
+      if self.file_reference
+          self.file_reference.collectFilesContent(resultFilesContent)
+      end
+
+
     end
 
     def validate()
       raise ArgumentError, 'Property author in CompareData is required.' if self.author.nil?
-      raise ArgumentError, 'Property comparing_with_document in CompareData is required.' if self.comparing_with_document.nil?
+      raise ArgumentError, 'Property file_reference in CompareData is required.' if self.file_reference.nil?
       unless self.compare_options.nil?
           self.compare_options.validate
       end
+      unless self.file_reference.nil?
+          self.file_reference.validate
+      end
 
     end
 

lib/aspose_words_cloud/models/requests/compare_document_online_request.rb

@@ -35,9 +35,6 @@ class CompareDocumentOnlineRequest
     # Compare data.
     attr_accessor :compare_data
 
-    # The comparing document.
-    attr_accessor :comparing_document
-
     # Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     attr_accessor :load_encoding
 
@@ -57,17 +54,15 @@ class CompareDocumentOnlineRequest
     # Initializes a new instance.
     # @param document The document.
     # @param compare_data Compare data.
-    # @param comparing_document The comparing document.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don't recommend to use the parameter to pass a plain password for direct call of API.
     # @param encrypted_password Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
     # @param dest_file_name Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
     # @param encrypted_password2 encrypted password for the second document.
 
-    def initialize(document:, compare_data:, comparing_document: nil, load_encoding: nil, password: nil, encrypted_password: nil, dest_file_name: nil, encrypted_password2: nil)
+    def initialize(document:, compare_data:, load_encoding: nil, password: nil, encrypted_password: nil, dest_file_name: nil, encrypted_password2: nil)
       self.document = document
       self.compare_data = compare_data
-      self.comparing_document = comparing_document
       self.load_encoding = load_encoding
       self.password = password
       self.encrypted_password = encrypted_password
@@ -123,10 +118,7 @@ def to_batch_part(api_client, requestId, parentRequestId = nil)
       end
       unless self.compare_data.nil?
         form_params.push({:'Name' => 'compareData', :'Data' => self.compare_data.to_body.to_json, :'MimeType' =>'application/json'})
-      end
-
-      unless self.comparing_document.nil?
-        form_params.push({:'Name' => 'comparingDocument', :'Data' => self.comparing_document, :'MimeType' =>'application/octet-stream'})
+        self.compare_data.collectFilesContent(files_content)
       end
 
 
@@ -190,10 +182,7 @@ def create_http_request(api_client)
       end
       unless self.compare_data.nil?
         form_params.push({:'Name' => 'compareData', :'Data' => self.compare_data.to_body.to_json, :'MimeType' =>'application/json'})
-      end
-
-      unless self.comparing_document.nil?
-        form_params.push({:'Name' => 'comparingDocument', :'Data' => self.comparing_document, :'MimeType' =>'application/octet-stream'})
+        self.compare_data.collectFilesContent(files_content)
       end
 
       body = api_client.build_request_body(header_params, form_params, files_content)

lib/aspose_words_cloud/models/requests/compare_document_request.rb

@@ -124,6 +124,7 @@ def to_batch_part(api_client, requestId, parentRequestId = nil)
       end
       unless self.compare_data.nil?
         form_params.push({:'Name' => 'compareData', :'Data' => self.compare_data.to_body.to_json, :'MimeType' =>'application/json'})
+        self.compare_data.collectFilesContent(files_content)
       end
 
 
@@ -183,6 +184,7 @@ def create_http_request(api_client)
       end
       unless self.compare_data.nil?
         form_params.push({:'Name' => 'compareData', :'Data' => self.compare_data.to_body.to_json, :'MimeType' =>'application/json'})
+        self.compare_data.collectFilesContent(files_content)
       end
 
       body = api_client.build_request_body(header_params, form_params, files_content)