words_ruby_sdk 18.6

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

@@ -0,0 +1,85 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose" file="PutFormFieldRequest.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_form_field operation.
+  #
+  class PutFormFieldRequest
+
+        # The document name.
+        attr_accessor :name
+        # From field data.
+        attr_accessor :form_field
+        # 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
+        # Path to node that contains collection of formfields.
+        attr_accessor :node_path
+        # Form field will be inserted before node with index.
+        attr_accessor :insert_before_node
+	
+        #
+        # Initializes a new instance.
+        # @param name The document name.
+        # @param form_field From field 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.
+        # @param node_path Path to node that contains collection of formfields.
+        # @param insert_before_node Form field will be inserted before node with index.
+        def initialize(name, form_field, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil, node_path = nil, insert_before_node = nil)
+           self.name = name
+           self.form_field = form_field
+           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.node_path = node_path
+           self.insert_before_node = insert_before_node
+        end
+  end
+end

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

@@ -0,0 +1,81 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose" file="PutHeaderFooterRequest.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_header_footer operation.
+  #
+  class PutHeaderFooterRequest
+
+        # The document name.
+        attr_accessor :name
+        # Type of header/footer.
+        attr_accessor :header_footer_type
+        # 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
+        # Path to parent section.
+        attr_accessor :section_path
+	
+        #
+        # Initializes a new instance.
+        # @param name The document name.
+        # @param header_footer_type Type of header/footer.
+        # @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.
+        # @param section_path Path to parent section.
+        def initialize(name, header_footer_type, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil, section_path = nil)
+           self.name = name
+           self.header_footer_type = header_footer_type
+           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.section_path = section_path
+        end
+  end
+end

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

@@ -0,0 +1,85 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose" file="PutParagraphRequest.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_paragraph operation.
+  #
+  class PutParagraphRequest
+
+        # The document name.
+        attr_accessor :name
+        # Paragraph data.
+        attr_accessor :paragraph
+        # 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
+        # Path to node which contains paragraphs.
+        attr_accessor :node_path
+        # Paragraph will be inserted before node with index.
+        attr_accessor :insert_before_node
+	
+        #
+        # Initializes a new instance.
+        # @param name The document name.
+        # @param paragraph Paragraph 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.
+        # @param node_path Path to node which contains paragraphs.
+        # @param insert_before_node Paragraph will be inserted before node with index.
+        def initialize(name, paragraph, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil, node_path = nil, insert_before_node = nil)
+           self.name = name
+           self.paragraph = paragraph
+           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.node_path = node_path
+           self.insert_before_node = insert_before_node
+        end
+  end
+end

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

@@ -0,0 +1,69 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose" file="PutProtectDocumentRequest.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_protect_document operation.
+  #
+  class PutProtectDocumentRequest
+
+        # The document name.
+        attr_accessor :name
+        # with protection settings.            
+        attr_accessor :protection_request
+        # 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 protection_request with protection settings.            
+        # @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, 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/words_ruby_sdk/models/requests/PutRunRequest.rb

@@ -0,0 +1,85 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose" file="PutRunRequest.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_run operation.
+  #
+  class PutRunRequest
+
+        # The document name.
+        attr_accessor :name
+        # Path to parent paragraph.
+        attr_accessor :paragraph_path
+        # Run data.
+        attr_accessor :run
+        # 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
+        # Paragraph will be inserted before node with index.
+        attr_accessor :insert_before_node
+	
+        #
+        # Initializes a new instance.
+        # @param name The document name.
+        # @param paragraph_path Path to parent paragraph.
+        # @param run Run 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.
+        # @param insert_before_node Paragraph will be inserted before node with index.
+        def initialize(name, paragraph_path, run, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil, insert_before_node = nil)
+           self.name = name
+           self.paragraph_path = paragraph_path
+           self.run = run
+           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.insert_before_node = insert_before_node
+        end
+  end
+end

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

@@ -0,0 +1,65 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose" file="RejectAllRevisionsRequest.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 reject_all_revisions operation.
+  #
+  class RejectAllRevisionsRequest
+
+        # 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