aspose_words_cloud 20.1.0 → 20.7.0

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

@@ -0,0 +1,93 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="insert_watermark_image_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 insert_watermark_image operation.
+  #
+  class InsertWatermarkImageRequest
+    # The document name.
+    attr_accessor :name
+
+    # File with image.
+    attr_accessor :image_file
+
+    # 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
+
+    # The watermark rotation angle.
+    attr_accessor :rotation_angle
+
+    # The image file server full name. If the name is empty the image is expected in request content.
+    attr_accessor :image
+
+    #
+    # Initializes a new instance.
+    # @param name The document name.
+    # @param image_file File with image.
+    # @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.
+    # @param rotation_angle The watermark rotation angle.
+    # @param image The image file server full name. If the name is empty the image is expected in request content.
+
+    def initialize(name, image_file = nil, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil, rotation_angle = nil, image = nil)
+      self.name = name
+      self.image_file = image_file
+      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
+      self.rotation_angle = rotation_angle
+      self.image = image
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="insert_watermark_text_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 insert_watermark_text operation.
+  #
+  class InsertWatermarkTextRequest
+    # The document name.
+    attr_accessor :name
+
+    # WatermarkText with the watermark data.
+    attr_accessor :watermark_text
+
+    # 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 watermark_text WatermarkText with the watermark 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 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, watermark_text, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil)
+      self.name = name
+      self.watermark_text = watermark_text
+      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/load_web_document_request.rb

@@ -0,0 +1,48 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="load_web_document_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 load_web_document operation.
+  #
+  class LoadWebDocumentRequest
+    # Parameters of loading.
+    attr_accessor :data
+
+    # Original document storage.
+    attr_accessor :storage
+
+    #
+    # Initializes a new instance.
+    # @param data Parameters of loading.
+    # @param storage Original document storage.
+
+    def initialize(data, storage = nil)
+      self.data = data
+      self.storage = storage
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="move_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 move_file operation.
+  #
+  class MoveFileRequest
+    # Destination file path e.g. '/dest.ext'.
+    attr_accessor :dest_path
+
+    # Source file's path e.g. '/Folder 1/file.ext' or '/Bucket/Folder 1/file.ext'.
+    attr_accessor :src_path
+
+    # Source storage name.
+    attr_accessor :src_storage_name
+
+    # Destination storage name.
+    attr_accessor :dest_storage_name
+
+    # File version ID to move.
+    attr_accessor :version_id
+
+    #
+    # Initializes a new instance.
+    # @param dest_path Destination file path e.g. '/dest.ext'.
+    # @param src_path Source file's path e.g. '/Folder 1/file.ext' or '/Bucket/Folder 1/file.ext'.
+    # @param src_storage_name Source storage name.
+    # @param dest_storage_name Destination storage name.
+    # @param version_id File version ID to move.
+
+    def initialize(dest_path, src_path, src_storage_name = nil, dest_storage_name = nil, version_id = nil)
+      self.dest_path = dest_path
+      self.src_path = src_path
+      self.src_storage_name = src_storage_name
+      self.dest_storage_name = dest_storage_name
+      self.version_id = version_id
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="move_folder_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 move_folder operation.
+  #
+  class MoveFolderRequest
+    # Destination folder path to move to e.g '/dst'.
+    attr_accessor :dest_path
+
+    # Source folder path e.g. /Folder1.
+    attr_accessor :src_path
+
+    # Source storage name.
+    attr_accessor :src_storage_name
+
+    # Destination storage name.
+    attr_accessor :dest_storage_name
+
+    #
+    # Initializes a new instance.
+    # @param dest_path Destination folder path to move to e.g '/dst'.
+    # @param src_path Source folder path e.g. /Folder1.
+    # @param src_storage_name Source storage name.
+    # @param dest_storage_name Destination storage name.
+
+    def initialize(dest_path, src_path, src_storage_name = nil, dest_storage_name = nil)
+      self.dest_path = dest_path
+      self.src_path = src_path
+      self.src_storage_name = src_storage_name
+      self.dest_storage_name = dest_storage_name
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="protect_document_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 protect_document operation.
+  #
+  class ProtectDocumentRequest
+    # The document name.
+    attr_accessor :name
+
+    # ProtectionRequest with protection settings.
+    attr_accessor :protection_request
+
+    # 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
+
+    #
+    # Initializes a new instance.
+    # @param name The document name.
+    # @param protection_request ProtectionRequest with protection settings.
+    # @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.
+
+    def initialize(name, protection_request, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil)
+      self.name = name
+      self.protection_request = protection_request
+      self.folder = folder
+      self.storage = storage
+      self.load_encoding = load_encoding
+      self.password = password
+      self.dest_file_name = dest_file_name
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="reject_all_revisions_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 reject_all_revisions operation.
+  #
+  class RejectAllRevisionsRequest
+    # 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
+
+    #
+    # 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.
+
+    def initialize(name, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = 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
+    end
+  end
+end