aspose_words_cloud 20.9.0 → 21.3.0

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="delete_header_footer_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 delete_header_footer operation.
   #
   class DeleteHeaderFooterRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Path to parent section.
+    # The path to the section in the document tree.
     attr_accessor :section_path
 
     # Object index.
@@ -61,8 +61,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param section_path Path to parent section.
+    # @param name The filename of the input document.
+    # @param section_path The path to the section in the document tree.
     # @param index Object index.
     # @param folder Original document folder.
     # @param storage Original document storage.

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

@@ -0,0 +1,78 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="delete_headers_footers_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_headers_footers_online operation.
+  #
+  class DeleteHeadersFootersOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # The path to the section in the document tree.
+    attr_accessor :section_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
+
+    # 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
+
+    # The list of HeaderFooter types.
+    attr_accessor :headers_footers_types
+
+    #
+    # Initializes a new instance.
+    # @param document The document.
+    # @param section_path The path to the section 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 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.
+    # @param headers_footers_types The list of HeaderFooter types.
+
+    def initialize(document, section_path, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil, headers_footers_types = nil)
+      self.document = document
+      self.section_path = section_path
+      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
+      self.headers_footers_types = headers_footers_types
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="delete_headers_footers_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 delete_headers_footers operation.
   #
   class DeleteHeadersFootersRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Path to parent section.
+    # The path to the section in the document tree.
     attr_accessor :section_path
 
     # Original document folder.
@@ -56,13 +56,13 @@ module AsposeWordsCloud
     # The date and time to use for revisions.
     attr_accessor :revision_date_time
 
-    # List of types of headers and footers.
+    # The list of HeaderFooter types.
     attr_accessor :headers_footers_types
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param section_path Path to parent section.
+    # @param name The filename of the input document.
+    # @param section_path The path to the section 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.
@@ -70,7 +70,7 @@ module AsposeWordsCloud
     # @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.
-    # @param headers_footers_types List of types of headers and footers.
+    # @param headers_footers_types The list of HeaderFooter types.
 
     def initialize(name, section_path, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil, headers_footers_types = nil)
       self.name = name

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

@@ -0,0 +1,68 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="delete_macros_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_macros_online operation.
+  #
+  class DeleteMacrosOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
+    attr_accessor :load_encoding
+
+    # 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 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, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil)
+      self.document = document
+      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/delete_macros_request.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="delete_macros_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 delete_macros operation.
   #
   class DeleteMacrosRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Original document folder.
@@ -55,7 +55,7 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @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/delete_office_math_object_online_request.rb

@@ -0,0 +1,78 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="delete_office_math_object_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_office_math_object_online operation.
+  #
+  class DeleteOfficeMathObjectOnlineRequest
+    # 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
+
+    # 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 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.
+    # @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, index, node_path = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = 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
+      self.revision_author = revision_author
+      self.revision_date_time = revision_date_time
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="delete_office_math_object_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_office_math_object operation.
   #
   class DeleteOfficeMathObjectRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Object index.
     attr_accessor :index
 
-    # Path to the node, which contains collection of OfficeMath objects.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -61,9 +61,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 collection of OfficeMath objects.
+    # @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.

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

@@ -0,0 +1,78 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="delete_paragraph_list_format_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_paragraph_list_format_online operation.
+  #
+  class DeleteParagraphListFormatOnlineRequest
+    # 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
+
+    # 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 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.
+    # @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, index, node_path = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = 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
+      self.revision_author = revision_author
+      self.revision_date_time = revision_date_time
+    end
+  end
+end