aspose_words_cloud 23.11.0 → 23.12.0

data/lib/aspose_words_cloud/models/requests/insert_watermark_request.rb

@@ -0,0 +1,220 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="insert_watermark_request.rb">
+#   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>
+# ------------------------------------------------------------------------------------
+
+module AsposeWordsCloud
+
+  #
+  # Request model for insert_watermark operation.
+  #
+  class InsertWatermarkRequest
+    # The filename of the input document.
+    attr_accessor :name
+
+    # The watermark data.
+    attr_accessor :watermark_data
+
+    # Original document folder.
+    attr_accessor :folder
+
+    # Original document storage.
+    attr_accessor :storage
+
+    # Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
+    attr_accessor :load_encoding
+
+    # 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.
+    attr_accessor :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.
+    attr_accessor :encrypted_password
+
+    # 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.
+    attr_accessor :dest_file_name
+
+    # Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
+    attr_accessor :revision_author
+
+    # The date and time to use for revisions.
+    attr_accessor :revision_date_time
+
+    #
+    # Initializes a new instance.
+    # @param name The filename of the input document.
+    # @param watermark_data The watermark data.
+    # @param folder Original document folder.
+    # @param storage Original document storage.
+    # @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 revision_author Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
+    # @param revision_date_time The date and time to use for revisions.
+
+    def initialize(name:, watermark_data:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, dest_file_name: nil, revision_author: nil, revision_date_time: nil)
+      self.name = name
+      self.watermark_data = watermark_data
+      self.folder = folder
+      self.storage = storage
+      self.load_encoding = load_encoding
+      self.password = password
+      self.encrypted_password = encrypted_password
+      self.dest_file_name = dest_file_name
+      self.revision_author = revision_author
+      self.revision_date_time = revision_date_time
+    end
+
+    # Creating batch part from request
+    def to_batch_part(api_client, requestId, parentRequestId = nil)
+      # verify the required parameter 'name' is set
+      raise ArgumentError, 'Missing the required parameter name when calling WordsApi.insert_watermark' if api_client.config.client_side_validation && self.name.nil?
+      # verify the required parameter 'watermark_data' is set
+      raise ArgumentError, 'Missing the required parameter watermark_data when calling WordsApi.insert_watermark' if api_client.config.client_side_validation && self.watermark_data.nil?
+      self.watermark_data.validate
+      # resource path
+      local_var_path = '/words/{name}/watermarks/insert'[7..-1]
+      local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', self.name.nil? ? '' : self.name.to_s)
+      local_var_path = local_var_path.sub('//', '/')
+
+      # query parameters
+      query_params = {}
+      query_params[downcase_first_letter('Folder')] = self.folder unless self.folder.nil?
+      query_params[downcase_first_letter('Storage')] = self.storage unless self.storage.nil?
+      query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil?
+      query_params[downcase_first_letter('Password')] = self.password unless self.password.nil?
+      query_params[downcase_first_letter('EncryptedPassword')] = self.encrypted_password unless self.encrypted_password.nil?
+      query_params[downcase_first_letter('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil?
+      query_params[downcase_first_letter('RevisionAuthor')] = self.revision_author unless self.revision_author.nil?
+      query_params[downcase_first_letter('RevisionDateTime')] = self.revision_date_time unless self.revision_date_time.nil?
+
+      if query_params
+        query_params.each { |key, value| local_var_path = api_client.add_param_to_query(local_var_path, key, value) }
+      end
+
+      header_params = {}
+      # header parameters
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = api_client.select_header_content_type(['application/xml', 'application/json'])
+      header_params['RequestId'] = requestId
+
+      if parentRequestId != nil
+        header_params['DependsOn'] = parentRequestId
+      end
+
+      # form parameters
+      form_params = []
+      files_content = []
+      if self.watermark_data.nil?
+        raise "Parameter WatermarkData is required."
+      end
+      unless self.watermark_data.nil?
+        form_params.push({:'Name' => 'watermarkData', :'Data' => self.watermark_data.to_body.to_json, :'MimeType' =>'application/json'})
+        self.watermark_data.collectFilesContent(files_content)
+      end
+
+
+      # http body (model)
+      body = api_client.build_request_body_batch(header_params, form_params, files_content)
+      part = ""
+      part.concat("POST".force_encoding('UTF-8'))
+      part.concat(" ".force_encoding('UTF-8'))
+      part.concat(local_var_path.force_encoding('UTF-8'))
+      part.concat(" \r\n".force_encoding('UTF-8'))
+
+      header_params.each_pair {|key, value| part.concat(key.dup.force_encoding('UTF-8') , ": ".force_encoding('UTF-8'), value.dup.force_encoding('UTF-8'), "\r\n".force_encoding('UTF-8')) }
+      part.concat("\r\n".force_encoding('UTF-8'))
+      if body
+        if body.is_a?(Hash)
+          body.each do |key, value|
+            part.concat(value, "\r\n")
+          end
+        else
+          part.concat(body)
+        end
+      end
+     part
+    end
+
+    def create_http_request(api_client)
+      # verify the required parameter 'name' is set
+      raise ArgumentError, 'Missing the required parameter name when calling WordsApi.insert_watermark' if api_client.config.client_side_validation && self.name.nil?
+      # verify the required parameter 'watermark_data' is set
+      raise ArgumentError, 'Missing the required parameter watermark_data when calling WordsApi.insert_watermark' if api_client.config.client_side_validation && self.watermark_data.nil?
+      self.watermark_data.validate
+      # resource path
+      local_var_path = '/words/{name}/watermarks/insert'[1..-1]
+      local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', self.name.nil? ? '' : self.name.to_s)
+      local_var_path = local_var_path.sub('//', '/')
+
+      # query parameters
+      query_params = {}
+      query_params[downcase_first_letter('Folder')] = self.folder unless self.folder.nil?
+      query_params[downcase_first_letter('Storage')] = self.storage unless self.storage.nil?
+      query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil?
+      query_params[downcase_first_letter('Password')] = self.password unless self.password.nil?
+      query_params[downcase_first_letter('EncryptedPassword')] = self.encrypted_password unless self.encrypted_password.nil?
+      query_params[downcase_first_letter('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil?
+      query_params[downcase_first_letter('RevisionAuthor')] = self.revision_author unless self.revision_author.nil?
+      query_params[downcase_first_letter('RevisionDateTime')] = self.revision_date_time unless self.revision_date_time.nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = api_client.select_header_content_type(['application/xml', 'application/json'])
+
+      # form parameters
+      form_params = []
+      files_content = []
+      if self.watermark_data.nil?
+        raise "Parameter WatermarkData is required."
+      end
+      unless self.watermark_data.nil?
+        form_params.push({:'Name' => 'watermarkData', :'Data' => self.watermark_data.to_body.to_json, :'MimeType' =>'application/json'})
+        self.watermark_data.collectFilesContent(files_content)
+      end
+
+      body = api_client.build_request_body(header_params, form_params, files_content)
+      {
+        'method': :POST,
+        'path': local_var_path,
+        'header_params': header_params,
+        'query_params': query_params,
+        'body': body,
+        'auth_names': ['JWT']
+      }
+    end
+
+    #
+    # Helper method to convert first letter to downcase
+    #
+    def downcase_first_letter(str)
+      str[0].downcase + str[1..-1]
+    end
+
+    # Get response type
+    def get_response_type
+      'DocumentResponse'
+    end
+  end
+end

data/lib/aspose_words_cloud/models/requests/protect_document_online_request.rb

@@ -32,7 +32,7 @@ module AsposeWordsCloud
     # The document.
     attr_accessor :document
 
-    # Protection request.
+    # Use ProtectionRequestV2 model to provide protection options.
     attr_accessor :protection_request
 
     # Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
@@ -50,7 +50,7 @@ module AsposeWordsCloud
     #
     # Initializes a new instance.
     # @param document The document.
-    # @param protection_request Protection request.
+    # @param protection_request Use ProtectionRequestV2 model to provide protection options.
     # @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.

data/lib/aspose_words_cloud/models/requests/protect_document_request.rb

@@ -32,7 +32,7 @@ module AsposeWordsCloud
     # The filename of the input document.
     attr_accessor :name
 
-    # Protection request.
+    # Use ProtectionRequestV2 model to provide protection options.
     attr_accessor :protection_request
 
     # Original document folder.
@@ -56,7 +56,7 @@ module AsposeWordsCloud
     #
     # Initializes a new instance.
     # @param name The filename of the input document.
-    # @param protection_request Protection request.
+    # @param protection_request Use ProtectionRequestV2 model to provide protection options.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/unprotect_document_online_request.rb

@@ -32,9 +32,6 @@ module AsposeWordsCloud
     # The document.
     attr_accessor :document
 
-    # Protection request.
-    attr_accessor :protection_request
-
     # Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     attr_accessor :load_encoding
 
@@ -50,15 +47,13 @@ module AsposeWordsCloud
     #
     # Initializes a new instance.
     # @param document The document.
-    # @param protection_request Protection request.
     # @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.
 
-    def initialize(document:, protection_request:, load_encoding: nil, password: nil, encrypted_password: nil, dest_file_name: nil)
+    def initialize(document:, load_encoding: nil, password: nil, encrypted_password: nil, dest_file_name: nil)
       self.document = document
-      self.protection_request = protection_request
       self.load_encoding = load_encoding
       self.password = password
       self.encrypted_password = encrypted_password
@@ -69,9 +64,7 @@ module AsposeWordsCloud
     def to_batch_part(api_client, requestId, parentRequestId = nil)
       # verify the required parameter 'document' is set
       raise ArgumentError, 'Missing the required parameter document when calling WordsApi.unprotect_document_online' if api_client.config.client_side_validation && self.document.nil?
-      # verify the required parameter 'protection_request' is set
-      raise ArgumentError, 'Missing the required parameter protection_request when calling WordsApi.unprotect_document_online' if api_client.config.client_side_validation && self.protection_request.nil?
-      self.protection_request.validate
+
       # resource path
       local_var_path = '/words/online/delete/protection'[7..-1]
       local_var_path = local_var_path.sub('//', '/')
@@ -107,13 +100,6 @@ module AsposeWordsCloud
         form_params.push({:'Name' => 'document', :'Data' => self.document, :'MimeType' =>'application/octet-stream'})
       end
 
-      if self.protection_request.nil?
-        raise "Parameter ProtectionRequest is required."
-      end
-      unless self.protection_request.nil?
-        form_params.push({:'Name' => 'protectionRequest', :'Data' => self.protection_request.to_body.to_json, :'MimeType' =>'application/json'})
-      end
-
 
       # http body (model)
       body = api_client.build_request_body_batch(header_params, form_params, files_content)
@@ -140,9 +126,7 @@ module AsposeWordsCloud
     def create_http_request(api_client)
       # verify the required parameter 'document' is set
       raise ArgumentError, 'Missing the required parameter document when calling WordsApi.unprotect_document_online' if api_client.config.client_side_validation && self.document.nil?
-      # verify the required parameter 'protection_request' is set
-      raise ArgumentError, 'Missing the required parameter protection_request when calling WordsApi.unprotect_document_online' if api_client.config.client_side_validation && self.protection_request.nil?
-      self.protection_request.validate
+
       # resource path
       local_var_path = '/words/online/delete/protection'[1..-1]
       local_var_path = local_var_path.sub('//', '/')
@@ -169,13 +153,6 @@ module AsposeWordsCloud
         form_params.push({:'Name' => 'document', :'Data' => self.document, :'MimeType' =>'application/octet-stream'})
       end
 
-      if self.protection_request.nil?
-        raise "Parameter ProtectionRequest is required."
-      end
-      unless self.protection_request.nil?
-        form_params.push({:'Name' => 'protectionRequest', :'Data' => self.protection_request.to_body.to_json, :'MimeType' =>'application/json'})
-      end
-
       body = api_client.build_request_body(header_params, form_params, files_content)
       {
         'method': :PUT,

data/lib/aspose_words_cloud/models/requests/unprotect_document_request.rb

@@ -32,9 +32,6 @@ module AsposeWordsCloud
     # The filename of the input document.
     attr_accessor :name
 
-    # Protection request.
-    attr_accessor :protection_request
-
     # Original document folder.
     attr_accessor :folder
 
@@ -56,7 +53,6 @@ module AsposeWordsCloud
     #
     # Initializes a new instance.
     # @param name The filename of the input document.
-    # @param protection_request Protection request.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
@@ -64,9 +60,8 @@ module AsposeWordsCloud
     # @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.
 
-    def initialize(name:, protection_request:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, dest_file_name: nil)
+    def initialize(name:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, dest_file_name: nil)
       self.name = name
-      self.protection_request = protection_request
       self.folder = folder
       self.storage = storage
       self.load_encoding = load_encoding
@@ -79,9 +74,7 @@ module AsposeWordsCloud
     def to_batch_part(api_client, requestId, parentRequestId = nil)
       # verify the required parameter 'name' is set
       raise ArgumentError, 'Missing the required parameter name when calling WordsApi.unprotect_document' if api_client.config.client_side_validation && self.name.nil?
-      # verify the required parameter 'protection_request' is set
-      raise ArgumentError, 'Missing the required parameter protection_request when calling WordsApi.unprotect_document' if api_client.config.client_side_validation && self.protection_request.nil?
-      self.protection_request.validate
+
       # resource path
       local_var_path = '/words/{name}/protection'[7..-1]
       local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', self.name.nil? ? '' : self.name.to_s)
@@ -101,9 +94,6 @@ module AsposeWordsCloud
       end
 
       header_params = {}
-      # header parameters
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = api_client.select_header_content_type(['application/xml', 'application/json'])
       header_params['RequestId'] = requestId
 
       if parentRequestId != nil
@@ -113,13 +103,6 @@ module AsposeWordsCloud
       # form parameters
       form_params = []
       files_content = []
-      if self.protection_request.nil?
-        raise "Parameter ProtectionRequest is required."
-      end
-      unless self.protection_request.nil?
-        form_params.push({:'Name' => 'protectionRequest', :'Data' => self.protection_request.to_body.to_json, :'MimeType' =>'application/json'})
-      end
-
 
       # http body (model)
       body = api_client.build_request_body_batch(header_params, form_params, files_content)
@@ -146,9 +129,7 @@ module AsposeWordsCloud
     def create_http_request(api_client)
       # verify the required parameter 'name' is set
       raise ArgumentError, 'Missing the required parameter name when calling WordsApi.unprotect_document' if api_client.config.client_side_validation && self.name.nil?
-      # verify the required parameter 'protection_request' is set
-      raise ArgumentError, 'Missing the required parameter protection_request when calling WordsApi.unprotect_document' if api_client.config.client_side_validation && self.protection_request.nil?
-      self.protection_request.validate
+
       # resource path
       local_var_path = '/words/{name}/protection'[1..-1]
       local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', self.name.nil? ? '' : self.name.to_s)
@@ -171,13 +152,6 @@ module AsposeWordsCloud
       # form parameters
       form_params = []
       files_content = []
-      if self.protection_request.nil?
-        raise "Parameter ProtectionRequest is required."
-      end
-      unless self.protection_request.nil?
-        form_params.push({:'Name' => 'protectionRequest', :'Data' => self.protection_request.to_body.to_json, :'MimeType' =>'application/json'})
-      end
-
       body = api_client.build_request_body(header_params, form_params, files_content)
       {
         'method': :DELETE,

data/lib/aspose_words_cloud/models/responses/insert_watermark_online_response.rb

@@ -0,0 +1,46 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="insert_watermark_online_response.rb">
+#   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>
+# ------------------------------------------------------------------------------------
+
+module AsposeWordsCloud
+
+  #
+  # Response model for insert_watermark_online operation.
+  #
+  class InsertWatermarkOnlineResponse
+    # The REST response with a document description.
+    attr_accessor :model
+
+    # The document after modification.
+    attr_accessor :document
+
+    #
+    # Initializes a new instance.
+    #
+    def initialize()
+      self.model = nil
+      self.document = nil
+    end
+  end
+end

data/lib/aspose_words_cloud/models/structured_document_tag.rb

@@ -210,7 +210,7 @@ module AsposeWordsCloud
         :'building_block_gallery' => :'String',
         :'building_block_category' => :'String',
         :'multiline' => :'BOOLEAN',
-        :'color' => :'String',
+        :'color' => :'XmlColor',
         :'style_name' => :'String',
         :'calendar_type' => :'String',
         :'is_temporary' => :'BOOLEAN',
@@ -594,6 +594,9 @@ module AsposeWordsCloud
               end
           end
       end
+      unless self.color.nil?
+          self.color.validate
+      end
 
     end
 

data/lib/aspose_words_cloud/models/structured_document_tag_insert.rb

@@ -210,7 +210,7 @@ module AsposeWordsCloud
         :'building_block_gallery' => :'String',
         :'building_block_category' => :'String',
         :'multiline' => :'BOOLEAN',
-        :'color' => :'String',
+        :'color' => :'XmlColor',
         :'style_name' => :'String',
         :'calendar_type' => :'String',
         :'is_temporary' => :'BOOLEAN',
@@ -596,6 +596,9 @@ module AsposeWordsCloud
               end
           end
       end
+      unless self.color.nil?
+          self.color.validate
+      end
 
     end
 

data/lib/aspose_words_cloud/models/structured_document_tag_update.rb

@@ -210,7 +210,7 @@ module AsposeWordsCloud
         :'building_block_gallery' => :'String',
         :'building_block_category' => :'String',
         :'multiline' => :'BOOLEAN',
-        :'color' => :'String',
+        :'color' => :'XmlColor',
         :'style_name' => :'String',
         :'calendar_type' => :'String',
         :'is_temporary' => :'BOOLEAN',
@@ -594,6 +594,9 @@ module AsposeWordsCloud
               end
           end
       end
+      unless self.color.nil?
+          self.color.validate
+      end
 
     end