Class: SyncteraRubySdk::ResponseLicense

Inherits:
Object
  • Object
show all
Defined in:
lib/synctera_ruby_sdk/models/response_license.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResponseLicense

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 148

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#business_id ⇒ Object

Unique ID for the business. Exactly one of ‘business_id` or `person_id` must be set.



19
20
21
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 19

def business_id
  @business_id
end

#creation_time ⇒ Object

The date and time the license resource was created.



22
23
24
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 22

def creation_time
  @creation_time
end

#customer_id ⇒ Object

Returns the value of attribute customer_id.



24
25
26
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 24

def customer_id
  @customer_id
end

#id ⇒ Object

License record unique id



27
28
29
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 27

def id
  @id
end

#last_updated_time ⇒ Object

The date and time the license resource was last updated.



30
31
32
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 30

def last_updated_time
  @last_updated_time
end

#last_verified_time ⇒ Object

Timestamp of the last time the license was verified



33
34
35
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 33

def last_verified_time
  @last_verified_time
end

#license_classification ⇒ Object

The classification of the license



36
37
38
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 36

def license_classification
  @license_classification
end

#license_expiration_date ⇒ Object

The date on which the license will expire



39
40
41
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 39

def license_expiration_date
  @license_expiration_date
end

#license_issuance_date ⇒ Object

The date on which the license was issued



42
43
44
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 42

def license_issuance_date
  @license_issuance_date
end

#license_number ⇒ Object

The entity’s license number



45
46
47
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 45

def license_number
  @license_number
end

#license_type ⇒ Object

Returns the value of attribute license_type.



47
48
49
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 47

def license_type
  @license_type
end

#license_type_description ⇒ Object

Free-form text describing the type of the license



50
51
52
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 50

def license_type_description
  @license_type_description
end

#licensee_address ⇒ Object

The address of the entity that holds the license as reported by the verifying vendor



53
54
55
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 53

def licensee_address
  @licensee_address
end

#licensee_name ⇒ Object

The name of the entity that holds the license that’s reported by the verifying vendor



56
57
58
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 56

def licensee_name
  @licensee_name
end

#licensing_authority ⇒ Object

The name of the licensing body that granted the license



59
60
61
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 59

def licensing_authority
  @licensing_authority
end

#status ⇒ Object

The status of the license



62
63
64
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 62

def status
  @status
end

#tenant ⇒ Object

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.



65
66
67
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 65

def tenant
  @tenant
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



113
114
115
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 113

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 90

def self.attribute_map
  {
    :'business_id' => :'business_id',
    :'creation_time' => :'creation_time',
    :'customer_id' => :'customer_id',
    :'id' => :'id',
    :'last_updated_time' => :'last_updated_time',
    :'last_verified_time' => :'last_verified_time',
    :'license_classification' => :'license_classification',
    :'license_expiration_date' => :'license_expiration_date',
    :'license_issuance_date' => :'license_issuance_date',
    :'license_number' => :'license_number',
    :'license_type' => :'license_type',
    :'license_type_description' => :'license_type_description',
    :'licensee_address' => :'licensee_address',
    :'licensee_name' => :'licensee_name',
    :'licensing_authority' => :'licensing_authority',
    :'status' => :'status',
    :'tenant' => :'tenant'
  }
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



360
361
362
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 360

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



141
142
143
144
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 141

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 118

def self.openapi_types
  {
    :'business_id' => :'String',
    :'creation_time' => :'Time',
    :'customer_id' => :'String',
    :'id' => :'String',
    :'last_updated_time' => :'Time',
    :'last_verified_time' => :'Time',
    :'license_classification' => :'String',
    :'license_expiration_date' => :'Date',
    :'license_issuance_date' => :'Date',
    :'license_number' => :'String',
    :'license_type' => :'LicenseType',
    :'license_type_description' => :'String',
    :'licensee_address' => :'String',
    :'licensee_name' => :'String',
    :'licensing_authority' => :'String',
    :'status' => :'String',
    :'tenant' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 323

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      business_id == o.business_id &&
      creation_time == o.creation_time &&
      customer_id == o.customer_id &&
      id == o.id &&
      last_updated_time == o.last_updated_time &&
      last_verified_time == o.last_verified_time &&
      license_classification == o.license_classification &&
      license_expiration_date == o.license_expiration_date &&
      license_issuance_date == o.license_issuance_date &&
      license_number == o.license_number &&
      license_type == o.license_type &&
      license_type_description == o.license_type_description &&
      licensee_address == o.licensee_address &&
      licensee_name == o.licensee_name &&
      licensing_authority == o.licensing_authority &&
      status == o.status &&
      tenant == o.tenant
end

#_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



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 391

def _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 = SyncteraRubySdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 462

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 367

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


347
348
349
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 347

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



353
354
355
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 353

def hash
  [business_id, creation_time, customer_id, id, last_updated_time, last_verified_time, license_classification, license_expiration_date, license_issuance_date, license_number, license_type, license_type_description, licensee_address, licensee_name, licensing_authority, status, tenant].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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 232

def list_invalid_properties
  invalid_properties = Array.new
  if @creation_time.nil?
    invalid_properties.push('invalid value for "creation_time", creation_time cannot be nil.')
  end

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

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

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

  if @license_number.to_s.length < 1
    invalid_properties.push('invalid value for "license_number", the character length must be great than or equal to 1.')
  end

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

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

  if @tenant.nil?
    invalid_properties.push('invalid value for "tenant", tenant 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



438
439
440
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 438

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



444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 444

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



432
433
434
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 432

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/synctera_ruby_sdk/models/response_license.rb', line 271

def valid?
  return false if @creation_time.nil?
  return false if @id.nil?
  return false if @last_updated_time.nil?
  license_classification_validator = EnumAttributeValidator.new('String', ["MEDICAL_CANNABIS", "RECREATIONAL_CANNABIS", "MEDICAL_AND_RECREATIONAL_CANNABIS"])
  return false unless license_classification_validator.valid?(@license_classification)
  return false if @license_number.nil?
  return false if @license_number.to_s.length < 1
  return false if @license_type.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["UNVERIFIED", "ACCEPTED", "REJECTED", "REVIEW"])
  return false unless status_validator.valid?(@status)
  return false if @tenant.nil?
  true
end