Class: TalonOne::MessageLogEntry

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/message_log_entry.rb

Overview

Message Log.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MessageLogEntry

Initializes the object

Parameters:

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

    Model attributes in the form of hash



113
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
 
# File 'lib/talon_one/models/message_log_entry.rb', line 113

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#application_id ⇒ Object

Identifier of the Application.



44
45
46
 
# File 'lib/talon_one/models/message_log_entry.rb', line 44

def application_id
  @application_id
end

#change_type ⇒ Object

Type of change that triggered the notification.



25
26
27
 
# File 'lib/talon_one/models/message_log_entry.rb', line 25

def change_type
  @change_type
end

#created_at ⇒ Object

Timestamp when the log entry was created.



38
39
40
 
# File 'lib/talon_one/models/message_log_entry.rb', line 38

def created_at
  @created_at
end

#entity_type ⇒ Object

The entity type the notification is related to.



41
42
43
 
# File 'lib/talon_one/models/message_log_entry.rb', line 41

def entity_type
  @entity_type
end

#id ⇒ Object

Unique identifier of the message.



19
20
21
 
# File 'lib/talon_one/models/message_log_entry.rb', line 19

def id
  @id
end

#loyalty_program_id ⇒ Object

Identifier of the loyalty program.



47
48
49
 
# File 'lib/talon_one/models/message_log_entry.rb', line 47

def loyalty_program_id
  @loyalty_program_id
end

#notification_id ⇒ Object

ID of the notification.



28
29
30
 
# File 'lib/talon_one/models/message_log_entry.rb', line 28

def notification_id
  @notification_id
end

#notification_name ⇒ Object

The name of the notification.



31
32
33
 
# File 'lib/talon_one/models/message_log_entry.rb', line 31

def notification_name
  @notification_name
end

#request ⇒ Object

Returns the value of attribute request.



33
34
35
 
# File 'lib/talon_one/models/message_log_entry.rb', line 33

def request
  @request
end

#response ⇒ Object

Returns the value of attribute response.



35
36
37
 
# File 'lib/talon_one/models/message_log_entry.rb', line 35

def response
  @response
end

#service ⇒ Object

Name of the service that generated the log entry.



22
23
24
 
# File 'lib/talon_one/models/message_log_entry.rb', line 22

def service
  @service
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'service' => :'service',
    :'change_type' => :'changeType',
    :'notification_id' => :'notificationId',
    :'notification_name' => :'notificationName',
    :'request' => :'request',
    :'response' => :'response',
    :'created_at' => :'createdAt',
    :'entity_type' => :'entityType',
    :'application_id' => :'applicationId',
    :'loyalty_program_id' => :'loyaltyProgramId'
  }
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



274
275
276
 
# File 'lib/talon_one/models/message_log_entry.rb', line 274

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



106
107
108
109
 
# File 'lib/talon_one/models/message_log_entry.rb', line 106

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

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/talon_one/models/message_log_entry.rb', line 89

def self.openapi_types
  {
    :'id' => :'String',
    :'service' => :'String',
    :'change_type' => :'String',
    :'notification_id' => :'Integer',
    :'notification_name' => :'String',
    :'request' => :'MessageLogRequest',
    :'response' => :'MessageLogResponse',
    :'created_at' => :'DateTime',
    :'entity_type' => :'String',
    :'application_id' => :'Integer',
    :'loyalty_program_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/talon_one/models/message_log_entry.rb', line 243

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      service == o.service &&
      change_type == o.change_type &&
      notification_id == o.notification_id &&
      notification_name == o.notification_name &&
      request == o.request &&
      response == o.response &&
      created_at == o.created_at &&
      entity_type == o.entity_type &&
      application_id == o.application_id &&
      loyalty_program_id == o.loyalty_program_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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/talon_one/models/message_log_entry.rb', line 302

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
    TalonOne.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



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/talon_one/models/message_log_entry.rb', line 371

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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/talon_one/models/message_log_entry.rb', line 281

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


261
262
263
 
# File 'lib/talon_one/models/message_log_entry.rb', line 261

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



267
268
269
 
# File 'lib/talon_one/models/message_log_entry.rb', line 267

def hash
  [id, service, change_type, notification_id, notification_name, request, response, created_at, entity_type, application_id, loyalty_program_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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/talon_one/models/message_log_entry.rb', line 173

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

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

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

  if !@application_id.nil? && @application_id < 1
    invalid_properties.push('invalid value for "application_id", must be greater than or equal to 1.')
  end

  if !@loyalty_program_id.nil? && @loyalty_program_id < 1
    invalid_properties.push('invalid value for "loyalty_program_id", must be greater than or equal to 1.')
  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



347
348
349
 
# File 'lib/talon_one/models/message_log_entry.rb', line 347

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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/talon_one/models/message_log_entry.rb', line 353

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



341
342
343
 
# File 'lib/talon_one/models/message_log_entry.rb', line 341

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



200
201
202
203
204
205
206
207
208
209
 
# File 'lib/talon_one/models/message_log_entry.rb', line 200

def valid?
  return false if @id.nil?
  return false if @service.nil?
  return false if @created_at.nil?
  entity_type_validator = EnumAttributeValidator.new('String', ["application", "loyalty_program"])
  return false unless entity_type_validator.valid?(@entity_type)
  return false if !@application_id.nil? && @application_id < 1
  return false if !@loyalty_program_id.nil? && @loyalty_program_id < 1
  true
end