Class: Zernio::ListInboxConversations200ResponseDataInner

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

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_idObject

Returns the value of attribute account_id.



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

def 
  @account_id
end

#account_usernameObject

Returns the value of attribute account_username.



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

def 
  @account_username
end

#idObject

Opaque conversation identifier. Pass it back verbatim to any /v1/inbox/conversations/conversationId route; do not assume a fixed format.



19
20
21
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 19

def id
  @id
end

#instagram_profileObject

Returns the value of attribute instagram_profile.



51
52
53
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 51

def instagram_profile
  @instagram_profile
end

#last_messageObject

Returns the value of attribute last_message.



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

def last_message
  @last_message
end

#metadataObject

Returns the value of attribute metadata.



53
54
55
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 53

def 
  @metadata
end

#participant_idObject

Returns the value of attribute participant_id.



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

def participant_id
  @participant_id
end

#participant_nameObject

Returns the value of attribute participant_name.



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

def participant_name
  @participant_name
end

#participant_pictureObject

Returns the value of attribute participant_picture.



31
32
33
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 31

def participant_picture
  @participant_picture
end

#participant_verified_typeObject

X verified badge type. Only present for X conversations.



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

def participant_verified_type
  @participant_verified_type
end

#platformObject

Returns the value of attribute platform.



21
22
23
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 21

def platform
  @platform
end

#statusObject

Returns the value of attribute status.



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

def status
  @status
end

#thread_controlObject

WhatsApp only, present once Meta Business Agent has touched the thread. ai_agent: the agent answers and new inbound arrive flagged metadata.standby; app: you hold control; other: another partner app does. Change it with POST /v1/inbox/conversations/conversationId/thread-control.



46
47
48
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 46

def thread_control
  @thread_control
end

#unread_countObject

Number of unread messages



43
44
45
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 43

def unread_count
  @unread_count
end

#updated_timeObject

Returns the value of attribute updated_time.



38
39
40
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 38

def updated_time
  @updated_time
end

#urlObject

Direct link to open the conversation on the platform (if available)



49
50
51
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 49

def url
  @url
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



100
101
102
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 100

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 78

def self.attribute_map
  {
    :'id' => :'id',
    :'platform' => :'platform',
    :'account_id' => :'accountId',
    :'account_username' => :'accountUsername',
    :'participant_id' => :'participantId',
    :'participant_name' => :'participantName',
    :'participant_picture' => :'participantPicture',
    :'participant_verified_type' => :'participantVerifiedType',
    :'last_message' => :'lastMessage',
    :'updated_time' => :'updatedTime',
    :'status' => :'status',
    :'unread_count' => :'unreadCount',
    :'thread_control' => :'threadControl',
    :'url' => :'url',
    :'instagram_profile' => :'instagramProfile',
    :'metadata' => :'metadata'
  }
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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 311

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_nullableObject

List of attributes with nullable: true



132
133
134
135
136
137
138
139
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 132

def self.openapi_nullable
  Set.new([
    :'participant_picture',
    :'participant_verified_type',
    :'unread_count',
    :'url',
  ])
end

.openapi_typesObject

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 110

def self.openapi_types
  {
    :'id' => :'String',
    :'platform' => :'String',
    :'account_id' => :'String',
    :'account_username' => :'String',
    :'participant_id' => :'String',
    :'participant_name' => :'String',
    :'participant_picture' => :'String',
    :'participant_verified_type' => :'String',
    :'last_message' => :'String',
    :'updated_time' => :'Time',
    :'status' => :'String',
    :'unread_count' => :'Integer',
    :'thread_control' => :'String',
    :'url' => :'String',
    :'instagram_profile' => :'ListInboxConversations200ResponseDataInnerInstagramProfile',
    :'metadata' => :'ListInboxConversations200ResponseDataInnerMetadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 275

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      platform == o.platform &&
       == o. &&
       == o. &&
      participant_id == o.participant_id &&
      participant_name == o.participant_name &&
      participant_picture == o.participant_picture &&
      participant_verified_type == o.participant_verified_type &&
      last_message == o.last_message &&
      updated_time == o.updated_time &&
      status == o.status &&
      unread_count == o.unread_count &&
      thread_control == o.thread_control &&
      url == o.url &&
      instagram_profile == o.instagram_profile &&
       == o.
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


298
299
300
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 298

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



304
305
306
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 304

def hash
  [id, platform, , , participant_id, participant_name, participant_picture, participant_verified_type, last_message, updated_time, status, unread_count, thread_control, url, instagram_profile, ].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



224
225
226
227
228
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 224

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 333

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



232
233
234
235
236
237
238
239
240
241
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb', line 232

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  participant_verified_type_validator = EnumAttributeValidator.new('String', ["blue", "government", "business", "none"])
  return false unless participant_verified_type_validator.valid?(@participant_verified_type)
  status_validator = EnumAttributeValidator.new('String', ["active", "archived"])
  return false unless status_validator.valid?(@status)
  thread_control_validator = EnumAttributeValidator.new('String', ["app", "ai_agent", "other"])
  return false unless thread_control_validator.valid?(@thread_control)
  true
end