Class: DocuSign_eSign::IdCheckInformationInput
- Inherits:
-
Object
- Object
- DocuSign_eSign::IdCheckInformationInput
- Defined in:
- lib/docusign_esign/models/id_check_information_input.rb
Overview
A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: * dateOfBirth: Specifies the recipient’s date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient’s SSN information and consists of: * ssn4: Specifies the last four digits of the recipient’s SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient’s SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: * ssn9: Specifies the recipient’s SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
Instance Attribute Summary collapse
-
#address_information_input ⇒ Object
Returns the value of attribute address_information_input.
-
#dob_information_input ⇒ Object
Returns the value of attribute dob_information_input.
-
#ssn4_information_input ⇒ Object
Returns the value of attribute ssn4_information_input.
-
#ssn9_information_input ⇒ Object
Returns the value of attribute ssn9_information_input.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ IdCheckInformationInput
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ IdCheckInformationInput
Initializes the object
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/docusign_esign/models/id_check_information_input.rb', line 47 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?(:'addressInformationInput') self.address_information_input = attributes[:'addressInformationInput'] end if attributes.has_key?(:'dobInformationInput') self.dob_information_input = attributes[:'dobInformationInput'] end if attributes.has_key?(:'ssn4InformationInput') self.ssn4_information_input = attributes[:'ssn4InformationInput'] end if attributes.has_key?(:'ssn9InformationInput') self.ssn9_information_input = attributes[:'ssn9InformationInput'] end end |
Instance Attribute Details
#address_information_input ⇒ Object
Returns the value of attribute address_information_input.
17 18 19 |
# File 'lib/docusign_esign/models/id_check_information_input.rb', line 17 def address_information_input @address_information_input end |
#dob_information_input ⇒ Object
Returns the value of attribute dob_information_input.
19 20 21 |
# File 'lib/docusign_esign/models/id_check_information_input.rb', line 19 def dob_information_input @dob_information_input end |
#ssn4_information_input ⇒ Object
Returns the value of attribute ssn4_information_input.
21 22 23 |
# File 'lib/docusign_esign/models/id_check_information_input.rb', line 21 def ssn4_information_input @ssn4_information_input end |
#ssn9_information_input ⇒ Object
Returns the value of attribute ssn9_information_input.
23 24 25 |
# File 'lib/docusign_esign/models/id_check_information_input.rb', line 23 def ssn9_information_input @ssn9_information_input end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
26 27 28 29 30 31 32 33 |
# File 'lib/docusign_esign/models/id_check_information_input.rb', line 26 def self.attribute_map { :'address_information_input' => :'addressInformationInput', :'dob_information_input' => :'dobInformationInput', :'ssn4_information_input' => :'ssn4InformationInput', :'ssn9_information_input' => :'ssn9InformationInput' } end |
.swagger_types ⇒ Object
Attribute type mapping.
36 37 38 39 40 41 42 43 |
# File 'lib/docusign_esign/models/id_check_information_input.rb', line 36 def self.swagger_types { :'address_information_input' => :'AddressInformationInput', :'dob_information_input' => :'DobInformationInput', :'ssn4_information_input' => :'Ssn4InformationInput', :'ssn9_information_input' => :'Ssn9InformationInput' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
85 86 87 88 89 90 91 92 |
# File 'lib/docusign_esign/models/id_check_information_input.rb', line 85 def ==(o) return true if self.equal?(o) self.class == o.class && address_information_input == o.address_information_input && dob_information_input == o.dob_information_input && ssn4_information_input == o.ssn4_information_input && ssn9_information_input == o.ssn9_information_input end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/docusign_esign/models/id_check_information_input.rb', line 130 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 |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
196 197 198 199 200 201 202 203 204 205 206 207 208 |
# File 'lib/docusign_esign/models/id_check_information_input.rb', line 196 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/docusign_esign/models/id_check_information_input.rb', line 109 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 |
#eql?(o) ⇒ Boolean
96 97 98 |
# File 'lib/docusign_esign/models/id_check_information_input.rb', line 96 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
102 103 104 |
# File 'lib/docusign_esign/models/id_check_information_input.rb', line 102 def hash [address_information_input, dob_information_input, ssn4_information_input, ssn9_information_input].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
72 73 74 75 |
# File 'lib/docusign_esign/models/id_check_information_input.rb', line 72 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
176 177 178 |
# File 'lib/docusign_esign/models/id_check_information_input.rb', line 176 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
182 183 184 185 186 187 188 189 190 |
# File 'lib/docusign_esign/models/id_check_information_input.rb', line 182 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 |
#to_s ⇒ String
Returns the string representation of the object
170 171 172 |
# File 'lib/docusign_esign/models/id_check_information_input.rb', line 170 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
79 80 81 |
# File 'lib/docusign_esign/models/id_check_information_input.rb', line 79 def valid? true end |