Class: Zernio::WebhookPayloadMessageSentMetadata

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

Overview

Platform-specific context for the sent message: a quote-reply reference, a WhatsApp location pin, WhatsApp contact cards, the TikTok message type, or outgoing Instagram/Facebook buttons, quick replies and template. The key is present only when the send carried some context, and absent otherwise: it is never null and never an empty object. Read it to tell a location or contact-card message from a text one without a GET on the message.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/zernio-sdk/models/webhook_payload_message_sent_metadata.rb', line 78

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

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

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

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

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

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

Instance Attribute Details

#contacts ⇒ Object

WhatsApp only. The contact cards this message carries. On API sends this is the contacts array exactly as given to the inbox send API (name, phones[].phone / type, emails[]); on Coexistence echoes of a card shared from the WhatsApp Business app it is Meta's shape (phones[].wa_id, vcard). The message text is only the emoji preview (👤 <name>); the cards live here.



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

def contacts
  @contacts
end

#location ⇒ Object

Returns the value of attribute location.



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

def location
  @location
end

#meta_interactive ⇒ Object

Instagram/Facebook only. The buttons, quickReplies and/or template this outgoing message carried, as sent (tracked urls included when link tracking wrapped a button). Absent when the send carried none.



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

def meta_interactive
  @meta_interactive
end

#quoted_message_id ⇒ Object

platformMessageId of the message this send is a quote-reply to. Present when the reply was sent through Zernio with replyTo on the inbox send API (WhatsApp and Telegram). A WhatsApp API send fires its message.sent off the delivery status, and the quote reference is forwarded from the stored send there, so it arrives on the same message.sent as any other WhatsApp send. Not delivered on Instagram echoes. Zernio forwards reply_to.mid whenever Meta puts it on an echo, but on Instagram Meta does not send it, so a reply the operator quoted in the Instagram app arrives with no quotedMessageId. Facebook Messenger rides a separate subscription (message_echoes) and has not been measured, so treat it as unverified rather than supported. Absent on WhatsApp Coexistence echoes. Meta omits the quote context from smb_message_echoes, so a reply the operator sent from the WhatsApp Business app arrives with no quotedMessageId even though WhatsApp shows it as a quote-reply. Do not read the absence of this field as "not a reply".



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

def quoted_message_id
  @quoted_message_id
end

#thread_ts ⇒ Object

Slack only. Parent thread ts of the sent message. Pass it back as replyTo on the inbox send API to keep replying inside the thread.



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

def thread_ts
  @thread_ts
end

#tiktok_message_type ⇒ Object

TikTok only. The message type as TikTok reports it, forwarded verbatim (for example image, video, sticker, share_post, emoji, reaction, template). Present on every TikTok DM that is not plain text; those arrive with text empty and, for image, video, share_post, sticker and emoji, an attachment (share_post as type share with the embed url and payload.videoId; sticker/emoji as type sticker, url signed and expiring). Absent on image sends made through the Zernio API, which carry the image in attachments.



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

def tiktok_message_type
  @tiktok_message_type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



54
55
56
 
# File 'lib/zernio-sdk/models/webhook_payload_message_sent_metadata.rb', line 54

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/zernio-sdk/models/webhook_payload_message_sent_metadata.rb', line 37

def self.attribute_map
  {
    :'meta_interactive' => :'metaInteractive',
    :'location' => :'location',
    :'contacts' => :'contacts',
    :'quoted_message_id' => :'quotedMessageId',
    :'thread_ts' => :'threadTs',
    :'tiktok_message_type' => :'tiktokMessageType'
  }
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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/zernio-sdk/models/webhook_payload_message_sent_metadata.rb', line 164

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



71
72
73
74
 
# File 'lib/zernio-sdk/models/webhook_payload_message_sent_metadata.rb', line 71

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

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/zernio-sdk/models/webhook_payload_message_sent_metadata.rb', line 59

def self.openapi_types
  {
    :'meta_interactive' => :'Hash<String, Object>',
    :'location' => :'WebhookPayloadMessageSentMetadataLocation',
    :'contacts' => :'Array<Hash<String, Object>>',
    :'quoted_message_id' => :'String',
    :'thread_ts' => :'String',
    :'tiktok_message_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/zernio-sdk/models/webhook_payload_message_sent_metadata.rb', line 138

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      meta_interactive == o.meta_interactive &&
      location == o.location &&
      contacts == o.contacts &&
      quoted_message_id == o.quoted_message_id &&
      thread_ts == o.thread_ts &&
      tiktok_message_type == o.tiktok_message_type
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


151
152
153
 
# File 'lib/zernio-sdk/models/webhook_payload_message_sent_metadata.rb', line 151

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



157
158
159
 
# File 'lib/zernio-sdk/models/webhook_payload_message_sent_metadata.rb', line 157

def hash
  [meta_interactive, location, contacts, quoted_message_id, thread_ts, tiktok_message_type].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



123
124
125
126
127
 
# File 'lib/zernio-sdk/models/webhook_payload_message_sent_metadata.rb', line 123

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/zernio-sdk/models/webhook_payload_message_sent_metadata.rb', line 186

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



131
132
133
134
 
# File 'lib/zernio-sdk/models/webhook_payload_message_sent_metadata.rb', line 131

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end