aspose_words_cloud 20.10.0 → 21.4.0

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="get_document_drawing_object_ole_data_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_document_drawing_object_ole_data operation.
   #
   class GetDocumentDrawingObjectOleDataRequest
-    # 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 drawing objects.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -52,9 +52,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 drawing 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/get_document_drawing_objects_online_request.rb

@@ -0,0 +1,58 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="get_document_drawing_objects_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_document_drawing_objects_online operation.
+  #
+  class GetDocumentDrawingObjectsOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # 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
+
+    #
+    # Initializes a new instance.
+    # @param document The document.
+    # @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.
+
+    def initialize(document, node_path = nil, load_encoding = nil, password = nil)
+      self.document = document
+      self.node_path = node_path
+      self.load_encoding = load_encoding
+      self.password = password
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="get_document_drawing_objects_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_document_drawing_objects operation.
   #
   class GetDocumentDrawingObjectsRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Path to the node, which contains collection of drawing objects.
+    # 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, which contains collection of drawing objects.
+    # @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_document_field_names_online_request.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="get_document_field_names_online_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,19 +29,29 @@ module AsposeWordsCloud
   # Request model for get_document_field_names_online operation.
   #
   class GetDocumentFieldNamesOnlineRequest
-    # File with template.
-    attr_accessor :template
+    # The document.
+    attr_accessor :document
 
-    # Use non merge fields or not.
+    # 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 non merge fields. If true, result includes "mustache" field names.
     attr_accessor :use_non_merge_fields
 
     #
     # Initializes a new instance.
-    # @param template File with template.
-    # @param use_non_merge_fields Use non merge fields or not.
+    # @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 use_non_merge_fields The flag indicating whether to use non merge fields. If true, result includes "mustache" field names.
 
-    def initialize(template, use_non_merge_fields = nil)
-      self.template = template
+    def initialize(document, load_encoding = nil, password = nil, use_non_merge_fields = nil)
+      self.document = document
+      self.load_encoding = load_encoding
+      self.password = password
       self.use_non_merge_fields = use_non_merge_fields
     end
   end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="get_document_field_names_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 get_document_field_names operation.
   #
   class GetDocumentFieldNamesRequest
-    # The template name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Original document folder.
@@ -44,17 +44,17 @@ module AsposeWordsCloud
     # Password for opening an encrypted document.
     attr_accessor :password
 
-    # If true, result includes "mustache" field names.
+    # The flag indicating whether to use non merge fields. If true, result includes "mustache" field names.
     attr_accessor :use_non_merge_fields
 
     #
     # Initializes a new instance.
-    # @param name The template 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.
     # @param password Password for opening an encrypted document.
-    # @param use_non_merge_fields If true, result includes "mustache" field names.
+    # @param use_non_merge_fields The flag indicating whether to use non merge fields. If true, result includes "mustache" field names.
 
     def initialize(name, folder = nil, storage = nil, load_encoding = nil, password = nil, use_non_merge_fields = nil)
       self.name = name

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

@@ -0,0 +1,58 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="get_document_hyperlink_by_index_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_document_hyperlink_by_index_online operation.
+  #
+  class GetDocumentHyperlinkByIndexOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # The index of the hyperlink.
+    attr_accessor :hyperlink_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
+
+    #
+    # Initializes a new instance.
+    # @param document The document.
+    # @param hyperlink_index The index of the hyperlink.
+    # @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, hyperlink_index, load_encoding = nil, password = nil)
+      self.document = document
+      self.hyperlink_index = hyperlink_index
+      self.load_encoding = load_encoding
+      self.password = password
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="get_document_hyperlink_by_index_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_document_hyperlink_by_index operation.
   #
   class GetDocumentHyperlinkByIndexRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # The hyperlink index.
+    # The index of the hyperlink.
     attr_accessor :hyperlink_index
 
     # Original document folder.
@@ -49,8 +49,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param hyperlink_index The hyperlink index.
+    # @param name The filename of the input document.
+    # @param hyperlink_index The index of the hyperlink.
     # @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_document_hyperlinks_online_request.rb

@@ -0,0 +1,53 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="get_document_hyperlinks_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_document_hyperlinks_online operation.
+  #
+  class GetDocumentHyperlinksOnlineRequest
+    # 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
+
+    #
+    # 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.
+
+    def initialize(document, load_encoding = nil, password = nil)
+      self.document = document
+      self.load_encoding = load_encoding
+      self.password = password
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="get_document_hyperlinks_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 get_document_hyperlinks operation.
   #
   class GetDocumentHyperlinksRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Original document folder.
@@ -46,7 +46,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/get_document_properties_online_request.rb

@@ -0,0 +1,53 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="get_document_properties_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_document_properties_online operation.
+  #
+  class GetDocumentPropertiesOnlineRequest
+    # 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
+
+    #
+    # 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.
+
+    def initialize(document, load_encoding = nil, password = nil)
+      self.document = document
+      self.load_encoding = load_encoding
+      self.password = password
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="get_document_properties_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 get_document_properties operation.
   #
   class GetDocumentPropertiesRequest
-    # The document's name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Original document folder.
@@ -46,7 +46,7 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document's 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.