aspose_words_cloud 20.6.0 → 20.7.0

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

@@ -0,0 +1,83 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="delete_table_without_node_path_request.rb">
+#   Copyright (c) 2020 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_table_without_node_path operation.
+  #
+  class DeleteTableWithoutNodePathRequest
+    # The document name.
+    attr_accessor :name
+
+    # Object index.
+    attr_accessor :index
+
+    # Original document folder.
+    attr_accessor :folder
+
+    # Original document storage.
+    attr_accessor :storage
+
+    # 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 name The document name.
+    # @param index Object index.
+    # @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 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(name, index, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil)
+      self.name = name
+      self.index = index
+      self.folder = folder
+      self.storage = storage
+      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_watermark_request.rb

@@ -0,0 +1,78 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="delete_watermark_request.rb">
+#   Copyright (c) 2020 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_watermark operation.
+  #
+  class DeleteWatermarkRequest
+    # The document name.
+    attr_accessor :name
+
+    # Original document folder.
+    attr_accessor :folder
+
+    # Original document storage.
+    attr_accessor :storage
+
+    # 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 name The document name.
+    # @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 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(name, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil)
+      self.name = name
+      self.folder = folder
+      self.storage = storage
+      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/download_file_request.rb

@@ -0,0 +1,53 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="download_file_request.rb">
+#   Copyright (c) 2020 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 download_file operation.
+  #
+  class DownloadFileRequest
+    # Path of the file including the file name and extension e.g. /folder1/file.ext.
+    attr_accessor :path
+
+    # Storage name.
+    attr_accessor :storage_name
+
+    # File version ID to download.
+    attr_accessor :version_id
+
+    #
+    # Initializes a new instance.
+    # @param path Path of the file including the file name and extension e.g. /folder1/file.ext.
+    # @param storage_name Storage name.
+    # @param version_id File version ID to download.
+
+    def initialize(path, storage_name = nil, version_id = nil)
+      self.path = path
+      self.storage_name = storage_name
+      self.version_id = version_id
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="execute_mail_merge_online_request.rb">
+#   Copyright (c) 2020 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 execute_mail_merge_online operation.
+  #
+  class ExecuteMailMergeOnlineRequest
+    # File with template.
+    attr_accessor :template
+
+    # File with mailmerge data.
+    attr_accessor :data
+
+    # With regions flag.
+    attr_accessor :with_regions
+
+    # Clean up options.
+    attr_accessor :cleanup
+
+    # This file name will be used when resulting document has dynamic field for document file name {filename}. If it is not set, "template" will be used instead.
+    attr_accessor :document_file_name
+
+    #
+    # Initializes a new instance.
+    # @param template File with template.
+    # @param data File with mailmerge data.
+    # @param with_regions With regions flag.
+    # @param cleanup Clean up options.
+    # @param document_file_name This file name will be used when resulting document has dynamic field for document file name {filename}. If it is not set, "template" will be used instead.
+
+    def initialize(template, data, with_regions = nil, cleanup = nil, document_file_name = nil)
+      self.template = template
+      self.data = data
+      self.with_regions = with_regions
+      self.cleanup = cleanup
+      self.document_file_name = document_file_name
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="execute_mail_merge_request.rb">
+#   Copyright (c) 2020 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 execute_mail_merge operation.
+  #
+  class ExecuteMailMergeRequest
+    # The template name.
+    attr_accessor :name
+
+    # Mail merge data.
+    attr_accessor :data
+
+    # Original document folder.
+    attr_accessor :folder
+
+    # Original document storage.
+    attr_accessor :storage
+
+    # 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
+
+    # With regions flag.
+    attr_accessor :with_regions
+
+    # Mail merge data file.
+    attr_accessor :mail_merge_data_file
+
+    # Clean up options.
+    attr_accessor :cleanup
+
+    # Gets or sets a value indicating whether paragraph with TableStart or.
+    # TableEnd field should be fully included into mail merge region or particular range between TableStart and TableEnd fields.
+    # The default value is true.
+    attr_accessor :use_whole_paragraph_as_region
+
+    # Result name of the document after the operation. If this parameter is omitted then result of the operation will be saved with autogenerated name.
+    attr_accessor :dest_file_name
+
+    #
+    # Initializes a new instance.
+    # @param name The template name.
+    # @param data Mail merge 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.
+    # @param password Password for opening an encrypted document.
+    # @param with_regions With regions flag.
+    # @param mail_merge_data_file Mail merge data file.
+    # @param cleanup Clean up options.
+    # @param use_whole_paragraph_as_region Gets or sets a value indicating whether paragraph with TableStart or. TableEnd field should be fully included into mail merge region or particular range between TableStart and TableEnd fields. The default value is true.
+    # @param dest_file_name Result name of the document after the operation. If this parameter is omitted then result of the operation will be saved with autogenerated name.
+
+    def initialize(name, data = nil, folder = nil, storage = nil, load_encoding = nil, password = nil, with_regions = nil, mail_merge_data_file = nil, cleanup = nil, use_whole_paragraph_as_region = nil, dest_file_name = nil)
+      self.name = name
+      self.data = data
+      self.folder = folder
+      self.storage = storage
+      self.load_encoding = load_encoding
+      self.password = password
+      self.with_regions = with_regions
+      self.mail_merge_data_file = mail_merge_data_file
+      self.cleanup = cleanup
+      self.use_whole_paragraph_as_region = use_whole_paragraph_as_region
+      self.dest_file_name = dest_file_name
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="get_available_fonts_request.rb">
+#   Copyright (c) 2020 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_available_fonts operation.
+  #
+  class GetAvailableFontsRequest
+    # Folder in filestorage with custom fonts.
+    attr_accessor :fonts_location
+
+    #
+    # Initializes a new instance.
+    # @param fonts_location Folder in filestorage with custom fonts.
+
+    def initialize(fonts_location = nil)
+      self.fonts_location = fonts_location
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="get_bookmark_by_name_request.rb">
+#   Copyright (c) 2020 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_bookmark_by_name operation.
+  #
+  class GetBookmarkByNameRequest
+    # The document name.
+    attr_accessor :name
+
+    # The bookmark name.
+    attr_accessor :bookmark_name
+
+    # Original document folder.
+    attr_accessor :folder
+
+    # Original document storage.
+    attr_accessor :storage
+
+    # 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 name The document name.
+    # @param bookmark_name The bookmark name.
+    # @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.
+
+    def initialize(name, bookmark_name, folder = nil, storage = nil, load_encoding = nil, password = nil)
+      self.name = name
+      self.bookmark_name = bookmark_name
+      self.folder = folder
+      self.storage = storage
+      self.load_encoding = load_encoding
+      self.password = password
+    end
+  end
+end