aspose_words_cloud 19.12.0 → 20.6.0

data/lib/aspose_words_cloud/models/report_build_options.rb

@@ -0,0 +1,26 @@
+
+require 'date'
+
+module AsposeWordsCloud
+
+  class ReportBuildOptions
+    
+    NONE = "None".freeze
+    
+    ALLOWMISSINGMEMBERS = "AllowMissingMembers".freeze
+    
+    REMOVEEMPTYPARAGRAPHS = "RemoveEmptyParagraphs".freeze
+    
+    INLINEERRORMESSAGES = "InlineErrorMessages".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = ReportBuildOptions.constants.select{|c| ReportBuildOptions::const_get(c) == value}
+      raise "Invalid ENUM value #{value} for class #ReportBuildOptions" if constantValues.empty?
+      value
+    end
+  end
+
+end

data/lib/aspose_words_cloud/models/report_engine_settings.rb

@@ -0,0 +1,275 @@
+
+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 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
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data_source_type' => :'DataSourceType',
+        :'report_build_options' => :'ReportBuildOptions',
+        :'data_source_name' => :'DataSourceName',
+        :'csv_data_load_options' => :'CsvDataLoadOptions'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'data_source_type' => :'String',
+        :'report_build_options' => :'Array<ReportBuildOptions>',
+        :'data_source_name' => :'String',
+        :'csv_data_load_options' => :'CsvDataLoadOptions'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.key?(:'DataSourceType')
+        self.data_source_type = attributes[:'DataSourceType']
+      end
+
+      if attributes.key?(:'ReportBuildOptions')
+        if (value = attributes[:'ReportBuildOptions']).is_a?(Array)
+          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?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = []
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    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
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] data_source_type Object to be assigned
+    def data_source_type=(data_source_type)
+      validator = EnumAttributeValidator.new('String', ["Xml", "Json", "Csv"])
+      if data_source_type.to_i == 0
+        unless validator.valid?(data_source_type)
+          raise ArgumentError, "invalid value for 'data_source_type', must be one of #{validator.allowable_values}."
+        end
+        @data_source_type = data_source_type
+      else
+        @data_source_type = validator.allowable_values[data_source_type.to_i]
+      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 &&
+          data_source_name == other.data_source_name &&
+          csv_data_load_options == other.csv_data_load_options
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # 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
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+        # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        Time.at(/\d/.match(value)[0].to_f).to_datetime
+      when :Date
+        Time.at(/\d/.match(value)[0].to_f).to_date
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else
+      # model
+        temp_model = AsposeWordsCloud.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

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

@@ -1,65 +1,65 @@
- #
- # --------------------------------------------------------------------------------------------------------------------
- # <copyright company="Aspose" file="AcceptAllRevisionsRequest.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>
- # --------------------------------------------------------------------------------------------------------------------
- #
-
-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
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose" file="AcceptAllRevisionsRequest.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>
+ # --------------------------------------------------------------------------------------------------------------------
+ #
+
+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/AppendDocumentRequest.rb

@@ -1,77 +1,77 @@
- #
- # --------------------------------------------------------------------------------------------------------------------
- # <copyright company="Aspose" file="AppendDocumentRequest.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>
- # --------------------------------------------------------------------------------------------------------------------
- #
-
-module AsposeWordsCloud
-
-  #
-  # Request model for append_document operation.
-  #
-  class AppendDocumentRequest
-
-        # Original document name.
-        attr_accessor :name
-        # 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 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
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose" file="AppendDocumentRequest.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>
+ # --------------------------------------------------------------------------------------------------------------------
+ #
+
+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