aspose_words_cloud 20.9.0 → 21.3.0

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="replace_with_text_request.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -29,12 +29,10 @@ module AsposeWordsCloud
   # Request model for replace_with_text operation.
   #
   class ReplaceWithTextRequest
-    # The document.
+    # The filename of the input document.
     attr_accessor :name
 
     # The range start identifier.
-    # Identifier is the value of the "nodeId" field, which every document node has, extended with the prefix "id".
-    # It looks like "id0.0.7". Also values like "image5" and "table3" can be used as an identifier for images and tables, where the number is an index of the image/table.
     attr_accessor :range_start_identifier
 
     # Model with text for replacement.
@@ -60,8 +58,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document.
-    # @param range_start_identifier The range start identifier. Identifier is the value of the "nodeId" field, which every document node has, extended with the prefix "id". It looks like "id0.0.7". Also values like "image5" and "table3" can be used as an identifier for images and tables, where the number is an index of the image/table.
+    # @param name The filename of the input document.
+    # @param range_start_identifier The range start identifier.
     # @param range_text Model with text for replacement.
     # @param range_end_identifier The range end identifier.
     # @param folder Original document folder.

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="reset_cache_request.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy

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

@@ -0,0 +1,63 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="save_as_online_request.rb">
+#   Copyright (c) 2021 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 save_as_online operation.
+  #
+  class SaveAsOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # Save options.
+    attr_accessor :save_options_data
+
+    # 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 for opening an encrypted document.
+    attr_accessor :password
+
+    # Folder in filestorage with custom fonts.
+    attr_accessor :fonts_location
+
+    #
+    # Initializes a new instance.
+    # @param document The document.
+    # @param save_options_data Save 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 for opening an encrypted document.
+    # @param fonts_location Folder in filestorage with custom fonts.
+
+    def initialize(document, save_options_data, load_encoding = nil, password = nil, fonts_location = nil)
+      self.document = document
+      self.save_options_data = save_options_data
+      self.load_encoding = load_encoding
+      self.password = password
+      self.fonts_location = fonts_location
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="save_as_range_online_request.rb">
+#   Copyright (c) 2021 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 save_as_range_online operation.
+  #
+  class SaveAsRangeOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # The range start identifier.
+    attr_accessor :range_start_identifier
+
+    # Parameters of a new document.
+    attr_accessor :document_parameters
+
+    # The range end identifier.
+    attr_accessor :range_end_identifier
+
+    # 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 for opening an encrypted document.
+    attr_accessor :password
+
+    #
+    # Initializes a new instance.
+    # @param document The document.
+    # @param range_start_identifier The range start identifier.
+    # @param document_parameters Parameters of a new document.
+    # @param range_end_identifier The range end identifier.
+    # @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 for opening an encrypted document.
+
+    def initialize(document, range_start_identifier, document_parameters, range_end_identifier = nil, load_encoding = nil, password = nil)
+      self.document = document
+      self.range_start_identifier = range_start_identifier
+      self.document_parameters = document_parameters
+      self.range_end_identifier = range_end_identifier
+      self.load_encoding = load_encoding
+      self.password = password
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="save_as_range_request.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -29,12 +29,10 @@ module AsposeWordsCloud
   # Request model for save_as_range operation.
   #
   class SaveAsRangeRequest
-    # The document.
+    # The filename of the input document.
     attr_accessor :name
 
     # The range start identifier.
-    # Identifier is the value of the "nodeId" field, which every document node has, extended with the prefix "id".
-    # It looks like "id0.0.7". Also values like "image5" and "table3" can be used as an identifier for images and tables, where the number is an index of the image/table.
     attr_accessor :range_start_identifier
 
     # Parameters of a new document.
@@ -57,8 +55,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document.
-    # @param range_start_identifier The range start identifier. Identifier is the value of the "nodeId" field, which every document node has, extended with the prefix "id". It looks like "id0.0.7". Also values like "image5" and "table3" can be used as an identifier for images and tables, where the number is an index of the image/table.
+    # @param name The filename of the input document.
+    # @param range_start_identifier The range start identifier.
     # @param document_parameters Parameters of a new document.
     # @param range_end_identifier The range end identifier.
     # @param folder Original document folder.

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="save_as_request.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for save_as operation.
   #
   class SaveAsRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Save options.
@@ -52,7 +52,7 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param save_options_data Save options.
     # @param folder Original document folder.
     # @param storage Original document storage.

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

@@ -0,0 +1,148 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="save_as_tiff_online_request.rb">
+#   Copyright (c) 2021 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 save_as_tiff_online operation.
+  #
+  class SaveAsTiffOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # Tiff save options.
+    attr_accessor :save_options
+
+    # 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 for opening an encrypted document.
+    attr_accessor :password
+
+    # The flag indicating whether to use antialiasing.
+    attr_accessor :use_anti_aliasing
+
+    # The flag indicating whether to use high quality.
+    attr_accessor :use_high_quality_rendering
+
+    # The level of brightness for the generated images.
+    attr_accessor :image_brightness
+
+    # The color mode for the generated images.
+    attr_accessor :image_color_mode
+
+    # The contrast for the generated images.
+    attr_accessor :image_contrast
+
+    # The images numeral format.
+    attr_accessor :numeral_format
+
+    # The number of pages to render.
+    attr_accessor :page_count
+
+    # The index of the page to start rendering.
+    attr_accessor :page_index
+
+    # The background image color.
+    attr_accessor :paper_color
+
+    # The pixel format of the generated images.
+    attr_accessor :pixel_format
+
+    # The resolution of the generated images.
+    attr_accessor :resolution
+
+    # The zoom factor for the generated images.
+    attr_accessor :scale
+
+    # The compression tipe.
+    attr_accessor :tiff_compression
+
+    # The optional dml rendering mode. The default value is Fallback.
+    attr_accessor :dml_rendering_mode
+
+    # The optional dml effects rendering mode. The default value is Simplified.
+    attr_accessor :dml_effects_rendering_mode
+
+    # The optional TIFF binarization method. Possible values are: FloydSteinbergDithering, Threshold.
+    attr_accessor :tiff_binarization_method
+
+    # The flag indicating whether to ZIP the output.
+    attr_accessor :zip_output
+
+    # Folder in filestorage with custom fonts.
+    attr_accessor :fonts_location
+
+    #
+    # Initializes a new instance.
+    # @param document The document.
+    # @param save_options Tiff save 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 for opening an encrypted document.
+    # @param use_anti_aliasing The flag indicating whether to use antialiasing.
+    # @param use_high_quality_rendering The flag indicating whether to use high quality.
+    # @param image_brightness The level of brightness for the generated images.
+    # @param image_color_mode The color mode for the generated images.
+    # @param image_contrast The contrast for the generated images.
+    # @param numeral_format The images numeral format.
+    # @param page_count The number of pages to render.
+    # @param page_index The index of the page to start rendering.
+    # @param paper_color The background image color.
+    # @param pixel_format The pixel format of the generated images.
+    # @param resolution The resolution of the generated images.
+    # @param scale The zoom factor for the generated images.
+    # @param tiff_compression The compression tipe.
+    # @param dml_rendering_mode The optional dml rendering mode. The default value is Fallback.
+    # @param dml_effects_rendering_mode The optional dml effects rendering mode. The default value is Simplified.
+    # @param tiff_binarization_method The optional TIFF binarization method. Possible values are: FloydSteinbergDithering, Threshold.
+    # @param zip_output The flag indicating whether to ZIP the output.
+    # @param fonts_location Folder in filestorage with custom fonts.
+
+    def initialize(document, save_options, load_encoding = nil, password = nil, use_anti_aliasing = nil, use_high_quality_rendering = nil, image_brightness = nil, image_color_mode = nil, image_contrast = nil, numeral_format = nil, page_count = nil, page_index = nil, paper_color = nil, pixel_format = nil, resolution = nil, scale = nil, tiff_compression = nil, dml_rendering_mode = nil, dml_effects_rendering_mode = nil, tiff_binarization_method = nil, zip_output = nil, fonts_location = nil)
+      self.document = document
+      self.save_options = save_options
+      self.load_encoding = load_encoding
+      self.password = password
+      self.use_anti_aliasing = use_anti_aliasing
+      self.use_high_quality_rendering = use_high_quality_rendering
+      self.image_brightness = image_brightness
+      self.image_color_mode = image_color_mode
+      self.image_contrast = image_contrast
+      self.numeral_format = numeral_format
+      self.page_count = page_count
+      self.page_index = page_index
+      self.paper_color = paper_color
+      self.pixel_format = pixel_format
+      self.resolution = resolution
+      self.scale = scale
+      self.tiff_compression = tiff_compression
+      self.dml_rendering_mode = dml_rendering_mode
+      self.dml_effects_rendering_mode = dml_effects_rendering_mode
+      self.tiff_binarization_method = tiff_binarization_method
+      self.zip_output = zip_output
+      self.fonts_location = fonts_location
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="save_as_tiff_request.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for save_as_tiff operation.
   #
   class SaveAsTiffRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Tiff save options.
@@ -47,16 +47,16 @@ module AsposeWordsCloud
     # Password for opening an encrypted document.
     attr_accessor :password
 
-    # Use antialiasing flag.
+    # The flag indicating whether to use antialiasing.
     attr_accessor :use_anti_aliasing
 
-    # Use high quality flag.
+    # The flag indicating whether to use high quality.
     attr_accessor :use_high_quality_rendering
 
-    # Brightness for the generated images.
+    # The level of brightness for the generated images.
     attr_accessor :image_brightness
 
-    # Color mode for the generated images.
+    # The color mode for the generated images.
     attr_accessor :image_color_mode
 
     # The contrast for the generated images.
@@ -65,37 +65,37 @@ module AsposeWordsCloud
     # The images numeral format.
     attr_accessor :numeral_format
 
-    # Number of pages to render.
+    # The number of pages to render.
     attr_accessor :page_count
 
-    # Page index to start rendering.
+    # The index of the page to start rendering.
     attr_accessor :page_index
 
-    # Background image color.
+    # The background image color.
     attr_accessor :paper_color
 
-    # The pixel format of generated images.
+    # The pixel format of the generated images.
     attr_accessor :pixel_format
 
-    # The resolution of generated images.
+    # The resolution of the generated images.
     attr_accessor :resolution
 
-    # Zoom factor for generated images.
+    # The zoom factor for the generated images.
     attr_accessor :scale
 
     # The compression tipe.
     attr_accessor :tiff_compression
 
-    # Optional, default is Fallback.
+    # The optional dml rendering mode. The default value is Fallback.
     attr_accessor :dml_rendering_mode
 
-    # Optional, default is Simplified.
+    # The optional dml effects rendering mode. The default value is Simplified.
     attr_accessor :dml_effects_rendering_mode
 
-    # Optional, Tiff binarization method, possible values are: FloydSteinbergDithering, Threshold.
+    # The optional TIFF binarization method. Possible values are: FloydSteinbergDithering, Threshold.
     attr_accessor :tiff_binarization_method
 
-    # Optional. A value determining zip output or not.
+    # The flag indicating whether to ZIP the output.
     attr_accessor :zip_output
 
     # Folder in filestorage with custom fonts.
@@ -103,29 +103,29 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param save_options Tiff save 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.
     # @param password Password for opening an encrypted document.
-    # @param use_anti_aliasing Use antialiasing flag.
-    # @param use_high_quality_rendering Use high quality flag.
-    # @param image_brightness Brightness for the generated images.
-    # @param image_color_mode Color mode for the generated images.
+    # @param use_anti_aliasing The flag indicating whether to use antialiasing.
+    # @param use_high_quality_rendering The flag indicating whether to use high quality.
+    # @param image_brightness The level of brightness for the generated images.
+    # @param image_color_mode The color mode for the generated images.
     # @param image_contrast The contrast for the generated images.
     # @param numeral_format The images numeral format.
-    # @param page_count Number of pages to render.
-    # @param page_index Page index to start rendering.
-    # @param paper_color Background image color.
-    # @param pixel_format The pixel format of generated images.
-    # @param resolution The resolution of generated images.
-    # @param scale Zoom factor for generated images.
+    # @param page_count The number of pages to render.
+    # @param page_index The index of the page to start rendering.
+    # @param paper_color The background image color.
+    # @param pixel_format The pixel format of the generated images.
+    # @param resolution The resolution of the generated images.
+    # @param scale The zoom factor for the generated images.
     # @param tiff_compression The compression tipe.
-    # @param dml_rendering_mode Optional, default is Fallback.
-    # @param dml_effects_rendering_mode Optional, default is Simplified.
-    # @param tiff_binarization_method Optional, Tiff binarization method, possible values are: FloydSteinbergDithering, Threshold.
-    # @param zip_output Optional. A value determining zip output or not.
+    # @param dml_rendering_mode The optional dml rendering mode. The default value is Fallback.
+    # @param dml_effects_rendering_mode The optional dml effects rendering mode. The default value is Simplified.
+    # @param tiff_binarization_method The optional TIFF binarization method. Possible values are: FloydSteinbergDithering, Threshold.
+    # @param zip_output The flag indicating whether to ZIP the output.
     # @param fonts_location Folder in filestorage with custom fonts.
 
     def initialize(name, save_options, folder = nil, storage = nil, load_encoding = nil, password = nil, use_anti_aliasing = nil, use_high_quality_rendering = nil, image_brightness = nil, image_color_mode = nil, image_contrast = nil, numeral_format = nil, page_count = nil, page_index = nil, paper_color = nil, pixel_format = nil, resolution = nil, scale = nil, tiff_compression = nil, dml_rendering_mode = nil, dml_effects_rendering_mode = nil, tiff_binarization_method = nil, zip_output = nil, fonts_location = nil)