Class: Zernio::InboxWebhookConversationDetail

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb

Overview

The conversation object included in conversation lifecycle webhook payloads (conversation.started, conversation.control_changed).

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 = {}) ⇒ InboxWebhookConversationDetail

Initializes the object

Parameters:

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

    Model attributes in the form of hash



111
112
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
170
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 111

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

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

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

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

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

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

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

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

Instance Attribute Details

#contact_id ⇒ Object

Zernio CRM Contact ID for the participant, when one exists. Resolved by joining participantId to the ContactChannel collection (same join used by message., reaction.received, and call. webhooks). Best-effort: omitted when no channel matches or participantId is absent. Lets integrators seed the CRM straight from conversation.started without waiting for the first message.* event.



39
40
41
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 39

def contact_id
  @contact_id
end

#id ⇒ Object

Internal conversation ID



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

def id
  @id
end

#participant_id ⇒ Object

Contact's platform identifier (IGSID, PSID, wa_id, etc.)



27
28
29
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 27

def participant_id
  @participant_id
end

#participant_name ⇒ Object

Returns the value of attribute participant_name.



29
30
31
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 29

def participant_name
  @participant_name
end

#participant_picture ⇒ Object

Returns the value of attribute participant_picture.



34
35
36
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 34

def participant_picture
  @participant_picture
end

#participant_username ⇒ Object

Contact's handle when the platform exposes one



32
33
34
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 32

def participant_username
  @participant_username
end

#platform ⇒ Object

Returns the value of attribute platform.



22
23
24
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 22

def platform
  @platform
end

#platform_conversation_id ⇒ Object

Returns the value of attribute platform_conversation_id.



24
25
26
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 24

def platform_conversation_id
  @platform_conversation_id
end

#status ⇒ Object

Returns the value of attribute status.



36
37
38
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 36

def status
  @status
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



79
80
81
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 79

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 84

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 64

def self.attribute_map
  {
    :'id' => :'id',
    :'platform' => :'platform',
    :'platform_conversation_id' => :'platformConversationId',
    :'participant_id' => :'participantId',
    :'participant_name' => :'participantName',
    :'participant_username' => :'participantUsername',
    :'participant_picture' => :'participantPicture',
    :'status' => :'status',
    :'contact_id' => :'contactId'
  }
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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 297

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



104
105
106
107
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 104

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
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 89

def self.openapi_types
  {
    :'id' => :'String',
    :'platform' => :'String',
    :'platform_conversation_id' => :'String',
    :'participant_id' => :'String',
    :'participant_name' => :'String',
    :'participant_username' => :'String',
    :'participant_picture' => :'String',
    :'status' => :'String',
    :'contact_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 268

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      platform == o.platform &&
      platform_conversation_id == o.platform_conversation_id &&
      participant_id == o.participant_id &&
      participant_name == o.participant_name &&
      participant_username == o.participant_username &&
      participant_picture == o.participant_picture &&
      status == o.status &&
      contact_id == o.contact_id
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


284
285
286
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 284

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



290
291
292
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 290

def hash
  [id, platform, platform_conversation_id, participant_id, participant_name, participant_username, participant_picture, status, contact_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



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
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 174

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 @platform.nil?
    invalid_properties.push('invalid value for "platform", platform cannot be nil.')
  end

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

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

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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 319

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



202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/zernio-sdk/models/inbox_webhook_conversation_detail.rb', line 202

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @platform.nil?
  platform_validator = EnumAttributeValidator.new('String', ["instagram", "facebook", "telegram", "whatsapp", "twitter", "reddit", "bluesky", "sms", "slack"])
  return false unless platform_validator.valid?(@platform)
  return false if @platform_conversation_id.nil?
  return false if @participant_name.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["active", "archived"])
  return false unless status_validator.valid?(@status)
  true
end