Class: TrinsicApi::SignzyIndiaAadhaarFetchProviderOutput

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb

Overview

Exposed properties for the ‘india-digilocker-aadhaar-fetch` Provider which do not directly map to the normalized IdentityData model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ SignzyIndiaAadhaarFetchProviderOutput

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



119
120
121
122
123
124
125
126
127
128
129
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 119

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::SignzyIndiaAadhaarFetchProviderOutput` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::SignzyIndiaAadhaarFetchProviderOutput`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'document_type')
    self.document_type = attributes[:'document_type']
  end

  if attributes.key?(:'timestamp')
    self.timestamp = attributes[:'timestamp']
  end

  if attributes.key?(:'time_to_live')
    self.time_to_live = attributes[:'time_to_live']
  end

  if attributes.key?(:'aadhaar_number_last_four')
    self.aadhaar_number_last_four = attributes[:'aadhaar_number_last_four']
  end

  if attributes.key?(:'claims')
    self.claims = attributes[:'claims']
  end

  if attributes.key?(:'localized_claims')
    self.localized_claims = attributes[:'localized_claims']
  end

  if attributes.key?(:'document_signature_validated')
    self.document_signature_validated = attributes[:'document_signature_validated']
  else
    self.document_signature_validated = nil
  end

  if attributes.key?(:'digilocker_id')
    self.digilocker_id = attributes[:'digilocker_id']
  end

  if attributes.key?(:'issuer_id')
    self.issuer_id = attributes[:'issuer_id']
  end

  if attributes.key?(:'issuer')
    self.issuer = attributes[:'issuer']
  end

  if attributes.key?(:'mobile_phone')
    self.mobile_phone = attributes[:'mobile_phone']
  end

  if attributes.key?(:'scope')
    if (value = attributes[:'scope']).is_a?(Array)
      self.scope = value
    end
  else
    self.scope = nil
  end
end

Instance Attribute Details

#aadhaar_number_last_four ⇒ Object

The Aadhaar number (UID) value for the individual. This is only the last four digits of the Aadhaar number.



29
30
31
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 29

def aadhaar_number_last_four
  @aadhaar_number_last_four
end

#claims ⇒ Object

The claims extracted from the Aadhaar document.



32
33
34
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 32

def claims
  @claims
end

#digilocker_id ⇒ Object

DigiLocker’s 36-character stable account identifier. This identifier is deemed safe to use to reference the individual. *Note, the format is not guaranteed to be a UUID.



41
42
43
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 41

def digilocker_id
  @digilocker_id
end

#document_signature_validated ⇒ Object

Whether our own validation of the Aadhaar document signature and certificate chain succeeded. When the signed document (e.g. Digilocker XML) is available, we validate it using the standard CCA/SafeScrypt chain. When the document is not returned, the signature cannot be validated and this is false. Some providers (e.g. Signzy) also supply a separate DSC validation indicator in the webhook payload; that is independent of this flag, which reflects only our validation.



38
39
40
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 38

def document_signature_validated
  @document_signature_validated
end

#document_type ⇒ Object

The document type from which the identity data was retrieved.



20
21
22
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 20

def document_type
  @document_type
end

#issuer ⇒ Object

Issuer name for the DigiLocker document.



47
48
49
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 47

def issuer
  @issuer
end

#issuer_id ⇒ Object

The identifier for the issuer of the DigiLocker document.



44
45
46
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 44

def issuer_id
  @issuer_id
end

#localized_claims ⇒ Object

The localized claims extracted from the Aadhaar document.



35
36
37
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 35

def localized_claims
  @localized_claims
end

#mobile_phone ⇒ Object

The individual’s mobile phone number from DigiLocker’s account details.



50
51
52
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 50

def mobile_phone
  @mobile_phone
end

#scope ⇒ Object

DigiLocker consent scopes that the individual actually consented to for this session. Included in provider output so customers can verify what was granted: the customer does not control these—the individual chooses scopes in the DigiLocker consent UI, and there is no way to pre-select or enforce them. This is a common source of error (e.g. the individual skips a scope), so surfacing the granted scopes lets customers confirm the session had the expected consent.



53
54
55
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 53

def scope
  @scope
end

#time_to_live ⇒ Object

The validity expiration timestamp for the verification document.



26
27
28
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 26

def time_to_live
  @time_to_live
end

#timestamp ⇒ Object

The timestamp when the signed document was generated and verified.



23
24
25
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 23

def timestamp
  @timestamp
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



74
75
76
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 74

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 79

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 56

def self.attribute_map
  {
    :'document_type' => :'documentType',
    :'timestamp' => :'timestamp',
    :'time_to_live' => :'timeToLive',
    :'aadhaar_number_last_four' => :'aadhaarNumberLastFour',
    :'claims' => :'claims',
    :'localized_claims' => :'localizedClaims',
    :'document_signature_validated' => :'documentSignatureValidated',
    :'digilocker_id' => :'digilockerId',
    :'issuer_id' => :'issuerId',
    :'issuer' => :'issuer',
    :'mobile_phone' => :'mobilePhone',
    :'scope' => :'scope'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 267

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 102

def self.openapi_nullable
  Set.new([
    :'document_type',
    :'timestamp',
    :'time_to_live',
    :'aadhaar_number_last_four',
    :'claims',
    :'localized_claims',
    :'digilocker_id',
    :'issuer_id',
    :'issuer',
    :'mobile_phone',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 84

def self.openapi_types
  {
    :'document_type' => :'String',
    :'timestamp' => :'Time',
    :'time_to_live' => :'Time',
    :'aadhaar_number_last_four' => :'String',
    :'claims' => :'AadhaarClaims',
    :'localized_claims' => :'AadhaarLocalizedClaims',
    :'document_signature_validated' => :'Boolean',
    :'digilocker_id' => :'String',
    :'issuer_id' => :'String',
    :'issuer' => :'String',
    :'mobile_phone' => :'String',
    :'scope' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 235

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      document_type == o.document_type &&
      timestamp == o.timestamp &&
      time_to_live == o.time_to_live &&
      aadhaar_number_last_four == o.aadhaar_number_last_four &&
      claims == o.claims &&
      localized_claims == o.localized_claims &&
      document_signature_validated == o.document_signature_validated &&
      digilocker_id == o.digilocker_id &&
      issuer_id == o.issuer_id &&
      issuer == o.issuer &&
      mobile_phone == o.mobile_phone &&
      scope == o.scope
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


254
255
256
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



260
261
262
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 260

def hash
  [document_type, timestamp, time_to_live, aadhaar_number_last_four, claims, localized_claims, document_signature_validated, digilocker_id, issuer_id, issuer, mobile_phone, scope].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 190

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @document_signature_validated.nil?
    invalid_properties.push('invalid value for "document_signature_validated", document_signature_validated cannot be nil.')
  end

  if @scope.nil?
    invalid_properties.push('invalid value for "scope", scope cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 289

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



206
207
208
209
210
211
 
# File 'lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb', line 206

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @document_signature_validated.nil?
  return false if @scope.nil?
  true
end