Class: SyncteraRubySdk::BaseDisclosure

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BaseDisclosure

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
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 119

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

  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?(:'disclosure_date')
    self.disclosure_date = attributes[:'disclosure_date']
  end

  if attributes.key?(:'event_type')
    self.event_type = attributes[:'event_type']
  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?(:'metadata')
    self.metadata = attributes[:'metadata']
  end

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

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

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

Instance Attribute Details

#acknowledging_person_id ⇒ Object

Unique ID for the person acknowledging the disclosure. Applicable for disclosures where the person acknowledging is different from the subject of the disclosure. Required for OWNER_CERTIFICATION disclosures.



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

def acknowledging_person_id
  @acknowledging_person_id
end

#business_id ⇒ Object

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



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

def business_id
  @business_id
end

#creation_time ⇒ Object

The date and time the resource was created.



25
26
27
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 25

def creation_time
  @creation_time
end

#disclosure_date ⇒ Object

Date and time the disclosure was made.



28
29
30
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 28

def disclosure_date
  @disclosure_date
end

#event_type ⇒ Object

Describes how the disclosure was shown and what the user did as a result. One of the following: * ‘DISPLAYED` — The document was made visible to the user, but they did not interact with it. * `VIEWED` — The document was made visible to the user, and they interacted enough to see the whole document (e.g. scrolled to the bottom). * `ACKNOWLEDGED` — The document was made visible to the user, and they took positive action to confirm that they have read and accepted the document.



31
32
33
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 31

def event_type
  @event_type
end

#id ⇒ Object

The unique identifier for this resource.



34
35
36
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 34

def id
  @id
end

#last_updated_time ⇒ Object

The date and time the resource was last updated.



37
38
39
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 37

def last_updated_time
  @last_updated_time
end

#metadata ⇒ Object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.



40
41
42
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 40

def metadata
  @metadata
end

#person_id ⇒ Object

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



43
44
45
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 43

def person_id
  @person_id
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#version ⇒ Object

Version of the disclosure document.



48
49
50
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 48

def version
  @version
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 73

def self.attribute_map
  {
    :'acknowledging_person_id' => :'acknowledging_person_id',
    :'business_id' => :'business_id',
    :'creation_time' => :'creation_time',
    :'disclosure_date' => :'disclosure_date',
    :'event_type' => :'event_type',
    :'id' => :'id',
    :'last_updated_time' => :'last_updated_time',
    :'metadata' => :'metadata',
    :'person_id' => :'person_id',
    :'type' => :'type',
    :'version' => :'version'
  }
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



252
253
254
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 252

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 95

def self.openapi_types
  {
    :'acknowledging_person_id' => :'String',
    :'business_id' => :'String',
    :'creation_time' => :'Time',
    :'disclosure_date' => :'Time',
    :'event_type' => :'String',
    :'id' => :'String',
    :'last_updated_time' => :'Time',
    :'metadata' => :'Object',
    :'person_id' => :'String',
    :'type' => :'DisclosureType',
    :'version' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 221

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      acknowledging_person_id == o.acknowledging_person_id &&
      business_id == o.business_id &&
      creation_time == o.creation_time &&
      disclosure_date == o.disclosure_date &&
      event_type == o.event_type &&
      id == o.id &&
      last_updated_time == o.last_updated_time &&
      metadata == o.metadata &&
      person_id == o.person_id &&
      type == o.type &&
      version == o.version
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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 283

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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 354

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 259

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


239
240
241
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



245
246
247
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 245

def hash
  [acknowledging_person_id, business_id, creation_time, disclosure_date, event_type, id, last_updated_time, metadata, person_id, type, version].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



179
180
181
182
183
184
185
186
187
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 179

def list_invalid_properties
  invalid_properties = Array.new
  pattern = Regexp.new(/^v?[0-9]+\.[0-9]+$/)
  if !@version.nil? && @version !~ pattern
    invalid_properties.push("invalid value for \"version\", must conform to the pattern #{pattern}.")
  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



330
331
332
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 330

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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 336

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



324
325
326
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 324

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



191
192
193
194
195
196
 
# File 'lib/synctera_ruby_sdk/models/base_disclosure.rb', line 191

def valid?
  event_type_validator = EnumAttributeValidator.new('String', ["DISPLAYED", "VIEWED", "ACKNOWLEDGED"])
  return false unless event_type_validator.valid?(@event_type)
  return false if !@version.nil? && @version !~ Regexp.new(/^v?[0-9]+\.[0-9]+$/)
  true
end