Class: Zernio::InboxWebhookMessage

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/inbox_webhook_message.rb

Overview

The message object included in inbox webhook payloads.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ InboxWebhookMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 117

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attachments ⇒ Object

Returns the value of attribute attachments.



35
36
37
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 35

def attachments
  @attachments
end

#conversation_id ⇒ Object

Internal conversation ID



23
24
25
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 23

def conversation_id
  @conversation_id
end

#direction ⇒ Object

Returns the value of attribute direction.



30
31
32
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 30

def direction
  @direction
end

#id ⇒ Object

Internal message ID



20
21
22
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 20

def id
  @id
end

#is_read ⇒ Object

Returns the value of attribute is_read.



42
43
44
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 42

def is_read
  @is_read
end

#platform ⇒ Object

Returns the value of attribute platform.



25
26
27
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 25

def platform
  @platform
end

#platform_message_id ⇒ Object

Platform's message ID



28
29
30
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 28

def platform_message_id
  @platform_message_id
end

#sender ⇒ Object

Returns the value of attribute sender.



37
38
39
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 37

def sender
  @sender
end

#sent_at ⇒ Object

When the message was sent, as reported by the platform and passed through unmodified. Full ISO 8601 date-time: Instagram and Facebook carry millisecond precision, while some platforms (for example WhatsApp and Telegram) report whole seconds. Use this field as the chronological ordering key. If two messages share the same value, fetch the conversation messages with sortOrder=desc for the deterministic order.



40
41
42
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 40

def sent_at
  @sent_at
end

#text ⇒ Object

Message text content (retained on deleted messages for API consumers; Zernio dashboard UI hides this)



33
34
35
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 33

def text
  @text
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



83
84
85
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 83

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



88
89
90
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 88

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 67

def self.attribute_map
  {
    :'id' => :'id',
    :'conversation_id' => :'conversationId',
    :'platform' => :'platform',
    :'platform_message_id' => :'platformMessageId',
    :'direction' => :'direction',
    :'text' => :'text',
    :'attachments' => :'attachments',
    :'sender' => :'sender',
    :'sent_at' => :'sentAt',
    :'is_read' => :'isRead'
  }
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



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 380

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



109
110
111
112
113
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 109

def self.openapi_nullable
  Set.new([
    :'text',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 93

def self.openapi_types
  {
    :'id' => :'String',
    :'conversation_id' => :'String',
    :'platform' => :'String',
    :'platform_message_id' => :'String',
    :'direction' => :'String',
    :'text' => :'String',
    :'attachments' => :'Array<InboxWebhookMessageAttachmentsInner>',
    :'sender' => :'InboxWebhookMessageSender',
    :'sent_at' => :'Time',
    :'is_read' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 350

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      conversation_id == o.conversation_id &&
      platform == o.platform &&
      platform_message_id == o.platform_message_id &&
      direction == o.direction &&
      text == o.text &&
      attachments == o.attachments &&
      sender == o.sender &&
      sent_at == o.sent_at &&
      is_read == o.is_read
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


367
368
369
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 367

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



373
374
375
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 373

def hash
  [id, conversation_id, platform, platform_message_id, direction, text, attachments, sender, sent_at, is_read].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



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
229
230
231
232
233
234
235
236
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 196

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

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 402

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/zernio-sdk/models/inbox_webhook_message.rb', line 240

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @conversation_id.nil?
  return false if @platform.nil?
  platform_validator = EnumAttributeValidator.new('String', ["instagram", "facebook", "telegram", "whatsapp", "sms"])
  return false unless platform_validator.valid?(@platform)
  return false if @platform_message_id.nil?
  return false if @direction.nil?
  direction_validator = EnumAttributeValidator.new('String', ["incoming", "outgoing"])
  return false unless direction_validator.valid?(@direction)
  return false if @attachments.nil?
  return false if @sender.nil?
  return false if @sent_at.nil?
  return false if @is_read.nil?
  true
end