aspose_words_cloud 20.6.0 → 20.7.0

data/lib/aspose_words_cloud/models/report_engine_settings.rb

@@ -1,47 +1,46 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="report_engine_settings.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>
+# ------------------------------------------------------------------------------------
 
 require 'date'
 
 module AsposeWordsCloud
- #
- # --------------------------------------------------------------------------------------------------------------------
- # <copyright company="Aspose" file="ReportEngineSettings.rb">
- #   Copyright (c) 2019 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>
- # --------------------------------------------------------------------------------------------------------------------
- #
 
   # Report engine settings.
   class ReportEngineSettings
+    # Gets or sets options for parsing CSV data.
+    attr_accessor :csv_data_load_options
+
+    # Gets or sets a name to reference the data source object in the template.
+    attr_accessor :data_source_name
+
     # Gets or sets type of datasource.
     attr_accessor :data_source_type
 
     # Gets or sets type of options to build report.
     attr_accessor :report_build_options
 
-    # Gets or sets a name to reference the data source object in the template.
-    attr_accessor :data_source_name
-
-    attr_accessor :csv_data_load_options
-
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -67,20 +66,20 @@ module AsposeWordsCloud
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'data_source_type' => :'DataSourceType',
-        :'report_build_options' => :'ReportBuildOptions',
+        :'csv_data_load_options' => :'CsvDataLoadOptions',
         :'data_source_name' => :'DataSourceName',
-        :'csv_data_load_options' => :'CsvDataLoadOptions'
+        :'data_source_type' => :'DataSourceType',
+        :'report_build_options' => :'ReportBuildOptions'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'data_source_type' => :'String',
-        :'report_build_options' => :'Array<ReportBuildOptions>',
+        :'csv_data_load_options' => :'CsvDataLoadOptions',
         :'data_source_name' => :'String',
-        :'csv_data_load_options' => :'CsvDataLoadOptions'
+        :'data_source_type' => :'String',
+        :'report_build_options' => :'Array<String>'
       }
     end
 
@@ -92,6 +91,14 @@ module AsposeWordsCloud
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.key?(:'CsvDataLoadOptions')
+        self.csv_data_load_options = attributes[:'CsvDataLoadOptions']
+      end
+
+      if attributes.key?(:'DataSourceName')
+        self.data_source_name = attributes[:'DataSourceName']
+      end
+
       if attributes.key?(:'DataSourceType')
         self.data_source_type = attributes[:'DataSourceType']
       end
@@ -101,15 +108,6 @@ module AsposeWordsCloud
           self.report_build_options = value
         end
       end
-
-      if attributes.key?(:'DataSourceName')
-        self.data_source_name = attributes[:'DataSourceName']
-      end
-
-      if attributes.key?(:'CsvDataLoadOptions')
-        self.csv_data_load_options = attributes[:'CsvDataLoadOptions']
-      end
-
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -124,6 +122,7 @@ module AsposeWordsCloud
     def valid?
       data_source_type_validator = EnumAttributeValidator.new('String', ["Xml", "Json", "Csv"])
       return false unless data_source_type_validator.valid?(@data_source_type)
+
       return true
     end
 
@@ -141,15 +140,16 @@ module AsposeWordsCloud
       end
     end
 
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
-          data_source_type == other.data_source_type &&
-          report_build_options == other.report_build_options &&
+          csv_data_load_options == other.csv_data_load_options &&
           data_source_name == other.data_source_name &&
-          csv_data_load_options == other.csv_data_load_options
+          data_source_type == other.data_source_type &&
+          report_build_options == other.report_build_options
     end
 
     # @see the `==` method
@@ -161,7 +161,7 @@ module AsposeWordsCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [data_source_type, report_build_options, data_source_name, csv_data_load_options].hash
+      [csv_data_load_options, data_source_name, data_source_type, report_build_options].hash
     end
 
     # Builds the object from hash
@@ -271,5 +271,4 @@ module AsposeWordsCloud
     end
 
   end
-
 end

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

@@ -0,0 +1,68 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="accept_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 accept_all_revisions operation.
+  #
+  class AcceptAllRevisionsRequest
+    # 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

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

@@ -0,0 +1,83 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="append_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 append_document operation.
+  #
+  class AppendDocumentRequest
+    # Original document name.
+    attr_accessor :name
+
+    # DocumentEntryList with a list of documents to append.
+    attr_accessor :document_list
+
+    # 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 Original document name.
+    # @param document_list DocumentEntryList with a list of documents to append.
+    # @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, document_list, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil)
+      self.name = name
+      self.document_list = document_list
+      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/apply_style_to_document_element_request.rb

@@ -0,0 +1,88 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="apply_style_to_document_element_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 apply_style_to_document_element operation.
+  #
+  class ApplyStyleToDocumentElementRequest
+    # The document name.
+    attr_accessor :name
+
+    # Style to apply.
+    attr_accessor :style_apply
+
+    # The path to the node that supports a style. Supported node types: ParagraphFormat, List, ListLevel, Table.
+    attr_accessor :styled_node_path
+
+    # 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 style_apply Style to apply.
+    # @param styled_node_path The path to the node that supports a style. Supported node types: ParagraphFormat, List, ListLevel, Table.
+    # @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, style_apply, styled_node_path, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil)
+      self.name = name
+      self.style_apply = style_apply
+      self.styled_node_path = styled_node_path
+      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/build_report_online_request.rb

@@ -0,0 +1,58 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="build_report_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 build_report_online operation.
+  #
+  class BuildReportOnlineRequest
+    # File with template.
+    attr_accessor :template
+
+    # A string providing a data to populate the specified template. The string must be of one of the following types: xml, json, csv.
+    attr_accessor :data
+
+    # An object providing a settings of report engine.
+    attr_accessor :report_engine_settings
+
+    # 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 A string providing a data to populate the specified template. The string must be of one of the following types: xml, json, csv.
+    # @param report_engine_settings An object providing a settings of report engine.
+    # @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, report_engine_settings, document_file_name = nil)
+      self.template = template
+      self.data = data
+      self.report_engine_settings = report_engine_settings
+      self.document_file_name = document_file_name
+    end
+  end
+end