aspose_words_cloud 20.7.0 → 21.1.0

data/lib/aspose_words_cloud/models/requests/{render_drawing_object_without_node_path_request.rb → render_table_online_request.rb}

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
-# <copyright company="Aspose" file="render_drawing_object_without_node_path_request.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+# <copyright company="Aspose" file="render_table_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
@@ -26,11 +26,11 @@
 module AsposeWordsCloud
 
   #
-  # Request model for render_drawing_object_without_node_path operation.
+  # Request model for render_table_online operation.
   #
-  class RenderDrawingObjectWithoutNodePathRequest
-    # The document name.
-    attr_accessor :name
+  class RenderTableOnlineRequest
+    # The document.
+    attr_accessor :document
 
     # The destination format.
     attr_accessor :format
@@ -38,11 +38,8 @@ module AsposeWordsCloud
     # Object index.
     attr_accessor :index
 
-    # Original document folder.
-    attr_accessor :folder
-
-    # Original document storage.
-    attr_accessor :storage
+    # The path to the node in the document tree.
+    attr_accessor :node_path
 
     # 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,28 +47,31 @@ module AsposeWordsCloud
     # Password for opening an encrypted document.
     attr_accessor :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
+
     # Folder in filestorage with custom fonts.
     attr_accessor :fonts_location
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param document The document.
     # @param format The destination format.
     # @param index Object index.
-    # @param folder Original document folder.
-    # @param storage Original document storage.
+    # @param node_path The path to the node in the document tree.
     # @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 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 fonts_location Folder in filestorage with custom fonts.
 
-    def initialize(name, format, index, folder = nil, storage = nil, load_encoding = nil, password = nil, fonts_location = nil)
-      self.name = name
+    def initialize(document, format, index, node_path = nil, load_encoding = nil, password = nil, dest_file_name = nil, fonts_location = nil)
+      self.document = document
       self.format = format
       self.index = index
-      self.folder = folder
-      self.storage = storage
+      self.node_path = node_path
       self.load_encoding = load_encoding
       self.password = password
+      self.dest_file_name = dest_file_name
       self.fonts_location = fonts_location
     end
   end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="render_table_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,18 +29,18 @@ module AsposeWordsCloud
   # Request model for render_table operation.
   #
   class RenderTableRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # The destination format.
     attr_accessor :format
 
-    # Path to the node, which contains tables.
-    attr_accessor :node_path
-
     # Object index.
     attr_accessor :index
 
+    # The path to the node in the document tree.
+    attr_accessor :node_path
+
     # Original document folder.
     attr_accessor :folder
 
@@ -53,30 +53,35 @@ module AsposeWordsCloud
     # Password for opening an encrypted document.
     attr_accessor :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
+
     # Folder in filestorage with custom fonts.
     attr_accessor :fonts_location
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param format The destination format.
-    # @param node_path Path to the node, which contains tables.
     # @param index Object index.
+    # @param node_path The path to the node in the document tree.
     # @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 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 fonts_location Folder in filestorage with custom fonts.
 
-    def initialize(name, format, node_path, index, folder = nil, storage = nil, load_encoding = nil, password = nil, fonts_location = nil)
+    def initialize(name, format, index, node_path = nil, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, fonts_location = nil)
       self.name = name
       self.format = format
-      self.node_path = node_path
       self.index = index
+      self.node_path = node_path
       self.folder = folder
       self.storage = storage
       self.load_encoding = load_encoding
       self.password = password
+      self.dest_file_name = dest_file_name
       self.fonts_location = fonts_location
     end
   end

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

@@ -0,0 +1,73 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="replace_text_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 replace_text_online operation.
+  #
+  class ReplaceTextOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # The replace operation settings.
+    attr_accessor :replace_text
+
+    # 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
+
+    # 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 document The document.
+    # @param replace_text The replace operation settings.
+    # @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 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(document, replace_text, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil)
+      self.document = document
+      self.replace_text = replace_text
+      self.load_encoding = load_encoding
+      self.password = password
+      self.dest_file_name = dest_file_name
+      self.revision_author = revision_author
+      self.revision_date_time = revision_date_time
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="replace_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,10 +29,10 @@ module AsposeWordsCloud
   # Request model for replace_text operation.
   #
   class ReplaceTextRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # ReplaceTextResponse with the replace operation settings.
+    # The replace operation settings.
     attr_accessor :replace_text
 
     # Original document folder.
@@ -58,8 +58,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param replace_text ReplaceTextResponse with the replace operation settings.
+    # @param name The filename of the input document.
+    # @param replace_text The replace operation settings.
     # @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/replace_with_text_online_request.rb

@@ -0,0 +1,73 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="replace_with_text_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 replace_with_text_online operation.
+  #
+  class ReplaceWithTextOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # The range start identifier.
+    attr_accessor :range_start_identifier
+
+    # Model with text for replacement.
+    attr_accessor :range_text
+
+    # 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
+
+    # 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
+
+    #
+    # Initializes a new instance.
+    # @param document The 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 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 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, range_start_identifier, range_text, range_end_identifier = nil, load_encoding = nil, password = nil, dest_file_name = nil)
+      self.document = document
+      self.range_start_identifier = range_start_identifier
+      self.range_text = range_text
+      self.range_end_identifier = range_end_identifier
+      self.load_encoding = load_encoding
+      self.password = password
+      self.dest_file_name = dest_file_name
+    end
+  end
+end

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