groupdocs_comparison_cloud 18.9

data/lib/groupdocs_comparison_cloud/models/comparison_request.rb

@@ -0,0 +1,240 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="comparison_request.rb">
+ #   Copyright (c) 2003-2018 Aspose Pty Ltd
+ # </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 GroupDocsComparisonCloud
+  # ComparisonRequest
+  class ComparisonRequest
+
+    # The source name
+    attr_accessor :source_file
+
+    # The files names
+    attr_accessor :target_files
+
+    # The settings
+    attr_accessor :settings
+
+    # The changes
+    attr_accessor :changes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'source_file' => :'SourceFile',
+        :'target_files' => :'TargetFiles',
+        :'settings' => :'Settings',
+        :'changes' => :'Changes'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'source_file' => :'ComparisonFileInfo',
+        :'target_files' => :'Array<ComparisonFileInfo>',
+        :'settings' => :'ComparisonRequestSettings',
+        :'changes' => :'Array<ComparisonChange>'
+      }
+    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?(:'sourceFile')
+        self.source_file = attributes[:'sourceFile']
+      end
+
+      if attributes.key?(:'targetFiles')
+        if (value = attributes[:'targetFiles']).is_a?(Array)
+          self.target_files = value
+        end
+      end
+
+      if attributes.key?(:'settings')
+        self.settings = attributes[:'settings']
+      end
+
+      if attributes.key?(:'changes')
+        if (value = attributes[:'changes']).is_a?(Array)
+          self.changes = value
+        end
+      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 &&
+          source_file == other.source_file &&
+          target_files == other.target_files &&
+          settings == other.settings &&
+          changes == other.changes
+    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
+      [source_file, target_files, settings, changes].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 = GroupDocsComparisonCloud.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/groupdocs_comparison_cloud/models/comparison_request_settings.rb

@@ -0,0 +1,378 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="comparison_request_settings.rb">
+ #   Copyright (c) 2003-2018 Aspose Pty Ltd
+ # </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 GroupDocsComparisonCloud
+  # ComparisonRequestSettings dto
+  class ComparisonRequestSettings
+
+    # The generate summary page
+    attr_accessor :generate_summary_page
+
+    # The show deleted content
+    attr_accessor :show_deleted_content
+
+    # The style change detection
+    attr_accessor :style_change_detection
+
+    # The inserted items style
+    attr_accessor :inserted_items_style
+
+    # The deleted items style
+    attr_accessor :deleted_items_style
+
+    # The style changed items style
+    attr_accessor :style_changed_items_style
+
+    # The words separator chars
+    attr_accessor :words_separator_chars
+
+    # The use frames for delete ins elements
+    attr_accessor :use_frames_for_del_ins_elements
+
+    # The detail level
+    attr_accessor :detail_level
+
+    # The calculate component coordinates
+    attr_accessor :calculate_component_coordinates
+
+    # The clone metadata
+    attr_accessor :clone_metadata
+
+    # The metadata
+    attr_accessor :meta_data
+
+    # The password save option
+    attr_accessor :password_save_option
+
+    # The password
+    attr_accessor :password
+
+    # The mark deleted inserted content deep
+    attr_accessor :mark_deleted_inserted_content_deep
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'generate_summary_page' => :'GenerateSummaryPage',
+        :'show_deleted_content' => :'ShowDeletedContent',
+        :'style_change_detection' => :'StyleChangeDetection',
+        :'inserted_items_style' => :'InsertedItemsStyle',
+        :'deleted_items_style' => :'DeletedItemsStyle',
+        :'style_changed_items_style' => :'StyleChangedItemsStyle',
+        :'words_separator_chars' => :'WordsSeparatorChars',
+        :'use_frames_for_del_ins_elements' => :'UseFramesForDelInsElements',
+        :'detail_level' => :'DetailLevel',
+        :'calculate_component_coordinates' => :'CalculateComponentCoordinates',
+        :'clone_metadata' => :'CloneMetadata',
+        :'meta_data' => :'MetaData',
+        :'password_save_option' => :'PasswordSaveOption',
+        :'password' => :'Password',
+        :'mark_deleted_inserted_content_deep' => :'MarkDeletedInsertedContentDeep'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'generate_summary_page' => :'BOOLEAN',
+        :'show_deleted_content' => :'BOOLEAN',
+        :'style_change_detection' => :'BOOLEAN',
+        :'inserted_items_style' => :'StyleSettingsValues',
+        :'deleted_items_style' => :'StyleSettingsValues',
+        :'style_changed_items_style' => :'StyleSettingsValues',
+        :'words_separator_chars' => :'Array<String>',
+        :'use_frames_for_del_ins_elements' => :'BOOLEAN',
+        :'detail_level' => :'String',
+        :'calculate_component_coordinates' => :'BOOLEAN',
+        :'clone_metadata' => :'String',
+        :'meta_data' => :'ComparisonMetadataValues',
+        :'password_save_option' => :'String',
+        :'password' => :'String',
+        :'mark_deleted_inserted_content_deep' => :'BOOLEAN'
+      }
+    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?(:'generateSummaryPage')
+        self.generate_summary_page = attributes[:'generateSummaryPage']
+      end
+
+      if attributes.key?(:'showDeletedContent')
+        self.show_deleted_content = attributes[:'showDeletedContent']
+      end
+
+      if attributes.key?(:'styleChangeDetection')
+        self.style_change_detection = attributes[:'styleChangeDetection']
+      end
+
+      if attributes.key?(:'insertedItemsStyle')
+        self.inserted_items_style = attributes[:'insertedItemsStyle']
+      end
+
+      if attributes.key?(:'deletedItemsStyle')
+        self.deleted_items_style = attributes[:'deletedItemsStyle']
+      end
+
+      if attributes.key?(:'styleChangedItemsStyle')
+        self.style_changed_items_style = attributes[:'styleChangedItemsStyle']
+      end
+
+      if attributes.key?(:'wordsSeparatorChars')
+        if (value = attributes[:'wordsSeparatorChars']).is_a?(Array)
+          self.words_separator_chars = value
+        end
+      end
+
+      if attributes.key?(:'useFramesForDelInsElements')
+        self.use_frames_for_del_ins_elements = attributes[:'useFramesForDelInsElements']
+      end
+
+      if attributes.key?(:'detailLevel')
+        self.detail_level = attributes[:'detailLevel']
+      end
+
+      if attributes.key?(:'calculateComponentCoordinates')
+        self.calculate_component_coordinates = attributes[:'calculateComponentCoordinates']
+      end
+
+      if attributes.key?(:'cloneMetadata')
+        self.clone_metadata = attributes[:'cloneMetadata']
+      end
+
+      if attributes.key?(:'metaData')
+        self.meta_data = attributes[:'metaData']
+      end
+
+      if attributes.key?(:'passwordSaveOption')
+        self.password_save_option = attributes[:'passwordSaveOption']
+      end
+
+      if attributes.key?(:'password')
+        self.password = attributes[:'password']
+      end
+
+      if attributes.key?(:'markDeletedInsertedContentDeep')
+        self.mark_deleted_inserted_content_deep = attributes[:'markDeletedInsertedContentDeep']
+      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 = []
+      if @generate_summary_page.nil?
+        invalid_properties.push("invalid value for 'generate_summary_page', generate_summary_page cannot be nil.")
+      end
+
+      if @show_deleted_content.nil?
+        invalid_properties.push("invalid value for 'show_deleted_content', show_deleted_content cannot be nil.")
+      end
+
+      if @style_change_detection.nil?
+        invalid_properties.push("invalid value for 'style_change_detection', style_change_detection cannot be nil.")
+      end
+
+      if @use_frames_for_del_ins_elements.nil?
+        invalid_properties.push("invalid value for 'use_frames_for_del_ins_elements', use_frames_for_del_ins_elements cannot be nil.")
+      end
+
+      if @calculate_component_coordinates.nil?
+        invalid_properties.push("invalid value for 'calculate_component_coordinates', calculate_component_coordinates cannot be nil.")
+      end
+
+      if @mark_deleted_inserted_content_deep.nil?
+        invalid_properties.push("invalid value for 'mark_deleted_inserted_content_deep', mark_deleted_inserted_content_deep cannot be nil.")
+      end
+
+      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 false if @generate_summary_page.nil?
+      return false if @show_deleted_content.nil?
+      return false if @style_change_detection.nil?
+      return false if @use_frames_for_del_ins_elements.nil?
+      return false if @calculate_component_coordinates.nil?
+      return false if @mark_deleted_inserted_content_deep.nil?
+      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 &&
+          generate_summary_page == other.generate_summary_page &&
+          show_deleted_content == other.show_deleted_content &&
+          style_change_detection == other.style_change_detection &&
+          inserted_items_style == other.inserted_items_style &&
+          deleted_items_style == other.deleted_items_style &&
+          style_changed_items_style == other.style_changed_items_style &&
+          words_separator_chars == other.words_separator_chars &&
+          use_frames_for_del_ins_elements == other.use_frames_for_del_ins_elements &&
+          detail_level == other.detail_level &&
+          calculate_component_coordinates == other.calculate_component_coordinates &&
+          clone_metadata == other.clone_metadata &&
+          meta_data == other.meta_data &&
+          password_save_option == other.password_save_option &&
+          password == other.password &&
+          mark_deleted_inserted_content_deep == other.mark_deleted_inserted_content_deep
+    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
+      [generate_summary_page, show_deleted_content, style_change_detection, inserted_items_style, deleted_items_style, style_changed_items_style, words_separator_chars, use_frames_for_del_ins_elements, detail_level, calculate_component_coordinates, clone_metadata, meta_data, password_save_option, password, mark_deleted_inserted_content_deep].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 = GroupDocsComparisonCloud.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