Class: TrinsicApi::CreateMdlExchangeRequest

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

Overview

Request to create an mDL Exchange.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateMdlExchangeRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



114
115
116
117
118
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
 
# File 'lib/trinsic_api/models/create_mdl_exchange_request.rb', line 114

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::CreateMdlExchangeRequest` 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::CreateMdlExchangeRequest`. 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?(:'verification_profile_id')
    self.verification_profile_id = attributes[:'verification_profile_id']
  else
    self.verification_profile_id = nil
  end

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

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

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

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

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

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

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

Instance Attribute Details

#android_native_app_package_name ⇒ Object

If using the ‘NativeApp` exchange mechanism with the `google-wallet` provider, this is the package name of the Android App which will execute the mDL exchange. This should be set to the package name of your app. Present for ease of testing only. May be removed as this API is stabilized.



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

def android_native_app_package_name
  @android_native_app_package_name
end

#android_native_app_signing_certificate_fingerprint ⇒ Object

If using the ‘NativeApp` exchange mechanism with the `google-wallet` provider, this is the SHA-256 fingerprint of the signing certificate used to sign the Android App which will execute the mDL exchange. Present for ease of testing only. May be removed as this API is stabilized.



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

def android_native_app_signing_certificate_fingerprint
  @android_native_app_signing_certificate_fingerprint
end

#digital_credentials_api_host ⇒ Object

If using the ‘DigitalCredentialsApi` exchange mechanism, this is the hostname on which the Digital Credentials API will be called. For example, if the user is on the page `foo.example.com/verify-mdl`, the proper value to use is `foo.example.com`. Present for ease of testing only. May be removed as this API is stabilized.



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

def digital_credentials_api_host
  @digital_credentials_api_host
end

#document_type ⇒ Object

The document type to request from the wallet. Typically, this is one of the following values: - ‘org.iso.18013.5.1.mDL` (Mobile Driver’s License) - ‘com.google.wallet.idcard.1` (Google Wallet ID Pass)



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

def document_type
  @document_type
end

#exchange_mechanism ⇒ Object

The mechanism by which the mDL exchange will occur (web, native SDK, etc.)



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

def exchange_mechanism
  @exchange_mechanism
end

#name_spaces ⇒ Object

The namespaces and fields to request from the mDL. This is a nested map / dictionary. The outer dictionary’s keys are namespaces (e.g. "org.iso.18013.5.1"). The inner dictionary’s keys are field names within each namespace, with boolean values indicating whether the specified field will be retained post-verification.



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

def name_spaces
  @name_spaces
end

#provider ⇒ Object

The ID of the provider to use for this mDL exchange.



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

def provider
  @provider
end

#verification_profile_id ⇒ Object

The ID of the VerificationProfile to use for this mDL exchange.



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

def verification_profile_id
  @verification_profile_id
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/trinsic_api/models/create_mdl_exchange_request.rb', line 317

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = TrinsicApi.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



80
81
82
 
# File 'lib/trinsic_api/models/create_mdl_exchange_request.rb', line 80

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



85
86
87
 
# File 'lib/trinsic_api/models/create_mdl_exchange_request.rb', line 85

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/trinsic_api/models/create_mdl_exchange_request.rb', line 66

def self.attribute_map
  {
    :'verification_profile_id' => :'verificationProfileId',
    :'provider' => :'provider',
    :'exchange_mechanism' => :'exchangeMechanism',
    :'document_type' => :'documentType',
    :'name_spaces' => :'nameSpaces',
    :'digital_credentials_api_host' => :'digitalCredentialsApiHost',
    :'android_native_app_package_name' => :'androidNativeAppPackageName',
    :'android_native_app_signing_certificate_fingerprint' => :'androidNativeAppSigningCertificateFingerprint'
  }
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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/trinsic_api/models/create_mdl_exchange_request.rb', line 293

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



104
105
106
107
108
109
110
 
# File 'lib/trinsic_api/models/create_mdl_exchange_request.rb', line 104

def self.openapi_nullable
  Set.new([
    :'digital_credentials_api_host',
    :'android_native_app_package_name',
    :'android_native_app_signing_certificate_fingerprint'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/trinsic_api/models/create_mdl_exchange_request.rb', line 90

def self.openapi_types
  {
    :'verification_profile_id' => :'String',
    :'provider' => :'String',
    :'exchange_mechanism' => :'MdlExchangeMechanism',
    :'document_type' => :'String',
    :'name_spaces' => :'Hash<String, Hash<String, Boolean>>',
    :'digital_credentials_api_host' => :'String',
    :'android_native_app_package_name' => :'String',
    :'android_native_app_signing_certificate_fingerprint' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/trinsic_api/models/create_mdl_exchange_request.rb', line 265

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      verification_profile_id == o.verification_profile_id &&
      provider == o.provider &&
      exchange_mechanism == o.exchange_mechanism &&
      document_type == o.document_type &&
      name_spaces == o.name_spaces &&
      digital_credentials_api_host == o.digital_credentials_api_host &&
      android_native_app_package_name == o.android_native_app_package_name &&
      android_native_app_signing_certificate_fingerprint == o.android_native_app_signing_certificate_fingerprint
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/trinsic_api/models/create_mdl_exchange_request.rb', line 388

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


280
281
282
 
# File 'lib/trinsic_api/models/create_mdl_exchange_request.rb', line 280

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



286
287
288
 
# File 'lib/trinsic_api/models/create_mdl_exchange_request.rb', line 286

def hash
  [verification_profile_id, provider, exchange_mechanism, document_type, name_spaces, digital_credentials_api_host, android_native_app_package_name, android_native_app_signing_certificate_fingerprint].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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/trinsic_api/models/create_mdl_exchange_request.rb', line 175

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



364
365
366
 
# File 'lib/trinsic_api/models/create_mdl_exchange_request.rb', line 364

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/trinsic_api/models/create_mdl_exchange_request.rb', line 370

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



358
359
360
 
# File 'lib/trinsic_api/models/create_mdl_exchange_request.rb', line 358

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



203
204
205
206
207
208
209
210
211
 
# File 'lib/trinsic_api/models/create_mdl_exchange_request.rb', line 203

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @verification_profile_id.nil?
  return false if @provider.nil?
  return false if @exchange_mechanism.nil?
  return false if @document_type.nil?
  return false if @name_spaces.nil?
  true
end