aspose_words_cloud 20.8.0 → 21.2.0

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="get_paragraphs_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_paragraphs operation.
   #
   class GetParagraphsRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Path to the node which contains paragraphs.
+    # 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 paragraphs.
+    # @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_range_text_online_request.rb

@@ -0,0 +1,63 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="get_range_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 get_range_text_online operation.
+  #
+  class GetRangeTextOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # The range start identifier.
+    attr_accessor :range_start_identifier
+
+    # 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 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, range_end_identifier = nil, load_encoding = nil, password = nil)
+      self.document = document
+      self.range_start_identifier = range_start_identifier
+      self.range_end_identifier = range_end_identifier
+      self.load_encoding = load_encoding
+      self.password = password
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="get_range_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 get_range_text operation.
   #
   class GetRangeTextRequest
-    # 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
 
     # The range end identifier.
@@ -54,8 +52,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_end_identifier The range end identifier.
     # @param folder Original document folder.
     # @param storage Original document storage.

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

@@ -0,0 +1,63 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="get_run_font_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_run_font_online operation.
+  #
+  class GetRunFontOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # The path to the paragraph in the document tree.
+    attr_accessor :paragraph_path
+
+    # Object index.
+    attr_accessor :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 paragraph_path The path to the paragraph in the document tree.
+    # @param index Object index.
+    # @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, paragraph_path, index, load_encoding = nil, password = nil)
+      self.document = document
+      self.paragraph_path = paragraph_path
+      self.index = index
+      self.load_encoding = load_encoding
+      self.password = password
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="get_run_font_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_run_font operation.
   #
   class GetRunFontRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Path to parent paragraph.
+    # The path to the paragraph in the document tree.
     attr_accessor :paragraph_path
 
     # Object index.
@@ -52,8 +52,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param paragraph_path Path to parent paragraph.
+    # @param name The filename of the input document.
+    # @param paragraph_path The path to the paragraph 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/get_run_online_request.rb

@@ -0,0 +1,63 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="get_run_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_run_online operation.
+  #
+  class GetRunOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # The path to the paragraph in the document tree.
+    attr_accessor :paragraph_path
+
+    # Object index.
+    attr_accessor :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 paragraph_path The path to the paragraph in the document tree.
+    # @param index Object index.
+    # @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, paragraph_path, index, load_encoding = nil, password = nil)
+      self.document = document
+      self.paragraph_path = paragraph_path
+      self.index = index
+      self.load_encoding = load_encoding
+      self.password = password
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="get_run_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_run operation.
   #
   class GetRunRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Path to parent paragraph.
+    # The path to the paragraph in the document tree.
     attr_accessor :paragraph_path
 
     # Object index.
@@ -52,8 +52,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param paragraph_path Path to parent paragraph.
+    # @param name The filename of the input document.
+    # @param paragraph_path The path to the paragraph 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/get_runs_online_request.rb

@@ -0,0 +1,58 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="get_runs_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_runs_online operation.
+  #
+  class GetRunsOnlineRequest
+    # The document.
+    attr_accessor :document
+
+    # The path to the paragraph in the document tree.
+    attr_accessor :paragraph_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 paragraph_path The path to the paragraph 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, paragraph_path, load_encoding = nil, password = nil)
+      self.document = document
+      self.paragraph_path = paragraph_path
+      self.load_encoding = load_encoding
+      self.password = password
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="get_runs_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_runs operation.
   #
   class GetRunsRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Path to parent paragraph.
+    # The path to the paragraph in the document tree.
     attr_accessor :paragraph_path
 
     # Original document folder.
@@ -49,8 +49,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param paragraph_path Path to parent paragraph.
+    # @param name The filename of the input document.
+    # @param paragraph_path The path to the paragraph 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_section_online_request.rb

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