words_ruby_sdk 18.6

data/lib/words_ruby_sdk/models/requests/PostSplitDocumentRequest.rb

@@ -0,0 +1,85 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose" file="PostSplitDocumentRequest.rb">
+ #   Copyright (c) 2018 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 WordsRubySdk
+
+  #
+  # Request model for post_split_document operation.
+  #
+  class PostSplitDocumentRequest
+
+        # Original document name.
+        attr_accessor :name
+        # Original document folder.
+        attr_accessor :folder
+        # File storage, which have to be used.
+        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 name 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
+        # Format to split.
+        attr_accessor :format
+        # Start page.
+        attr_accessor :from
+        # End page.
+        attr_accessor :to
+        # ZipOutput or not.
+        attr_accessor :zip_output
+        # Folder in filestorage with custom fonts.
+        attr_accessor :fonts_location
+	
+        #
+        # Initializes a new instance.
+        # @param name Original document name.
+        # @param folder Original document folder.
+        # @param storage File storage, which have to be used.
+        # @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 name of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
+        # @param format Format to split.
+        # @param from Start page.
+        # @param to End page.
+        # @param zip_output ZipOutput or not.
+        # @param fonts_location Folder in filestorage with custom fonts.
+        def initialize(name, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, format = nil, from = nil, to = nil, zip_output = nil, fonts_location = 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.format = format
+           self.from = from
+           self.to = to
+           self.zip_output = zip_output
+           self.fonts_location = fonts_location
+        end
+  end
+end

data/lib/words_ruby_sdk/models/requests/PostUpdateDocumentBookmarkRequest.rb

@@ -0,0 +1,81 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose" file="PostUpdateDocumentBookmarkRequest.rb">
+ #   Copyright (c) 2018 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 WordsRubySdk
+
+  #
+  # Request model for post_update_document_bookmark operation.
+  #
+  class PostUpdateDocumentBookmarkRequest
+
+        # The document name.
+        attr_accessor :name
+        # with new bookmark data.            
+        attr_accessor :bookmark_data
+        # The bookmark name.
+        attr_accessor :bookmark_name
+        # Original document folder.
+        attr_accessor :folder
+        # File storage, which have to be used.
+        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 name 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 bookmark_data with new bookmark data.            
+        # @param bookmark_name The bookmark name.
+        # @param folder Original document folder.
+        # @param storage File storage, which have to be used.
+        # @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 name 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, bookmark_data, bookmark_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.bookmark_data = bookmark_data
+           self.bookmark_name = bookmark_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/words_ruby_sdk/models/requests/PostUpdateDocumentFieldsRequest.rb

@@ -0,0 +1,65 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose" file="PostUpdateDocumentFieldsRequest.rb">
+ #   Copyright (c) 2018 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 WordsRubySdk
+
+  #
+  # Request model for post_update_document_fields operation.
+  #
+  class PostUpdateDocumentFieldsRequest
+
+        # The document name.
+        attr_accessor :name
+        # Original document folder.
+        attr_accessor :folder
+        # File storage, which have to be used.
+        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 name 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 File storage, which have to be used.
+        # @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 name 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

data/lib/words_ruby_sdk/models/requests/PutCommentRequest.rb

@@ -0,0 +1,77 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose" file="PutCommentRequest.rb">
+ #   Copyright (c) 2018 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 WordsRubySdk
+
+  #
+  # Request model for put_comment operation.
+  #
+  class PutCommentRequest
+
+        # The document name.
+        attr_accessor :name
+        # Comment data.
+        attr_accessor :comment
+        # Original document folder.
+        attr_accessor :folder
+        # File storage, which have to be used.
+        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 name 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 comment Comment data.
+        # @param folder Original document folder.
+        # @param storage File storage, which have to be used.
+        # @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 name 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, comment, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil)
+           self.name = name
+           self.comment = comment
+           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/words_ruby_sdk/models/requests/PutConvertDocumentRequest.rb

@@ -0,0 +1,65 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose" file="PutConvertDocumentRequest.rb">
+ #   Copyright (c) 2018 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 WordsRubySdk
+
+  #
+  # Request model for put_convert_document operation.
+  #
+  class PutConvertDocumentRequest
+
+        # Converting document
+        attr_accessor :document
+        # Format to convert.
+        attr_accessor :format
+        # File storage, which have to be used.
+        attr_accessor :storage
+        # Path for saving operation result to the local storage.
+        attr_accessor :out_path
+        # This file name will be used when resulting document has dynamic field for document file name {filename}. If it is not setted, \"sourceFilename\" will be used instead. 
+        attr_accessor :document_file_name
+        # Folder in filestorage with custom fonts.
+        attr_accessor :fonts_location
+	
+        #
+        # Initializes a new instance.
+        # @param document Converting document
+        # @param format Format to convert.
+        # @param storage File storage, which have to be used.
+        # @param out_path Path for saving operation result to the local storage.
+        # @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 setted, \"sourceFilename\" will be used instead. 
+        # @param fonts_location Folder in filestorage with custom fonts.
+        def initialize(document, format, storage = nil, out_path = nil, document_file_name = nil, fonts_location = nil)
+           self.document = document
+           self.format = format
+           self.storage = storage
+           self.out_path = out_path
+           self.document_file_name = document_file_name
+           self.fonts_location = fonts_location
+        end
+  end
+end

data/lib/words_ruby_sdk/models/requests/PutCreateDocumentRequest.rb

@@ -0,0 +1,53 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose" file="PutCreateDocumentRequest.rb">
+ #   Copyright (c) 2018 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 WordsRubySdk
+
+  #
+  # Request model for put_create_document operation.
+  #
+  class PutCreateDocumentRequest
+
+        # File storage, which have to be used.
+        attr_accessor :storage
+        # The file name.
+        attr_accessor :file_name
+        # The document folder.
+        attr_accessor :folder
+	
+        #
+        # Initializes a new instance.
+        # @param storage File storage, which have to be used.
+        # @param file_name The file name.
+        # @param folder The document folder.
+        def initialize(storage = nil, file_name = nil, folder = nil)
+           self.storage = storage
+           self.file_name = file_name
+           self.folder = folder
+        end
+  end
+end

data/lib/words_ruby_sdk/models/requests/PutDocumentFieldNamesRequest.rb

@@ -0,0 +1,49 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose" file="PutDocumentFieldNamesRequest.rb">
+ #   Copyright (c) 2018 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 WordsRubySdk
+
+  #
+  # Request model for put_document_field_names operation.
+  #
+  class PutDocumentFieldNamesRequest
+
+        # File with template
+        attr_accessor :template
+        # Use non merge fields or not.
+        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.
+        def initialize(template, use_non_merge_fields = nil)
+           self.template = template
+           self.use_non_merge_fields = use_non_merge_fields
+        end
+  end
+end