Class: Yapstone::ConsentResource

Inherits:
Object
  • Object
show all
Defined in:
lib/yapstone-so/models/consent_resource.rb

Overview

Represents the consent resource.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConsentResource

Initializes the object

Parameters:

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

    Model attributes in the form of hash



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 61

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

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

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

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

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

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

Instance Attribute Details

#accepted ⇒ Object

Indicates the acceptance of the T&Cs.



27
28
29
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 27

def accepted
  @accepted
end

#device_fingerprint_id ⇒ Object

The device fingerprint identifier.



33
34
35
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 33

def device_fingerprint_id
  @device_fingerprint_id
end

#ip_address ⇒ Object

The ipAddress origin of the incoming call.



30
31
32
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 30

def ip_address
  @ip_address
end

#time_of_consent ⇒ Object

The timestamp in ISO 8601 format when the user consentted.



19
20
21
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 19

def time_of_consent
  @time_of_consent
end

#type ⇒ Object

Returns the value of attribute type.



21
22
23
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 21

def type
  @type
end

#version ⇒ Object

The version of the consent if there is one.



24
25
26
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 24

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 36

def self.attribute_map
  {
    :'time_of_consent' => :'timeOfConsent',
    :'type' => :'type',
    :'version' => :'version',
    :'accepted' => :'accepted',
    :'ip_address' => :'ipAddress',
    :'device_fingerprint_id' => :'deviceFingerprintId'
  }
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



165
166
167
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 165

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

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 48

def self.openapi_types
  {
    :'time_of_consent' => :'DateTime',
    :'type' => :'ConsentType',
    :'version' => :'Integer',
    :'accepted' => :'Boolean',
    :'ip_address' => :'String',
    :'device_fingerprint_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



139
140
141
142
143
144
145
146
147
148
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 139

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      time_of_consent == o.time_of_consent &&
      type == o.type &&
      version == o.version &&
      accepted == o.accepted &&
      ip_address == o.ip_address &&
      device_fingerprint_id == o.device_fingerprint_id
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



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/yapstone-so/models/consent_resource.rb', line 193

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
    Yapstone.const_get(type).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



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 258

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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 172

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


152
153
154
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 152

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



158
159
160
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 158

def hash
  [time_of_consent, type, version, accepted, ip_address, device_fingerprint_id].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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 101

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

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

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

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

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



238
239
240
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 238

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



244
245
246
247
248
249
250
251
252
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 244

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

Returns:

  • (String) —

    String presentation of the object



232
233
234
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 232

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



128
129
130
131
132
133
134
135
 
# File 'lib/yapstone-so/models/consent_resource.rb', line 128

def valid?
  return false if @type.nil?
  return false if @version.nil?
  return false if @accepted.nil?
  return false if @ip_address.nil?
  return false if @device_fingerprint_id.nil?
  true
end