aspose_words_cloud 20.8.0 → 21.2.0

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="compare_document_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 compare_document operation.
   #
   class CompareDocumentRequest
-    # Original document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # CompareData with a document to compare.
+    # Compare data.
     attr_accessor :compare_data
 
     # Original document folder.
@@ -52,8 +52,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name Original document name.
-    # @param compare_data CompareData with a document to compare.
+    # @param name The filename of the input document.
+    # @param compare_data Compare 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.

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="convert_document_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
@@ -32,36 +32,36 @@ module AsposeWordsCloud
     # Converting document.
     attr_accessor :document
 
-    # Format to convert.
+    # The format to convert.
     attr_accessor :format
 
-    # Original document storage.
-    attr_accessor :storage
-
-    # Path for saving operation result to the local storage.
+    # The path to the output document on a local storage.
     attr_accessor :out_path
 
-    # This file name will be used when resulting document has dynamic field for document file name {filename}. If it is not set, "sourceFilename" will be used instead.
+    # The filename of the output document, that will be used when the resulting document has a dynamic field {filename}. If it is not set, the "sourceFilename" will be used instead.
     attr_accessor :file_name_field_value
 
+    # Original document storage.
+    attr_accessor :storage
+
     # Folder in filestorage with custom fonts.
     attr_accessor :fonts_location
 
     #
     # Initializes a new instance.
     # @param document Converting document.
-    # @param format Format to convert.
+    # @param format The format to convert.
+    # @param out_path The path to the output document on a local storage.
+    # @param file_name_field_value The filename of the output document, that will be used when the resulting document has a dynamic field {filename}. If it is not set, the "sourceFilename" will be used instead.
     # @param storage Original document storage.
-    # @param out_path Path for saving operation result to the local storage.
-    # @param file_name_field_value This file name will be used when resulting document has dynamic field for document file name {filename}. If it is not set, "sourceFilename" will be used instead.
     # @param fonts_location Folder in filestorage with custom fonts.
 
-    def initialize(document, format, storage = nil, out_path = nil, file_name_field_value = nil, fonts_location = nil)
+    def initialize(document, format, out_path = nil, file_name_field_value = nil, storage = nil, fonts_location = nil)
       self.document = document
       self.format = format
-      self.storage = storage
       self.out_path = out_path
       self.file_name_field_value = file_name_field_value
+      self.storage = storage
       self.fonts_location = fonts_location
     end
   end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="copy_file_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/copy_folder_request.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="copy_folder_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/copy_style_online_request.rb

@@ -0,0 +1,73 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="copy_style_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 copy_style_online operation.
+  #
+  class CopyStyleOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # Style to copy.
+    attr_accessor :style_copy
+
+    # 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 style_copy Style to copy.
+    # @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, style_copy, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil)
+      self.document = document
+      self.style_copy = style_copy
+      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/copy_style_request.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="copy_style_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 copy_style operation.
   #
   class CopyStyleRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Style to copy.
@@ -58,7 +58,7 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param style_copy Style to copy.
     # @param folder Original document folder.
     # @param storage Original document storage.

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="create_document_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,25 +29,25 @@ module AsposeWordsCloud
   # Request model for create_document operation.
   #
   class CreateDocumentRequest
-    # Original document storage.
-    attr_accessor :storage
-
-    # The document name.
+    # The filename of the document.
     attr_accessor :file_name
 
-    # The document folder.
+    # The path to the document folder.
     attr_accessor :folder
 
+    # Original document storage.
+    attr_accessor :storage
+
     #
     # Initializes a new instance.
+    # @param file_name The filename of the document.
+    # @param folder The path to the document folder.
     # @param storage Original document storage.
-    # @param file_name The document name.
-    # @param folder The document folder.
 
-    def initialize(storage = nil, file_name = nil, folder = nil)
-      self.storage = storage
+    def initialize(file_name = nil, folder = nil, storage = nil)
       self.file_name = file_name
       self.folder = folder
+      self.storage = storage
     end
   end
 end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="create_folder_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/create_or_update_document_property_online_request.rb

@@ -0,0 +1,78 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="create_or_update_document_property_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 create_or_update_document_property_online operation.
+  #
+  class CreateOrUpdateDocumentPropertyOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # The name of the property.
+    attr_accessor :property_name
+
+    # The property with new value.
+    attr_accessor :property
+
+    # 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 property_name The name of the property.
+    # @param property The property with new value.
+    # @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, property_name, property, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil)
+      self.document = document
+      self.property_name = property_name
+      self.property = property
+      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/create_or_update_document_property_request.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="create_or_update_document_property_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 create_or_update_document_property operation.
   #
   class CreateOrUpdateDocumentPropertyRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # The property name.
+    # The name of the property.
     attr_accessor :property_name
 
     # The property with new value.
@@ -61,8 +61,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param property_name The property name.
+    # @param name The filename of the input document.
+    # @param property_name The name of the property.
     # @param property The property with new value.
     # @param folder Original document folder.
     # @param storage Original document storage.

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

@@ -0,0 +1,68 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="delete_all_paragraph_tab_stops_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 delete_all_paragraph_tab_stops_online operation.
+  #
+  class DeleteAllParagraphTabStopsOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # Object index.
+    attr_accessor :index
+
+    # 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
+
+    # 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 index Object index.
+    # @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.
+
+    def initialize(document, index, node_path = nil, load_encoding = nil, password = nil, dest_file_name = nil)
+      self.document = document
+      self.index = index
+      self.node_path = node_path
+      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/delete_all_paragraph_tab_stops_request.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="delete_all_paragraph_tab_stops_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,13 +29,13 @@ module AsposeWordsCloud
   # Request model for delete_all_paragraph_tab_stops operation.
   #
   class DeleteAllParagraphTabStopsRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Object index.
     attr_accessor :index
 
-    # Path to the node which contains paragraph.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -55,9 +55,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param index Object index.
-    # @param node_path Path to the node which contains paragraph.
+    # @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.