aspose_words_cloud 20.10.0 → 21.4.0

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="get_form_fields_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 get_form_fields operation.
   #
   class GetFormFieldsRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Path to the node containing collection of form fields.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -49,8 +49,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param node_path Path to the node containing collection of form fields.
+    # @param name The filename of the input document.
+    # @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/get_header_footer_of_section_online_request.rb

@@ -0,0 +1,68 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="get_header_footer_of_section_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 get_header_footer_of_section_online operation.
+  #
+  class GetHeaderFooterOfSectionOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # The index of the HeaderFooter object.
+    attr_accessor :header_footer_index
+
+    # The index of the section.
+    attr_accessor :section_index
+
+    # 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 list of HeaderFooter types.
+    attr_accessor :filter_by_type
+
+    #
+    # Initializes a new instance.
+    # @param document The document.
+    # @param header_footer_index The index of the HeaderFooter object.
+    # @param section_index The index of the section.
+    # @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 filter_by_type The list of HeaderFooter types.
+
+    def initialize(document, header_footer_index, section_index, load_encoding = nil, password = nil, filter_by_type = nil)
+      self.document = document
+      self.header_footer_index = header_footer_index
+      self.section_index = section_index
+      self.load_encoding = load_encoding
+      self.password = password
+      self.filter_by_type = filter_by_type
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="get_header_footer_of_section_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 get_header_footer_of_section operation.
   #
   class GetHeaderFooterOfSectionRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Header/footer index.
+    # The index of the HeaderFooter object.
     attr_accessor :header_footer_index
 
-    # Section index.
+    # The index of the section.
     attr_accessor :section_index
 
     # Original document folder.
@@ -50,19 +50,19 @@ module AsposeWordsCloud
     # Password for opening an encrypted document.
     attr_accessor :password
 
-    # List of types of headers and footers.
+    # The list of HeaderFooter types.
     attr_accessor :filter_by_type
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param header_footer_index Header/footer index.
-    # @param section_index Section index.
+    # @param name The filename of the input document.
+    # @param header_footer_index The index of the HeaderFooter object.
+    # @param section_index The index of the section.
     # @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 filter_by_type List of types of headers and footers.
+    # @param filter_by_type The list of HeaderFooter types.
 
     def initialize(name, header_footer_index, section_index, folder = nil, storage = nil, load_encoding = nil, password = nil, filter_by_type = nil)
       self.name = name

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

@@ -0,0 +1,63 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="get_header_footer_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 get_header_footer_online operation.
+  #
+  class GetHeaderFooterOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # The index of the HeaderFooter object.
+    attr_accessor :header_footer_index
+
+    # 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 list of HeaderFooter types.
+    attr_accessor :filter_by_type
+
+    #
+    # Initializes a new instance.
+    # @param document The document.
+    # @param header_footer_index The index of the HeaderFooter object.
+    # @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 filter_by_type The list of HeaderFooter types.
+
+    def initialize(document, header_footer_index, load_encoding = nil, password = nil, filter_by_type = nil)
+      self.document = document
+      self.header_footer_index = header_footer_index
+      self.load_encoding = load_encoding
+      self.password = password
+      self.filter_by_type = filter_by_type
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="get_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 get_header_footer operation.
   #
   class GetHeaderFooterRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Header/footer index.
+    # The index of the HeaderFooter object.
     attr_accessor :header_footer_index
 
     # Original document folder.
@@ -47,18 +47,18 @@ module AsposeWordsCloud
     # Password for opening an encrypted document.
     attr_accessor :password
 
-    # List of types of headers and footers.
+    # The list of HeaderFooter types.
     attr_accessor :filter_by_type
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param header_footer_index Header/footer index.
+    # @param name The filename of the input document.
+    # @param header_footer_index The index of the HeaderFooter object.
     # @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 filter_by_type List of types of headers and footers.
+    # @param filter_by_type The list of HeaderFooter types.
 
     def initialize(name, header_footer_index, folder = nil, storage = nil, load_encoding = nil, password = nil, filter_by_type = nil)
       self.name = name

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

@@ -0,0 +1,63 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="get_header_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 get_header_footers_online operation.
+  #
+  class GetHeaderFootersOnlineRequest
+    # 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
+
+    # The list of HeaderFooter types.
+    attr_accessor :filter_by_type
+
+    #
+    # 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 filter_by_type The list of HeaderFooter types.
+
+    def initialize(document, section_path, load_encoding = nil, password = nil, filter_by_type = nil)
+      self.document = document
+      self.section_path = section_path
+      self.load_encoding = load_encoding
+      self.password = password
+      self.filter_by_type = filter_by_type
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="get_header_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 get_header_footers operation.
   #
   class GetHeaderFootersRequest
-    # 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.
@@ -47,18 +47,18 @@ module AsposeWordsCloud
     # Password for opening an encrypted document.
     attr_accessor :password
 
-    # List of types of headers and footers.
+    # The list of HeaderFooter types.
     attr_accessor :filter_by_type
 
     #
     # 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.
     # @param password Password for opening an encrypted document.
-    # @param filter_by_type List of types of headers and footers.
+    # @param filter_by_type The list of HeaderFooter types.
 
     def initialize(name, section_path, folder = nil, storage = nil, load_encoding = nil, password = nil, filter_by_type = nil)
       self.name = name

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

@@ -0,0 +1,58 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="get_list_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 get_list_online operation.
+  #
+  class GetListOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # The list Id.
+    attr_accessor :list_id
+
+    # 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 list_id The list Id.
+    # @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, list_id, load_encoding = nil, password = nil)
+      self.document = document
+      self.list_id = list_id
+      self.load_encoding = load_encoding
+      self.password = password
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="get_list_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 get_list operation.
   #
   class GetListRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # List unique identifier.
+    # The list Id.
     attr_accessor :list_id
 
     # Original document folder.
@@ -49,8 +49,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param list_id List unique identifier.
+    # @param name The filename of the input document.
+    # @param list_id The list Id.
     # @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.