aspose_words_cloud 20.4.0 → 20.9.0

data/lib/aspose_words_cloud/models/compare_options.rb

@@ -1,61 +1,66 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="compare_options.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="CompareOptions.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>
- # --------------------------------------------------------------------------------------------------------------------
- #
 
   # Container class for compare documents options.
   class CompareOptions
-    # Gets or sets a value indicating whether true indicates that documents comparison is case insensitive. By default comparison is case sensitive.             
+    # Gets or sets a value indicating whether true indicates that documents comparison is case insensitive. By default comparison is case sensitive.
     attr_accessor :ignore_case_changes
 
-    # Gets or sets a value indicating whether specifies whether to compare the differences in data contained in tables. By default tables are not ignored.             
-    attr_accessor :ignore_tables
+    # Gets or sets a value indicating whether specifies whether to compare differences in comments. By default comments are
+    # not ignored.
+    attr_accessor :ignore_comments
 
-    # Gets or sets a value indicating whether specifies whether to compare differences in fields. By default fields are not ignored.             
+    # Gets or sets a value indicating whether specifies whether to compare differences in fields. By default fields are not
+    # ignored.
     attr_accessor :ignore_fields
 
-    # Gets or sets a value indicating whether specifies whether to compare differences in footnotes and endnotes. By default footnotes are not ignored.             
+    # Gets or sets a value indicating whether specifies whether to compare differences in footnotes and endnotes. By default
+    # footnotes are not ignored.
     attr_accessor :ignore_footnotes
 
-    # Gets or sets a value indicating whether specifies whether to compare differences in comments. By default comments are not ignored.             
-    attr_accessor :ignore_comments
-
-    # Gets or sets a value indicating whether specifies whether to compare differences in the data contained within text boxes. By default textboxes are not ignored.             
-    attr_accessor :ignore_textboxes
-
-    # Gets or sets a value indicating whether true indicates that formatting is ignored. By default document formatting is not ignored.             
+    # Gets or sets a value indicating whether true indicates that formatting is ignored. By default document formatting is
+    # not ignored.
     attr_accessor :ignore_formatting
 
-    # Gets or sets a value indicating whether true indicates that headers and footers content is ignored. By default headers and footers are not ignored.             
+    # Gets or sets a value indicating whether true indicates that headers and footers content is ignored. By default headers
+    # and footers are not ignored.
     attr_accessor :ignore_headers_and_footers
 
-    # Gets or sets specifies which document shall be used as a target during comparison.             
+    # Gets or sets a value indicating whether specifies whether to compare the differences in data contained in tables. By
+    # default tables are not ignored.
+    attr_accessor :ignore_tables
+
+    # Gets or sets a value indicating whether specifies whether to compare differences in the data contained within text boxes.
+    # By default textboxes are not ignored.
+    attr_accessor :ignore_textboxes
+
+    # Gets or sets specifies which document shall be used as a target during comparison.
     attr_accessor :target
 
     class EnumAttributeValidator
@@ -84,13 +89,13 @@ module AsposeWordsCloud
     def self.attribute_map
       {
         :'ignore_case_changes' => :'IgnoreCaseChanges',
-        :'ignore_tables' => :'IgnoreTables',
+        :'ignore_comments' => :'IgnoreComments',
         :'ignore_fields' => :'IgnoreFields',
         :'ignore_footnotes' => :'IgnoreFootnotes',
-        :'ignore_comments' => :'IgnoreComments',
-        :'ignore_textboxes' => :'IgnoreTextboxes',
         :'ignore_formatting' => :'IgnoreFormatting',
         :'ignore_headers_and_footers' => :'IgnoreHeadersAndFooters',
+        :'ignore_tables' => :'IgnoreTables',
+        :'ignore_textboxes' => :'IgnoreTextboxes',
         :'target' => :'Target'
       }
     end
@@ -99,13 +104,13 @@ module AsposeWordsCloud
     def self.swagger_types
       {
         :'ignore_case_changes' => :'BOOLEAN',
-        :'ignore_tables' => :'BOOLEAN',
+        :'ignore_comments' => :'BOOLEAN',
         :'ignore_fields' => :'BOOLEAN',
         :'ignore_footnotes' => :'BOOLEAN',
-        :'ignore_comments' => :'BOOLEAN',
-        :'ignore_textboxes' => :'BOOLEAN',
         :'ignore_formatting' => :'BOOLEAN',
         :'ignore_headers_and_footers' => :'BOOLEAN',
+        :'ignore_tables' => :'BOOLEAN',
+        :'ignore_textboxes' => :'BOOLEAN',
         :'target' => :'String'
       }
     end
@@ -122,8 +127,8 @@ module AsposeWordsCloud
         self.ignore_case_changes = attributes[:'IgnoreCaseChanges']
       end
 
-      if attributes.key?(:'IgnoreTables')
-        self.ignore_tables = attributes[:'IgnoreTables']
+      if attributes.key?(:'IgnoreComments')
+        self.ignore_comments = attributes[:'IgnoreComments']
       end
 
       if attributes.key?(:'IgnoreFields')
@@ -134,14 +139,6 @@ module AsposeWordsCloud
         self.ignore_footnotes = attributes[:'IgnoreFootnotes']
       end
 
-      if attributes.key?(:'IgnoreComments')
-        self.ignore_comments = attributes[:'IgnoreComments']
-      end
-
-      if attributes.key?(:'IgnoreTextboxes')
-        self.ignore_textboxes = attributes[:'IgnoreTextboxes']
-      end
-
       if attributes.key?(:'IgnoreFormatting')
         self.ignore_formatting = attributes[:'IgnoreFormatting']
       end
@@ -150,10 +147,17 @@ module AsposeWordsCloud
         self.ignore_headers_and_footers = attributes[:'IgnoreHeadersAndFooters']
       end
 
+      if attributes.key?(:'IgnoreTables')
+        self.ignore_tables = attributes[:'IgnoreTables']
+      end
+
+      if attributes.key?(:'IgnoreTextboxes')
+        self.ignore_textboxes = attributes[:'IgnoreTextboxes']
+      end
+
       if attributes.key?(:'Target')
         self.target = attributes[:'Target']
       end
-
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -168,6 +172,7 @@ module AsposeWordsCloud
     def valid?
       target_validator = EnumAttributeValidator.new('String', ["Current", "New"])
       return false unless target_validator.valid?(@target)
+
       return true
     end
 
@@ -185,19 +190,20 @@ 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 &&
           ignore_case_changes == other.ignore_case_changes &&
-          ignore_tables == other.ignore_tables &&
+          ignore_comments == other.ignore_comments &&
           ignore_fields == other.ignore_fields &&
           ignore_footnotes == other.ignore_footnotes &&
-          ignore_comments == other.ignore_comments &&
-          ignore_textboxes == other.ignore_textboxes &&
           ignore_formatting == other.ignore_formatting &&
           ignore_headers_and_footers == other.ignore_headers_and_footers &&
+          ignore_tables == other.ignore_tables &&
+          ignore_textboxes == other.ignore_textboxes &&
           target == other.target
     end
 
@@ -210,7 +216,7 @@ module AsposeWordsCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [ignore_case_changes, ignore_tables, ignore_fields, ignore_footnotes, ignore_comments, ignore_textboxes, ignore_formatting, ignore_headers_and_footers, target].hash
+      [ignore_case_changes, ignore_comments, ignore_fields, ignore_footnotes, ignore_formatting, ignore_headers_and_footers, ignore_tables, ignore_textboxes, target].hash
     end
 
     # Builds the object from hash
@@ -320,5 +326,4 @@ module AsposeWordsCloud
     end
 
   end
-
 end

data/lib/aspose_words_cloud/models/csv_data_load_options.rb

@@ -0,0 +1,231 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="csv_data_load_options.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
+
+  # Represents options for parsing CSV data.
+  class CsvDataLoadOptions
+    # Gets or sets the character that is used to comment lines of CSV data.
+    attr_accessor :comment_char
+
+    # Gets or sets the character to be used as a column delimiter.
+    attr_accessor :delimiter
+
+    # Gets or sets a value indicating whether the first record of CSV data contains column names.
+    attr_accessor :has_headers
+
+    # Gets or sets the character that is used to quote field values.
+    attr_accessor :quote_char
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'comment_char' => :'CommentChar',
+        :'delimiter' => :'Delimiter',
+        :'has_headers' => :'HasHeaders',
+        :'quote_char' => :'QuoteChar'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'comment_char' => :'String',
+        :'delimiter' => :'String',
+        :'has_headers' => :'BOOLEAN',
+        :'quote_char' => :'String'
+      }
+    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?(:'CommentChar')
+        self.comment_char = attributes[:'CommentChar']
+      end
+
+      if attributes.key?(:'Delimiter')
+        self.delimiter = attributes[:'Delimiter']
+      end
+
+      if attributes.key?(:'HasHeaders')
+        self.has_headers = attributes[:'HasHeaders']
+      end
+
+      if attributes.key?(:'QuoteChar')
+        self.quote_char = attributes[:'QuoteChar']
+      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?
+      return true
+    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 &&
+          comment_char == other.comment_char &&
+          delimiter == other.delimiter &&
+          has_headers == other.has_headers &&
+          quote_char == other.quote_char
+    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
+      [comment_char, delimiter, has_headers, quote_char].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