class DocuSign_eSign::AccessCodeFormat
Object
specifying the format of the string provided to a recipient in order to access an envelope.
Attributes
Metadata indicating whether the `formatRequired` property is editable.
Metadata indicating whether the `letterRequired` property is editable.
Metadata indicating whether the `minimumLength` property is editable.
Metadata indicating whether the `numberRequired` property is editable.
Metadata indicating whether the `specialCharacterRequired` property is editable.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/docusign_esign/models/access_code_format.rb, line 48 def self.attribute_map { :'format_required' => :'formatRequired', :'format_required_metadata' => :'formatRequiredMetadata', :'letter_required' => :'letterRequired', :'letter_required_metadata' => :'letterRequiredMetadata', :'minimum_length' => :'minimumLength', :'minimum_length_metadata' => :'minimumLengthMetadata', :'number_required' => :'numberRequired', :'number_required_metadata' => :'numberRequiredMetadata', :'special_character_required' => :'specialCharacterRequired', :'special_character_required_metadata' => :'specialCharacterRequiredMetadata' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/docusign_esign/models/access_code_format.rb, line 81 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.has_key?(:'formatRequired') self.format_required = attributes[:'formatRequired'] end if attributes.has_key?(:'formatRequiredMetadata') self.format_required_metadata = attributes[:'formatRequiredMetadata'] end if attributes.has_key?(:'letterRequired') self.letter_required = attributes[:'letterRequired'] end if attributes.has_key?(:'letterRequiredMetadata') self.letter_required_metadata = attributes[:'letterRequiredMetadata'] end if attributes.has_key?(:'minimumLength') self.minimum_length = attributes[:'minimumLength'] end if attributes.has_key?(:'minimumLengthMetadata') self.minimum_length_metadata = attributes[:'minimumLengthMetadata'] end if attributes.has_key?(:'numberRequired') self.number_required = attributes[:'numberRequired'] end if attributes.has_key?(:'numberRequiredMetadata') self.number_required_metadata = attributes[:'numberRequiredMetadata'] end if attributes.has_key?(:'specialCharacterRequired') self.special_character_required = attributes[:'specialCharacterRequired'] end if attributes.has_key?(:'specialCharacterRequiredMetadata') self.special_character_required_metadata = attributes[:'specialCharacterRequiredMetadata'] end end
Attribute type mapping.
# File lib/docusign_esign/models/access_code_format.rb, line 64 def self.swagger_types { :'format_required' => :'String', :'format_required_metadata' => :'SettingsMetadata', :'letter_required' => :'String', :'letter_required_metadata' => :'SettingsMetadata', :'minimum_length' => :'String', :'minimum_length_metadata' => :'SettingsMetadata', :'number_required' => :'String', :'number_required_metadata' => :'SettingsMetadata', :'special_character_required' => :'String', :'special_character_required_metadata' => :'SettingsMetadata' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/docusign_esign/models/access_code_format.rb, line 143 def ==(o) return true if self.equal?(o) self.class == o.class && format_required == o.format_required && format_required_metadata == o.format_required_metadata && letter_required == o.letter_required && letter_required_metadata == o.letter_required_metadata && minimum_length == o.minimum_length && minimum_length_metadata == o.minimum_length_metadata && number_required == o.number_required && number_required_metadata == o.number_required_metadata && special_character_required == o.special_character_required && special_character_required_metadata == o.special_character_required_metadata end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/docusign_esign/models/access_code_format.rb, line 194 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) 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 = DocuSign_eSign.const_get(type).new temp_model.build_from_hash(value) end 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
# File lib/docusign_esign/models/access_code_format.rb, line 260 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/docusign_esign/models/access_code_format.rb, line 173 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 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
@see the `==` method @param [Object] Object
to be compared
# File lib/docusign_esign/models/access_code_format.rb, line 160 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/docusign_esign/models/access_code_format.rb, line 166 def hash [format_required, format_required_metadata, letter_required, letter_required_metadata, minimum_length, minimum_length_metadata, number_required, number_required_metadata, special_character_required, special_character_required_metadata].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/docusign_esign/models/access_code_format.rb, line 130 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/docusign_esign/models/access_code_format.rb, line 246 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/docusign_esign/models/access_code_format.rb, line 234 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/docusign_esign/models/access_code_format.rb, line 137 def valid? true end