# ------------------------------------------------------------------------------------ # # Copyright (c) 2024 Aspose.Words for Cloud # # # 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. # # ------------------------------------------------------------------------------------ require 'date' module AsposeWordsCloud # Represents a document which will be appended to the original resource document. class DocumentEntry # Gets or sets the file reference. attr_accessor :file_reference # Gets or sets document password encrypted on API public key. The default value is null (the document has no password). attr_accessor :encrypted_password # Gets or sets the option that controls formatting will be used: appended or destination document. Can be KeepSourceFormatting or UseDestinationStyles. attr_accessor :import_format_mode 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 { :'file_reference' => :'FileReference', :'encrypted_password' => :'EncryptedPassword', :'import_format_mode' => :'ImportFormatMode' } end # Attribute type mapping. def self.swagger_types { :'file_reference' => :'FileReference', :'encrypted_password' => :'String', :'import_format_mode' => :'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?(:'FileReference') self.file_reference = attributes[:'FileReference'] end if attributes.key?(:'EncryptedPassword') self.encrypted_password = attributes[:'EncryptedPassword'] end if attributes.key?(:'ImportFormatMode') self.import_format_mode = attributes[:'ImportFormatMode'] end end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? import_format_mode_validator = EnumAttributeValidator.new('String', ["UseDestinationStyles", "KeepSourceFormatting", "KeepDifferentStyles"]) return false unless import_format_mode_validator.valid?(@import_format_mode) return true end # Custom attribute writer method checking allowed values (enum). # @param [Object] import_format_mode Object to be assigned def import_format_mode=(import_format_mode) validator = EnumAttributeValidator.new('String', ["UseDestinationStyles", "KeepSourceFormatting", "KeepDifferentStyles"]) if import_format_mode.to_i == 0 unless validator.valid?(import_format_mode) raise ArgumentError, "invalid value for 'import_format_mode', must be one of #{validator.allowable_values}." end @import_format_mode = import_format_mode else @import_format_mode = validator.allowable_values[import_format_mode.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 && file_reference == other.file_reference && encrypted_password == other.encrypted_password && import_format_mode == other.import_format_mode 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 [file_reference, encrypted_password, import_format_mode].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<(?.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?.+?), (?.+)>\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 if value[:'$type'] type = value[:'$type'][0..-4] end 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 def collectFilesContent(resultFilesContent) if self.file_reference self.file_reference.collectFilesContent(resultFilesContent) end end def validate() raise ArgumentError, 'Property file_reference in DocumentEntry is required.' if self.file_reference.nil? raise ArgumentError, 'Property import_format_mode in DocumentEntry is required.' if self.import_format_mode.nil? unless self.file_reference.nil? self.file_reference.validate end end end end