Class: Zernio::GetInboxConversation200ResponseDataMetadata

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

Overview

Ad-click attribution for a conversation that started from a Meta ad. Absent when the conversation did not originate from an ad click. Captured once, on the first inbound message after the click, and never overwritten. If the same person later clicks a different ad, the original values are kept. Meta only sends the referral on that first message. This operation currently returns only the meta_ad_* family, which covers Instagram Click-to-Direct and Facebook Messenger Click-to-Message. WhatsApp Click-to-WhatsApp attribution (the ctwa_* keys, where the ad ID is ctwa_source_id) is returned by GET /v1/inbox/conversations instead. Every key is optional and only the keys Meta supplied are returned, so read defensively. Meta does not send a campaign or ad set ID, so none is exposed here. More keys may be added over time. Treat any key you do not recognise as an opaque string. Key names differ from the message.received webhook on purpose. The webhook forwards Meta's referral verbatim (ad_id, source, type) while the stored conversation record uses the prefixed names below. Renaming either side would break existing integrations, so both spellings are kept.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



104
105
106
107
108
109
110
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
 
# File 'lib/zernio-sdk/models/get_inbox_conversation200_response_data_metadata.rb', line 104

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#meta_ad_captured_at ⇒ Object

When Zernio stored this referral. Always present when a referral was captured.



50
51
52
 
# File 'lib/zernio-sdk/models/get_inbox_conversation200_response_data_metadata.rb', line 50

def meta_ad_captured_at
  @meta_ad_captured_at
end

#meta_ad_flow_id ⇒ Object

The Meta flow the ad launched, for flow ads.



47
48
49
 
# File 'lib/zernio-sdk/models/get_inbox_conversation200_response_data_metadata.rb', line 47

def meta_ad_flow_id
  @meta_ad_flow_id
end

#meta_ad_id ⇒ Object

The Meta ad ID the user clicked. Always present when a referral was captured.



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

def meta_ad_id
  @meta_ad_id
end

#meta_ad_photo_url ⇒ Object

Image of the ad creative at click time.



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

def meta_ad_photo_url
  @meta_ad_photo_url
end

#meta_ad_post_id ⇒ Object

The organic post the ad promoted, when the ad was a boosted post.



41
42
43
 
# File 'lib/zernio-sdk/models/get_inbox_conversation200_response_data_metadata.rb', line 41

def meta_ad_post_id
  @meta_ad_post_id
end

#meta_ad_product_id ⇒ Object

The catalogue product the user clicked, for product ads.



44
45
46
 
# File 'lib/zernio-sdk/models/get_inbox_conversation200_response_data_metadata.rb', line 44

def meta_ad_product_id
  @meta_ad_product_id
end

#meta_ad_ref ⇒ Object

The ref parameter passed through from the ad creative.



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

def meta_ad_ref
  @meta_ad_ref
end

#meta_ad_source ⇒ Object

Meta-supplied source identifier, for example ADS.



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

def meta_ad_source
  @meta_ad_source
end

#meta_ad_title ⇒ Object

Title of the ad creative at click time.



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

def meta_ad_title
  @meta_ad_title
end

#meta_ad_type ⇒ Object

Meta-supplied referral type, for example OPEN_THREAD.



26
27
28
 
# File 'lib/zernio-sdk/models/get_inbox_conversation200_response_data_metadata.rb', line 26

def meta_ad_type
  @meta_ad_type
end

#meta_ad_video_url ⇒ Object

Video of the ad creative at click time.



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

def meta_ad_video_url
  @meta_ad_video_url
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



70
71
72
 
# File 'lib/zernio-sdk/models/get_inbox_conversation200_response_data_metadata.rb', line 70

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/zernio-sdk/models/get_inbox_conversation200_response_data_metadata.rb', line 75

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/zernio-sdk/models/get_inbox_conversation200_response_data_metadata.rb', line 53

def self.attribute_map
  {
    :'meta_ad_id' => :'meta_ad_id',
    :'meta_ad_source' => :'meta_ad_source',
    :'meta_ad_type' => :'meta_ad_type',
    :'meta_ad_ref' => :'meta_ad_ref',
    :'meta_ad_title' => :'meta_ad_title',
    :'meta_ad_photo_url' => :'meta_ad_photo_url',
    :'meta_ad_video_url' => :'meta_ad_video_url',
    :'meta_ad_post_id' => :'meta_ad_post_id',
    :'meta_ad_product_id' => :'meta_ad_product_id',
    :'meta_ad_flow_id' => :'meta_ad_flow_id',
    :'meta_ad_captured_at' => :'meta_ad_captured_at'
  }
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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/zernio-sdk/models/get_inbox_conversation200_response_data_metadata.rb', line 211

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



97
98
99
100
 
# File 'lib/zernio-sdk/models/get_inbox_conversation200_response_data_metadata.rb', line 97

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'meta_ad_id' => :'String',
    :'meta_ad_source' => :'String',
    :'meta_ad_type' => :'String',
    :'meta_ad_ref' => :'String',
    :'meta_ad_title' => :'String',
    :'meta_ad_photo_url' => :'String',
    :'meta_ad_video_url' => :'String',
    :'meta_ad_post_id' => :'String',
    :'meta_ad_product_id' => :'String',
    :'meta_ad_flow_id' => :'String',
    :'meta_ad_captured_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/zernio-sdk/models/get_inbox_conversation200_response_data_metadata.rb', line 180

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      meta_ad_id == o.meta_ad_id &&
      meta_ad_source == o.meta_ad_source &&
      meta_ad_type == o.meta_ad_type &&
      meta_ad_ref == o.meta_ad_ref &&
      meta_ad_title == o.meta_ad_title &&
      meta_ad_photo_url == o.meta_ad_photo_url &&
      meta_ad_video_url == o.meta_ad_video_url &&
      meta_ad_post_id == o.meta_ad_post_id &&
      meta_ad_product_id == o.meta_ad_product_id &&
      meta_ad_flow_id == o.meta_ad_flow_id &&
      meta_ad_captured_at == o.meta_ad_captured_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


198
199
200
 
# File 'lib/zernio-sdk/models/get_inbox_conversation200_response_data_metadata.rb', line 198

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



204
205
206
 
# File 'lib/zernio-sdk/models/get_inbox_conversation200_response_data_metadata.rb', line 204

def hash
  [meta_ad_id, meta_ad_source, meta_ad_type, meta_ad_ref, meta_ad_title, meta_ad_photo_url, meta_ad_video_url, meta_ad_post_id, meta_ad_product_id, meta_ad_flow_id, meta_ad_captured_at].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



165
166
167
168
169
 
# File 'lib/zernio-sdk/models/get_inbox_conversation200_response_data_metadata.rb', line 165

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



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/zernio-sdk/models/get_inbox_conversation200_response_data_metadata.rb', line 233

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



173
174
175
176
 
# File 'lib/zernio-sdk/models/get_inbox_conversation200_response_data_metadata.rb', line 173

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